Node.js 中使用 node-cron 进行定时任务的教程-JavaScript中文网-JavaScript教程资源分享门户

在开发 Web 应用程序时，经常需要执行一些定时任务，例如生成数据报告、定时发送电子邮件、清理缓存等等。Node.js 是一个开源的服务端 JavaScript 运行环境，可以用来编写高效的 Web 应用程序和服务器端脚本。在 Node.js 中，我们可以使用 node-cron 模块来轻松实现定时任务。

安装 node-cron 模块

在使用 node-cron 模块前，需要先安装它。在命令行中执行以下命令：

npm install node-cron

使用 node-cron 实现定时任务

接下来我们来看一个简单的例子，使用 node-cron 模块实现每天凌晨 3 点执行一次任务的功能。首先，我们需要引入 node-cron 模块，并调用它的 schedule 函数来创建一个定时任务：

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

cron.schedule('0 3 * * *', () => {
  // 执行定时任务的代码
});

这里的 '0 3 * * *' 是 cron 表达式，表示在每天 3 点整执行任务。cron 表达式的详细用法可以参考 Cron Expression Generator & Explainer - Quartz。

执行定时任务的代码可以是任何合法的 JavaScript 代码，例如：

// javascriptcn.com 代码示例
const cron = require('node-cron');
const fs = require('fs');

cron.schedule('0 3 * * *', () => {
  const date = new Date();
  const fileName = `report-${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}.txt`;
  const data = 'This is a report for today.';
  fs.writeFile(fileName, data, (err) => {
    if (err) throw err;
    console.log(`${fileName} has been saved.`);
  });
});

这段代码的作用是生成一个以当前日期为文件名的文本文件，并将一段文本内容写入该文件中。当定时任务被触发时，这个函数将被执行。

node-cron 的几种定时任务模式

node-cron 提供了多种定时任务模式，我们来一一介绍一下。

每秒执行一次任务

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

cron.schedule('* * * * * *', () => {
  // 在这里编写每秒执行的任务
});

每分钟执行一次任务

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

cron.schedule('* * * * *', () => {
  // 在这里编写每分钟执行的任务
});

每小时执行一次任务

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

cron.schedule('0 * * * *', () => {
  // 在这里编写每小时执行的任务
});

每天凌晨 3 点执行一次任务

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

cron.schedule('0 3 * * *', () => {
  // 在这里编写每天凌晨 3 点执行的任务
});

每周五凌晨 3 点执行一次任务

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

cron.schedule('0 3 * * 5', () => {
  // 在这里编写每周五凌晨 3 点执行的任务
});

每月的第一天凌晨 3 点执行一次任务

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

cron.schedule('0 3 1 * *', () => {
  // 在这里编写每月的第一天凌晨 3 点执行的任务
});

取消定时任务

如果我们需要取消一个已经创建的定时任务，可以调用 cron.cancel() 方法：

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

const task = cron.schedule('* * * * *', () => {
  // 在这里编写每分钟执行的任务
});

task.cancel();

总结

在 Node.js 中，使用 node-cron 模块可以方便地实现定时任务功能。我们可以使用 cron 表达式来定义定时任务的执行时间，使用 JavaScript 代码来编写需要执行的任务。在实现定时任务时，需要注意任务执行时间的间隔和任务的耗时，以免对服务器的资源导致过度压力。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/6583ac99d2f5e1655de825b4