Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Note

定时任务采用了类Linux Crontab的表达格式,使得开发者能够快速理解掌握定时任务表达式技巧。但需要注意的是,由于定时任务模块是基于代码层面的控制,因此控制的粒度会更细,最小粒度到,格式被划分为了6段。而Linux Crontab是基于程序层面的控制,最小粒度到,格式被划分为了5段。

基本介绍

cron表达式表示一组时间,使用6个空格分隔的字段。

Code Block
languagexml
Seconds Minutes Hours Day Month Week

秒 分 时  日 月 周

每个字段的含义如下:

Code Block
languagexml
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  | * / , - ?


Note

月份和星期字段值英文不区分大小写。 例如传递SUNSun 和sun同样被接受。

特殊字符

星号(*

星号表示cron表达式将匹配所有的值。例如,在第五个字段(Month)中使用星号表示每个月。

斜线(/

斜杠用于描述范围的增量。例如:第二个字段使用3-59/15表示每小时的第3分钟开始到第59分钟,每隔15分钟执行。

逗号(,

逗号用于分隔列表的项目。例如,第五个字段使用MON,WED,FRI将指每周一,周三和周五执行。

连字符(-

连字符用于定义范围。例如,第三个字段使用9-17表示每天上午9点至下午5点(含)。

忽略号(#

忽略号表示cron表达式将忽略这个字段的使用,目前仅秒字段支持该符号,用于将6cron pattern无缝转换为5linux crontab pattern

问号(?

可以使用问号而不是*来让DayWeek字段为空。

预定义格式

您可以使用几个预定义的时间来代替cron表达式。

Code Block
languagexml
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规范来支持,如下所示:

Code Block
languagexml
@every <duration>

其中durationtime.ParseDuration接受的字符串 (http://golang.org/pkg/time/#ParseDuration)。

例如,@every 1h30m10s将表示添加任务之后每隔1小时30分10秒执行。

Note

间隔不会考虑任务的执行开销时间。例如,如果一项工作需要3分钟才能执行完成,并且计划每隔5分钟运行一次,那么每次任务之间只有2分钟的空闲时间。

表达式示例

表达式示例表达式说明

* * * * * *

每秒执行

# * * * * *

每分钟执行,每一次执行至少间隔60
2 * * * * *每分钟的第2秒执行
*/5 * * * * *5秒执行一次
# */30 * * * *30分钟执行一次
# 0 2 * * *每天凌晨2点执行
# */30 9-18 * * *每天9点到18点,每隔30分钟执行一次
# 0 9 * * MON,FRI周一周五9点执行一次

注意事项🔥

所有开发语言级别6段式的cron pattern设计从实践上来说,由于底层定时器的不准确性,因此都是有一定的设计缺陷。由于cron pattern精确到秒级,当延迟达到了秒级,那么任务可能会存在丢失情况。而当golang引擎调度比较慢的时候,那么延迟很容易达到秒级引发程序逻辑问题。

考虑大部分的场景其实并不需要如此精准的定时任务粒度控制,因此从框架v2.7版本开始,我们对秒字段提供了忽略符号#,用于将6段式的cron pattern转换为5段式的linux crontab pattern,更加稳健。如果是秒级粒度的定时任务场景,请考虑使用gtimer定时器,但同时也需要注意,任何的定时器都是不准确的,不能完全依赖底层的系统时间。









Panel
titleContent Menu

Table of Contents