在實際開發項目中,會遇到很多定時任務的工作。比如:定時導出某些數據、定時發送消息或郵件給用戶、定時備份什麼類型的文件等等 一般可以寫個定時器,來完成相應的需求,在node.js中自已實現也非常容易,接下來要介紹的是node-schedule來完成定時任務 下麵就用示例來說明一下node-schedu
目錄
寫在之前
在實際開發項目中,會遇到很多定時任務的工作。比如:定時導出某些數據、定時發送消息或郵件給用戶、定時備份什麼類型的文件等等
一般可以寫個定時器,來完成相應的需求,在node.js中自已實現也非常容易,接下來要介紹的是node-schedule來完成定時任務
下麵就用示例來說明一下node-schedule的用法。
node-schedule:https://github.com/node-schedule/node-schedule
安裝:
npm install node-schedule
Cron風格定時器
var schedule = require('node-schedule'); function scheduleCronstyle(){ schedule.scheduleJob('30 * * * * *', function(){ console.log('scheduleCronstyle:' + new Date()); }); } scheduleCronstyle();
schedule.scheduleJob的回調函數中寫入要執行的任務代碼,一個定時器就完成了!
下麵我們再來講講Cron風格定時器傳入的參數具體代表什麼,先來看看上面執行結果,如下圖
從輸出結果可以看出,傳入的'30 * * * * *'帶來的結果是每分鐘的30秒時都會執行,下麵來看看這個傳入參數分別代碼什麼
* * * * * *
┬ ┬ ┬ ┬ ┬ ┬
│ │ │ │ │ |
│ │ │ │ │ └ 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'
這樣很容易根據自已的需求用簡短的代碼去實現。
上面的傳入參數占位符中還可以傳入範圍,比如下麵示例
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秒時就會觸發,其它規則可以看我註釋中的代碼,當然,也可以組合使用,達到需求效果!
對象文本語法定時器
直接看使用示例
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分觸發,其它組合可以根據我代碼中的註釋參數名自由組合
取消定時器
示例如下,定時器對象的cancl方法即可
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();
結果如下:
寫在之後
定時器功能大部分需求都可以藉助node-schedule完成了,用它在項目中使用效果也不錯,各種需求可以滿足^_^!