1. 什么是 node-cron
node-cron
是一个基于 Node.js 的轻量级定时任务库,它使用 cron 语法来调度任务。相比原生setInterval
,它提供了更强大、更灵活的任务调度能力。
主要特性:
- 支持完整的 cron 语法
- 轻量级(仅 40KB)
- 简单易用的 API
- 支持时区设置
- 任务启动/停止控制
2. 安装
npm install --save node-cron
var cron = require('node-cron');
cron.schedule('* * * * *', () => {
console.log('running a task every minute');
});
3. cron 语法
* * * * * *
┬ ┬ ┬ ┬ ┬ ┬
│ │ │ │ │ │
│ │ │ │ │ └ 星期几 (0 - 7) (0或7是星期日)
│ │ │ │ └───── 月份 (1 - 12)
│ │ │ └────────── 日期 (1 - 31)
│ │ └─────────────── 小时 (0 - 23)
│ └──────────────────── 分钟 (0 - 59)
└───────────────────────── 秒 (0 - 59, 可选)
注意
:秒是可选
的,那就是说,如若是5位,那就是没有秒,如若是六位就是有秒
4. 示例
const cron = require("node-cron");
const nodemailder = require("nodemailer");
console.log("index.js 代码开始执行");
cron.schedule("* * * * * *", () => {
console.log("每秒输出一次");
});
cron.schedule("* * * * *", () => {
console.log("每分钟输出一次");
});
5. 定时发送邮件示例
const cron = require("node-cron");
const nodemailder = require("nodemailer");
console.log("index.js 代码开始执行");
// cron.schedule("* * * * * *", () => {
// console.log("每秒输出一次");
// });
// cron.schedule("* * * * *", () => {
// console.log("每分钟输出一次");
// });
// 这个是错误的
// try {
// let job = cron.schedule(
// "*/5 * * * * ?",
// () => {
// console.log("每5秒输出一次", Math.random());
// },
// {
// scheduled: true,
// timezone: "Asia/Shanghai",
// }
// );
// } catch (err) {
// console.log("err", err.message);
// }
const transPort = nodemailder.createTransport({
service: "qq", // 服务商
host: "smtp.qq.com", // 服务器地址
auth: {
pass: "xxxx", // 密码 或者 授权码
user: "xxxx@qq.com", // 邮箱账号
},
secure: true, // 加密发送
});
try {
let job = cron.schedule(
"*/10 * * * * *",
() => {
let orderId = Math.random();
console.log("每10秒输出一次", orderId);
transPort
.sendMail({
to: "tjingliye@teld.cn", // 发送给谁
// from: "xxxx@qq.com", // 发送人;这种写法也可以
from: `"呆呆狗"<xxxx@qq.com>`, // 发送人
subject: "测试", // 主题
html: `
<h1>你好,您的邮件已收到!${orderId}</h1>
<hr/>
<p>
<b>祝:</b><br/>
身体健康,工作顺利!
</p>
`,
})
.then(
(res) => {
console.log("发送成功");
transPort.close();
},
(err) => {
console.log("发送失败", err);
}
);
},
{
scheduled: true, // 任务创建后立即开始按 cron 表达式调度执行 , false 任务创建后不会自动启动,需要手动调用 task.start() 才会开始调度
timezone: "Asia/Shanghai", // 指定时区
}
);
} catch (err) {
console.log("err", err.message);
}