Класс SwingWorker<T,V>

При написании многопоточного приложения, использующего Swing, следует учитывать два ограничения: (см. Конкурентность в Swing для получения дополнительной информации):

• Задачи, требующие много времени, не должны выполняться в потоке обработки событий. В противном случае приложение перестанет отвечать.
• Компоненты Swing должны обращаться только к потоку обработки событий.

Эти ограничения означают, что приложение GUI с ресурсоёмкими вычислениями нуждается как минимум в двух потоках: 1) поток для выполнения длительной задачи и 2) поток обработки событий (EDT) для всех операций, связанных с GUI. Это предполагает межпоточное взаимодействие, которое может быть трудно реализовать.

SwingWorker предназначен для ситуаций, когда требуется запуск длительной задачи в фоновом потоке и предоставление обновлений в интерфейсе пользователя, либо по завершении, либо во время обработки. Подклассы SwingWorker должны реализовать метод doInBackground() для выполнения вычислений в фоновом режиме.

Порядок работы

В жизненном цикле SwingWorker участвуют три потока:

• Текущий поток: В этом потоке вызывается метод execute(). Он планирует SwingWorker для выполнения в рабочем потоке и возвращается немедленно. Дождаться завершения SwingWorker можно с помощью методов get.

• Рабочий поток: В этом потоке вызывается метод doInBackground(). Здесь должны происходить все фоновые действия. Для уведомления PropertyChangeListeners о изменениях свойств используйте методы firePropertyChange и getPropertyChangeSupport(). По умолчанию доступны два связанных свойства: state и progress.

• Поток обработки событий: Все операции, связанные со Swing, происходят в этом потоке. SwingWorker вызывает методы process и done() и уведомляет любых PropertyChangeListeners в этом потоке.

Часто Текущий поток — это Поток обработки событий.

Перед вызовом метода doInBackground в рабочем потоке, SwingWorker уведомляет любых PropertyChangeListeners об изменении свойства state на StateValue.STARTED. После завершения метода doInBackground выполняется метод done. Затем SwingWorker уведомляет любых PropertyChangeListeners об изменении свойства state на StateValue.DONE.

SwingWorker предназначен для выполнения только один раз. Выполнение SwingWorker более одного раза не приведёт к двукратному вызову метода doInBackground.

Пример использования

Следующий пример иллюстрирует самый простой случай использования. Некоторые вычисления выполняются в фоновом режиме, а по завершении вы обновляете компонент Swing.

Предположим, что мы хотим найти «Смысл Жизни» и отобразить результат в JLabel.

   final JLabel label;
   class MeaningOfLifeFinder extends SwingWorker<String, Object> {
       @Override
       public String doInBackground() {
           return findTheMeaningOfLife();
       }

       @Override
       protected void done() {
           try {
               label.setText(get());
           } catch (Exception ignore) {
           }
       }
   }

   (new MeaningOfLifeFinder()).execute();
 

Следующий пример полезен в ситуациях, когда вы хотите обрабатывать данные по мере их готовности в потоке обработки событий.

Теперь мы хотим найти первые N простых чисел и отобразить результаты в JTextArea. Пока это происходит, мы хотим обновлять наш прогресс в JProgressBar. Наконец, мы также хотим вывести простые числа в System.out.

 class PrimeNumbersTask extends
         SwingWorker<List<Integer>, Integer> {
     PrimeNumbersTask(JTextArea textArea, int numbersToFind) {
         //initialize
     }

     @Override
     public List<Integer> doInBackground() {
         while (! enough && ! isCancelled()) {
                 number = nextPrimeNumber();
                 publish(number);
                 setProgress(100 * numbers.size() / numbersToFind);
             }
         }
         return numbers;
     }

     @Override
     protected void process(List<Integer> chunks) {
         for (int number : chunks) {
             textArea.append(number + "\n");
         }
     }
 }

 JTextArea textArea = new JTextArea();
 final JProgressBar progressBar = new JProgressBar(0, 100);
 PrimeNumbersTask task = new PrimeNumbersTask(textArea, N);
 task.addPropertyChangeListener(
     new PropertyChangeListener() {
         public  void propertyChange(PropertyChangeEvent evt) {
             if ("progress".equals(evt.getPropertyName())) {
                 progressBar.setValue((Integer)evt.getNewValue());
             }
         }
     });

 task.execute();
 System.out.println(task.get()); //prints all prime numbers we have got
 

Поскольку SwingWorker реализует Runnable, SwingWorker можно отправить на выполнение в Executor.