Spring-Boot中一个不起眼的好工具StopWatch - 文章详情

你好，我是风一样的树懒，一个工作十多年的后端开发，曾就职京东、阿里等多家互联网头部企业。

点击下方👇关注公众号，带你一起复习后端技术，看看面试考点，补充积累技术知识，每天都为面试准备积累

在 Spring Boot 中，StopWatch 是一个用于计时和性能监控的工具类，主要用于测量一段代码的执行时间。它可以帮助开发者轻松地在程序中进行性能分析，尤其适合用于对比不同操作的时间消耗，帮助优化代码或进行调试。

StopWatch 属于Spring Framework 提供的工具类，在 org.springframework.util.StopWatch 包下。它的核心功能是记录开始和结束时间，并且可以测量多个任务的执行时间。

StopWatch 的基本使用

创建 StopWatch 实例
开始计时
执行需要测量的任务
停止计时
获取执行时间
输出结果

StopWatch 的常用方法

import org.springframework.util.StopWatch;public class StopWatchExample {    public static void main(String[] args) throws InterruptedException {        StopWatch stopWatch = new StopWatch();                // 启动计时        stopWatch.start("Task 1");                // 执行任务（模拟耗时操作）        Thread.sleep(1000);                // 结束计时        stopWatch.stop();                // 启动下一个任务        stopWatch.start("Task 2");                // 执行另一个任务（模拟耗时操作）        Thread.sleep(500);                // 结束计时        stopWatch.stop();                // 打印结果        System.out.println(stopWatch.prettyPrint());    }}

核心方法解释

start(String taskName)
启动计时，taskName 用于标识这段任务。可以多次调用 start 方法来启动多个任务。
stop()
停止当前的计时任务，记录下当前任务的执行时间。如果没有调用 start 方法，调用 stop 会抛出异常。
getTotalTimeMillis()
获取所有任务的总执行时间，单位是毫秒。
getTaskCount()
获取已经启动并执行的任务数。
getTaskInfo()
获取所有任务的详细信息。返回一个 TaskInfo[] 数组，包含每个任务的名称、执行时间、任务状态等信息。
prettyPrint()
格式化输出任务的执行信息。返回一个易于阅读的字符串，包含了每个任务的执行时间等详细信息。

prettyPrint() 方法输出格式

假设你有两个任务分别花费了 1 秒和 500 毫秒，prettyPrint() 输出大致会是：

StopWatch '': running time = 1.5 seconds-----------------------------------------task 'Task 1' running time = 1.000 secondstask 'Task 2' running time = 0.500 seconds-----------------------------------------Total running time = 1.500 seconds