StopWatch 是 Spring 框架提供的一个轻量级计时工具类

StopWatch是 Spring 框架提供的一个轻量级计时工具类位于org.springframework.util包下。它提供了一种比直接使用System.currentTimeMillis()更优雅、更强大的代码执行时间测量方式。它尤其适合在开发、调试和性能分析等场景下使用。 为什么选择 StopWatch使用StopWatch而非System.currentTimeMillis()的好处是显著的更易用、更清晰通过start()和stop()方法代码逻辑一目了然无需手动进行繁琐的时间戳相减。支持多任务计时可以顺序记录多个不同任务的耗时。可读性强的报告能直接生成包含每个任务耗时及占比的格式化报告如prettyPrint()方便定位性能瓶颈。高精度底层基于System.nanoTime()实现提供纳秒级精度。 核心方法速览StopWatch的使用遵循“创建 - 开始 - 停止 - 获取结果”的简单模式。方法描述new StopWatch()创建一个新的计时器实例。new StopWatch(String id)创建一个带有指定ID的计时器实例。start(String taskName)开始一个命名任务的计时。stop()停止当前正在计时的任务。getTotalTimeMillis()获取所有任务的总耗时毫秒。getTotalTimeSeconds()获取所有任务的总耗时秒。getLastTaskTimeMillis()获取最后一个任务的耗时毫秒。getTaskCount()获取已停止的任务数量。getTaskInfo()获取所有任务的详细信息数组。prettyPrint()生成一个格式美观、包含所有任务耗时和百分比的报告字符串。shortSummary()生成一个包含总耗时的简短报告字符串。 基础用法示例这是一个典型的多任务计时例子javaimport org.springframework.util.StopWatch; public class StopWatchExample { public static void main(String[] args) throws InterruptedException { // 1. 创建一个StopWatch实例并指定一个ID StopWatch stopWatch new StopWatch(API性能测试); // 2. 开始第一个任务 stopWatch.start(查询用户信息); Thread.sleep(300); // 模拟业务耗时 stopWatch.stop(); // 停止当前任务 // 3. 开始第二个任务 stopWatch.start(更新用户缓存); Thread.sleep(500); // 模拟业务耗时 stopWatch.stop(); // 停止当前任务 // 4. 开始第三个任务 stopWatch.start(发送通知消息); Thread.sleep(200); // 模拟业务耗时 stopWatch.stop(); // 停止当前任务 // 5. 打印格式化的性能报告 System.out.println(stopWatch.prettyPrint()); } }输出结果示例textStopWatch API性能测试: running time 1003202900 ns --------------------------------------------- ns % Task name --------------------------------------------- 0300300200 030% 查询用户信息 0500300100 050% 更新用户缓存 0200300200 020% 发送通知消息通过这份报告可以直观地看到哪个任务耗时最长、占比最高从而精确锁定性能瓶颈。⚠️ 最佳实践与注意事项成对调用务必确保start()和stop()方法成对出现否则可能导致计时不准确或抛出异常。非线程安全StopWatch不是线程安全的。不要在多线程环境下共享同一个实例每个线程应使用各自的实例。适用场景它主要定位为开发和测试阶段的轻量级工具。在生产环境进行全链路监控建议使用专业的APM应用性能管理工具如 SkyWalking、Pinpoint。单任务限制一个StopWatch实例在同一时间只能运行一个任务必须在当前任务stop()后才能start()新任务。代码侵入性使用StopWatch需要在代码中硬编码计时逻辑。为避免污染业务代码通常会将其与AOP面向切面编程结合使用。 进阶用法结合 AOP 实现无侵入式监控将StopWatch与 Spring AOP 结合可以实现对特定方法如所有 Controller 接口的无侵入式性能监控。javaimport org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.springframework.stereotype.Component; import org.springframework.util.StopWatch; Aspect Component public class PerformanceAspect { Around(execution(* com.example.controller..*.*(..))) public Object measureTime(ProceedingJoinPoint joinPoint) throws Throwable { StopWatch stopWatch new StopWatch(); // 使用类名和方法名作为任务名称 String taskName joinPoint.getSignature().toShortString(); stopWatch.start(taskName); Object result; try { result joinPoint.proceed(); // 执行目标方法 } finally { stopWatch.stop(); // 将耗时信息打印到日志 System.out.println(stopWatch.prettyPrint()); } return result; } }这样每当 Controller 的方法被调用时AOP 就会自动记录其执行时间而无需修改任何业务代码。 总结StopWatch是 Spring 框架中一个非常实用的工具类。它通过简洁的 API 和强大的报告功能极大地简化了代码执行时间的测量工作。无论是快速定位性能瓶颈、对比不同实现的效率还是在开发阶段对接口性能进行初步摸底StopWatch都是一个值得推荐的选择。