1. 前言
在实际开发项目中,会遇到很多定时任务的工作。比如:定时导出某些数据、定时发送消息或邮件给用户、定时备份什么类型的文件等等
一般可以写个定时器,来完成相应的需求,在node.js中自已实现也非常容易,接下来要介绍的是node-schedule来完成定时任务
下面就用示例来说明一下node-schedule的用法。
安装:
npm install node-schedule
2. Cron风格定时器
const schedule = require('node-schedule');
function scheduleCronstyle(){
schedule.scheduleJob('30 * * * * *', function(){
console.log('scheduleCronstyle:' + new Date());
});
}
scheduleCronstyle();
schedule.scheduleJob的回调函数中写入要执行的任务代码,一个定时器就完成了!
下面我们再来讲讲Cron风格定时器传入的参数具体代表什么,先来看看上面执行结果,如下
➜ node-schedule-learning node index.js
scheduleCronstyle:Tue Jan 08 2019 17:13:30 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:14:30 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:15:30 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:16:30 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:17:30 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:18:30 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:19:30 GMT+0800 (CST)
从输出结果可以看出,传入的'30 * * * * *'带来的结果是每分钟的30秒时都会执行,下面来看看这个传入参数分别代码什么
2.1 通配符解释
* * * * * *
┬ ┬ ┬ ┬ ┬ ┬
│ │ │ │ │ |
│ │ │ │ │ └ day of week (0 - 7) (0 or 7 is Sun)
│ │ │ │ └───── month (1 - 12)
│ │ │ └────────── day of month (1 - 31)
│ │ └─────────────── hour (0 - 23)
│ └──────────────────── minute (0 - 59)
└───────────────────────── second (0 - 59, OPTIONAL)
6个占位符从左到右分别代表:秒、分、时、日、月、周几
''表示通配符,匹配任意,当秒是''时,表示任意秒数都触发,其它类推
下面可以看看以下传入参数分别代表的意思
每分钟的第30秒触发: '30 * * * * *'
每小时的1分30秒触发 :'30 1 * * * *'
每天的凌晨1点1分30秒触发 :'30 1 1 * * *'
每月的1日1点1分30秒触发 :'30 1 1 1 * *'
2016年的1月1日1点1分30秒触发 :'30 1 1 1 2016 *'
每周1的1点1分30秒触发 :'30 1 1 * * 1'
2.2 Cron风格定时器-范围触发
上面的传入参数占位符中还可以传入范围,比如下面示例
const schedule = require('node-schedule');
function scheduleCronstyle(){
schedule.scheduleJob('1-10 * * * * *', function(){
console.log('scheduleCronstyle:' + new Date());
});
}
scheduleCronstyle();
结果如下:
scheduleCronstyle:Tue Jan 08 2019 17:41:01 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:41:02 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:41:03 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:41:04 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:41:05 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:41:06 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:41:07 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:41:08 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:41:09 GMT+0800 (CST)
scheduleCronstyle:Tue Jan 08 2019 17:41:10 GMT+0800 (CST)
从输出结果可以看出每分钟的1-10秒都会触发,
其它占用符使用方法一样,输入范围可以看到参考前面"通配符解释"
3. 递归规则定时器
再看看另一种风格写定时器
const schedule = require('node-schedule');
function scheduleRecurrenceRule(){
let rule = new schedule.RecurrenceRule();
// rule.dayOfWeek = 2;
// rule.month = 3;
// rule.dayOfMonth = 1;
// rule.hour = 1;
// rule.minute = 42;
rule.second = 0;
schedule.scheduleJob(rule, function(){
console.log('scheduleRecurrenceRule:' + new Date());
});
}
scheduleRecurrenceRule();
结果如下:
scheduleRecurrenceRule:Tue Jan 08 2019 17:45:00 GMT+0800 (CST)
scheduleRecurrenceRule:Tue Jan 08 2019 17:46:00 GMT+0800 (CST)
scheduleRecurrenceRule:Tue Jan 08 2019 17:47:00 GMT+0800 (CST)
scheduleRecurrenceRule:Tue Jan 08 2019 17:48:00 GMT+0800 (CST)
scheduleRecurrenceRule:Tue Jan 08 2019 17:49:00 GMT+0800 (CST)
从结果中可以看出,每分钟第60秒时就会触发,其它规则可以看我注释中的代码,当然,也可以组合使用,达到需求效果!
4. 对象文本语法定时器
直接看使用示例
const schedule = require('node-schedule');
function scheduleObjectLiteralSyntax(){
//dayOfWeek
//month
//dayOfMonth
//hour
//minute
//second
schedule.scheduleJob({hour: 17, minute: 59, dayOfWeek: 2}, function(){
console.log('scheduleObjectLiteralSyntax:' + new Date());
});
}
scheduleObjectLiteralSyntax();
结果如下:
scheduleObjectLiteralSyntax:Tue Jan 08 2019 17:59:00 GMT+0800 (CST)
代码实现的是每周二的下午17:59分触发,其它组合可以根据我代码中的注释参数名自由组合
5. 取消定时器
示例如下,定时器对象的cancl方法即可
const schedule = require('node-schedule');
function scheduleCancel(){
let counter = 1;
const j = schedule.scheduleJob('* * * * * *', function(){
console.log('定时器触发次数:' + counter);
counter++;
});
setTimeout(function() {
console.log('定时器取消')
j.cancel();
}, 5000);
}
scheduleCancel();
结果如下:
定时器触发次数:1
定时器触发次数:2
定时器触发次数:3
定时器触发次数:4
定时器触发次数:5
定时器取消
6. nest-schedule
nest-schedule是一个基于node-schedule实现的用于nest.js的任务库