@Scheduled 是 Spring Framework 中用于实现定时任务的核心注解,能够方便地配置方法在特定时间或周期执行。以下是详细解析:
1. 启用定时任务
在 Spring Boot 中,需在配置类添加 @EnableScheduling 注解以启用定时任务支持:
@Configuration
@EnableScheduling
public class AppConfig {
}
2. 基本用法
直接在方法上添加 @Scheduled
注解,并配置执行规则:
@Component
public class ScheduledTasks {
// 固定延迟(任务结束后的间隔)
@Scheduled(fixedDelay = 5000)
public void taskWithFixedDelay() {
// 每隔5秒执行一次(任务完成后开始计时)
}
// 固定速率(任务开始的间隔)
@Scheduled(fixedRate = 3000)
public void taskWithFixedRate() {
// 每隔3秒执行一次(任务开始后开始计时)
}
// 初始延迟(首次执行前的等待时间)
@Scheduled(initialDelay = 10000, fixedRate = 5000)
public void taskWithInitialDelay() {
// 首次延迟10秒,之后每隔5秒执行一次
}
// Cron表达式(复杂时间规则)
@Scheduled(cron = "0 0 12 * * ?")
public void taskWithCronExpression() {
// 每天中午12点执行
}
}
3. 参数详解
(1) fixedDelay
- 作用:任务结束后的固定延迟时间(单位:毫秒)。
- 示例:@Scheduled(fixedDelay = 5000) 表示任务结束后等待5秒再执行下一次。
- 适用场景:需确保前一次任务完成后再执行下一次。
(2) fixedRate - 作用:任务开始的固定时间间隔(单位:毫秒)。
- 示例:@Scheduled(fixedRate = 3000) 表示每隔3秒执行一次(无论前一次任务是否完成)。
- 注意:若任务执行时间超过间隔时间,可能导致任务重叠(需结合线程池配置)。
(3) initialDelay - 作用:首次任务执行前的初始延迟时间(单位:毫秒)。
- 示例:@Scheduled(initialDelay = 10000, fixedRate = 5000) 表示首次延迟10秒后执行,之后每隔5秒执行一次。
(4) cron - 作用:通过 Cron 表达式定义复杂调度规则。
- Cron 表达式格式:秒 分 时 日 月 周 年(可选)
- 常用示例:
- 0 0 10 * * ?:每天上午10点执行。
- 0 0/5 14 * * ?:每天下午2点开始,每隔5分钟执行一次。
- 0 15 10 ? * MON-FRI:每周一至周五上午10:15执行。
- 在线工具:推荐使用 Cron表达式生成器。
4. 线程池配置
默认情况下,定时任务使用单线程执行。若任务耗时较长,需配置线程池避免阻塞:
@Configuration
public class SchedulerConfig implements SchedulingConfigurer {
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
taskRegistrar.setScheduler(taskExecutor());
}
@Bean(destroyMethod = "shutdown")
public Executor taskExecutor() {
return Executors.newScheduledThreadPool(10); // 自定义线程数
}
}
5. 注意事项
1. 避免长时间阻塞:若任务执行时间超过调度间隔,需合理设计逻辑或配置线程池。
2. 分布式环境问题:在集群中,定时任务可能被多个实例重复执行。解决方案:
使用分布式锁(如 Redis 或 ZooKeeper)。
通过数据库唯一标识控制任务执行。
3. 动态调整:默认 @Scheduled 参数不支持动态修改。如需动态调度,可结合 ScheduledTaskRegistrar 或使用 Quartz 框架。
6. 常见问题
Q1:Cron 表达式中的 ? 和 * 有什么区别?
*
表示任意值(如:*
在“日”字段表示每天)。?
用于“日”和“周”字段的互斥条件(避免冲突)。
Q2:如何避免任务重复执行?- 单机环境:确保任务幂等性。
- 分布式环境:使用分布式锁或数据库唯一约束。
Q3:如何调试定时任务? - 开启 Spring 的调试日志:logging.level.org.springframework.scheduling=DEBUG
总结
@Scheduled 是 Spring 中实现定时任务的便捷工具,通过灵活配置 fixedDelay、fixedRate 或 cron 表达式,可以满足大多数调度需求。在复杂场景(如动态任务或分布式环境)中,可结合 Quartz 或其他分布式调度框架实现更高级功能。