[技巧]IDEA的debug+StopWatch监测程序运行时间

场景

我们经常需要监测一个方法中的某些程序片段的运行时间，从而定位到性能问题。

常用方式:

1. 通过代码中两次插入System.currentTimeMillis()获取差值,计算程序片段运行时间

2. 通过StopWatch工具类获取程序片段运行时间

以上两种方式在实际开发中随处可见,具体可以搜索相关文章,这里不具体介绍使用方式。

但是上述两种方式都面临一个问题,就是代码侵入。使用完了以后一般还需要去删除。

因此介绍一种在IDEA中debug结合StopWatch方式，无侵入的去统计程序代码片段运行时间。想去除时只需要禁用断点就行。

StopWatchExpand(拓展一下StopWatch)

该工具类做了如下操作:

1. 将StopWatch中使用到的方法包装成static方法,方便debug中直接调用

2. 拓展了prettyPrint方法，因为从spring framework 5.2开始，原先运行时间打印显示的millis(毫秒数)变成了nanos(纳秒数)，虽然纳秒更加精确，可是实际查看时转换也是比较麻烦的事情。因此拓展了该方法，提供ms(毫秒)与s(秒)为单位的显示，使得查看更为方便。

代码如下:

import lombok.extern.slf4j.Slf4j;
import org.springframework.util.StopWatch;

import java.text.NumberFormat;

/**
 * 检测程序片段运行时间拓展
 *
 * @author sdevil507
 * created on 2021/5/27
 */
@Slf4j
public class StopWatchExpand {

    /**
     * StopWatch实例
     */
    private static StopWatch STOP_WATCH;

    /**
     * StopWatch实例初始化
     */
    public static void init() {
        STOP_WATCH = new StopWatch("运行时间");
    }

    /**
     * 开启计时
     *
     * @param taskName 任务名称
     * @return 提示字符串
     */
    public static String start(String taskName) {
        STOP_WATCH.start(taskName);
        return "[ 任务: " + taskName + " ]" + " 监测运行时间开始......";
    }

    /**
     * 结束计时
     */
    public static void stop() {
        STOP_WATCH.stop();
    }

    /**
     * 格式化的统计输出
     *
     * @return 统计输出
     */
    public static String prettyPrint() {
        // 获取运行的毫秒数与秒数
        long totalTimeMillis = STOP_WATCH.getTotalTimeMillis();
        double totalTimeSeconds = STOP_WATCH.getTotalTimeSeconds();
        // 编写总结
        String shortSummary = "StopWatch '" + STOP_WATCH.getId() + "': running time [ " + String.format("%9s", totalTimeMillis) + "ms / " + String.format("%9.3f", totalTimeSeconds) + "s ]";
        StringBuilder sb = new StringBuilder();
        sb.append("---------------------------------------------------------------\n");
        sb.append(shortSummary);
        sb.append('\n');
        sb.append("---------------------------------------------------------------\n");
        sb.append("       ms           s      %      Task name\n");
        sb.append("---------------------------------------------------------------\n");
        NumberFormat pf = NumberFormat.getPercentInstance();
        pf.setMinimumIntegerDigits(3);
        pf.setGroupingUsed(false);
        for (StopWatch.TaskInfo task : STOP_WATCH.getTaskInfo()) {
            sb.append(String.format("%9s", task.getTimeMillis())).append("   ");
            sb.append(String.format("%9.3f", task.getTimeSeconds())).append("   ");
            sb.append(pf.format((double) task.getTimeMillis() / totalTimeMillis)).append("      ");
            sb.append(task.getTaskName()).append("\n");
        }
        return sb.toString();
    }
}

IDEA中debug的设置(重点)

示例图，描述打了3个无阻塞断点，两个任务断点，一个结束打印断点:

7.png

1. 设置无阻塞的断点(示例图中黄色断点)

右键点击该断点或者断点设置界面进入，取消Suspend阻塞设置，取消后断点演示变为黄色

2.png

1.png

取消Suspend时会弹出如下界面，选择“Evaluate and log”选项

3.png

2. 设置表达式

第一个断点设置"初始化并启动第一个任务的时间监测表达式"

4.png

第二个断点设置"第一个任务终止并开启第二个任务的时间监测表达式"

5.png

第三个断点设置"第二个任务终止并打印两次任务的运行时间"

6.png

上述的操作，其实就是StopWatch的基本操作，如果对这块有疑问，可以查看StopWatch文档。

3. 运行结果展示

使用debug运行测试内容，真实项目中也是需在debug下才会运行

8.png

运行完毕，可以细致的打印各任务运行时间和时间占比和运行总时间

[ 任务: 第一个任务 ] 监测运行时间开始......
[ 任务: 第二个任务 ] 监测运行时间开始......
---------------------------------------------------------------
StopWatch '运行时间': running time [      5017ms /     5.018s ]
---------------------------------------------------------------
       ms           s      %      Task name
---------------------------------------------------------------
     2008       2.008   040%      第一个任务
     3009       3.009   060%      第二个任务