本页

计划 cron 任务

Deno.cron 接口允许您使用 cron 语法 配置在可配置的时间表上执行的 JavaScript 或 TypeScript 代码。在下面的示例中,我们配置了一个将在每分钟执行的 JavaScript 代码块。

Deno.cron("Log a message", "* * * * *", () => {
  console.log("This will print once a minute.");
});

也可以使用 JavaScript 对象来定义 cron 时间表。在下面的示例中,我们配置了一个将在每小时执行一次的 JavaScript 代码块。

Deno.cron("Log a message", { hour: { every: 1 } }, () => {
  console.log("This will print once an hour.");
});

Deno.cron 接受三个参数

  • cron 任务的人类可读名称
  • 定义 cron 作业运行时间表的 cron 时间表字符串或 JavaScript 对象
  • 在给定时间表上执行的函数

如果您不熟悉 cron 语法,有一些第三方模块 像这个 将帮助您生成 cron 时间表字符串。

重试失败的运行 跳转到标题

失败的 cron 调用会自动使用默认重试策略进行重试。如果您想指定自定义重试策略,可以使用 backoffSchedule 属性指定一个等待时间数组(以毫秒为单位),以在再次重试函数调用之前等待。在以下示例中,我们将尝试重试失败的回调三次 - 一秒后、五秒后,然后十秒后。

Deno.cron("Retry example", "* * * * *", () => {
  throw new Error("Deno.cron will retry this three times, to no avail!");
}, {
  backoffSchedule: [1000, 5000, 10000],
});

设计和限制 跳转到标题

以下是使用Deno.cron时需要注意的一些设计细节和限制。

任务必须在顶级模块作用域中定义 跳转到标题

Deno.cron 接口旨在支持基于预定义时间表的 cron 任务的静态定义。所有Deno.cron任务都必须在模块的顶层定义。任何嵌套的Deno.cron定义(例如,在 Deno.serve 处理程序内)将导致错误或被忽略。

如果您需要在 Deno 程序执行期间动态调度任务,可以使用 Deno 队列 API。

时区 跳转到标题

Deno.cron 时间表使用 UTC 时区指定。这有助于避免与观察夏令时的时区相关的问题。

重叠执行 跳转到标题

您的 cron 任务的下一个计划调用可能会与上一次调用重叠。如果发生这种情况,Deno.cron 将跳过下一个计划调用以避免重叠执行。

星期几的数字表示 跳转到标题

Deno.cron 不使用基于 0 的星期几数字表示。相反,它使用 1-7(或 SUN-SAT)来表示星期日到星期六。这可能与使用 0-6 表示的其他 cron 引擎不同。

在 Deno Deploy 上使用 跳转到标题

使用 Deno Deploy,您可以在云中的 V8 隔离区中运行您的后台任务。这样做时,需要牢记以下几点。

与 Deno CLI 的区别 跳转到标题

与其他 Deno 运行时内置功能(如队列和 Deno KV)一样,Deno.cron 的实现方式在 Deno Deploy 上略有不同。

cron 的默认工作方式 跳转到标题

Deno 运行时中Deno.cron 的实现将执行状态保存在内存中。如果您运行多个使用Deno.cron 的 Deno 程序,每个程序将拥有自己独立的 cron 任务集。

cron 在 Deno Deploy 上的工作方式 跳转到标题

Deno Deploy 提供了Deno.cron 的无服务器实现,旨在实现高可用性和可扩展性。Deno Deploy 在部署时会自动提取您的Deno.cron 定义,并使用按需隔离区对其进行调度。您最新的生产部署定义了计划执行的活动 cron 任务集。要添加、删除或修改 cron 任务,只需修改您的代码并创建新的生产部署。

Deno Deploy 保证您的 cron 任务至少在每个计划时间间隔内执行一次。这通常意味着您的 cron 处理程序将在每个计划时间内被调用一次。在某些故障情况下,处理程序可能会在同一计划时间内被调用多次。

Cron 仪表板 跳转到标题

当您进行包含 cron 任务的生产部署时,您可以在 Deploy 仪表板 的项目Cron 选项卡中查看所有 cron 任务的列表。

a listing of cron tasks in the Deno dashboard

定价 跳转到标题

Deno.cron 调用与传入的 HTTP 请求到您的部署的收费率相同。了解有关定价的更多信息 此处

特定于部署的限制 跳转到标题

  • Deno.cron 仅适用于生产部署(不适用于预览部署)
  • 您的Deno.cron 处理程序的确切调用时间可能与计划时间相差最多一分钟

Cron 配置示例 跳转到标题

以下是一些常见的 cron 配置,供您参考。

每分钟运行一次
Deno.cron("Run once a minute", "* * * * *", () => {
  console.log("Hello, cron!");
});
每十五分钟运行一次
Deno.cron("Run every fifteen minutes", "*/15 * * * *", () => {
  console.log("Hello, cron!");
});
每小时运行一次,在整点
Deno.cron("Run once an hour, on the hour", "0 * * * *", () => {
  console.log("Hello, cron!");
});
每三小时运行一次
Deno.cron("Run every three hours", "0 */3 * * *", () => {
  console.log("Hello, cron!");
});
每天凌晨 1 点运行
Deno.cron("Run every day at 1am", "0 1 * * *", () => {
  console.log("Hello, cron!");
});
每周三午夜运行
Deno.cron("Run every Wednesday at midnight", "0 0 * * WED", () => {
  console.log("Hello, cron!");
});
每月第一天午夜运行
Deno.cron("Run on the first of the month at midnight", "0 0 1 * *", () => {
  console.log("Hello, cron!");
});