Java項目中統(tǒng)計代碼耗時的工具類

更新時間：2025年08月01日 08:30:44 作者：IT樂手

相信大家在實際工具中,經(jīng)常需要做性能分析,做性能分析就少不了代碼執(zhí)行的耗時分析,本文將使用Java編寫一個項目統(tǒng)計代碼耗時的工具類,希望對大家有所幫助

java 或安卓項目中耗時統(tǒng)計工具類

相信大家在實際工具中，經(jīng)常需要做性能分析，做性能分析就少不了代碼執(zhí)行的耗時分析，以下是比較實用的耗時統(tǒng)計工具，我在項目中應(yīng)用過，使用比較方便

完整代碼

import java.util.HashMap;
import java.util.Map;
import java.util.Timer;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * 描述:
 * 創(chuàng)建者: IT樂手
 * 日期: 2025/7/31
 */
public class TimeMonitor {
    private static final HashMap<String, Long> startTimeMap = new HashMap<>();
    private static final StringBuilder stringBuilder = new StringBuilder();
    private static final AtomicInteger taskCounter = new AtomicInteger(0);
    private static Timer timer = null;
    /**
     * 開始統(tǒng)計某個任務(wù)的耗時
     * @param taskName 任務(wù)名（可區(qū)分不同統(tǒng)計點(diǎn)）
     */
    public static void start(String taskName) {
        AtotoLogger.i("TimeMonitor", "Start monitoring task: " + taskName);
        checkTimeout();
        startTimeMap.put(taskName, System.currentTimeMillis());
    }

    /**
     * 結(jié)束統(tǒng)計，并返回耗時（毫秒）
     * @param taskName 任務(wù)名
     * @param isLast 最后的任務(wù)
     * @return 耗時（ms），如未調(diào)用 start 返回-1
     */
    public static void end(String taskName, boolean isLast) {
        AtotoLogger.i("TimeMonitor", "End monitoring task: " + taskName + ", isLast: " + isLast);
        checkTimeout();
        Map<String, Long> map = startTimeMap;
        Long startTime = map.get(taskName);
        if (startTime == null) {
            return;
        }
        long duration = System.currentTimeMillis() - startTime;
        map.remove(taskName); // 防止內(nèi)存泄漏

        // 統(tǒng)計任務(wù)數(shù)量
        int taskCount = taskCounter.incrementAndGet();
        // 輸出日志
        stringBuilder.append(taskCount).append(".")
                     .append(taskName)
                     .append(", 耗時: ")
                     .append(duration)
                     .append(" ms\n");
        if (isLast) {
            AtotoLogger.i("TimeMonitor", stringBuilder.toString());
            stringBuilder.setLength(0); // 清空 StringBuilder
            taskCounter.set(0); // 重置任務(wù)計數(shù)器
        } else {
            AtotoLogger.i("TimeMonitor", taskCount + ". " + taskName + ", 耗時: " + duration + " ms");
        }
    }


    public static void end(String taskName) {
        end(taskName, false);
    }

    private static void checkTimeout() {
        if (timer != null) {
            timer.cancel();
            timer = null; // 取消之前的定時器
        }
        timer = new Timer("TimeMonitorTimer");
        timer.schedule(
                new java.util.TimerTask() {
                    @Override
                    public void run() {
                        clear();
                        // 這里可以添加定時任務(wù)的邏輯
                    }
                }, 10000); // 每10秒執(zhí)行一次
    }
    /**
     * 清理該線程下的所有統(tǒng)計數(shù)據(jù)
     */
    public static void clear() {
        AtotoLogger.i("TimeMonitor", stringBuilder.toString());
        stringBuilder.setLength(0); // 清空 StringBuilder
        startTimeMap.clear();
        if (timer != null) {
            timer.cancel();
            timer = null; // 取消之前的定時器
        }
    }
}

Java統(tǒng)計代碼的執(zhí)行時間的6種方法

在日常開發(fā)中經(jīng)常需要測試一些代碼的執(zhí)行時間，但又不想使用向 JMH（Java Microbenchmark Harness，Java 微基準(zhǔn)測試套件）這么重的測試框架，所以本文就匯總了一些 Java 中比較常用的執(zhí)行時間統(tǒng)計方法，總共包含以下 6 種，如下圖所示：

方法一：System.currentTimeMillis

此方法為 Java 內(nèi)置的方法，使用 System#currentTimeMillis 來統(tǒng)計執(zhí)行的時間（統(tǒng)計單位：毫秒），示例代碼如下：

public class TimeIntervalTest {
    public static void main(String[] args) throws InterruptedException {
        // 開始時間
        long stime = System.currentTimeMillis();
        // 執(zhí)行時間（1s）
        Thread.sleep(1000);
        // 結(jié)束時間
        long etime = System.currentTimeMillis();
        // 計算執(zhí)行時間
        System.out.printf("執(zhí)行時長：%d 毫秒.", (etime - stime));
    }
}

以上程序的執(zhí)行結(jié)果為：

執(zhí)行時長：1000 毫秒.

方法二：System.nanoTime

此方法為 Java 內(nèi)置的方法，使用 System#nanoTime 來統(tǒng)計執(zhí)行時間（統(tǒng)計單位：納秒），它的執(zhí)行方法和 System#currentTimeMillis 類似，示例代碼如下：

public class TimeIntervalTest {
    public static void main(String[] args) throws InterruptedException {
        // 開始時間
        long stime = System.nanoTime();
        // 執(zhí)行時間（1s）
        Thread.sleep(1000);
        // 結(jié)束時間
        long etime = System.nanoTime();
        // 計算執(zhí)行時間
        System.out.printf("執(zhí)行時長：%d 納秒.", (etime - stime));
    }
}

以上程序的執(zhí)行結(jié)果為：

執(zhí)行時長：1000769200 納秒.

小貼士：1 毫秒 = 100 萬納秒。

方法三：new Date

此方法也是 Java 的內(nèi)置方法，在開始執(zhí)行前 new Date() 創(chuàng)建一個當(dāng)前時間對象，在執(zhí)行結(jié)束之后 new Date() 一個當(dāng)前執(zhí)行時間，然后再統(tǒng)計兩個 Date 的時間間隔，示例代碼如下：

import java.util.Date;
 
public class TimeIntervalTest {
    public static void main(String[] args) throws InterruptedException {
        // 開始時間
        Date sdate = new Date();
        // 執(zhí)行時間（1s）
        Thread.sleep(1000);
        // 結(jié)束時間
        Date edate = new Date();
        //  統(tǒng)計執(zhí)行時間（毫秒）
        System.out.printf("執(zhí)行時長：%d 毫秒." , (edate.getTime() - sdate.getTime())); 
    }
}

以上程序的執(zhí)行結(jié)果為：

執(zhí)行時長：1000 毫秒.

方法四：Spring StopWatch

如果我們使用的是 Spring 或 Spring Boot 項目，可以在項目中直接使用 StopWatch 對象來統(tǒng)計代碼執(zhí)行時間，示例代碼如下：

StopWatch stopWatch = new StopWatch();
// 開始時間
stopWatch.start();
// 執(zhí)行時間（1s）
Thread.sleep(1000);
// 結(jié)束時間
stopWatch.stop();
// 統(tǒng)計執(zhí)行時間（秒）
System.out.printf("執(zhí)行時長：%d 秒.%n", stopWatch.getTotalTimeSeconds()); // %n 為換行
// 統(tǒng)計執(zhí)行時間（毫秒）
System.out.printf("執(zhí)行時長：%d 毫秒.%n", stopWatch.getTotalTimeMillis()); 
// 統(tǒng)計執(zhí)行時間（納秒）
System.out.printf("執(zhí)行時長：%d 納秒.%n", stopWatch.getTotalTimeNanos());
以上程序的執(zhí)行結(jié)果為：

執(zhí)行時長：0.9996313 秒. 執(zhí)行時長：999 毫秒. 執(zhí)行時長：999631300 納秒.

小貼士：Thread#sleep 方法的執(zhí)行時間稍有偏差，在 1s 左右都是正常的。

方法五：commons-lang3 StopWatch

如果我們使用的是普通項目，那我們可以用 Apache commons-lang3 中的 StopWatch 對象來實現(xiàn)時間統(tǒng)計，首先先添加 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>

然后編寫時間統(tǒng)計代碼：

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();
        // 執(zhí)行時間（1s）
        Thread.sleep(1000);
        // 結(jié)束時間
        stopWatch.stop();
        // 統(tǒng)計執(zhí)行時間（秒）
        System.out.println("執(zhí)行時長：" + stopWatch.getTime(TimeUnit.SECONDS) + " 秒.");
        // 統(tǒng)計執(zhí)行時間（毫秒）
        System.out.println("執(zhí)行時長：" + stopWatch.getTime(TimeUnit.MILLISECONDS) + " 毫秒.");
        // 統(tǒng)計執(zhí)行時間（納秒）
        System.out.println("執(zhí)行時長：" + stopWatch.getTime(TimeUnit.NANOSECONDS) + " 納秒.");
    }
}

以上程序的執(zhí)行結(jié)果為：

執(zhí)行時長：1 秒. 執(zhí)行時長：1000 毫秒.
執(zhí)行時長：1000555100 納秒.

方法六：Guava Stopwatch

除了 Apache 的 commons-lang3 外，還有一個常用的 Java 工具包，那就是 Google 的 Guava，Guava 中也包含了 Stopwatch 統(tǒng)計類。首先先添加 Guava 的依賴：

<!-- https://mvnrepository.com/artifact/com.google.guava/guava -->
<dependency>
  <groupId>com.google.guava</groupId>
  <artifactId>guava</artifactId>
  <version>29.0-jre</version>
</dependency>

然后編寫時間統(tǒng)計代碼：

import com.google.common.base.Stopwatch;
 
import java.util.concurrent.TimeUnit;
 
public class TimeIntervalTest {
    public static void main(String[] args) throws InterruptedException {
        // 創(chuàng)建并啟動計時器
        Stopwatch stopwatch = Stopwatch.createStarted();
        // 執(zhí)行時間（1s）
        Thread.sleep(1000);
        // 停止計時器
        stopwatch.stop();
        // 執(zhí)行時間（單位：秒）
        System.out.printf("執(zhí)行時長：%d 秒. %n", stopwatch.elapsed().getSeconds()); // %n 為換行
        // 執(zhí)行時間（單位：毫秒）
        System.out.printf("執(zhí)行時長：%d 豪秒.", stopwatch.elapsed(TimeUnit.MILLISECONDS));
    }
}

以上程序的執(zhí)行結(jié)果為：

執(zhí)行時長：1 秒.
執(zhí)行時長：1000 豪秒.

原理分析

本文我們從 Spring 和 Google 的 Guava 源碼來分析一下，它們的 StopWatch 對象底層是如何實現(xiàn)的？

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 實現(xiàn)時間統(tǒng)計的本質(zhì)還是使用了 Java 的內(nèi)置方法 System.nanoTime() 來實現(xiàn)的。

2.Google Stopwatch 原理分析

Google Stopwatch 實現(xiàn)的核心源碼如下：

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 對象中調(diào)用了 ticker 類來實現(xiàn)時間統(tǒng)計的，那接下來我們進(jìn)入 ticker 類的實現(xiàn)源碼：

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 實現(xiàn)時間統(tǒng)計的本質(zhì)還是調(diào)用了 Java 內(nèi)置的 System.nanoTime() 來實現(xiàn)的。

結(jié)論

對于所有框架的 StopWatch 來說，其底層都是通過調(diào)用 Java 內(nèi)置的 System.nanoTime() 得到兩個時間，開始時間和結(jié)束時間，然后再通過結(jié)束時間減去開始時間來統(tǒng)計執(zhí)行時間的。

總結(jié)

本文介紹了 6 種實現(xiàn)代碼統(tǒng)計的方法，其中 3 種是 Java 內(nèi)置的方法：

System.currentTimeMillis()

System.nanoTime()

new Date()

還介紹了 3 種常用框架 spring、commons-langs3、guava 的時間統(tǒng)計器 StopWatch。

在沒有用到 spring、commons-langs3、guava 任意一種框架的情況下，推薦使用 System.currentTimeMillis() 或 System.nanoTime() 來實現(xiàn)代碼統(tǒng)計，否則建議直接使用 StopWatch 對象來統(tǒng)計執(zhí)行時間。

知識擴(kuò)展—Stopwatch 讓統(tǒng)計更方便

StopWatch 存在的意義是讓代碼統(tǒng)計更簡單，比如 Guava 中 StopWatch 使用示例如下：

import com.google.common.base.Stopwatch;
 
import java.util.concurrent.TimeUnit;
 
public class TimeIntervalTest {
    public static void main(String[] args) throws InterruptedException {
        // 創(chuàng)建并啟動計時器
        Stopwatch stopwatch = Stopwatch.createStarted();
        // 執(zhí)行時間（1s）
        Thread.sleep(1000);
        // 停止計時器
        stopwatch.stop();
        // 執(zhí)行統(tǒng)計
        System.out.printf("執(zhí)行時長：%d 毫秒. %n",
                stopwatch.elapsed(TimeUnit.MILLISECONDS));
        // 清空計時器
        stopwatch.reset();
        // 再次啟動統(tǒng)計
        stopwatch.start();
        // 執(zhí)行時間（2s）
        Thread.sleep(2000);
        // 停止計時器
        stopwatch.stop();
        // 執(zhí)行統(tǒng)計
        System.out.printf("執(zhí)行時長：%d 秒. %n",
                stopwatch.elapsed(TimeUnit.MILLISECONDS));
    }
}

以上就是Java項目中統(tǒng)計代碼耗時的工具類的詳細(xì)內(nèi)容，更多關(guān)于Java統(tǒng)計代碼耗時的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: