使用Spring的StopWatch實現(xiàn)代碼性能監(jiān)控的方法詳解

更新時間：2023年12月13日 09:10:45 作者：不務專業(yè)的程序員--阿飛

在開發(fā)過程中,偶爾還是需要分析代碼的執(zhí)行時間,Spring 框架提供了一個方便的工具類 StopWatch,本文將介紹 StopWatch 的基本用法,并通過示例演示如何在項目中使用 StopWatch 進行代碼性能監(jiān)控

前言

在開發(fā)過程中，偶爾還是需要分析代碼的執(zhí)行時間（比如定位線上執(zhí)行緩慢原因的時候，記錄任務執(zhí)行時間的時候），肯定有人去使用System.currentTimeMillis()然后自己去計算時間差再打印。其實Spring 框架提供了一個方便的工具類 StopWatch，用于測量代碼塊的執(zhí)行時間。本文將介紹 StopWatch 的基本用法，并通過示例演示如何在項目中使用 StopWatch 進行代碼性能監(jiān)控。（底層獲取時間的API用的System.nanoTime()，System.currentTimeMillis() 去統(tǒng)計時間差據(jù)說更精確）

1. StopWatch 簡介

StopWatch 是 Spring 框架中的一個工具類，用于測量代碼塊的執(zhí)行時間。StopWatch 可以精確地測量代碼塊的執(zhí)行時間，比是并提供了方便的方法來記錄和輸出執(zhí)行時間的信息。

2. 使用 StopWatch

2.1 導入依賴（基本java項目都是springboot的吧，不用做這一步了）

首先，我們需要在項目中導入 Spring 的相關依賴。在 Maven 項目中，可以在 pom.xml 文件中添加以下依賴項：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>5.3.10</version>
</dependency>

2.2 創(chuàng)建 StopWatch 實例

在代碼中，我們可以通過實例化 StopWatch 類來創(chuàng)建一個 StopWatch 對象：

StopWatch stopWatch = new StopWatch();

2.3 記錄代碼塊的執(zhí)行時間

使用 StopWatch 的 start() 和 stop() 方法可以記錄代碼塊的執(zhí)行時間。在代碼塊開始處調(diào)用 start() 方法，在代碼塊結束處調(diào)用 stop() 方法。以下是一個示例：

stopWatch.start();

// 執(zhí)行需要監(jiān)控的代碼塊
// ...

stopWatch.stop();

2.4 輸出執(zhí)行時間信息

StopWatch 提供了多種方法來輸出執(zhí)行時間的信息。可以使用 getTotalTimeMillis() 方法獲取總的執(zhí)行時間（以毫秒為單位），使用 getTotalTimeSeconds() 方法獲取總的執(zhí)行時間（以秒為單位）。還可以使用 prettyPrint() 方法將執(zhí)行時間以更友好的格式輸出。以下是一個示例：

System.out.println("總執(zhí)行時間（毫秒）：" + stopWatch.getTotalTimeMillis());
System.out.println("總執(zhí)行時間（秒）：" + stopWatch.getTotalTimeSeconds());

stopWatch.prettyPrint();

3. 示例演示

假設我們有一個需要監(jiān)控執(zhí)行時間的方法，如下所示：

public void performTimeConsumingTask() {
    StopWatch stopWatch = new StopWatch();
    stopWatch.start("任務1");

    // 執(zhí)行耗時任務
    // ...

    stopWatch.stop();
   stopWatch.start("任務1");

    // 執(zhí)行耗時任務2
    // ...

    stopWatch.stop();
    System.out.println("任務執(zhí)行時間（毫秒）：" + stopWatch.toString());

}

在上述示例中，我們在 performTimeConsumingTask() 方法中創(chuàng)建了一個 StopWatch 對象，并在任務開始和結束時調(diào)用了 start() 和 stop() 方法。最后，我們使用 toString() 方法打印任務的執(zhí)行時間。