前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
社区首页 >专栏 >golang cron 定时任务

golang cron 定时任务

作者头像
李海彬
发布于 2019-05-08 03:40:21
发布于 2019-05-08 03:40:21
12.3K00
代码可运行
举报
文章被收录于专栏:Golang语言社区Golang语言社区
运行总次数:0
代码可运行

作者:_AlphaBaby_

最开始接触定时任务的概念是在大二的一个计算机操作系统设计的实验课上,当时老师给了五个任务要求,自己任选三个小组完成。

依稀还记得当时有个作业的任务需要每隔一段时间就执行一次:上百度就了解到了这样要给命令:crontab,这个命令可以设定在后台定时跑一个脚本。

如果对这个命令比较感兴趣或者有这样一个需求,可以参考:在linux上定期执行命令、脚本(cron,crontab,anacron)

cron 功能

在Golang中也有这样一个工具的封装。提一下cron主要能干什么:

比如我们手机里面设置的闹钟,我们可以设置成每天早上7:00,每周周一到周三晚上一点,我们可以把cron形象的看作一个闹钟,会在我们规定的时间自动执行一些我们设置好的动作。

作为一个大学生,你可能追求过某某女孩子,你可能有这样一个需求:每天早上微信给她发早安和晚上给她发晚安。这可能是个不错的点子。

这都是浮云,还是努力学习,学会怎么用才是关键,不然你也写不出来。

cron 用法

首先先把第三方库下载下来:

$ go get -v -u github.com/robfig/cron

我们来看一个小的demo:每隔一秒打印"hello world"

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
 1package main
 2
 3import (
 4    "log"
 5
 6    "github.com/robfig/cron"
 7)
 8
 9func main() {
10    log.Println("Starting...")
11
12    c := cron.New()  // 新建一个定时任务对象
13    c.AddFunc("* * * * * *", func() {
14        log.Println("hello world")
15    })  // 给对象增加定时任务
16    c.Start()
17    select {
18    }
19}

这个小功能用time.Ticker也可以实现,我们为什么要使用cron来完成呢?别急接着往下面看就知道了。

cron表达式

我们在上面demo中使用了AddFunc,第一个参数我们传递了一个字符串是:"* * * * * *",这六个*是指什么呢?

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
 1 ┌─────────────second 范围 (0 - 60)
 2 │ ┌───────────── min (0 - 59)
 3 │ │ ┌────────────── hour (0 - 23)
 4 │ │ │ ┌─────────────── day of month (1 - 31)
 5 │ │ │ │ ┌──────────────── month (1 - 12)
 6 │ │ │ │ │ ┌───────────────── day of week (0 - 6) (0 to 6 are Sunday to
 7 │ │ │ │ │ │                  Saturday)
 8 │ │ │ │ │ │
 9 │ │ │ │ │ │
10 * * * * * *

匹配符号

  1. 星号(*) :表示 cron 表达式能匹配该字段的所有值。如在第5个字段使用星号(month),表示每个月
  2. 斜线(/):表示增长间隔,如第2个字段(minutes) 值是 3-59/15,表示每小时的第3分钟开始执行一次,之后 每隔 15 分钟执行一次(即 3(3+0*15)、18(3+1*15)、33(3+2*15)、48(3+3*15) 这些时间点执行),这里也可以表示为:3/15
  3. 逗号(,):用于枚举值,如第6个字段值是 MON,WED,FRI,表示 星期一、三、五 执行
  4. 连字号(-):表示一个范围,如第3个字段的值为 9-17 表示 9am 到 5pm 直接每个小时(包括9和17)
  5. 问号(?):只用于 日(Day of month) 和 星期(Day of week),表示不指定值,可以用于代替 *

example

比如我们的手机卡假设都是在每个月的开始时间就更新资费:

"0 0 0 1 * *" // 表示每个月1号的00:00:00 "0 1 1 1 * *" // 表示每个月1号的01:01:00

每隔5秒执行一次:"*/5 * * * * ?" 每隔1分钟执行一次:"0 */1 * * * ?" 每天23点执行一次:"0 0 23 * * ?" 每天凌晨1点执行一次:"0 0 1 * * ?" 每月1号凌晨1点执行一次:"0 0 1 1 * ?" 在26分、29分、33分执行一次:"0 26,29,33 * * * ?" 每天的0点、13点、18点、21点都执行一次:"0 0 0,13,18,21 * * ?"

pre-defined schedules

github.com/robfig/cron 包还给我门提供了一些预定义的模式:

Entry

Description

Equivalent To

@yearly (or @annually)

Run once a year, midnight, Jan. 1st

0 0 0 1 1 *

@monthly

Run once a month, midnight, first of month

0 0 0 1 * *

@weekly

Run once a week, midnight between Sat/Sun

0 0 0 * * 0

@daily (or @midnight)

Run once a day, midnight

0 0 0 * * *

@hourly

Run once an hour, beginning of hour

0 0 * * * *

@every <duration>

every duration

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1c.AddFunc("@every 1h30m", func() { fmt.Println("Every hour thirty") })

golang cron主要的设计思路

主要类型或接口说明 (借用大佬)

  1. Cron:包含一系列要执行的实体;支持暂停【stop】;添加实体等
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1type Cron struct {
2    entries  []*Entry
3    stop     chan struct{}   // 控制 Cron 实例暂停
4    add      chan *Entry     // 当 Cron 已经运行了,增加新的 Entity 是通过 add 这个 channel 实现的
5    snapshot chan []*Entry   // 获取当前所有 entity 的快照
6    running  bool            // 当已经运行时为true;否则为false
7}

注意,Cron 结构没有导出任何成员。 注意:有一个成员 stop,类型是 struct{},即空结构体。

  1. Entry:调度实体
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
 1type Entry struct {
 2    // The schedule on which this job should be run.
 3    // 负责调度当前 Entity 中的 Job 执行
 4    Schedule Schedule
 5
 6    // The next time the job will run. This is the zero time if Cron has not been
 7    // started or this entry's schedule is unsatisfiable
 8    // Job 下一次执行的时间
 9    Next time.Time
10
11    // The last time this job was run. This is the zero time if the job has never
12    // been run.
13    // 上一次执行时间
14    Prev time.Time
15
16    // The Job to run.
17    // 要执行的 Job
18    Job Job
19}
  1. Job:每一个实体包含一个需要运行的Job 这是一个接口,只有一个方法:Run
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1type Job interface {
2    Run()
3}

由于 Entity 中需要 Job 类型,因此,我们希望定期运行的任务,就需要实现 Job 接口。同时,由于 Job 接口只有一个无参数无返回值的方法,为了使用方便,作者提供了一个类型:

type FuncJob func()

它通过简单的实现 Run() 方法来实现 Job 接口:

func (f FuncJob) Run() { f() }

这样,任何无参数无返回值的函数,通过强制类型转换为 FuncJob,就可以当作 Job 来使用了,AddFunc 方法 就是这么做的。

  1. Schedule:每个实体包含一个调度器(Schedule) 负责调度 Job 的执行。它也是一个接口。
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1type Schedule interface {
2    // Return the next activation time, later than the given time.
3    // Next is invoked initially, and then each time the job is run.
4    // 返回同一 Entity 中的 Job 下一次执行的时间
5    Next(time.Time) time.Time
6}
代码语言:javascript
代码运行次数:0
运行
复制

Schedule 的具体实现通过解析 Cron 表达式得到。

库中提供了 Schedule 的两个具体实现,分别是 SpecScheduleConstantDelaySchedule

SpecSchedule

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1type SpecSchedule struct {
2    Second, Minute, Hour, Dom, Month, Dow uint64
3}

从开始介绍的 Cron 表达式可以容易得知各个字段的意思,同时,对各种表达式的解析也会最终得到一个 SpecSchedule 的实例。库中的 Parse 返回的其实就是 SpecSchedule 的实例(当然也就实现了 Schedule 接口)。

ConstantDelaySchedule

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1type ConstantDelaySchedule struct {
2    Delay time.Duration // 循环的时间间隔
3}
代码语言:javascript
代码运行次数:0
运行
复制

这是一个简单的循环调度器,如:每 5 分钟。注意,最小单位是秒,不能比秒还小,比如 毫秒。

通过 Every 函数可以获取该类型的实例,如:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1constDelaySchedule := Every(5e9)

得到的是一个每 5 秒执行一次的调度器。

函数调用

  1. 函数实例化 Cron
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1func New() *Cron {
2    return &Cron{
3        entries:  nil,
4        add:      make(chan *Entry),
5        stop:     make(chan struct{}),
6        snapshot: make(chan []*Entry),
7        running:  false,
8    }
9}

可见实例化时,成员使用的基本是默认值;

解析 Cron 表达式

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1func Parse(spec string) (_ Schedule, err error)

spec 可以是:

  • Full crontab specs, e.g. “* * * * * ?”
  • Descriptors, e.g. “@midnight”, “@every 1h30m”

② 成员方法

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
 1// 将 job 加入 Cron 中
 2// 如上所述,该方法只是简单的通过 FuncJob 类型强制转换 cmd,然后调用 AddJob 方法
 3func (c *Cron) AddFunc(spec string, cmd func()) error
 4
 5// 将 job 加入 Cron 中
 6// 通过 Parse 函数解析 cron 表达式 spec 的到调度器实例(Schedule),之后调用 c.Schedule 方法
 7func (c *Cron) AddJob(spec string, cmd Job) error
 8
 9// 获取当前 Cron 总所有 Entities 的快照
10func (c *Cron) Entries() []*Entry
11
12// 通过两个参数实例化一个 Entity,然后加入当前 Cron 中
13// 注意:如果当前 Cron 未运行,则直接将该 entity 加入 Cron 中;
14// 否则,通过 add 这个成员 channel 将 entity 加入正在运行的 Cron 中
15func (c *Cron) Schedule(schedule Schedule, cmd Job)
16
17// 新启动一个 goroutine 运行当前 Cron
18func (c *Cron) Start()
19
20// 通过给 stop 成员发送一个 struct{}{} 来停止当前 Cron,同时将 running 置为 false
21// 从这里知道,stop 只是通知 Cron 停止,因此往 channel 发一个值即可,而不关心值是多少
22// 所以,成员 stop 定义为空 struct
23func (c *Cron) Stop()
24
代码语言:javascript
代码运行次数:0
运行
复制

如果对每个方法调用还是不了解可以去看一下每隔函数的实现源码

example

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
 1package main
 2
 3import (
 4    "log"
 5
 6    "github.com/robfig/cron"
 7)
 8
 9type Hello struct {
10    Str string
11}
12
13func(h Hello) Run() {
14    log.Println(h.Str)
15}
16
17func main() {
18    log.Println("Starting...")
19
20    c := cron.New()
21    h := Hello{"I Love You!"}
22    // 添加定时任务
23    c.AddJob("*/2 * * * * * ", h)
24    // 添加定时任务
25    c.AddFunc("*/5 * * * * * ", func() {
26        log.Println("hello word")
27    })
28
29    s, err := cron.Parse("*/3 * * * * *")
30    if err != nil {
31        log.Println("Parse error")
32    }
33    h2 := Hello{"I Hate You!"}
34    c.Schedule(s, h2)
35    // 其中任务
36    c.Start()
37    // 关闭任务
38    defer c.Stop()
39    select {
40    }
41}
代码语言:javascript
代码运行次数:0
运行
复制

参考 GO语言版CRONTAB 官方文档


版权申明:内容来源网络,版权归原创者所有。除非无法确认,我们都会标明作者及出处,如有侵权烦请告知,我们会立即删除并表示歉意。谢谢。

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2019-03-13,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 Golang语言社区 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
python标识符命名规则和要求_python必背入门代码
标识符命名规则有如下4个要求: 1.见名知意 :看到变量的名字就能知道这个变量干什么的 2.由字母、下划线和数字组成,且数字不能开头 3.区分大小写 4.不能和关键字重复
全栈程序员站长
2022/09/30
4400
python 函数嵌套和nonlocal关键字
与global关键字有点相似,可以对比着理解。nonlocal关键字只能作用域局部变量,且始终找离当前最近的上层局部作用域中的变量。看栗子:
全栈程序员站长
2022/10/04
4270
java中用关键字定义常量_定义常量用什么关键字
public static void main(String[] args){
全栈程序员站长
2022/11/17
5470
Python标识符的命名规则,下列哪些是对的?_python标识符不能使用关键字
[快速理解] Python标识符是指变量、函数、类、模块等的名称。 例如:a=10中的a是标识符 反例:for i in [1,2,3]中的for和in不是标识符,是保留字,i是标识符。Python保留字有特殊的语法功能。
全栈程序员站长
2022/09/30
1.2K0
Python标识符的命名规则,下列哪些是对的?_python标识符不能使用关键字
Python 标识符与关键字[通俗易懂]
大家好,又见面了,我是你们的朋友全栈君。 Python 标识符与关键字
全栈程序员站长
2022/09/30
1.2K0
Python学习(十一)Python标识符命名规范
简单地理解,标识符就是一个名字,就好像我们每个人都有属于自己的名字,它的主要作用就是作为变量、函数、类、模块以及其他对象的名称。
全栈程序员站长
2022/09/30
6340
javaScript的基本语法结构「建议收藏」
javascript标识符必须要以字母、下划线、或美元符号开头,后续可以数字、字母、下划线、或美元符号
全栈程序员站长
2022/11/07
6890
python nonlocal关键字「建议收藏」
non – local 非局部变量 如果两个嵌套函数,一个函数A里面又包含了一个函数B,那么对于B中的名称来说A中的作用域就为nonlocal 作用域:enclosing作用域 —外层非全局作用域 如果要在内层函数中修改外层变量,则需要用到 nonlocal 关键字
全栈程序员站长
2022/10/03
3330
python nonlocal关键字「建议收藏」
python语言关键字是_Python 关键字
Python 关键字(或称 保留字)指的是 Python 语言中一些已经被赋予特定意义的单词。
全栈程序员站长
2022/11/01
1K0
python基础知识点汇总
if语句,当条件成立时运行语句块。经常与else, elif(相当于else if) 配合使用。
全栈程序员站长
2022/11/03
5710
python基础知识点汇总
Python学习:关键字global和nonlocal的用法说明
nonlocal声明的变量不是局部变量,也不是全局变量,而是外部嵌套函数内的变量。
全栈程序员站长
2022/10/04
2950
Python学习:关键字global和nonlocal的用法说明
__cplusplus、extern “C”关键字
我们在阅读程序时,经常会见到__cplusplus关键字,比如下面的代码:
全栈程序员站长
2022/11/17
3970
【Java SE】————标识符及命名规则和关键字
Java是一种可以撰写跨平台应用软件的面向对象的程序设计语言,其中,对于变量,常量,函数,语句块也有名字,我们统统称之为Java标识符.。
全栈程序员站长
2022/09/08
4110
关键字declare_protected关键字
在以上的例子中,因为函数模板的存在,我们并不能知道变量xpy的类型。 这时我们可以使用C++11新增的关键字decltype
全栈程序员站长
2022/09/30
7260
C语言标识符关键字_c语言标识符关键字有哪些
大致浏览一遍即可,不用去百度每个关键字的作用,这些关键字以后会经常用到的,到时候你想不记住都难。
全栈程序员站长
2022/11/09
6990
C语言标识符关键字_c语言标识符关键字有哪些
idea全局查找关键字快捷键_hbuilder全局搜索
在使用IDEA时,可以使用双击Shift的方式进行关键字的查找,这是个很好的功能。但IDEA也提供了对于字符串的查找,比如说查找代码中
全栈程序员站长
2022/11/01
1.1K0
python处理异常的关键字_如果抛出异常应用哪些关键字
Python用异常对象(exception object)表示异常情况,遇到错误后,会引发异常。如果异常对象并未被处理或捕捉,程序就会用所谓的回溯(Traceback,一种错误信息)终止执行。
全栈程序员站长
2022/11/02
5600
pep8风格指南_pep方案是什么意思
参考链接:https://github.com/jackfrued/Python-100-Days
全栈程序员站长
2022/11/17
3430
ora00904::标识符无效_ora-00911 无效字符
ORA:即Oracle报错。 标识符无效:SQL语句中,这个字段名不在表中。 解决方案:修改SQL语句中对应的字段或者修改表里面对应的列名。
全栈程序员站长
2022/11/01
1.4K0
ora00904::标识符无效_ora-00911 无效字符
以下哪些字符可以用于定义Python标识符_if可以作为用户标识符吗
1. 有效的Python标识符规则:(1)长度是任意长度;(2)标识符不能具有相同的名称作为关键词;(3)在Python的版本,用一个ASCII字母或下划线标识符开始,并且可以紧随其后的是字母,数字,下划线;在Python中,标识符ASCII字母、下划线和大多数非英语语言字母,只要用Unicode编码的字母可以作为主要人物,和随后的字符可以是任何主角,或任何的字符进行技术改造,包括任何在Unicode字符被认为是一个数字。(所以你可以用阿拉伯文、中文、日语和俄语字符或字符在任何其他语言支持Unicode字符集命名)2。约定:(1)不使用Python预定义的标识符的名称,所以避免使用NotImplemented Eliiipsis等名字,这可能是用于新版本的Python在未来;
全栈程序员站长
2022/09/30
1.2K0
推荐阅读
相关推荐
python标识符命名规则和要求_python必背入门代码
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档