GoFrame gcron-表达式
定时任务采用了类Linux Crontab
的表达格式,使得开发者能够快速理解掌握定时任务表达式技巧。但需要注意的是,由于定时任务模块是基于代码层面的控制,因此控制的粒度会更细,最小粒度到秒,格式被划分为了6段。而Linux Crontab
是基于程序层面的控制,最小粒度到分,格式被划分为了5段。
基本介绍
cron
表达式表示一组时间,使用6个空格分隔的字段。
Seconds Minutes Hours Day Month Week
即,秒,分,时,日,月,周
每个字段的含义如下:
Field name | Allowed values | Allowed special characters
---------- | -------------- | --------------------------
Seconds | 0-59 | * / , -
Minutes | 0-59 | * / , -
Hours | 0-23 | * / , -
Day | 1-31 | * / , - ?
Month | 1-12 or JAN-DEC | * / , -
Week | 0-6 or SUN-SAT | * / , - ?
注意:月份和星期几字段值不区分大小写。 SUN
、Sun
和sun
同样被接受。
特殊字符
星号(*)
星号表示cron
表达式将匹配所有的值。例如,在第五个字段(Month)中使用星号表示每个月。
斜线(/)
斜杠用于描述范围的增量。例如:第二个字段使用3-59/15表示每小时的第3分钟开始到第59分钟,每隔15分钟执行。
逗号(,)
逗号用于分隔列表的项目。例如,第五个字段使用MON,WED,FRI将指每周一,周三和周五执行。
连字符(-)
连字符用于定义范围。例如,第三个字段使用9-17表示每天上午9点至下午5点(含)。
问号(?)
可以使用问号而不是*
来让Day或Week字段为空。
预定义格式
您可以使用几个预定义的时间来代替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 * * * *
间隔
您还可以定义任务以固定的时间间隔执行,从添加时开始运行。这可以通过格式化cron
规范来支持,如下所示:
@every <duration>
其中duration
是time.ParseDuration
接受的字符串 (http://golang.org/pkg/time/#ParseDuration)。
例如,@every 1h30m10s将表示添加任务之后每隔1小时30分10秒执行。
注意:间隔不会考虑任务的执行时间。例如,如果一项工作需要3分钟才能执行完成,并且计划每隔5分钟运行一次,那么每次任务之间只有2分钟的空闲时间。
表达式示例
表达式示例
|
表达式说明
|
---|---|
|
每秒执行 |
2 * * * * *
|
每分钟的第2 秒执行 |
*/5 * * * * *
|
每5 秒执行一次 |
0 */30 * * * *
|
每30 分钟执行一次 |
0 0 2 * * *
|
每天凌晨2 点执行 |
0 */30 9-18 * * *
|
每天9 点到18 点,每隔30 分钟执行一次 |
0 0 9 * * MON,FRI
|
每周一 和周五 在9 点执行一次 |