Skip to content

定时任务触发器

特点

定时任务触发器(CronTaskTrigger)是一个基于Cron表达式的定时任务触发组件,可以按照指定的时间规则定期触发任务执行。当满足Cron表达式指定的时间条件时,触发器会向任务执行器发送消息,消息结构包含触发器名称和自定义上下文数据。

  • 触发条件:满足Cron表达式指定的时间规则
  • 发送消息结构:
    typescript
    {
      from: "cron-task-trigger",
      data: 自定义上下文数据(context)
    }

代码配置

typescript
const app = new PPAgent({
    // ... 其他配置 ...
    tasks: [
        {
            name: "定时任务示例",
            triggerName: "cron-task-trigger",
            triggerOptions: {
                instanceName: "my-cron-trigger", // 实例名称,必填
                cron: "0 0 * * *", // Cron表达式,必填
                context: { message: "这是定时任务" } // 传递给执行器的数据,可选
            },
            runnerName: "your-task-runner",
            runnerOptions: {
                // ... 执行器配置 ...
            }
        }
    ]
});

服务器运行请参考 install_code 文件。

注意事项

  1. Cron表达式必须符合标准格式,支持5-6位表达式(秒 分 时 日 月 星期),不支持年份字段。
  2. 如果提供了7位Cron表达式(包含年份),系统会自动忽略年份字段。
  3. 实例使用的是node-schedule库实现定时功能,确保服务器时间正确设置。