转载

org.springframework.util.StopWatch：简洁的耗时统计小工具

想知道一个代码块执行耗时多久，通常做法是执行前记录当前时间A，执行后用当前时间减去A就是耗时了。spring库中有个统计耗时的小工具：StopWatch类，它可以帮我们做这些事情，甚至做得更好，咱们直接上代码实战吧：

创建项目

我这里用的是Intellij IDEA社区版，用maven创建一个Java工程，如下图所示：

添加依赖

在pom.xml中添加spring core的依赖，另外，为了看到更丰富的对象信息，我们把fastjson也加入进来，如下：

<properties>
        <!-- spring版本号 -->
        <spring.version>4.0.2.RELEASE</spring.version>
        <!-- fastjson版本号 -->
        <fastjson.version>1.2.39</fastjson.version>
    </properties>
    <dependencies>
        <!-- spring核心包 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <!-- fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>${fastjson.version}</version>
        </dependency>
    </dependencies>

模拟耗时的方法

在实际项目中，我们在调用本地方法，操作数据库，发起远程调用等场景都有可能耗时较长，所以此处做三个方法来模拟这些场景，如下，这个类的名字是StopWatchDemo：

/**
     * 延时的方法
     * @param time 延时时常，单位毫秒
     */
    private static void delay(long time){
        try{
            Thread.sleep(time);
        }catch(InterruptedException e){
            e.printStackTrace();
        }
    }

    /**
     * 假设这个方法在执行本地调用，耗时100毫秒
     */
    private void executeNative(){
        delay(100);
    }

    /**
     * 假设这个方法在执行数据库操作，耗时200毫秒
     */
    private void executeDB(){
        delay(200);
    }

    /**
     * 假设这个方法在执行远程调用，耗时300毫秒
     */
    private void executeRPC(){
        delay(300);
    }

用StopWatch类统计耗时

执行每个方法，并且统计这些方法耗时的代码如下，不多说了，看注释就好：

StopWatchDemo demo = new StopWatchDemo();

        //起个名字，在最后面统计信息中会打印出来
        StopWatch stopWatch = new StopWatch("stopwatch test");

        //记录本地方法的耗时
        stopWatch.start("执行本地方法");
        demo.executeNative();
        stopWatch.stop();

        //记录数据库操作的耗时
        stopWatch.start("执行数据库操作");
        demo.executeDB();
        stopWatch.stop();

        //记录数远程调用耗时
        stopWatch.start("执行远程调用");
        demo.executeRPC();
        stopWatch.stop();

        //打印一份格式化好的汇总统计信息
        System.out.println(stopWatch.prettyPrint());

        System.out.println("/n");

        //打印统计名称和总的耗时
        System.out.println(stopWatch.shortSummary());

        System.out.println("/n");

        //一共执行了三段统计，stopWatch.getTaskInfo()返回的数组中就是每段的信息，这里用fastjson转成字符串便于查看
        System.out.println(JSON.toJSON(stopWatch.getTaskInfo()));

执行结果

代码的执行结果如下，可以看到prettyPrint()返回的信息是格式化好的汇总数据，包含了每段耗时以及所占整体的百分比，让人对大致情况一目了然，shortSummary()返回的是名称和总耗时，stopWatch.getTaskInfo()返回了一个数组，里面是每一段统计的名称和耗时：

StopWatch 'stopwatch test': running time (millis) = 612
-----------------------------------------
ms     %     Task name
-----------------------------------------
00106  017%  执行本地方法
00204  033%  执行数据库操作
00302  049%  执行远程调用



StopWatch 'stopwatch test': running time (millis) = 612


[{"timeSeconds":0.106,"taskName":"执行本地方法","timeMillis":106},{"timeSeconds":0.204,"taskName":"执行数据库操作","timeMillis":204},{"timeSeconds":0.302,"taskName":"执行远程调用","timeMillis":302}]