Класс SwingWorker<T,V>

Абстрактный класс для выполнения длительных задач взаимодействия с графическим интерфейсом в фоновом потоке. Несколько фоновых потоков могут использоваться для выполнения таких задач. Однако точная стратегия выбора потока для любой конкретной SwingWorker не определена и не должна использоваться.

При написании многопоточного приложения с использованием 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 для выполнения.

Конструкторы

SwingWorker

public SwingWorker()

Создаёт этот SwingWorker.

Методы

doInBackground

protected abstract T doInBackground()
                             throws Exception

Возвращает:

вычисленный результат

Исключения:

Exception - если невозможно вычислить результат

run

public final void run()

Устанавливает этот Future в результат вычисления, если он не был отменён.

Задано:

run в интерфейсе Runnable

Задано:

run в интерфейсе RunnableFuture<T>

См. также:

Thread.run()

publish

@SafeVarargs
protected final void publish(V... chunks)

publish("1");
 publish("2", "3");
 publish("4", "5", "6");

process("1", "2", "3", "4", "5", "6")

class TableSwingWorker extends
         SwingWorker<DefaultTableModel, Object[]> {
     private final DefaultTableModel tableModel;

     public TableSwingWorker(DefaultTableModel tableModel) {
         this.tableModel = tableModel;
     }

      @Override
     protected DefaultTableModel doInBackground() throws Exception {
         for (Object[] row = loadData();
                  ! isCancelled() && row != null;
                  row = loadData()) {
             publish((Object[]) row);
         }
         return tableModel;
     }

      @Override
     protected void process(List<Object[]> chunks) {
         for (Object[] row : chunks) {
             tableModel.addRow(row);
         }
     }
 }

Параметры:

chunks - промежуточные результаты для обработки

См. также:

process(java.util.List<V>)

process

protected void process(List<V> chunks)

Параметры:

chunks - промежуточные результаты для обработки

См. также:

publish(V...)

done

protected void done()

Выполняется в потоке обработки событий (Event Dispatch Thread) после завершения метода doInBackground. По умолчанию метод ничего не делает. Подклассы могут переопределять этот метод для выполнения действий завершения в потоке обработки событий (Event Dispatch Thread). Обратите внимание, что вы можете запросить статус внутри реализации этого метода, чтобы определить результат задачи или отменена ли она.

См. также:

doInBackground(), isCancelled(), get()

setProgress

protected final void setProgress(int progress)

setProgress(1);
 setProgress(2);
 setProgress(3);

Параметры:

progress - значение прогресса для установки

Исключения:

IllegalArgumentException - если значение не находится в диапазоне от 0 до 100

getProgress

public final int getProgress()

Возвращает свойство progress.

Возвращает:

свойство прогресса.

execute

public final void execute()

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Задано:

cancel в интерфейсе Future<T>

Параметры:

mayInterruptIfRunning - true если поток, выполняющий эту задачу, должен быть прерван; в противном случае текущие задачи могут завершиться

Возвращает:

false если задачу невозможно отменить, обычно потому, что она уже завершена нормально; true в противном случае

isCancelled

public final boolean isCancelled()

Возвращает true , если эта задача была отменена до нормального завершения.

Задано:

isCancelled в интерфейсе Future<T>

Возвращает:

true если эта задача была отменена до завершения

isDone

public final boolean isDone()

Возвращает true , если эта задача завершена. Завершение может быть вызвано нормальным завершением, исключением или отменением — во всех этих случаях этот метод вернёт true.

Задано:

isDone в интерфейсе Future<T>

Возвращает:

true если эта задача завершена

get

public final T get()
            throws InterruptedException,
                   ExecutionException

class SwingWorkerCompletionWaiter extends PropertyChangeListener {
     private JDialog dialog;

     public SwingWorkerCompletionWaiter(JDialog dialog) {
         this.dialog = dialog;
     }

     public void propertyChange(PropertyChangeEvent event) {
         if ("state".equals(event.getPropertyName())
                 && SwingWorker.StateValue.DONE == event.getNewValue()) {
             dialog.setVisible(false);
             dialog.dispose();
         }
     }
 }
 JDialog dialog = new JDialog(owner, true);
 swingWorker.addPropertyChangeListener(
     new SwingWorkerCompletionWaiter(dialog));
 swingWorker.execute();
 //the dialog will be visible until the SwingWorker is done
 dialog.setVisible(true);

Задано:

get в интерфейсе Future<T>

Возвращает:

вычисленный результат

Исключения:

InterruptedException - если текущий поток был прерван во время ожидания

ExecutionException - если вычисление выбросило исключение

get

public final T get(long timeout,
                   TimeUnit unit)
            throws InterruptedException,
                   ExecutionException,
                   TimeoutException

Задано:

get в интерфейсе Future<T>

Параметры:

timeout - максимальное время ожидания

unit - единица измерения времени аргумента таймаута

Возвращает:

вычисленный результат

Исключения:

InterruptedException - если текущий поток был прерван во время ожидания

ExecutionException - если вычисление выбросило исключение

TimeoutException - если ожидание истекло

addPropertyChangeListener

public final void addPropertyChangeListener(PropertyChangeListener listener)

Параметры:

listener - PropertyChangeListener для добавления

removePropertyChangeListener

public final void removePropertyChangeListener(PropertyChangeListener listener)

Параметры:

listener - PropertyChangeListener для удаления

firePropertyChange

public final void firePropertyChange(String propertyName,
                                     Object oldValue,
                                     Object newValue)

Параметры:

propertyName - программное имя свойства, которое было изменено

oldValue - старое значение свойства

newValue - новое значение свойства

getPropertyChangeSupport

public final PropertyChangeSupport getPropertyChangeSupport()

Возвращает:

PropertyChangeSupport для этого SwingWorker

getState

public final SwingWorker.StateValue getState()

Возвращает связанное свойство состояния SwingWorker.

Возвращает:

текущее состояние