Go定时任务库：cron

╰+哭是因爲堅強的太久メ 2022-09-03 09:28 379阅读 0赞

在Linux中，Cron是计划任务管理系统，通过crontab命令使任务在约定的时间执行已经计划好的工作，例如定时备份系统数据、周期性清理缓存、定时重启服务等。本文介绍的cron库，就是用Go实现Linux中crontab命令的相似效果。

![cb52e13d1cebf586787f2c2b88daf714.gif][]

**使用示例**

安装下载cron，目前最新的稳定版已经迭代到了v3

go get github.com/robfig/cron/v3@v3.0.0

在项目中导入包

import "github.com/robfig/cron/v3"

使用

1package main
     2
     3import (
     4    "fmt"
     5
     6    "github.com/robfig/cron/v3"
     7)
     8
     9func main() {
    10    c := cron.New()
    11    c.AddFunc("30 * * * *", func() { fmt.Println("Every hour on the half hour") })
    12    c.AddFunc("30 3-6,20-23 * * *", func() { fmt.Println(".. in the range 3-6am, 8-11pm") })
    13    c.AddFunc("CRON_TZ=Asia/Tokyo 30 04 * * *", func() { fmt.Println("Runs at 04:30 Tokyo time every day") })
    14    c.AddFunc("@hourly", func() { fmt.Println("Every hour, starting an hour from now") })
    15    c.AddFunc("@every 1h30m", func() { fmt.Println("Every hour thirty, starting an hour thirty from now") })
    16    c.AddFunc("@every 1s", func() {fmt.Println("Every 1 second, starting an hour thirty from now")})
    17    c.Start()
    18    select {}
    19}

*  **创建cron对象**

使用时，首先通过cron.New()创建cron对象，通过该对象管理定时任务。通过调用cron的AddFunc()方法添加定时任务。AddFun()入参为二，参数一是以字符串的形式指定触发任务规则，参数二是无入参的函数，任务触发时执行函数。

*  **添加触发任务**

30 \* \* \* \*表示每个小时内的第30分钟时触发；30 3-6,20-23 \* \* \*表示在早上3点到6点，下午8点到11点的第30分钟时触发；CRON\_TZ=Asia/Tokyo 30 04 \* \* \*表示东京时间每天早上4点半触发；@hourly表示从添加该任务时算起的之后每小时触发；@every 1h30m表示从添加该任务时算起的之后每一个半小时触发；@every 1s表示从添加该任务时算起的之后每秒触发。

*  **启动定时循环**

通过调用cron.Start()启动定时循环任务。

输出

1 $ go run main.go 
    2Every 1 second, starting an hour thirty from now
    3Every 1 second, starting an hour thirty from now
    4Every 1 second, starting an hour thirty from now
    5Every 1 second, starting an hour thirty from now
    6...

由于只让以上程序运行了几秒的时间，因此，输出中只包含执行了每秒触发的打印。随着程序运行时间的加长，其他触发任务也会在满足条件时进行打印。

![dc85a47b2f92cadd37242edf657f730d.gif][]

**cron时间表达式规则**

cron表达式默认通过使用5个以空格分隔的字段组合来表示触发时间（和linux的crontab保持一致）。

1Field name   | Mandatory? | Allowed values  | Allowed special characters
    2----------   | ---------- | --------------  | --------------------------
    3Minutes      | Yes        | 0-59            | * / , -
    4Hours        | Yes        | 0-23            | * / , -
    5Day of month | Yes        | 1-31            | * / , - ?
    6Month        | Yes        | 1-12 or JAN-DEC | * / , -
    7Day of week  | Yes        | 0-6 or SUN-SAT  | * / , - ?

如同30 \* \* \* \*一样，默认第1个字段表示分钟，第2个字段表示小时，第3个字段表示每月中的日期，第4个字段表示月份数，第5个字段表示星期几。

cron还提供了强大的自定义时间格式功能，可以通过调用cron.NewParser()创建自定义Parser对象，例如通过以下方式定义新的cron时间表达式规则

这样，时间字段一共是7位，第1位就是指定秒。秒执行的时间表达式就可以用1 \* \* \* \* \* \*表示。

因为添加Seconds是对标准cron规范的最常见修改，因此cron提供了一个内置函数cron.WithSeconds()来执行此操作，该函数等效于之前使用的自定义解析器。

1cron.New(cron.WithSeconds())

*  **预定义时间表**

由于cron的时间表达式可读性不是很好，因此cron库预定义了一些字符串来表示特定的时间规则。

*  **时间间隔**

cron还提供了更具可读性的固定时间间隔格式

1@every <duration>

它代码每隔duration触发执行一次任务。这里的duration是通过调用标准库time的ParseDuration()函数解析的，所以只要ParseDuration()支持的格式都能支持。例如上文示例的@every 1h30m和@every 1s。

![4d9129710256bcdd845b8b9b915f0d68.gif][]

**cron可控选项**

在cron源码option.go文件中，暴露了5个函数供开发者控制cron对象的选项。

*  **WithLocation()**

指定时区。默认情况下基于当前时区（在Unix系统中，查询TZ环境变量确定要使用的时区，若未定义TZ，则使用/etc/localtime文件中的定义时区）。可通过在时间字符串前添加CRON\_TZ=字符串再加上具体的时区。例如东京时区为Asia/Tokyo。

1c.AddFunc("CRON_TZ=Asia/Tokyo 30 04 * * *", func() { fmt.Println("Runs at 04:30 Tokyo time every day") })

*  **WithParser()**

自定义时间解析器，上文已有示例，这里不再赘述。

*  **WithSeconds()**

增加对秒的时间格式支持，其内部调用的WithParser()方法。

1func WithSeconds() Option {
    2    return WithParser(NewParser(
    3        Second | Minute | Hour | Dom | Month | Dow | Descriptor,
    4    ))
    5}

*  **WithChain()**

Job包装器，下文中会讲解Job接口。

*  **WithLogger()**

Logger是cron中用于记录日志的接口，WithLogger()可以设置自定义的Logger。

1package main
     2
     3import (
     4    "fmt"
     5    "log"
     6    "os"
     7
     8    "github.com/robfig/cron/v3"
     9)
    10
    11func main() {
    12    c := cron.New(cron.WithLogger(cron.VerbosePrintfLogger(log.New(os.Stdout, "cron process: ", log.LstdFlags))))
    13    c.AddFunc("@every 1s", func() { fmt.Println("Every 1 second") })
    14    c.Start()
    15    select {}
    16}

该logger记录了cron内部的调度过程，输入如下

1go run main.go 
     2cron process: 2020/08/30 00:07:04 start
     3cron process: 2020/08/30 00:07:04 schedule, now=2020-08-30T00:07:04+08:00, entry=1, next=2020-08-30T00:07:05+08:00
     4cron process: 2020/08/30 00:07:05 wake, now=2020-08-30T00:07:05+08:00
     5cron process: 2020/08/30 00:07:05 run, now=2020-08-30T00:07:05+08:00, entry=1, next=2020-08-30T00:07:06+08:00
     6Every 1 second
     7cron process: 2020/08/30 00:07:06 wake, now=2020-08-30T00:07:06+08:00
     8Every 1 second
     9cron process: 2020/08/30 00:07:06 run, now=2020-08-30T00:07:06+08:00, entry=1, next=2020-08-30T00:07:07+08:00
    10cron process: 2020/08/30 00:07:07 wake, now=2020-08-30T00:07:07+08:00
    11cron process: 2020/08/30 00:07:07 run, now=2020-08-30T00:07:07+08:00, entry=1, next=2020-08-30T00:07:08+08:00
    12Every 1 second
    13...

![f66701f92d693871eddd175ef9e72b2b.gif][]

**自定义Job**

cron中定义了Job接口，对象只要实现了Job接口所定义的Run()方法，均可以调用cron.AddJob()方法将该对象添加到定时管理器中。

1// Job is an interface for submitted cron jobs.
    2type Job interface {
    3    Run()
    4}

*  **AddFunc()**

在上文示例中，通过cron.AddFunc()方法为cron对象添加定时任务。实质上，AddFunc()方法内部调用的也是AddJob()方法：定义新类型对象FuncJob，为其实现Job接口，在AddFunc()方法中，将回调参数func()转为FuncJob类型，调用AddJob()方法。

1type FuncJob func()
    2
    3func (f FuncJob) Run() { f() }
    4
    5func (c *Cron) AddFunc(spec string, cmd func()) (EntryID, error) {
    6    return c.AddJob(spec, FuncJob(cmd))
    7}

*  **自实现Job接口**

除了通过AddFunc()将无参函数直接作为回调外，我们还可以通过AddJon()自定义对象。

如下，自定义对象CallJob，实现Run()方法。

1package main
     2
     3import (
     4    "fmt"
     5    "time"
     6
     7    "github.com/robfig/cron/v3"
     8)
     9
    10type CallJob struct {
    11    name   string
    12    number int
    13}
    14
    15func (c CallJob) Run() {
    16    fmt.Printf("call %s : %d\n", c.name, c.number)
    17}
    18func main() {
    19    c := cron.New()
    20    c.AddJob("@every 1s", CallJob{
    21        name:   "Bob",
    22        number: 13888888888,
    23    })
    24    c.Start()
    25
    26    time.Sleep(3 * time.Second)
    27}

输出

1 $ go run main.go 
    2call Bob : 13888888888
    3call Bob : 13888888888
    4call Bob : 13888888888

![1c77061df2b06d04f237c5c20ca99258.gif][]

**总结**

cron库为go开发者提供了强大的定时任务管理功能，它的时间表达式格式和linux下的crontab命令是对齐的。

cron的代码并不算多，其核心定时管理功能依赖了go标准库time和sort，非常值得学习和参考。另外有一个基于该库抽离出来的最小化定时任务库gron，更易理解和使用，文末会附上该库地址。

cron是小菜刀在实际项目中引入过的三方库，感觉挺不错，就总结出来分享给大家。如果你喜欢看更多关于三方库的文章，请点赞支持。

**仓库地址**

# 1. *https://github.com/robfig/cron* #

2. *https://github.com/roylee0704/gron*

**往期推荐推荐**

*  [goroutine的退出与泄露][goroutine]
 *  [一次错误吞并的教训][Link 1]  
    
 *  [Go工具之generate][Go_generate]  
    
 *  [no copy机制][no copy]
 *  [高并发系统之限流技术][Link 2]  
    
 *  [信号处理与Go程序的优雅退出][Go]
 *  [不要忽略goroutine的启动时间][goroutine 1]
 *  [设计模式之观察者模式][Link 3]

**Golang技术分享**

长按识别二维码关注我们

更多golang学习资料

回复关键词**1024**

![2846f1d3e4106aa8dc6961a796f1b4c6.png][]

[cb52e13d1cebf586787f2c2b88daf714.gif]: /images/20220829/fc1a47fc890c4d20895537a05fcd371b.png
[dc85a47b2f92cadd37242edf657f730d.gif]: /images/20220829/9df35aaf15b34fa4be56084c23439037.png
[4d9129710256bcdd845b8b9b915f0d68.gif]: /images/20220829/ca99a375d35a40fd96bb00e7257d6f90.png
[f66701f92d693871eddd175ef9e72b2b.gif]: /images/20220829/a1d0a9b0927d4347b022266b05ae5c02.png
[1c77061df2b06d04f237c5c20ca99258.gif]: /images/20220829/b06c0fa9cb664cd0a092127b2e654f60.png
[goroutine]: http://mp.weixin.qq.com/s?__biz=MzIwNTA4MDAwMQ%3D%3D&chksm=97371665a0409f73561af432cdbf2f21338c95ac486da491bd5e1d4fc432b51509bdb45f0c16&idx=1&mid=2247484107&scene=21&sn=a126a0cc7b0442589d83df29089b10b8#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzIwNTA4MDAwMQ%3D%3D&chksm=9737166fa0409f793dabcd8dd8ca5c85c1e89a8a7f99e36f5a48ec3d40d434cf1199a6ba6297&idx=1&mid=2247484097&scene=21&sn=5470f4107bb258e105d8ef33000188ae#wechat_redirect
[Go_generate]: http://mp.weixin.qq.com/s?__biz=MzIwNTA4MDAwMQ%3D%3D&chksm=9737161da0409f0b50f62b48c5b83d61d9754a43a80e83797df459afb2adada2176a0e04c2eb&idx=1&mid=2247484083&scene=21&sn=7571b866c11930c48830060f7a002b82#wechat_redirect
[no copy]: http://mp.weixin.qq.com/s?__biz=MzIwNTA4MDAwMQ%3D%3D&chksm=973716c7a0409fd1440d74edfb8949d2c3f2d49984fdae08fd1ce0581ea7705cbf6513a3bcdf&idx=1&mid=2247484009&scene=21&sn=1dc6689045b8a1d04cb4d6dd67a6b66b#wechat_redirect
[Link 2]: http://mp.weixin.qq.com/s?__biz=MzIwNTA4MDAwMQ%3D%3D&chksm=9737151aa0409c0cf8f39ce03c2ce90c7d3da029249ca80bcf06ca9f9b45cda45cd2079387bc&idx=1&mid=2247483828&scene=21&sn=88bcacc010a57311739f0cbc4f8920d8#wechat_redirect
[Go]: http://mp.weixin.qq.com/s?__biz=MzIwNTA4MDAwMQ%3D%3D&chksm=97371575a0409c635e4a66a4d23b37bc90b78504ad733055ebb1d0256f7b6cb1a26ae3ecffec&idx=1&mid=2247483867&scene=21&sn=5672d9bfabd66794b139f676d71ca5ca#wechat_redirect
[goroutine 1]: http://mp.weixin.qq.com/s?__biz=MzIwNTA4MDAwMQ%3D%3D&chksm=973717efa0409ef932a5452be719f341814f4c8bc322cb5cdb6b8e46d0069e83a91f5c0bd3ed&idx=1&mid=2247484225&scene=21&sn=6d71dfaf7fd4c4f249447a798cf03701#wechat_redirect
[Link 3]: http://mp.weixin.qq.com/s?__biz=MzIwNTA4MDAwMQ%3D%3D&chksm=973717e5a0409ef32e408539e2fbc50eafeec110bf676a11a0d2c2a2afda8e334234df703fa3&idx=1&mid=2247484235&scene=21&sn=eb98da90ae03ad20034d6b4b23d3224f#wechat_redirect
[2846f1d3e4106aa8dc6961a796f1b4c6.png]: /images/20220829/531c16118b874550967376cbf345449e.png