使用 Spring 的 StopWatch 实现代码性能监控

前言：在开发过程中，偶尔还是需要分析代码的执行时间（比如定位线上执行缓慢原因的时候，记录任务执行时间的时候），肯定有人去使用System.currentTimeMillis()然后自己去计算时间差再打印。其实Spring 框架提供了一个方便的工具类 StopWatch，用于测量代码块的执行时间。本文将介绍 StopWatch 的基本用法，并通过示例演示如何在项目中使用 StopWatch 进行代码性能监控。（底层获取时间的API用的System.nanoTime()，System.currentTimeMillis() 去统计时间差据说更精确）

1. StopWatch 简介

StopWatch 是 Spring 框架中的一个工具类，用于测量代码块的执行时间。StopWatch 可以精确地测量代码块的执行时间，比是并提供了方便的方法来记录和输出执行时间的信息。

2. 使用 StopWatch

2.1 导入依赖（基本java项目都是springboot的吧，不用做这一步了）

首先，我们需要在项目中导入 Spring 的相关依赖。在 Maven 项目中，可以在 pom.xml 文件中添加以下依赖项：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>5.3.10</version>
</dependency>

2.2 创建 StopWatch 实例

在代码中，我们可以通过实例化 StopWatch 类来创建一个 StopWatch 对象：

StopWatch stopWatch = new StopWatch();

2.3 记录代码块的执行时间

使用 StopWatch 的 start() 和 stop() 方法可以记录代码块的执行时间。在代码块开始处调用 start() 方法，在代码块结束处调用 stop() 方法。以下是一个示例：

stopWatch.start();

// 执行需要监控的代码块
// ...

stopWatch.stop();

2.4 输出执行时间信息

StopWatch 提供了多种方法来输出执行时间的信息。可以使用 getTotalTimeMillis() 方法获取总的执行时间（以毫秒为单位），使用 getTotalTimeSeconds() 方法获取总的执行时间（以秒为单位）。还可以使用 prettyPrint() 方法将执行时间以更友好的格式输出。以下是一个示例：

System.out.println("总执行时间（毫秒）：" + stopWatch.getTotalTimeMillis());
System.out.println("总执行时间（秒）：" + stopWatch.getTotalTimeSeconds());

stopWatch.prettyPrint();

3. 示例演示

假设我们有一个需要监控执行时间的方法，如下所示：

public void performTimeConsumingTask() {
    StopWatch stopWatch = new StopWatch();
    stopWatch.start("任务1");

    // 执行耗时任务
    // ...

    stopWatch.stop();
   stopWatch.start("任务1");

    // 执行耗时任务2
    // ...

    stopWatch.stop();
    System.out.println("任务执行时间（毫秒）：" + stopWatch.toString());

}

在上述示例中，我们在 performTimeConsumingTask() 方法中创建了一个 StopWatch 对象，并在任务开始和结束时调用了 start() 和 stop() 方法。最后，我们使用 toString() 方法打印任务的执行时间。

4. 总结

使用 Spring 的 StopWatch 工具类可以方便地测量代码块的执行时间，从而实现代码性能监控。本文介绍了 StopWatch 的基本用法，并通过示例演示了如何在项目中使用 StopWatch。这样又少些一点代码了，代码又变高级了。