Node.js中基于node-schedule实现定时任务之详解

文章目录

一、定时任务

实际工作中，可能会遇到定时清除某个文件夹内容，定时发送消息或发送邮件给指定用户，定时导出某些数据等。借助setTimeout和setInterval来实现的化太过麻烦，node-schedule是一个非常不错的npm包，可以帮助我们快速的创建和管理定时任务。

定时任务是指在预定的时间点或时间间隔内执行的任务或操作。它们是自动化执行特定逻辑的一种方式，可用于执行重复性的、周期性的或计划性的任务。

定时任务通常用于以下情况：

数据管理与备份：定时任务可以用于定期备份数据库中的数据，确保数据的安全性和可靠性。此外，还可以用于多个数据源之间的数据同步，保证数据的一致性。
系统监控与维护：定时任务可以用于监控系统中的各种指标和状态，如服务器负载、数据库连接池的使用情况等，及时发现并解决潜在的问题。同时，也可以用于定期刷新缓存，保证缓存数据的及时性和准确性。
执行定时任务：定时器可以用于在预定的时间间隔内执行特定的任务或代码块，例如数据备份、日志清理、缓存刷新等操作。
定时提醒和通知：定时器可以用于实现定时提醒和通知功能，如闹钟、定时器应用等，通过设置定时器，在指定的时间点触发提醒或通知，帮助用户记住重要事件或完成特定任务。
自动保存和自动提交：定时器可以用于自动保存或自动提交表单数据，通过设置定时器，在一定的时间间隔内自动将用户输入的数据保存到服务器或数据库，避免数据丢失或用户忘记保存的情况。
定时刷新页面内容：定时器可以用于定时刷新页面的特定部分或整个页面，通过设置定时器，在一定的时间间隔内更新页面内容，如实时展示新闻、股票行情等。
会话管理与心跳检测：在Web应用中，定时器可以用来检查并清理长时间未活动的用户会话，以及客户端和服务端之间利用定时器发送心跳包来维持长连接，及时发现连接异常。
延迟执行与调度任务：定时器可以用于延迟发送消息或在非高峰时段执行批处理作业，减轻服务器负载。

二、node-schedule、

1、安装

复制代码

npm install node-schedule

2、引入

CommonJS：

复制代码

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

ES模块

复制代码

import schedule from 'node-schedule'

3、基于Cron表达式的规则

Cron表达式是一种用于指定定时任务执行时间的字符串表示形式。它由6个字段组成，每个字段表示任务执行的时间单位和范围。

复制代码

*    *    *    *    *    *
┬    ┬    ┬    ┬    ┬    ┬
│    │    │    │    │    │
│    │    │    │    │    └ 星期几(0 - 7) (0相对于周日) 
│    │    │    │    └───── 月 (1 - 12)
│    │    │    └────────── 日 (1 - 31)
│    │    └─────────────── 时 (0 - 23)
│    └──────────────────── 分 (0 - 59)
└───────────────────────── 秒 (0 - 59)

每个字段可以接受特定的数值、范围、通配符和特殊字符来指定任务的执行时间：

数值：表示具体的时间单位，如1、2、10等。
范围：使用-连接起始和结束的数值，表示一个范围内的所有值，如1-5表示1到5的所有数值。
通配符：使用表示匹配该字段的所有可能值，如表示每分钟、每小时、每天等。
逗号分隔：使用逗号分隔多个数值或范围，表示匹配其中任意一个值，如1,3表示1或3。
步长：使用/表示步长，用于指定间隔的数值，如*/5表示每隔5个单位执行一次。
特殊字符：Cron表达式还支持一些特殊字符来表示特定的含义，如?用于替代日和星期字段中的任意值，L表示最后一天，W表示最近的工作日等。

使用cron字符串作为rule时，建议写完整，可读性比较好。

以下是一些常见的Cron表达式示例：

复制代码

* * * * * *     ：每秒执行

*/5 * * * * *   ：每5秒执行

* 30 * * * *    ：每30分钟执行

*/10 30 * * * * ：每30分钟的10秒执行

2,4,6 * * * * * ：每个2秒，4秒和6秒执行

0 0 0 ? * 1     ：每周一早上的零点执行

* * * 20 * ?    ：每月的20日触发

4、基于Date的规则

当你需要在具体的时间执行一次,可以使用new Date来定义一个时间。

假设您非常希望在一个精确到某一个时间点上的秒数的仅触发一次的计划。

复制代码

const schedule = require('node-schedule');
//2024年，6月，1日，6时，1分，0秒
//month 范围是 0~11 而非1~12
const date = new Date(2024, 5, 1, 6, 1, 0);
const job = schedule.scheduleJob(date, ()=>{
  console.log('Happy Children's Day !');
});

5、基于RecurrenceRule的规则

如果你的任务是定时重复执行的，并且你希望有比cron更高的可读性，你可以尝试使用RecurrenceRule对象作为rule。

复制代码

function Recurrence(year, month, date, dayOfWeek, hour, minute, second, tz)

dayOfWeek 范围是 0~6

month 范围是 0~11 而非1~12

如果是连续的值，node-schedule提供了一个Range函数用于创建连续的元素

每分钟的15、30、45秒执行

const rule = new schedule.RecurrenceRule();
//每个15、30、45秒执行
rule.second = [15, 30, 45];
const job = schedule.scheduleJob(rule, () => {
console.log(每次计划执行的时间：${new Date().toLocaleString()});
});

每分钟的第10秒

rule.second = 10;

每小时的第10分钟

rule.minute = 10;
每周四，周五，周六，周天的17点

rule.dayOfWeek = [0, new schedule.Range(4, 6)];
rule.hour = 17;
rule.minute = 0;

6、API

开启定时任务

需要用到scheduleJob函数，会返回一个Job实例对象：

复制代码

function scheduleJob(name: string, rule: ..., callback: function): schedule.Job

参数

参数名	参数类型	参数描述
name		任务名，当你没有指定时，它将以时间戳作为名字。
rule		任务调度的规则，支持多种形式的rule： string - Cron表达式 number schedule.RecurrenceRule Date
callback		创建任务时的回调函数

可以通过scheduleJob(name, rule, callback)或者scheduleJob(rule, callback)创建计划。

复制代码

const rule = '* * * * * *';
const job = schedule.scheduleJob(rule,()=>{});

取消定时任务

schedule.cancelJob(id)

7、状态监听

复制代码

import schedule from 'node-schedule';

//设置规则
const rule = "*/10 * * * * *"

//设置任务
const job = schedule.scheduleJob(rule, () => {
    console.log('2、每次计划执行中的事件。');
});


job.on("scheduled", () => {
    console.log("1、每次计划执行前的事件。");
});


job.on("run", () => {
    console.log("3、每次计划执行后的事件。");
});


job.on("success", () => {
    console.log(`4、每次计划执行成功事件。`);
});


job.on("error", (err) => {
    console.log(`[error][${new Date().toLocaleString()}]${err.message}`);
});


job.on("canceled", () => {
    console.log("计划取消!");
})