這是個人第 78 篇原創文章。java
咱們在平常開發中常常須要測試一些代碼的執行時間，但又不想使用向 JMH（Java Microbenchmark Harness，Java 微基準測試套件）這麼重的測試框架，因此本文就彙總了一些 Java 中比較經常使用的執行時間統計方法，總共包含如下 6 種，以下圖所示：
web
方法一：System.currentTimeMillis
此方法爲 Java 內置的方法，使用 System#currentTimeMillis 來統計執行的時間（統計單位：毫秒），示例代碼以下：spring
public class TimeIntervalTest {
public static void main(String[] args) throws InterruptedException {
// 開始時間
long stime = System.currentTimeMillis();
// 執行時間（1s）
Thread.sleep(1000);
// 結束時間
long etime = System.currentTimeMillis();
// 計算執行時間
System.out.printf("執行時長：%d 毫秒.", (etime - stime));
}
}
以上程序的執行結果爲：apache
執行時長：1000 毫秒.數組
方法二：System.nanoTime
此方法爲 Java 內置的方法，使用 System#nanoTime 來統計執行時間（統計單位：納秒），它的執行方法和 System#currentTimeMillis 相似，示例代碼以下：微信
public class TimeIntervalTest {
public static void main(String[] args) throws InterruptedException {
// 開始時間
long stime = System.nanoTime();
// 執行時間（1s）
Thread.sleep(1000);
// 結束時間
long etime = System.nanoTime();
// 計算執行時間
System.out.printf("執行時長：%d 納秒.", (etime - stime));
}
}
以上程序的執行結果爲：app
執行時長：1000769200 納秒.框架
小貼士：1 毫秒 = 100 萬納秒。編輯器
方法三：new Date
此方法也是 Java 的內置方法，在開始執行前 new Date() 建立一個當前時間對象，在執行結束以後 new Date() 一個當前執行時間，而後再統計兩個 Date 的時間間隔，示例代碼以下：工具
import java.util.Date;
public class TimeIntervalTest {
public static void main(String[] args) throws InterruptedException {
// 開始時間
Date sdate = new Date();
// 執行時間（1s）
Thread.sleep(1000);
// 結束時間
Date edate = new Date();
// 統計執行時間（毫秒）
System.out.printf("執行時長：%d 毫秒." , (edate.getTime() - sdate.getTime()));
}
}
以上程序的執行結果爲：
執行時長：1000 毫秒.
方法四：Spring StopWatch
若是咱們使用的是 Spring 或 Spring Boot 項目，能夠在項目中直接使用 StopWatch 對象來統計代碼執行時間，示例代碼以下：
StopWatch stopWatch = new StopWatch();
// 開始時間
stopWatch.start();
// 執行時間（1s）
Thread.sleep(1000);
// 結束時間
stopWatch.stop();
// 統計執行時間（秒）
System.out.printf("執行時長：%d 秒.%n", stopWatch.getTotalTimeSeconds()); // %n 爲換行
// 統計執行時間（毫秒）
System.out.printf("執行時長：%d 毫秒.%n", stopWatch.getTotalTimeMillis());
// 統計執行時間（納秒）
System.out.printf("執行時長：%d 納秒.%n", stopWatch.getTotalTimeNanos());
以上程序的執行結果爲：
執行時長：0.9996313 秒. 執行時長：999 毫秒. 執行時長：999631300 納秒.
小貼士：Thread#sleep 方法的執行時間稍有誤差，在 1s 左右都是正常的。
方法五：commons-lang3 StopWatch
若是咱們使用的是普通項目，那咱們能夠用 Apache commons-lang3 中的 StopWatch 對象來實現時間統計，首先先添加 commons-lang3 的依賴：
<!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.10</version>
</dependency>
而後編寫時間統計代碼：
import org.apache.commons.lang3.time.StopWatch;
import java.util.concurrent.TimeUnit;
public class TimeIntervalTest {
public static void main(String[] args) throws InterruptedException {
StopWatch stopWatch = new StopWatch();
// 開始時間
stopWatch.start();
// 執行時間（1s）
Thread.sleep(1000);
// 結束時間
stopWatch.stop();
// 統計執行時間（秒）
System.out.println("執行時長：" + stopWatch.getTime(TimeUnit.SECONDS) + " 秒.");
// 統計執行時間（毫秒）
System.out.println("執行時長：" + stopWatch.getTime(TimeUnit.MILLISECONDS) + " 毫秒.");
// 統計執行時間（納秒）
System.out.println("執行時長：" + stopWatch.getTime(TimeUnit.NANOSECONDS) + " 納秒.");
}
}
以上程序的執行結果爲：
執行時長：1 秒. 執行時長：1000 毫秒.
執行時長：1000555100 納秒.
方法六：Guava Stopwatch
除了 Apache 的 commons-lang3 外，還有一個經常使用的 Java 工具包，那就是 Google 的 Guava，Guava 中也包含了 Stopwatch 統計類。首先先添加 Guava 的依賴：
<!-- https://mvnrepository.com/artifact/com.google.guava/guava -->
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>29.0-jre</version>
</dependency>
而後編寫時間統計代碼：
import com.google.common.base.Stopwatch;
import java.util.concurrent.TimeUnit;
public class TimeIntervalTest {
public static void main(String[] args) throws InterruptedException {
// 建立並啓動計時器
Stopwatch stopwatch = Stopwatch.createStarted();
// 執行時間（1s）
Thread.sleep(1000);
// 中止計時器
stopwatch.stop();
// 執行時間（單位：秒）
System.out.printf("執行時長：%d 秒. %n", stopwatch.elapsed().getSeconds()); // %n 爲換行
// 執行時間（單位：毫秒）
System.out.printf("執行時長：%d 豪秒.", stopwatch.elapsed(TimeUnit.MILLISECONDS));
}
}
以上程序的執行結果爲：
執行時長：1 秒.
執行時長：1000 豪秒.
原理分析
本文咱們從 Spring 和 Google 的 Guava 源碼來分析一下，它們的 StopWatch 對象底層是如何實現的？
1.Spring StopWatch 原理分析
在 Spring 中 StopWatch 的核心源碼以下：
package org.springframework.util;
import java.text.NumberFormat;
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.TimeUnit;
import org.springframework.lang.Nullable;
public class StopWatch {
private final String id;
private boolean keepTaskList;
private final List<StopWatch.TaskInfo> taskList;
private long startTimeNanos;
@Nullable
private String currentTaskName;
@Nullable
private StopWatch.TaskInfo lastTaskInfo;
private int taskCount;
private long totalTimeNanos;
public StopWatch() {
this("");
}
public StopWatch(String id) {
this.keepTaskList = true;
this.taskList = new LinkedList();
this.id = id;
}
public String getId() {
return this.id;
}
public void setKeepTaskList(boolean keepTaskList) {
this.keepTaskList = keepTaskList;
}
public void start() throws IllegalStateException {
this.start("");
}
public void start(String taskName) throws IllegalStateException {
if (this.currentTaskName != null) {
throw new IllegalStateException("Can't start StopWatch: it's already running");
} else {
this.currentTaskName = taskName;
this.startTimeNanos = System.nanoTime();
}
}
public void stop() throws IllegalStateException {
if (this.currentTaskName == null) {
throw new IllegalStateException("Can't stop StopWatch: it's not running");
} else {
long lastTime = System.nanoTime() - this.startTimeNanos;
this.totalTimeNanos += lastTime;
this.lastTaskInfo = new StopWatch.TaskInfo(this.currentTaskName, lastTime);
if (this.keepTaskList) {
this.taskList.add(this.lastTaskInfo);
}
++this.taskCount;
this.currentTaskName = null;
}
}
// .... 忽略其餘代碼
}
從上述 start() 和 stop() 的源碼中能夠看出，Spring 實現時間統計的本質仍是使用了 Java 的內置方法 System.nanoTime() 來實現的。
2.Google Stopwatch 原理分析
Google Stopwatch 實現的核心源碼以下：
public final class Stopwatch {
private final Ticker ticker;
private boolean isRunning;
private long elapsedNanos;
private long startTick;
@CanIgnoreReturnValue
public Stopwatch start() {
Preconditions.checkState(!this.isRunning, "This stopwatch is already running.");
this.isRunning = true;
this.startTick = this.ticker.read();
return this;
}
@CanIgnoreReturnValue
public Stopwatch stop() {
long tick = this.ticker.read();
Preconditions.checkState(this.isRunning, "This stopwatch is already stopped.");
this.isRunning = false;
this.elapsedNanos += tick - this.startTick;
return this;
}
// 忽略其餘源碼...
}
從上述源碼中能夠看出 Stopwatch 對象中調用了 ticker 類來實現時間統計的，那接下來咱們進入 ticker 類的實現源碼：
public abstract class Ticker {
private static final Ticker SYSTEM_TICKER = new Ticker() {
public long read() {
return Platform.systemNanoTime();
}
};
protected Ticker() {
}
public abstract long read();
public static Ticker systemTicker() {
return SYSTEM_TICKER;
}
}
final class Platform {
private static final Logger logger = Logger.getLogger(Platform.class.getName());
private static final PatternCompiler patternCompiler = loadPatternCompiler();
private Platform() {
}
static long systemNanoTime() {
return System.nanoTime();
}
// 忽略其餘源碼...
}
從上述源碼能夠看出 Google Stopwatch 實現時間統計的本質仍是調用了 Java 內置的 System.nanoTime() 來實現的。
結論
對於全部框架的 StopWatch 來講，其底層都是經過調用 Java 內置的 System.nanoTime() 獲得兩個時間，開始時間和結束時間，而後再經過結束時間減去開始時間來統計執行時間的。
總結
本文介紹了 6 種實現代碼統計的方法，其中 3 種是 Java 內置的方法：
-
System.currentTimeMillis() -
System.nanoTime() -
new Date()
還介紹了 3 種經常使用框架 spring、commons-langs三、guava 的時間統計器 StopWatch。
在沒有用到 spring、commons-langs三、guava 任意一種框架的狀況下，推薦使用 System.currentTimeMillis() 或 System.nanoTime() 來實現代碼統計，不然建議直接使用 StopWatch 對象來統計執行時間。
知識擴展—Stopwatch 讓統計更方便
StopWatch 存在的意義是讓代碼統計更簡單，好比 Guava 中 StopWatch 使用示例以下：
import com.google.common.base.Stopwatch;
import java.util.concurrent.TimeUnit;
public class TimeIntervalTest {
public static void main(String[] args) throws InterruptedException {
// 建立並啓動計時器
Stopwatch stopwatch = Stopwatch.createStarted();
// 執行時間（1s）
Thread.sleep(1000);
// 中止計時器
stopwatch.stop();
// 執行統計
System.out.printf("執行時長：%d 毫秒. %n",
stopwatch.elapsed(TimeUnit.MILLISECONDS));
// 清空計時器
stopwatch.reset();
// 再次啓動統計
stopwatch.start();
// 執行時間（2s）
Thread.sleep(2000);
// 中止計時器
stopwatch.stop();
// 執行統計
System.out.printf("執行時長：%d 秒. %n",
stopwatch.elapsed(TimeUnit.MILLISECONDS));
}
}
咱們能夠使用一個 Stopwatch 對象統計多段代碼的執行時間，也能夠經過指定時間類型直接統計出對應的時間間隔，好比咱們能夠指定時間的統計單位，如秒、毫秒、納秒等類型。
互動話題
你還知道哪些統計代碼執行時間的方法嗎？歡迎評論區補充留言。
PS：原創不易，點個「贊」再走唄！
往期推薦
Oracle官方推薦的性能測試工具！簡單、精準又直觀！
鏈表居然比數組慢了1000多倍？(動圖+性能評測)
點亮「在看」，助我寫出更多好文！
本文分享自微信公衆號 - Java中文社羣（javacn666）。
若有侵權，請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」，歡迎正在閱讀的你也加入，一塊兒分享。