当前位置：首页 > news >正文

StopWatch的使用

news 2025/6/23 8:31:20

org.springframework.util.StopWatch 是 Spring 框架提供的一个轻量级的计时工具，用于测量代码执行时间。它比 Apache Commons Lang 的 StopWatch 提供了更多的功能，例如累计多个时间段、打印详细报告等。

以下是如何使用 Spring 的 StopWatch：

1. 创建 StopWatch 实例

首先，创建一个 StopWatch 对象：

import org.springframework.util.StopWatch;StopWatch stopWatch = new StopWatch();

2. 启动计时

在执行任务之前，调用 start() 方法来开始计时：

stopWatch.start("任务描述");

你可以给每个计时任务指定一个任务名，这有助于在输出报告时区分不同的任务。

3. 执行任务

执行你想要测量的任务：

// 执行一些操作
performTask();

4. 停止计时

任务完成后，调用 stop() 方法来停止计时：

stopWatch.stop();

5. 获取结果

调用 getLastTaskTimeMillis() 方法来获取最后一次任务的执行时间（毫秒）：

long lastTaskTime = stopWatch.getLastTaskTimeMillis();
System.out.println("Last task time: " + lastTaskTime + " ms");

6. 打印详细报告

使用 print() 方法打印 StopWatch 的详细报告：

stopWatch.print();

这将输出所有任务的名称、开始时间、持续时间等信息。

7. 重置 StopWatch

如果你想重新开始测量，可以调用 reset() 方法：

stopWatch.reset();

示例代码

import org.springframework.util.StopWatch;public class StopWatchExample {public static void main(String[] args) {StopWatch stopWatch = new StopWatch();stopWatch.start("Task1");// 执行 Task1performTask1();stopWatch.stop();stopWatch.start("Task2");// 执行 Task2performTask2();stopWatch.stop();// 打印详细报告stopWatch.print();// 重置 StopWatchstopWatch.reset();}private static void performTask1() {// 模拟耗时任务try {Thread.sleep(1000);} catch (InterruptedException e) {Thread.currentThread().interrupt();}}private static void performTask2() {// 模拟另一个耗时任务try {Thread.sleep(2000);} catch (InterruptedException e) {Thread.currentThread().interrupt();}}
}

注意事项

StopWatch 是线程安全的，但每个 StopWatch 实例只能用于测量一个时间段。
使用 stop() 方法后，你可以再次调用 start() 方法来测量新的时间段，而不需要创建新的 StopWatch 实例。
print() 方法默认使用 System.out 打印报告，你也可以传递一个 PrintWriter 或 PrintStream 到 print() 方法来指定输出目标。

Spring 的 StopWatch 是一个非常有用的工具，特别是在性能调优和基准测试中。
Spring 的 StopWatch 类提供了一些高级用法和功能，可以帮助你更细致地进行性能分析。以下是一些其他用法：

分阶段计时（Task Timing）

你可以对多个阶段或任务进行计时，这在测量整个流程中的各个部分的性能时非常有用：

StopWatch stopWatch = new StopWatch();
stopWatch.start("阶段1");
// 阶段1的代码
stopWatch.stop();stopWatch.start("阶段2");
// 阶段2的代码
stopWatch.stop();// 打印每个阶段的用时
System.out.println("阶段1用时：" + stopWatch.getLastTaskInfo().getTimeTaken() + "毫秒");
System.out.println("阶段2用时：" + stopWatch.getLastTaskInfo().getTimeTaken() + "毫秒");

累计计时（Cumulative Timing）

StopWatch 允许你多次调用 start() 和 stop()，它会累积计时结果：

StopWatch stopWatch = new StopWatch();
// 假设执行多个循环或重复任务
for (int i = 0; i < 5; i++) {stopWatch.start("循环" + i);// 循环任务的代码performTask();stopWatch.stop();
}
// 打印总用时
System.out.println("总用时：" + stopWatch.getTotalTimeMillis() + "毫秒");

格式化输出（Formatted Output）

StopWatch 的 prettyPrint() 方法提供了一种格式化的输出方式，使得输出结果更加易于阅读：

stopWatch.prettyPrint();
// 或者指定输出目的地
stopWatch.prettyPrint(System.out);

获取详细信息（Detailed Information）

你可以获取有关每个任务的详细信息，例如开始时间、结束时间、持续时间等：

StopWatch.TaskInfo taskInfo = stopWatch.getLastTaskInfo();
System.out.println("任务名称：" + taskInfo.getTaskName());
System.out.println("开始时间：" + taskInfo.getStartTime());
System.out.println("持续时间：" + taskInfo.getTimeTaken() + "毫秒");

异常处理（Exception Timing）

你可以测量抛出异常的任务的执行时间：

try {stopWatch.start("可能抛出异常的任务");// 可能抛出异常的代码stopWatch.stop();
} catch (Exception e) {System.out.println("任务失败，用时：" + stopWatch.getLastTaskTimeMillis());
}

嵌套计时（Nested Timing）

StopWatch 支持嵌套计时，这意味着你可以在另一个任务计时的内部开始和停止计时：

stopWatch.start("外部任务");
try {stopWatch.start("内部任务");// 内部任务的代码stopWatch.stop();
} finally {stopWatch.stop("外部任务");
}

配置输出（Customizing Output）

你可以自定义 StopWatch 的输出格式，通过传递自定义的 PrintWriter 或 PrintStream 到 print() 或 prettyPrint() 方法：

PrintWriter writer = new PrintWriter(new StringWriter());
stopWatch.prettyPrint(writer);
System.out.println(writer.toString());

测量代码块的执行时间（Measuring Code Block）

你可以测量任意代码块的执行时间，而不需要在代码块内部手动调用 start() 和 stop()：

StopWatch stopWatch = new StopWatch();
stopWatch.start("代码块任务");
long time = stopWatch.lastTaskTimeMillis();
System.out.println("代码块执行前用时：" + time + "毫秒");// 执行代码块
performTask();stopWatch.stop();
System.out.println("代码块执行后用时：" + stopWatch.getLastTaskTimeMillis() + "毫秒");