很多时候我们的项目需要一个定时任务, 让程序定时去做一些事情, egg.js框架为我们提供了一套机制来让定时任务的编写和维护更加优雅, 下面我们就写一个小例子来看看egg.js怎么实现一个定时任务功能
编写一个定时任务
在egg.js中, 所有的定时任务都统一放在app/schedule目录下, 在这个目录下创建的每个文件都是一个定时任务, 说白了就是你只要在这里创建一个文件, egg.js框架就会把它当做一个定时任务去执行
创建/app/schedule/log.js
module.exports = {
schedule: {
interval: '10s', // 任务的间隔时间, 这个定义的10秒执行一次
type: 'all', // 指定所有的 worker都需要执行
},
async task(ctx) {
// 这里编写我们要执行的任务代码, 我们这里就打印一下当前时间的试试
console.log("任务执行 : "+ new Date().toString());
},
};
就这就可以了？ 对, 就这就可以了, 就是这么简单
运行项目, 这个时候每隔10秒钟就会打印一条日志
任务执行 : Sat Aug 03 2019 10:31:52 GMT+0800 (GMT+08:00)
任务执行 : Sat Aug 03 2019 10:32:02 GMT+0800 (GMT+08:00)
任务执行 : Sat Aug 03 2019 10:32:12 GMT+0800 (GMT+08:00)
定时任务的方式
定时任务的方式有两种, 分别是interval和cron, 上面我们的例子使用的是interval的定时方式
- interval
这种定时方式定时任务会间隔指定时间去执行一次
interval的值有两种类型, 一种是数字类型, 单位是毫秒, 比如1000, 就代表每隔1000毫秒执行一次定时任务, 另外一种是字符类型, 例如'5s'就代表每隔5秒, '3m'就代表每隔3分钟执行一次定时任务 - cron
定时任务会按照cron表达式在特定时间点执行
* * * * * *
┬ ┬ ┬ ┬ ┬ ┬
│ │ │ │ │ |
│ │ │ │ │ └ 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)
cron: '0 0 */3 * * *', 意思就是每隔3个小时执行一次
类型
框架提供的定时任务默认支持两种类型，worker 和 all
worker类型：每台机器上只有一个worker 会执行这个定时任务，每次执行定时任务的 worker 的选择是随机的
all类型：每台机器上的每个worker 都会执行这个定时任务
执行日志
执行日志会输出到 ${appInfo.root}/logs/{app_name}/egg-schedule.log，默认不会输出到控制台
