Класс 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 для выполнения.