SpringBoot设置动态定时任务
1.准备工作
搭建SpringBoot工程
- 引入相关依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
- 启动类
ps:
springboot项目开启定时任务支持需要添加@EnableScheduling注解才会生效
@EnableScheduling
@SpringBootApplication
public class ScheduleApplication {
public static void main(String[] args) {
SpringApplication.run(ScheduleApplication.class, args);
}
}
- 配置文件application.yml,只定义了服务端口:
server:
port: 8089
2.代码实现
2.1 指定cron表达式动态执行
- 定时任务执行时间配置文件:task-config.ini:
printTime.cron=0/10 * * * * ?
- 编写任务类
/**
* 指定cron表达式执行任务
*/
@Data
@Slf4j
@Component
@PropertySource("classpath:/task-config.ini")
public class ScheduleTask implements SchedulingConfigurer {
@Value("${printTime.cron}")
private String cron;
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
// 动态使用cron表达式设置循环间隔
taskRegistrar.addTriggerTask(new Runnable() {
@Override
public void run() {
log.info(Thread.currentThread().getName()+"-ScheduleTask Current time: {}", LocalDateTime.now());
}
}, new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
// 使用CronTrigger触发器,可动态修改cron表达式来操作循环规则
CronTrigger cronTrigger = new CronTrigger(cron);
Date nextExecutionTime = cronTrigger.nextExecutionTime(triggerContext);
return nextExecutionTime;
}
});
}
}
- 测试方法
@Slf4j
@RestController
@RequestMapping("/test")
@RequiredArgsConstructor
public class TestController {
private final ScheduleTask scheduleTask;
@GetMapping("/updateCron")
public String updateCron(String cron) {
log.info("new cron :{}", cron);
scheduleTask.setCron(cron);
return "ok";
}
}
启动项目,可以看到任务每10秒执行一次:
访问接口,传入请求参数cron表达式,将定时任务修改为5秒执行一次:
http://localhost:8089/test/updateCron?cron=0/1%20*%20*%20*%20*%20?
2.2指定间隔时间执行
除了上面的借助cron表达式的方法,还有另一种触发器,区别于CronTrigger触发器,该触发器可随意设置循环间隔时间,不像cron表达式只能定义小于等于间隔59秒。
任务类
/**
* 指定间隔时间执行
*/
@Data
@Slf4j
@Component
@PropertySource("classpath:/task-config.ini")
public class IntervalScheduleTask implements SchedulingConfigurer {
@Value("${printTime.cron}")
private String cron;
//间隔时间,单位毫秒 9:30 9:40 9:50
private Long timer = 10000L;
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
// 动态使用cron表达式设置循环间隔
taskRegistrar.addTriggerTask(new Runnable() {
@Override
public void run() {
log.info(Thread.currentThread().getName()+"-intervalScheduleTask Current time: {}", LocalDateTime.now());
}
}, new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
// 使用CronTrigger触发器,可动态修改cron表达式来操作循环规则
// CronTrigger cronTrigger = new CronTrigger(cron);
// Date nextExecutionTime = cronTrigger.nextExecutionTime(triggerContext);
// 使用不同的触发器,为设置循环时间的关键,区别于CronTrigger触发器,该触发器可随意设置循环间隔时间,单位为毫秒
PeriodicTrigger periodicTrigger = new PeriodicTrigger(timer);
Date nextExecutionTime = periodicTrigger.nextExecutionTime(triggerContext);
return nextExecutionTime;
}
});
}
}
启动项目的效果如下,可以看到每隔10s执行一次
对接口进行访问,修改间隔时间为每2s执行一次
http://localhost:8089/test/updateTimer?timer=2000