Java开发利器Commons Lang之计时器StopWatch

标准Java库没有提供足够的方法来操作其核心类,Apache Commons Lang提供了这些额外的方法。

Apache Commons Lang为java提供了大量的帮助工具。lang API,特别是String操作方法、基本数值方法、对象反射、并发、创建和序列化以及System属性。此外,它还包含对java.util.Date的基本增强,以及一系列专门用于帮助构建方法的实用工具,如hashCode、toString和equals。

-- 来自官方简介http://commons.apache.org/proper/commons-lang/index.html

StopWatch介绍及核心API

StopWatch是位于org.apache.commons.lang3.time下的和时间有关的线程非安全的工具类。StopWatch为计时提供了很方便的API。StopWatch中提供的API都是成对使用的,比如有开始就有停止,有暂停就有恢复.....

启动、停止、重置计时相关API

  • start()
    启动计时

  • createStarted()
    StopWatch的静态方法,创建和启动计时器二合一

  • stop()
    停止计时器

  • reset()
    重置计时器,可以理解将计时器所有状态数据清零为初始状态(包括停止计时),从而可以继续复用这个计时器(重置之后,若要启动计时需要重新调用start()开启计时)

    @Test
    public void testStopWatch() throws InterruptedException {
        // 计时测试
        StopWatch stopWatch = StopWatch.createStarted();
        Thread.sleep(2000);
        System.out.println(stopWatch.getTime()); // 2001

        // 重置测试,重置之后,不再计时
        stopWatch.reset();
        Thread.sleep(2000);
        System.out.println(stopWatch.getTime()); // 3005

        // 重新启动重置之后的计时器
        stopWatch.start();
        Thread.sleep(2000);
        System.out.println(stopWatch.getTime()); // 2005

        // 停止计时测试
        stopWatch.stop();
        Thread.sleep(2000);
        System.out.println(stopWatch.getTime()); // 2001
    }

暂停、恢复计时相关API

  • suspend()
    暂停计时,此时计时器也将停止

  • resume()
    恢复计时,计时器重新开始计时

  • split()
    类似与暂停计时,但是它与暂停计时的区别在于,此时计时器还是正常计时的,只不过调用split()时相当于在此刻打了一个标记,然后在未来某个时间可以获取这个标记到开始计时之间的这段时间。

  • unsplit()
    与split()相反,用于清除上次split设置的标记

    public void testStopWatch002() throws InterruptedException {
        // 暂停计时测试
        StopWatch stopWatch = StopWatch.createStarted();
        Thread.sleep(2000);
        stopWatch.suspend();
        Thread.sleep(2000);
        System.out.println(stopWatch.getTime()); // 2005,暂停之后不再计时,所以暂停之后的2s不会计入

        // 恢复计时
        stopWatch.resume();
        Thread.sleep(2000);
        System.out.println(stopWatch.getTime()); // 4010,暂停期间不计时,恢复之后继续计时

        // 设置split停止标记
        stopWatch.split();
        Thread.sleep(2000);
        System.out.println(stopWatch.getSplitTime()); // 这里返回split标记到开始计时时的时间间隔,4010
        Thread.sleep(2000);
        stopWatch.unsplit();
        System.out.println(stopWatch.getTime()); // 设置split标记不影响计时,所以去除暂停的两秒,总共8010

    }

获取计时结果相关API

其主要核心的几个方法如下:

  • getTime()

  • getSplitTime()

  • getStartTime()

  • getStopTime()

  • formatTime()

  • formatSplitTime()

    public void testStopWatch003() throws InterruptedException {
        StopWatch stopWatch = StopWatch.createStarted();
        Thread.sleep(200);
        System.out.println(stopWatch.getTime()); // 205 
        System.out.println(stopWatch.formatTime()); // 00:00:00.205
    }

实现原理

StopWatch的实现原理比较简单,核心就是通过几个状态和几个变量来进行计时

    /**
     * The start time in nanoseconds.
     */
    private long startTimeNanos;

    /**
     * The start time in milliseconds - nanoTime is only for elapsed time so we
     * need to also store the currentTimeMillis to maintain the old
     * getStartTime API.
     */
    private long startTimeMillis;

    /**
     * The end time in milliseconds - nanoTime is only for elapsed time so we
     * need to also store the currentTimeMillis to maintain the old
     * getStartTime API.
     */
    private long stopTimeMillis;

  /**
     * The stop time in nanoseconds.
     */
    private long stopTimeNanos;

看start()方法

    public void start() {
        if (this.runningState == State.STOPPED) {
            throw new IllegalStateException("Stopwatch must be reset before being restarted. ");
        }
        if (this.runningState != State.UNSTARTED) {
            throw new IllegalStateException("Stopwatch already started. ");
        }
        this.startTimeNanos = System.nanoTime();
        this.startTimeMillis = System.currentTimeMillis();
        this.runningState = State.RUNNING;
    }

可以看到调用start()的方法时,记录开始计时的时间,以及修改计时器状态,再来看

    public long getNanoTime() {
        if (this.runningState == State.STOPPED || this.runningState == State.SUSPENDED) {
            return this.stopTimeNanos - this.startTimeNanos;
        } else if (this.runningState == State.UNSTARTED) {
            return 0;
        } else if (this.runningState == State.RUNNING) {
            return System.nanoTime() - this.startTimeNanos;
        }
        throw new IllegalStateException("Illegal running state has occurred.");
    }

其实就是返回当前时间和开始时间的间隔,StopWatch更多的还是状态分明,为我们封装了一些简单易用的API,比如开始停止计时,暂停恢复计时,StopWatch可以用来代替我们代码中经常类似下面这种计时:

        long startTime = System.currentTimeMillis();
        // run real action
        Thread.sleep(2000);
        long endTime = System.currentTimeMillis();
        System.out.println("方法耗时:" + (endTime - startTime)); // 方法耗时:2006
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,056评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,842评论 2 378
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,938评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,296评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,292评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,413评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,824评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,493评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,686评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,502评论 2 318
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,553评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,281评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,820评论 3 305
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,873评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,109评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,699评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,257评论 2 341