For AI agents: the complete documentation index is available at https://docs.halo.run/llms.txt, the full documentation bundle is available at https://docs.halo.run/llms-full.txt, and this page is available as Markdown at https://docs.halo.run/developer-guide/plugin/basics/server/scheduled-tasks.md.

定时任务

Halo 插件运行在独立的 Spring 应用上下文中,因此可以直接使用 Spring 的调度能力执行周期性任务,例如定时同步外部数据、生成站点地图、清理过期记录等。

启用调度

在插件启动类上添加 @EnableScheduling,然后在任意 Spring Bean 的方法上使用 @Scheduled

@EnableScheduling
public class MyPlugin extends BasePlugin {
    // ...
}
@Component
public class SitemapScheduler {

    // 每小时执行一次
    @Scheduled(fixedDelay = 60 * 60 * 1000L, initialDelay = 60 * 1000L)
    public void regenerate() {
        // do something
    }

    // 或使用 cron 表达式,每天凌晨 3:30 执行
    @Scheduled(cron = "0 30 3 * * *")
    public void dailyCleanup() {
        // do something
    }
}

@Scheduled 支持 fixedRatefixedDelayinitialDelaycron 等方式,完整说明参考 Spring 调度文档

生命周期

定时任务注册在插件自己的应用上下文中,因此:

  • 插件启动后任务才开始调度,插件停止或卸载时上下文关闭,任务随之取消,无需手动清理。
  • Halo 不保证根应用的 /actuator/scheduledtasks 能发现插件子应用上下文中的任务。插件应自行记录任务的开始、结束和失败信息。

注意事项

  • 避免阻塞调度线程:Spring 默认使用单线程调度器,长时间运行的任务会拖延同插件内其他任务的执行;耗时操作应切换到弹性线程执行(参考响应式服务端开发中的阻塞隔离方式)。
  • 任务应是幂等的:Halo 可能运行在多个副本或被重启,任务逻辑应能安全地重复执行,不要依赖上一次运行的内存状态。
  • 明确时区:使用 cron 时通过 zone 显式声明业务时区,避免部署环境的系统时区改变执行时间。
  • 避免任务重叠:执行时间可能超过调度间隔时,应使用互斥或状态检查防止同一实例重复执行;多副本部署还需要分布式协调。
  • 记录并处理异常:任务异常不能只依赖调度器日志。记录可定位的上下文,并让下次执行能够安全重试。
  • 返回响应式链:Spring Framework 6.1 起会自动订阅 @Scheduled 方法返回的 MonoFlux 或其他 Publisher,并在插件应用上下文关闭时取消后续调度和活动订阅。优先直接返回响应式链,不要在方法中再次手动订阅;只有未作为返回值交给调度器的后台订阅才需要按后台任务生命周期自行释放。
  • 与 Reconciler 的分工:如果是「让资源持续符合期望状态」的场景(如资源变更后重建索引),优先使用 Reconciler 的事件驱动调谐,而不是定时轮询;定时任务适合与资源变更无关的周期性工作,例如按时间触发的数据同步或清理。