在现代软件开发中,定时任务是一种常见的需求,用于执行周期性的任务或在特定的时间点执行任务。这些任务可能涉及数据同步、数据备份、报表生成、缓存刷新等方面,对系统的稳定性和可靠性有着重要的影响。Spring Boot提供了强大且简单的定时任务功能,使开发人员能够轻松地管理和执行这些任务。本文将介绍 Spring Boot中定时任务的基本用法、高级特性以及最佳实践,帮助开发人员更好地理解和应用定时任务,提高系统的稳定性和可靠性。
一、SpringBoot中的定时任务概述
1. @Scheduled注解
@Scheduled注解是Spring提供的一个注解,用于标记方法作为定时任务执行。通过 @Scheduled注解,开发人员可以轻松地配置方法在指定的时间间隔或时间点执行,实现各种定时任务需求。
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {
String cron() default "";
long fixedDelay() default -1;
long fixedRate() default -1;
long initialDelay() default -1;
}
以上为@Scheduled源码中关键属性,各属性含义如下:
- cron:接受标准的Unix Cron表达式,用于定义复杂的计划执行时间。例如:
@Scheduled(cron = "0 45 14 ? * *")
表示每天下午2:45执行。 - fixedRate:以固定的频率执行任务,指定两次执行之间的间隔时间(单位是毫秒)。例如:
@Scheduled(fixedRate = 5000)
表示每隔5秒执行一次。 - fixedDelay:在每次任务完成后等待一定的时间再进行下一次执行,指定连续执行之间的延迟时间。例如:
@Scheduled(fixedDelay = 10000)
表示上一次任务执行完成之后10秒后再次执行。 - initialDelay:首次执行前的延迟时间。例如:
@Scheduled(initialDelay=1000, fixedDelay=10000)
表示初始延迟1秒后开始,然后每10秒执行一次。
2. fixedRate与fixedDelay的区别
- fixedRate:基于任务开始执行的时间点来计算下一次任务开始执行的时间,因此任务的执行时间间隔是相对固定的,不受到任务执行时间的影响。如果指定的时间间隔小于任务执行的实际时间,则任务可能会并发执行。
- fixedDelay:基于任务执行完成的时间点来计算下一次任务开始执行的时间,因此任务的执行时间间隔是相对不规则的,受到任务执行时间的影响。
3. 使用示例
3.1 使用cron表达式
@Component
public class ScheduledTasks {
private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
// 每分钟执行一次
@Scheduled(cron = "0 * * * * ?")
public void reportCurrentTime() {
System.out.println("现在时间:" + dateFormat.format(new Date()));
}
// 每天上午10点执行
@Scheduled(cron = "0 0 10 * * ?")
public void performTaskUsingCron() {
System.out.println("执行定时任务:" + dateFormat.format(new Date()));
}
}
3.2 使用fixedRate
@Component
public class ScheduledTasks {
private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
// 每隔五秒执行一次
@Scheduled(fixedRate = 5000)
public void reportCurrentTime() {
System.out.println("每隔五秒执行一次" + dateFormat.format(new Date()));
}
}
3.3 使用fixedDelay
@Component
public class ScheduledTasks {
private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
// 上一次任务执行完成之后10秒后再执行
@Scheduled(fixedDelay = 10000)
public void runWithFixedDelay() {
System.out.println("指定时间 "+dateFormat.format(new Date())+"执行");
}
}
3.4 使用initialDelay
@Component
public class ScheduledTasks {
private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
// 初始延迟1秒后开始,然后每10秒执行一次
@Scheduled(initialDelay=1000, fixedDelay=10000)
public void executeWithInitialAndFixedDelay() {
System.out.println("指定时间 "+dateFormat.format(new Date())+"执行");
}
}
二、SpringBoot定时任务的配置与实现方式
1. 配置文件方式
除了在代码中使用注解配置定时任务外,还可以通过配置文件来配置定时任务的执行规则。这种方式更加灵活,可以在不修改源代码的情况下,动态调整定时任务的执行规则。
# application.properties
custom.scheduled.cron=0/5 * * * * ?
custom.scheduled.fixedRate=5000
custom.scheduled.fixedDelay=10000
custom.scheduled.initialDelay=1000
然后在@Scheduled的方法使用属性配置定时任务执行频率。
@Service
public class DemoScheduledTaskService {
private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
/**
* fixedRate属性设置每隔固定时间执行
*/
@Scheduled(fixedRateString = "${custom.scheduled.fixedRate}")
public void reportCurrentTime() {
System.out.println("每隔五秒执行一次" + dateFormat.format(new Date()));
}
/**
* cron属性可以设置指定时间执行,cron表达式跟linux一样
*/
@Scheduled(cron = "${custom.scheduled.cron}")
public void fixTimeExecution() {
System.out.println("指定时间 "+dateFormat.format(new Date())+"执行");
}
}
2. TaskScheduler接口方式
SpringBoot还提供了TaskScheduler接口来调度任务。这种方式更加灵活,可以通过编程的方式动态地创建和管理任务。
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.TaskScheduler;
import javax.annotation.PostConstruct;
import java.util.Date;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import static java.util.concurrent.Executors.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.context.ApplicationContext;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.scheduling.support.SimpleTriggerContext;
import org.springframework.core.env.Environment;
import org.springframework.scheduling.config.TaskSchedulerFactoryBean;
import org.springframework.scheduling.TriggerTask;
import java.text.SimpleDateFormat;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import org.springframework.scheduling.support.PeriodicTrigger;
import org.springframework.scheduling.support.RunOnceTrigger;
import java.time.temporal.ChronoUnit;
import org.springframework.scheduling.support.CronSequenceGenerator;
import static java.time.ZoneId.systemDefault;
import static java.util.concurrent.TimeUnit.*;
import org.springframework.stereotype.Component;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.scheduling.support.SimpleTriggerContext;
import org.springframework.core.env.Environment;
import org.springframework.scheduling.support.PeriodicTrigger;
import org.springframework.scheduling.support.RunOnceTrigger;
import java.time.temporal.ChronoUnit;
import org.springframework.scheduling.support.CronSequenceGenerator;
import static java.time.ZoneId.systemDefault;
import static java.util.concurrent.TimeUnit.*;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.Date;
import java.util.concurrent.*;
import static java.util.concurrent.Executors.*;
3. Quartz框架方式
对于复杂的调度需求,可以使用Quartz框架。Quartz是一个功能强大的任务调度库,适用于复杂的调度需求。以下是一个简单的示例:
import org.quartz.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.quartz.JobDetailFactoryBean;
import org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;
import org.springframework.stereotype.Component;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableScheduling;
import org.springframework.scheduling.quartz.*;
import org.springframework.beans.factory.annotation.*;
import org.springframework.scheduling.*;
import org.springframework.scheduling.quartz.*;
import org.springframework.scheduling.annotation.*;
import org.springframework.stereotype.*;
import org.springframework.scheduling.support.*;
import java.util.*;
import java.util.concurrent.*;
import org.springframework.core.*;
import org.springframework.core.env.*;