nodejs的定时任务模块(node-schedule)

node-schedule模块介绍

定时触发某个任务，去完成类似导出数据,定时发送消息等.

安装

npm i node-schedule

Cron风格定时器

var schedule = require('node-schedule');

function scheduleCronstyle(){
    schedule.scheduleJob('30 * * * * *', function(){
        console.log('scheduleCronstyle:' + new Date());
    }); 
}

scheduleCronstyle();

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)

RecurrenceRule实例规则定时器

比如你需要传递一个参数，在每5或者10分钟执行一次，那么就可以这样来处理。

const schedule=require('node-schedule');
const esDb=require('./terminusEs');
function getRuleTimes(period){
    const times=[];
    for (let i = 0; i < 60; i=i+period) {
        times.push(i);
    }
    return times;
}

async function writeEsTask(period){
    //每period周期执行一次
    const rule=new schedule.RecurrenceRule();
    const times=getRuleTimes(period);
    rule.minute=times;
    // rule.second=times;
    schedule.scheduleJob(rule,async function(){
        await esDb.writeDataToEs();
    })
}

module.exports={
    writeEsTask,getRuleTimes
}

RecurrenceRule实例属性：

second
minute
hour
data
month
year
dayOfWeek

实力属性中未显示设置的属性值将默认为null（除了second属性默认为0）

取消定时器

var schedule = require('node-schedule');

function scheduleCancel(){
    var counter = 1;
    var j = schedule.scheduleJob('* * * * * *', function(){
        console.log('定时器触发次数：' + counter);
        counter++;
    });

    setTimeout(function() {
        console.log('定时器取消')
        j.cancel();   
    }, 5000);
}
scheduleCancel();

原理

定时任务是利用setTimeOut和event事件进行管理的，对所有加入的时间进行排序，并且计算当前时间和最近一个时间发生时间的时间间隔，然后调用setTimeOut设置回调。总的来说分两种时间，一种是一次性的，一种是周期性的，一次性任务调用完就结束，周期性的会不断循环调用，当一个周期性事件被调用后，会根据周期生成下一个周期任务，并添加到任务列表中，重新排序。每个任务调用结束，都会计算并准备下一个任务。

注意

在循环任务中，每个任务需要单独new Schedule.RecurrenceRule对象，不能公用。如果我们对循环中的时间成员木有设置，源码中，未设置的时间成员为null,循环结构的匹配采用是从分钟开始的逐步累加，如果发现某成员是null，那么就直接匹配，如果不是null，就从0开始，逐渐累加，直到完全匹配。

git地址:
https://github.com/node-schedule/node-schedule