You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

gtimer是一个并发安全的高性能任务定时器,类似于JavaTimer

gtimer组件旧版本采用的是分层时间轮(Hierarchical Timing Wheel)设计,从goframe v1.16版本开始,采用了优先级队列(PriorityQueue)实现。

使用场景

任何定时任务场景,大批量定时任务/延迟任务的场景,超时控制/频率控制的业务场景,对于定时时间准确度要求不高的业务场景。

注意事项

  1. 任何的定时任务都是有误差的,在定时间隔比较大,或者并发量大,负载较高的系统中尤其明显,具体请参考:https://github.com/golang/go/issues/14410
  2. 定时间隔不会考虑任务的执行时间。例如,如果一项工作需要3分钟才能执行完成,并且计划每隔5分钟运行一次,那么每次任务之间只有2分钟的空闲时间。
  3. 需要注意的是单例模式运行的定时任务,任务的执行时间会影响该任务下一次执行的开始时间。例如:一个每秒执行的任务,运行耗时为1秒,那么在第1秒开始运行后,下一次任务将会在第3秒开始执行。

使用方式:

import "github.com/gogf/gf/os/gtimer"

接口文档

https://godoc.org/github.com/gogf/gf/os/gtimer

简要说明: 

  1. New方法用于创建自定义的任务定时器对象,并可在创建时通过intervalTimerOptions参数指定定时器的最小tick时间间隔。
  2. Add方法用于添加定时任务,其中:
    • interval 参数用于指定方法的执行的时间间隔。
    • job 参数为需要执行的任务方法(方法地址)。
  3. AddEntry方法添加定时任务,支持更多参数的控制。
  4. AddSingleton方法用于添加单例定时任务,即同时只能有一个该任务正在运行。
  5. AddOnce方法用于添加只运行一次的定时任务,当运行一次数后该定时任务自动销毁。
  6. AddTimes方法用于添加运行指定次数的定时任务,当运行times次数后该定时任务自动销毁。
  7. Search方法用于根据名称进行定时任务搜索(返回定时任务*Entry对象指针)。
  8. Start方法用于启动定时器(使用New创建定时器时会自动启动)。
  9. Stop方法用于停止定时器。
  10. Close方法用于关闭定时器。


默认定时器

大部分的场景下使用默认的定时器即可。如果确实有创建自定义时间轮对象的必要,务必提前理解时间轮设计概念,并且防止设计的时间刻度大小溢出。

使用gtimer的默认定时器时,默认的间隔时间为100ms,因此理论的时间间隔误差范围为0~100ms。可以使用以下两种方式修改默认的定时器参数:

  1. 使用启动参数
    • gf.gtimer.interval=50: 修改默认的时间刻度为50毫秒
  2. 使用环境变量
    • GF_GTIMER_INTERVAL=50

性能基准测试

goos: linux
goarch: amd64
pkg: github.com/gogf/gf/os/gtimer
Benchmark_Add-4               3000000             484 ns/op         152 B/op           5 allocs/op
Benchmark_StartStop-4       100000000            10.1 ns/op           0 B/op           0 allocs/op
PASS
ok      command-line-arguments    6.602s

示例1, 间隔任务

package main

import (
    "fmt"
    "github.com/gogf/gf/os/gtimer"
    "time"
)

func main() {
    now      := time.Now()
    interval := 1400*time.Millisecond
    gtimer.Add(interval, func() {
        fmt.Println(time.Now(), time.Duration(time.Now().UnixNano() - now.UnixNano()))
        now = time.Now()
    })

    select { }
}

执行后,输出结果为:

2019-01-17 18:17:37.022442 +0800 CST m=+1.354132542 1.353568s
2019-01-17 18:17:38.422467 +0800 CST m=+2.754148119 1.399624s
2019-01-17 18:17:39.82318 +0800 CST m=+4.154851847 1.40066s
2019-01-17 18:17:41.222422 +0800 CST m=+5.554084408 1.399094s
2019-01-17 18:17:42.622461 +0800 CST m=+6.954112968 1.399962s
2019-01-17 18:17:44.022769 +0800 CST m=+8.354411089 1.400251s
...

示例2, 单例任务

package main

import (
    "github.com/gogf/gf/os/glog"
    "github.com/gogf/gf/os/gtimer"
    "time"
)

func main() {
    interval := time.Second
    gtimer.AddSingleton(interval, func() {
        glog.Println("doing")
        time.Sleep(5*time.Second)
    })

    select { }
}

执行后,输出结果为:

2019-01-23 17:04:18.892 doing
2019-01-23 17:04:24.890 doing
2019-01-23 17:04:29.892 doing
2019-01-23 17:04:35.891 doing
...

gtimergcron区别

gtimer任务定时器与gcron定时任务模块区别:

  • gtimer属于高性能模块,是框架核心模块,构建任何定时任务的基础,任何方法操作耗时均在纳秒级别。
  • gtimer可适用于任何的定时任务场景中,例如: TCP通信、游戏开发等场景。
  • gcron支持经典的crontab形式的定时任务语法,最小时间设定间隔为
  • gcron底层实现基于gtimer



Content Menu

  • No labels