如何使用进度条

有时，程序中运行的任务可能需要一些时间才能完成。用户友好的程序向用户提供一些指示，表明任务正在进行中，任务可能需要多长时间，已经完成了多少工作。一种指示工作和进度的方法是使用动画图像。

另一种指示工作的方法是设置等待光标，使用Cursor类和Component定义的setCursor方法。例如，下面的代码使得当光标在container上方时（包括其中未指定光标的任何组件），等待光标将被显示：

container.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));

为了表明任务的完成程度，可以使用进度条，如下所示：

有时，无法立即确定长时间运行任务的长度，或者任务可能会在同一完成状态停留很长时间。可以通过将进度条置于不确定模式来显示工作而没有可测量的进度。不确定模式下的进度条会显示动画以指示工作正在进行中。一旦进度条可以显示更有意义的信息，应将其切换回默认的确定模式。在Java外观中，不确定进度条如下所示：

Swing提供了三个类来帮助您使用进度条：

JProgressBar

用于以图形方式显示总任务完成的组件。有关使用典型进度条的信息和示例，请参见使用确定进度条。在使用不确定模式部分，了解如何使用进度条来显示任务范围未知之前的活动。

ProgressMonitor

不是可见组件。而是该类的一个实例监视任务的进度，并在必要时弹出一个对话框。有关详细信息和使用进度监视器的示例，请参见如何使用进度监视器。

ProgressMonitorInputStream

附带进度监视器的输入流，用于监视从流中读取的数据。您可以像使用基本I/O中描述的其他输入流一样使用该流的实例。可以使用getProgressMonitor调用来获取流的进度监视器，并按照如何使用进度监视器中的说明进行配置。

在你看到进度条和进度监视器实际操作之后，决定使用进度条还是进度监视器可以帮助你确定哪种适用于你的应用程序。

使用确定进度条

这是一个使用进度条来测量其自己线程中运行的任务进度的小型演示应用程序的图片：

下面的代码来自ProgressBarDemo.java，创建并设置了进度条：

//声明成员变量的位置：
JProgressBar progressBar;
...
//构建GUI的位置：
progressBar = new JProgressBar(0, task.getLengthOfTask());
progressBar.setValue(0);
progressBar.setStringPainted(true);

创建进度条的构造函数设置了进度条的最小值和最大值。你也可以使用setMinimum和setMaximum方法设置这些值。此程序中使用的最小值和最大值为0和任务的长度，这是许多程序和任务的典型值。然而，进度条的最小值和最大值可以是任何值，甚至是负数。代码片段还将进度条的当前值设置为0。

调用setStringPainted方法会导致进度条在其边界内显示任务完成的百分比的文本指示。默认情况下，进度条显示其getPercentComplete方法返回的值格式化为百分数，例如33%。你也可以通过调用setString方法将默认值替换为其他字符串。例如：

if (/*...已完成一半...*/)
    progressBar.setString("已完成一半！");

public void actionPerformed(ActionEvent evt) {
    startButton.setEnabled(false);
    setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
    done = false;
    task = new Task();
    task.addPropertyChangeListener(this);
    task.execute();
}

1. 该实例在单独的线程中调用doInBackground。这是实际执行的长时间任务。使用后台线程而不是事件分派线程可以防止用户界面在任务运行时冻结。
2. 当后台任务完成时，该实例在事件分派线程中调用done方法。
3. 该实例维护一个绑定属性progress，用于指示任务的进度。每次progress更改时，都会调用propertyChange方法。

public void propertyChange(PropertyChangeEvent evt) {
    if (!done) {
        int progress = task.getProgress();
        progressBar.setValue(progress);
        taskOutput.append(String.format(
                "已完成任务的%d%%。\n", progress));
    }

public void done() {
    // 告诉进度监听器停止更新进度条。
    done = true;
    Toolkit.getDefaultToolkit().beep();
    startButton.setEnabled(true);
    setCursor(null); // 关闭等待光标
    progressBar.setValue(progressBar.getMinimum());
    taskOutput.append("完成！\n");
}

使用不确定模式

在ProgressBarDemo2中，直到实际进度开始前，它被设置为不确定模式：

public void propertyChange(PropertyChangeEvent evt) {
    if (!done) {
        int progress = task.getProgress();
        if (progress == 0) {
            progressBar.setIndeterminate(true);
            taskOutput.append("尚无进度\n");
        } else {
            progressBar.setIndeterminate(false); 
            progressBar.setString(null);
            progressBar.setValue(progress);
            taskOutput.append(String.format(
                    "已完成任务的%d%%。\n", progress));
        }
    }
}

代码中的其他更改与字符串显示相关。一个显示字符串的进度条很可能比不显示字符串的进度条要高，作为演示设计者，我们任意决定这个进度条只有在默认的确定模式下才显示字符串。然而，我们希望在模式改变时避免可能导致布局不美观的问题。因此，代码中保留了调用setStringPainted(true)的部分，但添加了调用setString("")的部分，以便不显示任何文本。稍后，当进度条从不确定模式切换到确定模式时，调用setString(null)会使进度条显示其默认字符串。

我们没有进行的一个更改是从progress事件处理程序中删除progressBar.setValue的调用。这个调用不会造成任何问题，因为一个不确定的进度条不使用其值属性，除了可能在状态字符串中显示它。实际上，保持进度条的数据尽可能更新是一个好的实践，因为某些外观可能不支持不确定模式。

如何使用进度监视器

现在让我们重新编写ProgressBarDemo，使用进度监视器而不是进度条。下面是新的演示程序ProgressMonitorDemo的图片：

进度监视器无法再次使用，因此每次开始新任务时都必须创建一个新的监视器。该程序在用户点击“开始”按钮时创建一个新的进度监视器。

下面是创建进度监视器的语句：

progressMonitor = new ProgressMonitor(ProgressMonitorDemo.this,
                                      "运行一个长时间的任务",
                                      "", 0, task.getLengthOfTask());

这段代码使用ProgressMonitor的唯一构造方法创建监视器，并初始化了几个参数：

• 第一个参数是对话框的父组件，由进度监视器弹出。
• 第二个参数是一个描述被监视任务性质的字符串。该字符串会显示在对话框中。有关该参数的详细信息，请参见进度监视API。
• 第三个参数是另一个字符串，提供一个可变的状态说明。示例中使用空字符串表示对话框应为可变的状态说明留出空间，但初始时为空。如果将该参数设为null，则对话框中不会显示状态说明。示例在每次progress属性变化时更新状态说明。它同时也更新监视器的当前值：

  int progress = task.getProgress();
  String message = String.format("已完成 %d%%。\n", progress);
  progressMonitor.setNote(message);
  progressMonitor.setProgress(progress);
  taskOutput.append(message);
  

• 最后两个参数分别提供进度对话框中进度条的最小值和最大值。

默认情况下，进度监视器在决定是否弹出对话框之前等待至少500毫秒。它还会等待进度超过最小值。如果计算出任务需要超过2000毫秒才能完成，进度对话框将出现。要调整最小等待时间，请调用setMillisToDecidedToPopup。要调整对话框出现所需的最小进度时间，请调用setMillisToPopup。

由于这个示例使用了进度监视器，因此添加了一个在使用进度条的版本中不存在的功能：用户可以通过在对话框上点击取消按钮来取消任务。以下是示例中检查用户是否取消了任务或任务是否正常退出的代码：

if (progressMonitor.isCanceled() || task.isDone()) {
    progressMonitor.close();
    Toolkit.getDefaultToolkit().beep();
    if (progressMonitor.isCanceled()) {
        task.cancel(true);
        taskOutput.append("任务已取消。\n");
    } else {
        taskOutput.append("任务已完成。\n");
    }
    startButton.setEnabled(true);
}

请注意，进度监视器本身不会取消任务。它提供GUI和API，以便程序可以轻松地这样做。

决定使用进度条还是进度监视器

如果满足以下条件，请使用进度条：

• 您希望对进度条的配置有更多控制权。如果直接使用进度条，您可以将其设置为不确定模式，垂直显示，提供字符串进行显示，注册更改监听器，并提供有界范围模型来控制进度条的最小值、最大值和当前值。
• 程序需要与进度条一起显示其他组件。
• 您需要多个进度条。对于某些任务，您需要监视多个参数。例如，安装程序可能会监视磁盘空间使用情况以及成功安装的文件数量。
• 您需要重复使用进度条。进度条可以重复使用，进度监视器不能。一旦进度监视器决定显示对话框（或不显示），它就不能再次显示。

如果满足以下条件，请使用进度监视器：

• 您希望以对话框的方式轻松显示进度。
• 正在运行的任务是次要的，用户可能对任务的进度不感兴趣。进度监视器提供了一种在任务仍在运行时用户可以关闭对话框的方式。
• 您希望任务可以轻松取消。进度监视器为用户提供了一个GUI来取消任务。您只需要调用进度监视器的isCanceled方法，以查看用户是否按下了取消按钮。
• 您的任务在运行时会定期显示一条短消息。进度监视器对话框提供了setNote方法，以便任务可以提供有关正在进行的操作的进一步信息。例如，安装任务可以报告每个文件的名称。
• 任务可能不需要很长时间才能完成。您可以决定在何时任务运行时间足够长，需要让用户了解情况。如果任务在您设置的时间范围内完成，进度监视器将不会弹出对话框。

如果您决定使用进度监视器，并且要监视的任务正在从输入流中读取数据，请使用ProgressMonitorInputStream类。

进度监视 API

以下表格列出了常用的用于使用进度条和进度监视器的 API。因为JProgressBar是JComponent的子类，您可能会调用JProgressBar上的其他方法，这些方法在JComponent 类中列出。请注意，ProgressMonitor是Object的子类，而不是可视组件。

用于监视进度的 API 分为以下几类：

• 创建进度条
• 设置或获取进度条的限制/值
• 控制进度条的外观
• 创建进度监视器
• 配置进度监视器
• 终止进度监视器

监视进度的示例

以下示例使用JProgressBar或ProgressMonitor。

如果您正在使用JavaFX进行编程，请参阅进度条和进度指示器。