Springboot源码-StopWatch工具

StopWatch，这个单词应该不陌生吧，没错就是秒表。

秒表，顾名思义就是一个计时器。在Springboot中它是一个计时工具。

介绍

StopWatch是位于org.springframework.util包下的一个工具类，通过它可方便的对程序部分代码进行计时(ms级别)，适用于同步单线程代码块。

一般情况下我们计时会选用System提供的System.currentTimeMillis()来记录开始与结束时的时间戳，然后做减法得到时间间隔。

这种方法简单直接有效，但想必写多了也是比较烦人的，尤其是碰到不可描述的代码时，会更加的让人忍不住多写几个bug聊表敬意，而且该结果也不够直观，此时会想是否有一个工具类，提供了这些方法，或者自己写个工具类，刚好可以满足这种场景，并且把结果更加直观的展现出来。
这就是StopWatch。用法如下：

StopWatch sw = new StopWatch("test");
sw.start("task1");
// do something
Thread.sleep(100);
sw.stop();
sw.start("task2");
// do something
Thread.sleep(200);
sw.stop();
System.out.println("sw.prettyPrint()~~~~~~~~~~~~~~~~~");
System.out.println(sw.prettyPrint());

运行结果：
sw.prettyPrint()~~~~~~~~~~~~~~~~~
StopWatch 'test': running time (millis) = 308
-----------------------------------------
ms     %     Task name
-----------------------------------------
00104  034%  task1
00204  066%  task2

start开始记录，stop停止记录，然后通过StopWatch的prettyPrint方法，可直观的输出代码执行耗时，以及执行时间百分比，瞬间感觉比之前的方式高大上了一个档次。

除此之外，还有以下两个方法shortSummary(),getTotalTimeMillis()，查看程序执行时间。

StopWatch优缺点：

优点：

• spring自带工具类，可直接使用
• 代码实现简单，使用更简单
• 统一归纳，展示每项任务耗时与占用总时间的百分比，展示结果直观
• 性能消耗相对较小，并且最大程度的保证了start与stop之间的时间记录的准确性
• 可在start时直接指定任务名字，从而更加直观的显示记录结果

缺点：

• 一个StopWatch实例一次只能开启一个task，不能同时start多个task，并且在该task未stop之前不能start一个新的task，必须在该task stop之后才能开启新的task，若要一次开启多个，需要new不同的StopWatch实例
• 代码侵入式使用，需要改动多处代码