Nodejs定時任務(node-schedule)
阿新 • • 發佈:2020-09-17
在實際開發專案中,會遇到很多定時任務的工作。比如:定時匯出某些資料、定時傳送訊息或郵件給使用者、定時備份什麼型別的檔案等等
一般可以寫個定時器,來完成相應的需求,在node.js
中自已實現也非常容易,接下來要介紹的是node-schedule
來完成定時任務
下面就用示例來說明一下node-schedule
的用法。
一、安裝
npm install node-schedule --save
或者yarn add node-schedule
二、用法
1、cron風格定時器
const schedule = require('node-schedule'); const scheduleCronstyle = ()=>{ //每分鐘的第30秒定時執行一次: schedule.scheduleJob('30 * * * * *',()=>{ console.log('scheduleCronstyle:' + new Date()); }); } scheduleCronstyle();
schedule.scheduleJob的回撥函式中寫入要執行的任務程式碼,一個定時器就完成了!
規則引數講解:*代表萬用字元
* * * * * * ┬ ┬ ┬ ┬ ┬ ┬ │ │ │ │ │ | │ │ │ │ │ └ 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'
每個引數還可以傳入數值範圍
const task1 = ()=>{ //每分鐘的1-10秒都會觸發,其它萬用字元依次類推 schedule.scheduleJob('1-10 * * * * *', ()=>{ console.log('scheduleCronstyle:'+ new Date()); }) } task1()
2、物件文字語法風格定時器
const schedule = require('node-schedule'); function scheduleObjectLiteralSyntax(){ //dayOfWeek //month //dayOfMonth //hour //minute //second //每週一的下午16:11分觸發,其它組合可以根據我程式碼中的註釋引數名自由組合 schedule.scheduleJob({hour: 16, minute: 11, dayOfWeek: 1}, function(){ console.log('scheduleObjectLiteralSyntax:' + new Date()); }); } scheduleObjectLiteralSyntax();
推薦使用該風格,比較容易理解
3、取消定時器
呼叫定時器物件的 cancel 方法即可
const schedule = require('node-schedule'); function scheduleCancel(){ var counter = 1; const j = schedule.scheduleJob('* * * * * *', function(){ console.log('定時器觸發次數:' + counter); counter++; }); setTimeout(function() { console.log('定時器取消') // 定時器取消 j.cancel(); }, 5000); } scheduleCancel();
定時器功能大部分需求都可以藉助node-schedule完成了,用它在專案中使用效果也不錯,各種需求可以滿足。