Класс SwingWorker<T,V>

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

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

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

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

Поток выполнения

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

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

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

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

Часто, Текущий поток является Потоком обработки событий.

Прежде чем метод doInBackground вызывается в рабочем потоке, SwingWorker уведомляет всех слушателей об изменении свойства state на StateValue.STARTED. После завершения метода doInBackground выполняется метод done. Затем SwingWorker уведомляет всех слушателей об изменении свойства 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 для выполнения.