Класс SwingWorker<T,V>

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

• Длительные задачи не следует выполнять в потоке обработки событий. В противном случае приложение перестанет отвечать на запросы.
• Доступ к компонентам Swing должен осуществляться только в потоке обработки событий.

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

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.