6種快速統計程式碼執行時間的方法，真香!
阿新 • • 發佈：2020-07-14
我們在日常開發中經常需要測試一些程式碼的執行時間，但又不想使用向 JMH（Java Microbenchmark Harness，Java 微基準測試套件）這麼重的測試框架，所以本文就彙總了一些 Java 中比較常用的執行時間統計方法，總共包含以下 6 種，如下圖所示：
## 方法一：System.currentTimeMillis
此方法為 Java 內建的方法，使用 `System#currentTimeMillis` 來統計執行的時間（統計單位：毫秒），示例程式碼如下：
```java
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));
}
}
```
以上程式的執行結果為：
> 執行時長：1000 毫秒.
## 方法二：System.nanoTime
此方法為 Java 內建的方法，使用 `System#nanoTime` 來統計執行時間（統計單位：納秒），它的執行方法和 `System#currentTimeMillis` 類似，示例程式碼如下：
```java
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));
}
}
```
以上程式的執行結果為：
> 執行時長：1000769200 納秒.
>
> 小貼士：1 毫秒 = 100 萬納秒。
## 方法三：new Date
此方法也是 Java 的內建方法，在開始執行前 `new Date()` 建立一個當前時間物件，在執行結束之後 `new Date()` 一個當前執行時間，然後再統計兩個 `Date` 的時間間隔，示例程式碼如下：
```java
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` 物件來統計程式碼執行時間，示例程式碼如下：
```java
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 的依賴：
```xml
org.apache.commons
commons-lang3
3.10
```
然後編寫時間統計程式碼：
```java
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) + " 納秒.");
}
}
```
以上程式的執行結果為：
>
com.google.guava
guava
29.0-jre
```
然後編寫時間統計程式碼：
```java
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));
}
}
```
以上程式的執行結果為：
> 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` 實現的核心原始碼如下：
```java
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` 類的實現原始碼：
```java
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-langs3、guava 的時間統計器 `StopWatch`。
在沒有用到 spring、commons-langs3、guava 任意一種框架的情況下，推薦使用 `System.currentTimeMillis()` 或 `System.nanoTime()` 來實現程式碼統計，否則建議直接使用 `StopWatch` 物件來統計執行時間。
## 知識擴充套件—Stopwatch 讓統計更方便
`StopWatch` 存在的意義是讓程式碼統計更簡單，比如 Guava 中 `StopWatch` 使用示例如下：
```java
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` 物件統計多段程式碼的執行時間，也可以通過指定時間型別直接統計出對應的時間間隔，比如我們可以指定時間的統計單位，如秒、毫秒、納秒等型別。
## 知識擴充套件—Stopwatch 讓統計更方便
`StopWatch` 存在的意義是讓程式碼統計更簡單，比如 Guava 中 `StopWatch` 使用示例如下：
```java
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` 物件統計多段程式碼的執行時間，也可以通過指定時間型別直接統計出對應的時間間隔，比如我們可以指定時間的統計單位，如秒、毫秒、納秒等