• 欢迎来到本博客,希望可以y一起学习与分享

go 定时任务 cron

笔记 benz 3周前 (09-27) 9次浏览 0个评论 扫描二维码
文章目录[隐藏]

入门

cron 默认支持最小粒度为分钟,最多支持秒级别。
GitHub:https://github.com/robfig/cron

安装

使用

使用非常简单,创建cron对象,这个对象用于管理定时任务。

调用cron对象的AddFunc()方法向管理器中添加定时任务。AddFunc()接受两个参数,参数 1 以字符串形式指定触发时间规则,参数 2 是一个无参的函数,每次触发时调用。@every 1s表示每秒触发一次,@every后加一个时间间隔,表示每隔多长时间触发一次。例如@every 1h表示每小时触发一次,@every 1m2s表示每隔 1 分 2 秒触发一次。time.ParseDuration()支持的格式都可以用在这里。

调用c.Start()启动定时循环。

运行效果,每隔 1s 输出一行字符串:

Job接口 自定义任务struct

除了直接将无参函数作为回调外,cron还支持Job接口:(以下是cron.go源码)

我们定义一个实现接口Job的结构:

调用cron对象的AddJob()方法将GreetingJob对象添加到定时管理器中:

运行效果:

使用自定义的结构可以让任务携带状态(Name字段)。

实际上AddFunc()方法内部也调用了AddJob()方法。

创建任务的3种方式

线程安全

cron会创建一个新的 goroutine 来执行触发回调。如果这些回调需要并发访问一些资源、数据,我们需要显式地做同步。

时间格式处理

时间格式

与Linux 中crontab命令相似,cron库支持用 5 个空格分隔的域来表示时间。这 5 个域含义依次为:

  • Minutes:分钟,取值范围[0-59],支持特殊字符* / , -
  • Hours:小时,取值范围[0-23],支持特殊字符* / , -
  • Day of month:每月的第几天,取值范围[1-31],支持特殊字符* / , - ?
  • Month:月,取值范围[1-12]或者使用月份名字缩写[JAN-DEC],支持特殊字符* / , -
  • Day of week:周历,取值范围[0-6]或名字缩写[JUN-SAT],支持特殊字符* / , - ?

注意,月份和周历名称都是不区分大小写的,也就是说SUN/Sun/sun表示同样的含义(都是周日)。

特殊字符含义如下:

  • *:使用*的域可以匹配任何值,例如将月份域(第 4 个)设置为*,表示每个月;
  • /:用来指定范围的步长,例如将小时域(第 2 个)设置为3-59/15表示第 3 分钟触发,以后每隔 15 分钟触发一次,因此第 2 次触发为第 18 分钟,第 3 次为 33 分钟。。。直到分钟大于 59;
  • ,:用来列举一些离散的值和多个范围,例如将周历的域(第 5 个)设置为MON,WED,FRI表示周一、三和五;
  • -:用来表示范围,例如将小时的域(第 1 个)设置为9-17表示上午 9 点到下午 17 点(包括 9 和 17);
  • ?:只能用在月历和周历的域中,用来代替*,表示每月/周的任意一天。

了解规则之后,我们可以定义任意时间:

  • 30 * * * *:分钟域为 30,其他域都是*表示任意。每小时的 30 分触发;
  • 30 3-6,20-23 * * *:分钟域为 30,小时域的3-6,20-23表示 3 点到 6 点和 20 点到 23 点。3,4,5,6,20,21,22,23 时的 30 分触发;
  • 0 0 1 1 *:1(第 4 个) 月 1(第 3 个) 号的 0(第 2 个) 时 0(第 1 个) 分触发。

记熟了这几个域的顺序,再多练习几次很容易就能掌握格式。熟悉规则了之后,就能熟练使用crontab命令了。

预定义时间规则

为了方便使用,cron预定义了一些时间规则:

  • @yearly:也可以写作@annually,表示每年第一天的 0 点。等价于0 0 1 1 *
  • @monthly:表示每月第一天的 0 点。等价于0 0 1 * *
  • @weekly:表示每周第一天的 0 点,注意第一天为周日,即周六结束,周日开始的那个 0 点。等价于0 0 * * 0
  • @daily:也可以写作@midnight,表示每天 0 点。等价于0 0 * * *
  • @hourly:表示每小时的开始。等价于0 * * * *

例如:

固定时间间隔

cron支持固定时间间隔,格式为:

含义为每隔duration触发一次。<duration>会调用time.ParseDuration()函数解析,所以ParseDuration支持的格式都可以。例如1h30m10s。在快速开始部分,我们已经演示了@every的用法了,这里就不赘述了。

 

时区

默认情况下,所有时间都是基于当前时区的。当然我们也可以指定时区,有 2 两种方式:

  • 在时间字符串前面添加一个CRON_TZ= + 具体时区,具体时区的格式在之前carbon的文章中有详细介绍。东京时区为Asia/Tokyo,纽约时区为America/New_York
  • 创建cron对象时增加一个时区选项cron.WithLocation(location)locationtime.LoadLocation(zone)加载的时区对象,zone为具体的时区格式。或者调用已创建好的cron对象的SetLocation()方法设置时区。

示例:

自定义时间格式

cron支持灵活的时间格式,如果默认的格式不能满足要求,我们可以自己定义时间格式。时间规则字符串需要cron.Parser对象来解析。我们先来看看默认的解析器是如何工作的。

首先定义各个域:(以下是parser.go源码)

除了Minute/Hour/Dom(Day of month)/Month/Dow(Day of week)外,还可以支持Second。相对顺序都是固定的:(以下是parser.go源码)

默认的时间格式使用 5 个域。

我们可以调用cron.NewParser()创建自己的Parser对象,以位格式传入使用哪些域,例如下面的Parser使用 6 个域,支持Second(秒):

调用cron.WithParser(parser)创建一个选项传入构造函数cron.New(),使用时就可以指定秒了:

这里时间格式必须使用 6 个域,顺序与上面的const定义一致。

因为上面的时间格式太常见了,cron定义了一个便捷的函数:(以下是option.go源码)

注意Descriptor表示对@every/@hour等的支持。有了WithSeconds(),我们不用手动创建Parser对象了:

 

cron.New()的选项

cron对象创建使用了选项模式,我们前面已经介绍了 3 个选项:

  • WithLocation:指定时区;
  • WithParser:使用自定义的解析器;
  • WithSeconds:让时间格式支持秒,实际上内部调用了WithParser

cron还提供了另外两种选项:

  • WithLogger:自定义Logger
  • WithChain:Job 包装器。

WithLocationWithParserWithSeconds 这三个选项是与时间相关的设置,上面已经说了,下面说一说另外两个。

WithLogger

WithLogger可以设置cron内部使用我们自定义的Logger

上面调用cron.VerbosPrintfLogger()包装log.Logger,这个logger会详细记录cron内部的调度过程:

我们看看默认的Logger是什么样的:(以下是logger.go的源码)

WithChain

Job 包装器可以在执行实际的Job前后添加一些逻辑:

  • 捕获panic
  • 如果Job上次运行还未结束,推迟本次执行;
  • 如果Job上次运行还未介绍,跳过本次执行;
  • 记录每个Job的执行情况。

我们可以将Chain类比为 Web 处理器的中间件。实际上就是在Job的执行逻辑外在封装一层逻辑。我们的封装逻辑需要写成一个函数,传入一个Job类型,返回封装后的Jobcron为这种函数定义了一个类型JobWrapper:(以下是chain.go源码)

然后使用一个Chain对象将这些JobWrapper组合到一起:(以下是chain.go源码)

调用Chain对象的Then(job)方法应用这些JobWrapper,返回最终的`Job:(以下是chain.go源码)

注意应用JobWrapper的顺序。

内置JobWrapper

cron内置了 3 个用得比较多的JobWrapper

  • Recover:捕获内部Job产生的 panic;
  • DelayIfStillRunning:触发时,如果上一次任务还未执行完成(耗时太长),则等待上一次任务完成之后再执行;
  • SkipIfStillRunning:触发时,如果上一次任务还未完成,则跳过此次执行。

下面分别介绍。

Recover

先看看如何使用:

panicJob在第一次触发时,触发了panic。因为有cron.Recover()保护,后续任务还能执行:

我们看看cron.Recover()的实现,很简单:(以下是cron.go的源码)

就是在执行内层的Job逻辑前,添加recover()调用。如果Job.Run()执行过程中有panic。这里的recover()会捕获到,输出调用堆栈。

DelayIfStillRunning

还是先看如何使用:

上面我们在Run()中增加了一个 2s 的延迟,输出中间隔变为 2s,而不是定时的 1s:

看看源码:(以下是chain.go的源码)

首先定义一个该任务共用的互斥锁sync.Mutex,每次执行任务前获取锁,执行结束之后释放锁。所以在上一个任务结束前,下一个任务获取锁是无法成功的,从而保证的任务的串行执行。

SkipIfStillRunning

还是先看看如何使用:

输出:

注意观察时间,第一个与第二个输出之间相差 3s,因为跳过了两次执行。

注意DelayIfStillRunningSkipIfStillRunning是有本质上的区别的,前者DelayIfStillRunning只要时间足够长,所有的任务都会按部就班地完成,只是可能前一个任务耗时过长,导致后一个任务的执行时间推迟了一点。SkipIfStillRunning会跳过一些执行。

看看源码:(以下是源码)

定义一个该任务共用的缓存大小为 1 的通道chan struct{}。执行任务时,从通道中取值,如果成功,执行,否则跳过。执行完成之后再向通道中发送一个值,确保下一个任务能执行。初始发送一个值到通道中,保证第一个任务的执行。

其它API

参考

Go 每日一库之 cron
Go Cron 定时任务


文章 go 定时任务 cron 转载需要注明出处
喜欢 (0)

您必须 登录 才能发表评论!