使用 StopWatch 进行代码计时和性能分析

使用 StopWatch 进行代码计时与性能分析

在现代软件开发过程中，代码性能的优化是不可忽视的一部分。对代码执行时间进行精准的测量，可以帮助开发者识别性能瓶颈，进而做出针对性的优化。Spring 框架为开发者提供了一个强大的工具类——StopWatch，它能够简洁、有效地记录代码执行的时间。本文将深入探讨如何使用 StopWatch 进行计时，并详细解析其内部原理。

一、StopWatch 的基本功能与应用场景

StopWatch 是一个位于 Spring 框架 org.springframework.util 包下的计时工具类，专门用于记录代码块的执行时间，特别适用于单线程同步代码块的性能测试和调试。在开发过程中，它的简单易用性能够大大提高分析和优化代码的效率。

1.1 `StopWatch` 的基础使用

以下示例展示了如何使用 StopWatch 来记录多个代码块的执行时间：

import org.springframework.util.StopWatch;

public class StopWatchExample {
    
    
    public static void main(String[] args) throws InterruptedException {
    
    
        StopWatch sw = new StopWatch();

        sw.start("Task 1");
        Thread.sleep(1000); // 模拟任务1的执行
        sw.stop();

        sw.start("Task 2");
        Thread.sleep(2000); // 模拟任务2的执行
        sw.stop();

        System.out.println(sw.prettyPrint());
        System.out.println("Total time in milliseconds: " + sw.getTotalTimeMillis());
    }
}

上例中，通过 StopWatch 对两个任务分别进行计时，并使用 prettyPrint() 方法输出每个任务的详细执行时间，最后获取了所有任务的总耗时。Thread.sleep() 用于模拟任务的执行时间。通过这种方式，可以方便地衡量不同代码块的性能表现。

1.2 `StopWatch` 的核心方法解析

为了更好地理解和应用 StopWatch，以下是它的一些主要方法：

start(String taskName): 开始记录一个以 taskName 命名的任务的执行时间。如果计时器已经启动，再次调用此方法会抛出 IllegalStateException 异常。
stop(): 停止当前任务的计时，记录执行时间。如果在没有开始任务的情况下调用此方法，同样会抛出 IllegalStateException。
getTotalTimeMillis(): 获取所有任务的总耗时，以毫秒为单位，通常用于精确衡量多个任务的执行效率。
getTotalTimeSeconds(): 获取所有任务的总耗时，以秒为单位，用于相对较长任务的时间分析。
getTaskCount(): 返回已经记录的任务总数，便于统计分析。
getLastTaskName(): 获取最后一个任务的名称，用于了解最后一次计时的具体任务。
getLastTaskTimeMillis(): 返回最后一个任务的执行时间（毫秒），方便对单个任务的性能做进一步优化。
prettyPrint(): 以易读的格式输出所有任务的详细信息，包括每个任务的执行时间和占总时间的比例。

这些方法使得 StopWatch 能够提供全面的时间分析和统计信息，非常适合在开发和性能测试中使用。

1.3 适用场景

StopWatch 的适用范围广泛，以下是一些常见的应用场景：

代码性能优化：通过对关键代码块的执行时间进行测量，可以找出性能瓶颈，并在此基础上进行优化，提升应用程序的整体性能。
测试用例分析：在性能测试中，StopWatch 可用于精确记录各个操作或接口的响应时间，从而帮助评估系统的表现和稳定性。
开发调试：在开发阶段，使用 StopWatch 能帮助开发者定位那些耗时较长的代码段，从而加快开发进度，提升开发效率。

二、StopWatch 的源码解析

了解 StopWatch 的实现原理，有助于深入理解它的工作机制，合理应用于复杂场景中。我们将从构造函数、计时方法、统计方法及输出方法四个方面分析 StopWatch 的源码。

2.1 构造函数详解

StopWatch 提供了两个构造函数，一个无参构造函数和一个带 id 参数的构造函数：

public StopWatch() {
    
    
    this("");
}

public StopWatch(String id) {
    
    
    this.id = id;
}

无参构造函数会将 id 设为空字符串，适合不需要区分多个计时器的简单应用。而带 id 的构造函数允许用户为每个计时器指定一个唯一的标识，方便在复杂场景下使用多个 StopWatch 实例时进行区分。

2.2 计时方法解析

StopWatch 的核心功能是通过 start() 和 stop() 方法来实现任务的计时。

start(String taskName):

public void start(String taskName) throws IllegalStateException {
      
      
    if (this.currentTaskName != null) {
      
      
        throw new IllegalStateException("Can't start StopWatch: it's already running");
    }
    this.currentTaskName = taskName;
    this.startTimeNanos = System.nanoTime();
}

在调用 start() 方法时，首先检查当前是否已有任务在运行，如果是，则抛出异常，防止多个任务同时计时。接着，它将当前任务名存储，并记录开始时间（以纳秒为单位）。

stop():

public void stop() throws IllegalStateException {
      
      
    if (this.currentTaskName == null) {
      
      
        throw new IllegalStateException("Can't stop StopWatch: it's not running");
    }
    long lastTime = System.nanoTime() - this.startTimeNanos;
    this.totalTimeNanos += lastTime;
    this.taskCount++;
    this.lastTaskInfo = new TaskInfo(this.currentTaskName, lastTime);
    if (this.keepTaskList) {
      
      
        this.taskList.add(this.lastTaskInfo);
    }
    this.currentTaskName = null;
}

在调用 stop() 方法时，同样会检查当前是否有任务正在运行，防止错误操作。随后，它计算出任务的耗时并更新总时间和任务计数。最后将任务信息保存，以便后续统计和分析。

2.3 统计方法与任务信息获取

StopWatch 的统计功能非常丰富，可以通过多个方法获取详细的任务执行信息。常用方法包括：

getTotalTimeMillis(): 获取所有任务的总执行时间，返回值以毫秒为单位。
getTaskCount(): 返回记录的任务总数，便于了解执行了多少个任务。
getLastTaskName(): 获取最后一个任务的名称，特别适用于分析最近执行的任务。
getLastTaskTimeMillis(): 返回最后一个任务的耗时，常用于最后任务的性能评估。

2.4 输出任务信息

StopWatch 通过 prettyPrint() 和 shortSummary() 方法来输出计时信息：

prettyPrint():

public String prettyPrint() {
      
      
    StringBuilder sb = new StringBuilder(this.id + ": running time (millis) = " + getTotalTimeMillis() + "\n");
    if (this.keepTaskList) {
      
      
        sb.append("-----------------------------------------\n");
        sb.append("ms     %     Task name\n");
        sb.append("-----------------------------------------\n");
        NumberFormat nf = NumberFormat.getNumberInstance();
        nf.setMinimumIntegerDigits(5);
        nf.setGroupingUsed(false);
        NumberFormat pf = NumberFormat.getPercentInstance();
        pf.setMinimumIntegerDigits(3);
        pf.setGroupingUsed(false);
        for (TaskInfo task : getTaskInfo()) {
      
      
            sb.append(nf.format(task.getTimeMillis())).append("  ");
            sb.append(pf.format((double) task.getTimeMillis() / getTotalTimeMillis())).append("  ");
            sb.append(task.getTaskName()).append("\n");
        }
    } else {
      
      
        sb.append("No task info kept\n");
    }
    return sb.toString();
}

prettyPrint() 方法会详细展示每个任务的执行时间、占总时间的百分比，并按任务顺序排列输出。对于需要对多个任务进行详细分析的场景，prettyPrint() 是一个非常有用的工具。

shortSummary(): 该方法则提供了更简洁的统计输出，仅包含总时间和任务数量。