定时任务(nodejs)
框架版本
服务框架@dfeidao/service
版本在4.6.201906031112
之后开始支持定时任务。
运维相关(如有定时任务,请开发组长或项目经理提醒运维注意jobs的配置,对应的运维文档)
如果启用多个nodejs服务实例,jobs有且只能有一个不配置,另外的需要配置为"jobs":[]
这种形式,如果只有一个服务实例,则一定不要配置该项
示例
在feidao.json
中配置定时任务
{
"jobs": [
{
"service": "s001",
"description": "示例任务",
"rule": "0 0 12 1 * *",
"start": "2019/06/03",
"end": "2025/12/31",
"data": {
"test": "feidao"
}
}
]
}
说明
service
服务名,应为某个js服务文件。
description
定时任务说明
rule
下面解释一下rule
的配置,一共分6个部分,每部分使用空格格开,星号为任意时间,不允许全部为星号。
第一位:秒,可选值为(0-59) 第二位:分钟,可选值(0-59) 第三位:几点,24小时制,可选值为(0-23) 第四位:几号,可选值为(1-31) 第五位:几月,可选值为(1-12) 第六位:星期几,可选值为(1-7),其中,1表示周一,2表示周二,3表示周三,4表示周四,5表示周五,6表示周六,7表示周日。
特殊情况:
- 多个值可以使用逗号
,
或减号-
格开。,
表示多个离散的枚举值,-
表示连续的值。如第6位2-4,7
表示周二,周三,周四,周日执行定时任务。 - 问号
?
只能用在第四位和第六位两个域。它也匹配域的任意值,但实际和*
有区别。因为第4和第6会相互影响。例如想在每月的20日触发调度,不管20日到底是星期几,则只能使用如下写法:13 13 15 20 * ?
, 其中最后一位只能用?
,而不能使用*
,如果使用*
表示不管星期几都会触发,实际上并不是这样。 #
用于确定每个月第几个星期几,只能出现在第四位。例如3#2
表示某月的第二个星期三。备注:目前这个经测试无效。- L 表示最后,只能出现在第4位和第6位,如果在第6位使用
4L
,意味着在最后的一个星期四触发。备注:目前该项还不支持。 - W 表示有效工作日(周一到周五),只能出现在第4位,系统将在离指定日期的最近的有效工作日触发事件。例如:在 第4位使用
5W
,如果5日是星期六,则将在最近的工作日:星期五,即4日触发。如果5日是星期天,则在6日(周一)触发;如果5日在星期一到星期五中的一天,则就在5日触发。另外一点,W的最近寻找不会跨过月份。备注:目前该项还不支持。
start
定时任务开始时间,可以为以下三种格式:
- 时间戳
- 日期字符串,使用
-
分隔。如2019-06-03
,推荐这一种。 - 日期字符串,使用
/
分隔。如2019/06/03
- 日期字符串,使用空格分隔。如
2019 06 03
- 完整的日期字符串,使用以上任意一种分隔符。如
2019 06 03 14:34:10.000
- 完整的日期字符串,使用以上任意一种分隔符。如
2019 06 03 14:37:32.000z
。注意,z
或Z
指中央经线时间,一般在我们的应用中不使用这种日期格式。
end
定时任务结束时间,格式请参考start
。
data
定时任务使用的固定数据,可以在定时任务的服务参数中获得。