乐趣区

6-种快速统计代码执行时间的方法真香

jiezi

咱们在日常开发中常常须要测试一些代码的执行工夫，但又不想应用向 JMH（Java Microbenchmark Harness，Java 微基准测试套件）这么重的测试框架，所以本文就汇总了一些 Java 中比拟罕用的执行工夫统计办法，总共蕴含以下 6 种，如下图所示：

办法一：System.currentTimeMillis

此办法为 Java 内置的办法，应用 System#currentTimeMillis 来统计执行的工夫（统计单位：毫秒），示例代码如下：

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 相似，示例代码如下：

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 的工夫距离，示例代码如下：

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-langs3、guava 的工夫统计器 StopWatch。

在没有用到 spring、commons-langs3、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 对象统计多段代码的执行工夫，也能够通过指定工夫类型间接统计出对应的工夫距离，比方咱们能够指定工夫的统计单位，如秒、毫秒、纳秒等类型。

常识扩大—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 对象统计多段代码的执行工夫，也能够通过指定工夫类型间接统计出对应的工夫距离，比方咱们能够指定工夫的统计单位，如秒、毫秒、纳秒等类型。

关注公众号「Java 中文社群 」订阅更多精彩。

<image src=”https://user-gold-cdn.xitu.io/2020/7/6/1732179389ab7c5c?w=344&h=344&f=jpeg&s=9375″ style=”zoom:75%;”></image>

退出移动版