NodeJs之定時器與隊列

一,介紹與需求

 1.1,介紹

定時任務（node-schedule)，是針對Node.js的一種靈活的cron-like和not-cron-like作業調度程序。它允許您使用可選的遞歸規則將作業(任意函數)安排在特定日期執行。它在任何給定的時間只使用一個計時器(而不是每秒鍾/分鍾重新評估即將到來的作業)。

Async是一個實用模塊，它為異步JavaScript提供了直接、強大的功能。async流程控制器--queue(隊列),queue流程控制器是一個並行的流程控制器,但是它與parallel的區別在於queue可以控制一次執行幾個函數,而parallel只是讓所有函數並行執行.

 1.2,需求

實際開發項目中，會遇到很多定時任務的工作。比如：定時導出某些數據、定時發送消息或郵件給用戶、定時備份什么類型的文件等等。在當時給用戶發送消息時,可能要發送的用戶就不只有一兩個,二是多個,這是可能就會用到隊列順序執行。

二,定時器

第一步:安裝node-schedule

npm install node-schedule --save

第二步:封裝定時器模塊

const schedule = require('node-schedule');//定時器
const nodeTimer = {};
let cancelTimer = ''
/**
     *Cron風格定時器/對象文本語法定時器
     * @param executionTime ：定時器字符串'30 * * * * *'/定時器對象{hour: 16, minute: 11, dayOfWeek: 1}
     * @param callback ：回調函數
   */
nodeTimer.scheduleTimer = (executionTime = '30 * * * * *', callback) => {
    // 每分鍾的第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'
    
    cancelTimer = schedule.scheduleJob(executionTime, () => {
        if (typeof callback === 'function') {
            callback()
        }
    });

}
module.exports = nodeTimer;

第三步:調用

在回調函數中寫入要執行的任務代碼，一個定時器就完成了！

引入定時器模塊：

const nodeTimer = require('./node_timer.js');

1,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)

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'
// 每分鍾的1-10秒都會觸發，其它通配符依次類推 ：'1-10 * * * * *'

調用定時器：

nodeTimer.scheduleTimer('30 * * * * *',function(err){
        if(!err){
            console.log('scheduleTimer:' + new Date());
        }
 });

效果：

2、對象文本語法定時器

• • • second (0-59)
    • minute (0-59)
    • hour (0-23)
    • date (1-31)
    • month (0-11)
    • year
    • dayOfWeek (0-6) Starting with Sunday

 //每周一的下午15：03：30觸發，其它組合可以根據我代碼中的注釋參數名自由組合
nodeTimer.scheduleTimer({hour: 15, minute: 3, second: 30},function(err){
        if(!err){
            console.log('scheduleTimer:' + new Date());
        }
    });

效果:

3、基於日期的定時器

var date = new Date(2019, 01, 07, 15, 03, 30);
nodeTimer.scheduleTimer(date,function(err){
        if(!err){
            console.log('scheduleTimer:' + new Date());
        }
  });

4、遞歸規則定時器

參數與對象文本語法定時器的參數類似

var rule = new schedule.RecurrenceRule();
rule.dayOfWeek = [0, new schedule.Range(4, 6)];//每周四，周五，周六執行
rule.hour = 15;
rule.minute = 0;
nodeTimer.scheduleTimer(rule,function(err){
        if(!err){
            console.log('scheduleTimer:' + new Date());
        }
 });

5、取消定時器

// 取消定時器
// 調用 定時器對象的cancl()方法即可
nodeTimer.scheduleCancel = () => {
    // 定時器取消
    cancelTimer.cancel();
    console.log('定時器成功取消');
}

調用：

nodeTimer.scheduleCancel()

效果：

三,隊列

第一步：安裝async

npm install --save async

第二步：封裝方法

queue相當於一個加強版的parallel，主要是限制了worker數量，不再一次性全部執行。當worker數量不夠用時，新加入的任務將會排隊等候，直到有新的worker可用。

該函數有多個點可供回調，如worker用完時、無等候任務時、全部執行完時等。

const async = require('async');
 /**
      *隊列
      * @param obj ：obj對象 包含執行時間
      * @param callback ：回調函數
    */
const nodeQueue = async.queue(function (obj, callback) {
    setTimeout(function () {
        // 需要執行的代碼的回調函數
        if(typeof callback==='function'){
            callback();
        }
    }, obj.time)
}, 1)

// worker數量將用完時，會調用saturated函數
nodeQueue.saturated = function() { 
    console.log('all workers to be used'); 
}
 
// 當最后一個任務交給worker執行時，會調用empty函數
nodeQueue.empty = function() { 
    console.log('no more tasks wating'); 
}
 
// 當所有任務都執行完時，會調用drain函數
nodeQueue.drain = function() { 
    console.log('all tasks have been processed'); 
}
module.exports = nodeQueue;

第三步：調用方法

 const nodeQueue = require('./node_queue.js');
    for (let i = 0; i < 10; i++) {
        nodeQueue.push({ name: 1, time: 2000 }, function (err) {
            console.log('隊列執行錯誤信息==',err);
            if(!err){
                // 需要執行的代碼或函數
                console.log('需要執行的代碼或函數第',i+1,'個')
            }
        })
    };

效果：