Swing通过后台线程实现页面更新

业务场景

在swing程序中，我们想实现一个随着任务的执行而同步更新组件的功能，如果在主线程（EDT）中直接执行任务并更新组件，则会导致组件只显示最终更新的状态的问题，这是因为EDT是单线程的，在执行耗时任务时会导致线程阻塞，无法即使更新swing组件。

为了实现这一功能，我们需要采用后台线程去执行任务，执行之后同步给EDT线程的方案，具体实现的话，我们可以使用 SwingWorker 这个函数在执行后台任务的同时实现组件的实时更新。

相关函数

下面我们介绍 SwingWorker中几个重要的函数：

1. doInBackground() 方法：

   • doInBackground() 是 SwingWorker 中最重要的方法之一。
   • 在这个方法中，您可以执行耗时的任务，例如文件下载、数据处理或计算等。
   • 这个方法运行在后台线程，不会阻塞事件分发线程（EDT），因此可以确保用户界面的响应性。

2. publish() 和 process() 方法：

   • publish(V... chunks) 方法用于将数据块（chunk）发布到事件分发线程（EDT）以供处理。
   • process(List<V> chunks) 方法用于在事件分发线程（EDT）上处理已发布的数据块。
   • 这对方法一起工作，允许您在后台任务执行期间向事件分发线程发送数据，以便在用户界面上实时更新 Swing 组件，例如进度条或文本标签。

3. done() 方法：

   • done() 方法在后台任务完成后在事件分发线程（EDT）上执行。
   • 您可以在这个方法中处理任务完成后的任何收尾工作，例如清理资源、显示结果或触发其他操作。

4. get() 方法：

   • get() 方法用于获取后台任务的结果。
   • 它可以用于在任务完成后检索结果，但要注意，调用 get() 方法会阻塞当前线程，直到任务完成。

5. cancel() 方法：

   • cancel(boolean mayInterruptIfRunning) 方法用于取消后台任务。
   • 如果 mayInterruptIfRunning 参数为 true，则会尝试中断正在运行的任务。否则，它将尝试取消任务，但不会中断正在运行的任务。

这里我们需要注意SwingWorker声明了一个数据块chunk泛型数组来实现后台进程和EDT主进程的数据交互。

在我们下面的案例代码中，doInBackground()每次模拟完耗时操作后都会通过publish更新chunk数组，在proces函数中拿到这个数组的最后一位数据，实现实时更新。

案例代码

import javax.swing.*;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

public class test {
    private JFrame frame;
    private JProgressBar progressBar;
    private JLabel progressLabel;

    public test() {
        frame = new JFrame("Progress Bar Demo");
        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        frame.setSize(300, 100);
        frame.setLayout(new FlowLayout());

        progressBar = new JProgressBar(0, 100);
        progressBar.setStringPainted(true); // 显示百分比
        frame.add(progressBar);

        progressLabel = new JLabel("Progress: 0%");
        frame.add(progressLabel);

        JButton startButton = new JButton("Start");
        startButton.addActionListener(new ActionListener() {
            @Override
            public void actionPerformed(ActionEvent e) {
                startTask();
            }
        });
        frame.add(startButton);

        frame.setVisible(true);
    }

    private void startTask() {
        SwingWorker<Void, Integer> worker = new SwingWorker<Void, Integer>() {
            @Override
            protected Void doInBackground() throws Exception {
                for (int i = 0; i <= 100; i++) {
                    Thread.sleep(100); // 模拟耗时任务
                    publish(i); // 发布进度
                }
                return null;
            }

            @Override
            protected void process(java.util.List<Integer> chunks) {
                int latestProgress = chunks.get(chunks.size() - 1);
                progressBar.setValue(latestProgress);
                progressLabel.setText("Progress: " + latestProgress + "%");
            }

            @Override
            protected void done() {
                progressLabel.setText("Progress: 100% (Task completed)");
            }
        };

        worker.execute(); // 启动后台任务
    }

    public static void main(String[] args) {
        SwingUtilities.invokeLater(new Runnable() {
            @Override
            public void run() {
                new test();
            }
        });
    }
}

效果图