学习node应用中node-schedule定时任务

1. 前言

在实际开发项目中,会遇到很多定时任务的工作。比如:定时导出某些数据、定时发送消息或邮件给用户、定时备份什么类型的文件等等

一般可以写个定时器,来完成相应的需求,在node.js中自已实现也非常容易,接下来要介绍的是node-schedule来完成定时任务

下面就用示例来说明一下node-schedule的用法。

安装:

npm install node-schedule
2019010801.png

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的任务库

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,163评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,301评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,089评论 0 352
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,093评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,110评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,079评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,005评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,840评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,278评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,497评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,394评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,980评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,628评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,649评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,548评论 2 352

推荐阅读更多精彩内容

  • 在实际开发项目中,会遇到很多定时任务的工作。比如:定时导出某些数据、定时发送消息或邮件给用户、定时备份什么类型的文...
    流川枫丶阅读 7,184评论 2 4
  • 在实际开发项目中,会遇到很多定时任务的工作。比如:定时导出某些数据、定时发送消息或邮件给用户、定时备份什么类型的文...
    四月天__阅读 99,257评论 4 34
  • 在大规模分布式系统中,每个业务都可能是集群,每个业务机都会产生定时任务,不同的业务会有不同的任务管理需求,统一的任...
    流星狂飙阅读 2,550评论 0 8
  • 用到了这个工具,顺便翻译一下,便于查看github看的舒服一点:https://github.com/ZZES-Z...
    ZZES_ZCDC阅读 4,403评论 0 3
  • 一点知识 在JAVA开发领域,目前可以通过以下几种方式进行定时任务: Timer:jdk中自带的一个定时调度类,可...
    雅倩兰爸爸阅读 3,839评论 1 28