別再用 System.currentTimeMillis 統(tǒng)計耗時了,太LOW,這個工具類好用到爆!

作者:沉默王二
Java 程序員進階之路:https://tobebetterjavaer.com
大家好,我是二哥呀!
昨天,二哥的編程星球里的一位球友問我能不能給他解釋一下@SpringBootApplication注解是什么意思,還有 Spring Boot 的運行原理,于是我就帶著他扒拉了一下這個注解的源碼,還有SpringApplication類的run()方法的源碼,一下子他就明白了。
你別說,看源碼的過程還真的是挺有趣,這不,我就發(fā)現(xiàn)了一個有意思的點。
public ConfigurableApplicationContext run(String... args) { StopWatch stopWatch = new StopWatch(); stopWatch.start(); ...... stopWatch.stop(); }
Spring Boot 是用 StopWatch 來統(tǒng)計耗時的,而通常情況下,我們會用System.currentTimeMillis()來統(tǒng)計耗時,對吧?編程喵????開源項目里就有這樣一段代碼,在處理統(tǒng)一日志處理切面的時候。
@Around("webLog()") public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable { long startTime = System.currentTimeMillis(); long endTime = System.currentTimeMillis(); webLog.setSpendTime((int) (endTime - startTime)); }
對比之下,我們就能發(fā)現(xiàn),JDK 提供的System.currentTimeMillis()沒有 Spring 提供的 StopWatch 簡潔、清晰。
尤其是在多任務(wù)的情況下,StopWatch 簡直好用到爆????!
// 創(chuàng)建一個 StopWatch 實例 StopWatch sw = new StopWatch("沉默王二是傻 X"); // 開始計時 sw.start("任務(wù)1"); Thread.sleep(1000); // 停止計時 sw.stop(); System.out.printf("任務(wù)1耗時:%d%s.\n", sw.getLastTaskTimeMillis(), "ms"); sw.start("任務(wù)2"); Thread.sleep(1100); sw.stop(); System.out.printf("任務(wù)2耗時:%d%s.\n", sw.getLastTaskTimeMillis(), "ms"); System.out.printf("任務(wù)數(shù)量:%s,總耗時:%ss.\n", sw.getTaskCount(), sw.getTotalTimeSeconds());
看到?jīng)],是不是很簡單?
- 先 new 一個 StopWatch 對象
- 再 start 開始計時
- 然后 stop 停止計時
- 最后通過sw.getLastTaskTimeMillis()得出時間差
如果換成System.currentTimeMillis()就要了老命,先得聲明好幾個 long 型的局部變量,然后要第二個減第一個,第三個減第二個,稍微粗心一點(尤其是 CV 大法)時,很容易搞錯。
除了可以通過局部時間,還可以通過sw.getTotalTimeSeconds()獲取總的耗時。
任務(wù)1耗時:1002ms. 任務(wù)2耗時:1105ms. 任務(wù)數(shù)量:2,總耗時:2.107820109s.
另外,StopWatch 還提供了一個sw.prettyPrint()方法供打印出漂亮的格式化結(jié)果:
StopWatch '沉默王二是傻 X': running time = 2108529351 ns
---------------------------------------------
ns % Task name
---------------------------------------------
1004338467 048% 任務(wù)1
1104190884 052% 任務(wù)2
有耗時,有占用百分比,還有任務(wù)名,非常清晰。
除了 Spring,hutool 工具庫和 Apache common 工具包都提供了各自的 StopWatch。

查看 hutool 工具庫中的 StopWatch 源碼可以得出,該類其實就來自 Spring 的 StopWatch.java,用法也完全一致。

這說明 hutool 的作者也認(rèn)為 Spring 的 StopWatch 寫得好,哈哈哈????。
使用 Beyond compare 比較后也能得出,兩者除了一個中文注釋,一個英文注釋,代碼幾乎一樣。setKeepTaskList 方法有比較大的不同。

那也就是說,如果你的項目中沒有使用 Spring 全家桶,只用了 hutool 工具包,那就可以使用 hutool 的 StopWatch 來代替System.currentTimeMillis()。
通過分析 StopWatch 的 stop 方法源碼:
public void stop() throws IllegalStateException { if (null == this.currentTaskName) { throw new IllegalStateException("Can't stop StopWatch: it's not running"); } final long lastTime = System.nanoTime() - this.startTimeNanos; this.totalTimeNanos += lastTime; this.lastTaskInfo = new TaskInfo(this.currentTaskName, lastTime); if (null != this.taskList) { this.taskList.add(this.lastTaskInfo); } ++this.taskCount; this.currentTaskName = null; }
其實可以發(fā)現(xiàn),StopWatch 的內(nèi)部是通過System.nanoTime()來計時的,本質(zhì)上和System.currentTimeMillis()差別并不大。
nanoTime 比 currentTimeMillis 的粒度更細(xì),前者是以納秒為單位,后者是以毫秒為單位。

注意兩者都是 native 方法,也就是說,值的粒度其實取決于底層的操作系統(tǒng)。
看到這,大家可能會恍然大悟,StopWatch 不過是披著一層外衣的System.currentTimeMillis()嘛?
但妙就妙在,這層外衣足夠的漂亮,足夠的優(yōu)雅。StopWatch 可以記錄每個子任務(wù)的名稱,以及按格式化打印結(jié)果,尤其是針對多任務(wù)統(tǒng)計時更友好一點。
當(dāng)然了,除了選擇 Spring 和 hutool 的 StopWatch,Apache commons-lang3 的 StopWatch 也是一個不錯的可選項,更加靈活多變。
StopWatch sw = StopWatch.createStarted(); Thread.sleep(1000); System.out.printf("耗時:%dms.\n", sw.getTime());
其他兩個都是通過 new 來創(chuàng)建 StopWatch 對象,commons-lang3 還可以通過 createStarted(創(chuàng)建并立即啟動)、create(創(chuàng)建)來完成。
還可以調(diào)用 suspend 方法暫停計時、resume 方法恢復(fù)計時、reset 重新計時。
// 暫停計時 sw.suspend(); System.out.printf("暫停耗時:%dms.\n", sw.getTime()); // 恢復(fù)計時 sw.resume(); System.out.printf("恢復(fù)耗時:%dms.\n", sw.getTime()); // 停止計時 sw.stop(); System.out.printf("總耗時:%dms.\n", sw.getTime()); // 重置計時 sw.reset(); // 開始計時 sw.start(); System.out.printf("重置耗時:%dms.\n", sw.getTime());
ending
文末給自己的編程星球打個廣告。一個人可以走得很快,但一群人才能走得更遠。歡迎加入二哥的編程星球,里面的每個球友都非常的友善,除了鼓勵你,還會給你提出合理的建議。

星球提供的三份專屬專欄《Java 面試指南》、《編程喵 ????(Spring Boot+Vue 前后端分離)實戰(zhàn)項目筆記》、《Java 版 LeetCode 刷題筆記》,干貨滿滿,價值連城。


已經(jīng)有 480 多名 小伙伴加入二哥的編程星球了,如果你也需要一個良好的學(xué)習(xí)氛圍,戳鏈接加入我們的大家庭吧!這是一個 Java 學(xué)習(xí)指南 + 編程實戰(zhàn) + LeetCode 刷題的私密圈子,你可以向二哥提問、幫你制定學(xué)習(xí)計劃、跟著二哥一起做實戰(zhàn)項目,沖沖沖。

沒有什么使我停留——除了目的,縱然岸旁有玫瑰、有綠蔭、有寧靜的港灣,我是不系之舟。