在 Spring Boot 中,有多种方法来编写定时任务,以执行周期性或延迟执行的任务。下面是几种常见的方式
Spring Boot 提供了 @Scheduled 注解,可以将该注解应用在方法上,以指定方法的执行时间,这也是最简单的开启定时任务的方法。
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
@Component
public class ScheduledTasks {
@Scheduled(fixedRate = 10000) // 每10秒执行一次
public void doTask() {
// 你的任务逻辑
}
}
这种方式非常简单,适用于简单的定时任务需求,下面是 @Scheduled 注解的常用参数:
fixedRate:以固定的速率执行任务。例如,@Scheduled(fixedRate = 10000) 表示每隔 10 秒执行一次任务。
fixedDelay:以固定的延迟执行任务。例如,@Scheduled(fixedDelay = 5000) 表示在上一个任务完成后延迟 5 秒再执行下一个任务。
initialDelay:在应用程序启动后,首次执行任务的延迟时间。例如,@Scheduled(initialDelay = 3000, fixedRate = 10000) 表示在应用启动后等待 3 秒,然后每隔 10 秒执行一次任务。
cron:使用 Cron 表达式来定义任务的执行时间。Cron 表达式非常灵活,可以指定精确的执行时间和日期。例如,@Scheduled(cron = “0 * * * * ?”) 表示每小时执行一次任务。
cron表达式语法:
[秒(0-59)] [分(0-59)] [时(0-23)] [日(1-31)] [月(1-12,或英文缩写))] [周(0-7,或英文缩写)]
Cron 表达式还支持一些特殊字符和符号,用于更复杂的时间规则:
*(星号): 表示匹配该字段的任意值,例如,* 在秒钟字段中表示每秒都触发。
,(逗号): 表示一个列表,可以包含多个数值,例如,1,3,5 在分钟字段中表示每小时的第1、3、5分钟触发。
-(连字符): 表示一个范围,例如,1-5 在分钟字段中表示每小时的第1到5分钟触发。
/(斜杠): 表示步长,例如,*/5 在分钟字段中表示每隔5分钟触发一次。
?(问号): 通常用在日期和星期几字段,表示不指定值。
L(大写字母L): 通常用在日期和星期几字段,表示最后一天或最后一周。
W(大写字母W): 通常用在日期字段,表示工作日(周一到周五)最接近指定日期,但可能不是准确的日期。
#(井号): 通常用在星期几字段,表示一个月中的第几个星期几,例如,6#3 表示每月的第三个星期五。
Cron 表达式 | 含义 |
---|---|
* * * * * ? |
每秒钟执行一次任务 |
0 * * * * ? |
每分钟的第0秒执行任务 |
0 0 * * * ? |
每小时的第0分0秒执行任务 |
0 0 12 * * ? |
每天中午(12:00)执行任务 |
0 0 12 * * MON |
每周一中午(12:00)执行任务 |
0 0 12 1 * ? |
每月1日中午(12:00)执行任务 |
0 0 12 1 1 ? |
每年1月1日中午(12:00)执行任务 |
0 0 * * 1-5 ? |
工作日(周一至周五)的每小时执行任务 |
0 0 0 * * ? |
每天凌晨(00:00)执行任务 |
0 0 * * SUN |
每周日的每小时执行任务 |
0 0 8-17 * * ? |
每天上午8点到下午5点的每小时执行任务 |
0 0/15 * * * ? |
每15分钟执行一次任务 |
Java 自带了 ScheduledExecutorService 接口,它允许创建并执行定时任务。可以使用 ScheduledThreadPoolExecutor 类来创建一个线程池,以执行周期性任务。这种方式更加灵活,可以处理复杂的任务。
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
public class ScheduledTasks {
private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);
public void scheduleTask() {
scheduler.scheduleAtFixedRate(this::doTask, 0, 10, TimeUnit.SECONDS);
}
public void doTask() {
// 你的任务逻辑
}
}
这种方式适用于需要更多控制的任务,如动态任务创建、取消等。
Spring 提供了 TaskScheduler 接口,它允许你执行定时任务。你可以使用 Spring 提供的实现类,如 ThreadPoolTaskScheduler。
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;
@Component
public class ScheduledTasks {
private final ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
public ScheduledTasks() {
scheduler.initialize();
scheduler.schedule(this::doTask, new CronTrigger("0/10 * * * * ?")); // 每10秒执行一次
}
public void doTask() {
// 你的任务逻辑
}
}
这种方式适用于需要更高级的任务调度,如使用 Cron 表达式等。
除了内置的方式,你还可以选择使用第三方调度框架,如 Quartz Scheduler。Quartz 提供了高度灵活的调度功能,允许你配置复杂的任务计划和调度策略。
选择哪种方法取决于你的具体需求。对于简单的定时任务,@Scheduled 注解通常足够,但如果需要更高级的控制和灵活性,可能需要考虑其他方式。