昔洛 的个人博客

Bug不空,誓不成佛

  menu
70 文章
14633 浏览
3 当前访客
ღゝ◡╹)ノ❤️

node-cron 定时任务

为什么使用 node-cron

在一些项目场景中,一些逻辑功能常常需要使用到定时器是完成某些时刻的定时任务,简单的功能基本上可以依靠 setTimeout 与 setInterval 去设置延迟的时间完成,但是复杂的定时任务依靠简单的计时器一般很难满足需求,并且通过 setTimeout 这些原生方法去创建的定时任务也很不方便去做到管理。为此,当有多个复杂逻辑任务功能时,并且希望能将其封装化而方便管理,那么就不妨使用 node-cron 去创建定时任务。

node-cron

npm i cron 或 npm install 安装
let cron = require('cron') 引入

API

  • job: new cron.CronJob() 新建一个任务
  • time:new cron.CronTime() 创建cron时间
  • sendAt: 计算下一次发送的时间
  • timeout: 计算下一次超时的时间
  • CronJob
    • constructor(cronTime, onTick, onComplete, start, timezone, context, runOnInit, unrefTimeout) 构造方法
      • cronTime 必填,何时执行任务,cron表达式的时间也可以是 js Date 对象时间
      • onTick 必填,要执行的任务方法
      • onComplete,选填,任务完成时的回调,如果设置改参数那么将其将作为 onTick 的参数,其会在 CronJob.stop 方法调用后自动执行
      • start 选填,默认值为 false,表示是否构造完毕后立即开始计时作业,如果为false,需调用 start 方法开启定时任务。更加方便对任务的调度控制
      • timezone 选填,用于设置指定的时区,如果时区无效将直接抛出错误,默认为当前所在时区
      • context 选填,初始化上下文
      • runOnInit 选填,是否在初始化完毕立即运行一次任务,默认 false
    • start 开始定时任务
    • stop 结束定时任务
    • setTime 停止并重新设置定时任务,参数必须为 cronTime
    • lastDate 最后执行的时间日期
    • nextDates 提供下一次onTick 执
    • fireOnTick 覆盖任务执行函数,有必要时再使用
    • addCallback 允许添加更多的回调任务,后添加的先执行
  • CronTime
    • constructor(time) cronTime 时间对象,参数可以使 cron 格式也可以是 js Date

Example

  • 在十分时执行任务

    const job = new CronJob('* 10 * * * *', function() {
    	const d = new Date();
    	console.log('At Ten Minutes:', d);
    });
    
  • 每十分钟执行一次

    const job = new CronJob('0 */10 * * * *', function() {
    	const d = new Date();
    	console.log('Every Tenth Minute:', d);
    });
    
  • 每星期一到星期五上午11点30分执行任务

    const job = new CronJob('00 30 11 * * 1-5', function() {
    	const d = new Date();
    	console.log('onTick', d);
    });
    

cron 表达式

以下转载自https://www.cnblogs.com/dwxt/p/10299283.html

结构

cron 表达式是一串字符串,以5个或6个空格隔开字符,表示6个或7个域

  1. Seconds Minutes Hours DayofMonth Month DayofWeek
  2. Seconds Minutes Hours DayofMonth Month DayofWeek Year
    分别表示 秒 分 时 月份中的日期 月数 星期中的日期 年份

各字段含义

字段允许值允许的特殊字符
秒(Seconds)0~59的整数, - * / 四个字符
分(Minutes0~59的整数, - * / 四个字符
小时(Hours0~23的整数, - * / 四个字符
日期(DayofMonth1~31的整数(但是你需要考虑你月的天数),- * ? / L W C 八个字符
月份(Month1~12的整数或者 JAN-DEC, - * / 四个字符
星期(DayofWeek1~7的整数或者 SUN-SAT (1=SUN), - * ? / L C # 八个字符
年(可选,留空)(Year1970~2099, - * / 四个字符

注意事项:

  每一个域都使用数字,但还可以出现如下特殊字符,它们的含义是:

  (1):表示匹配该域的任意值。假如在Minutes域使用, 即表示每分钟都会触发事件。

  (2)?:只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值,但实际不会。因为DayofMonth和DayofWeek会相互影响。例如想在每月的20日触发调度,不管20日到底是星期几,则只能使用如下写法: 13 13 15 20 * ?, 其中最后一位只能用?,而不能使用*,如果使用*表示不管星期几都会触发,实际上并不是这样。

  (3)-:表示范围。例如在Minutes域使用5-20,表示从5分到20分钟每分钟触发一次

  (4)/:表示起始时间开始触发,然后每隔固定时间触发一次。例如在Minutes域使用5/20,则意味着5分钟触发一次,而25,45等分别触发一次.

  (5),:表示列出枚举值。例如:在Minutes域使用5,20,则意味着在5和20分每分钟触发一次。

  (6)L:表示最后,只能出现在DayofWeek和DayofMonth域。如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。

  (7)W:表示有效工作日(周一到周五),只能出现在DayofMonth域,系统将在离指定日期的最近的有效工作日触发事件。例如:在 DayofMonth使用5W,如果5日是星期六,则将在最近的工作日:星期五,即4日触发。如果5日是星期天,则在6日(周一)触发;如果5日在星期一到星期五中的一天,则就在5日触发。另外一点,W的最近寻找不会跨过月份 。

  (8)LW:这两个字符可以连用,表示在某个月最后一个工作日,即最后一个星期五。

  (9)#:用于确定每个月第几个星期几,只能出现在DayofMonth域。例如在4#2,表示某月的第二个星期三。

常用表达式

(1)**0 0 2 1 * ? *** 表示在每月的1日的凌晨2点调整任务

(2)**0 15 10 ? * MON-FRI ** 表示周一到周五每天上午10:15执行作业

(3)0 15 10 ? 6L 2002-2006 表示2002-2006年的每个月的最后一个星期五上午10:15执行作

(4)0 0 10,14,16 * * ? 每天上午10点,下午2点,4点

(5)0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时

(6)0 0 12 ? * WED 表示每个星期三中午12点

(7)0 0 12 * * ? 每天中午12点触发

(8)**0 15 10 ? * * ** 每天上午10:15触发

(9)0 15 10 * * ? 每天上午10:15触发

(10)**0 15 10 * * ? * ** 每天上午10:15触发

(11)0 15 10 * * ? 2005 2005年的每天上午10:15触发

(12)0 * 14 * * ? 在每天下午2点到下午2:59期间的每1分钟触发

(13)0 0/5 14 * * ? 在每天下午2点到下午2:55期间的每5分钟触发

(14)0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发

(15)**0 0-5 14 * * ? ** 在每天下午2点到下午2:05期间的每1分钟触发

(16)0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44触发

(17)**0 15 10 ? * MON-FRI ** 周一至周五的上午10:15触发

(18)**0 15 10 15 * ? ** 每月15日上午10:15触发

(19)**0 15 10 L * ? ** 每月最后一日的上午10:15触发

(20)**0 15 10 ? * 6L ** 每月的最后一个星期五上午10:15触发

(21)0 15 10 ? * 6L 2002-2005 2002年至2005年的每月的最后一个星期五上午10:15触发

(22)0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发

注:
有些子表达式能包含一些范围或列表

  例如:子表达式(天(星期))可以为 “MON-FRI”,“MON,WED,FRI”,“MON-WED,SAT”

“*”字符代表所有可能的值

  因此,“”在子表达式(月)里表示每个月的含义,“”在子表达式(天(星期))表示星期的每一天

  “/”字符用来指定数值的增量
  例如:在子表达式(分钟)里的“0/15”表示从第0分钟开始,每15分钟
在子表达式(分钟)里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义一样

  “?”字符仅被用于天(月)和天(星期)两个子表达式,表示不指定值
  当2个子表达式其中之一被指定了值以后,为了避免冲突,需要将另一个子表达式的值设为“?”

  “L” 字符仅被用于天(月)和天(星期)两个子表达式,它是单词“last”的缩写
  但是它在两个子表达式里的含义是不同的。
  在天(月)子表达式中,“L”表示一个月的最后一天
  在天(星期)自表达式中,“L”表示一个星期的最后一天,也就是SAT

  如果在“L”前有具体的内容,它就具有其他的含义了

  例如:“6L”表示这个月的倒数第6天,“FRIL”表示这个月的最一个星期五
  注意:在使用“L”参数时,不要指定列表或范围,因为这会导致问题

内事不懂问百度,外事不懂问谷歌~