Nodejs ·

nodejs之定时任务

定时任务的作用是在一定时间间隔或到某个时间点执行一次任务,避免人手工操作,比如redis和本地数据库同步任务,定时备份数据库任务等。在nodejs中有一个模块node-schedule专门用来处理定时任务,其原理有点类似于setTimeout和setInterval,但是使用起来更加的方便。
用模块首先要做的就是安装

npm install node-schedule -S

安装完毕后我们在项目中新建一个目录,或者是直接在routes目录下直接新建一个文件:myTask.js(这里的项目结构以express项目为基准)。
在myTask中可以直接写代码了,先来看一个简单的例子

Cron风格定时器

var schedule = require('node-schedule');
function scheduleCronstyle(){
    schedule.scheduleJob('10 * * * * *', function(){
        console.log('scheduleCronstyle:' + new Date());
    }); 
}
scheduleCronstyle();

然后在app.js中引入一下即可

var myTask= require('./routes/myTask');

启动执行后效果如下图
nodejs之定时任务
从输出结果可以看出,传入的'10 * * * * *'带来的结果是每分钟的第10秒时都会执行,下面来看看这个传入参数分别代码什么
nodejs之定时任务
6个占位符从左到右分别代表:秒、分、时、日、月、周几

'*'表示通配符,匹配任意,当秒是'*'时,表示任意秒数都触发,其它类推

下面可以看看以下传入参数分别代表的意思

每分钟的第30秒触发: '30 * * * * *'
每小时的1分30秒触发 :'30 1 * * * *'
每天的凌晨1点1分30秒触发 :'30 1 1 * * *'
每月的1日1点1分30秒触发 :'30 1 1 1 * *'
每周1的1点1分30秒触发 :'30 1 1 * * 1'

上面的传入参数占位符中还可以传入范围,比如下面示例

var schedule = require('node-schedule');
function scheduleCronstyle(){
    schedule.scheduleJob('1-10 * * * * *', function(){
        console.log('scheduleCronstyle:' + new Date());
    });
}
scheduleCronstyle();

结果如下图:
占位符表示效果

从输出结果可以看出每分钟的1-10秒都会触发,
其它占用符使用方法一样,输入范围可以看到参考前面"通配符解释"

递归规则定时器

再看看另一种风格写定时器

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

function scheduleRecurrenceRule(){

    var 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();

该段代码执行结果为:每分钟第60秒时就会触发,其它规则可以看我注释中的代码,当然,也可以组合使用,达到需求效果!

如果你想实现每5秒执行一次,则可以将规则定义为如下方式

rule.second = [1, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55];//5秒

给second赋值为一个数组,附上需要执行的时间即可。当然也可以不完全按照5秒的间隔执行。

另外还可以用传入对象的方式来定义规则

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

function scheduleObjectLiteralSyntax(){

    //dayOfWeek
    //month
    //dayOfMonth
    //hour
    //minute
    //second

    schedule.scheduleJob({hour: 16, minute: 11, dayOfWeek: 1}, function(){
        console.log('scheduleObjectLiteralSyntax:' + new Date());
    });
}

scheduleObjectLiteralSyntax();

代码实现的是每周一的下午16:11分触发,其它组合可以根据我代码中的注释参数名自由组合

取消定时器

定时器不一定是要一直执行,需要到一定程度后进行取消,或者是通过调用接口来进行取消操作。

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();

参与评论