1. SpringBoot配置动态定时任务
SpringBoot项目中简单使用定时任务,不过由于要借助cron表达式且都提前定义好放在配置文件里,不能在项目运行中动态修改任务执行时间,实在不太灵活。
经过网上搜索学习后,特此记录如何在SpringBoot项目中实现动态定时任务。
因为只是一个demo,所以只引入了需要的依赖:
2. 创建Springboot项目
2.1 选择Spring Initializr(springboot项目)
2.2 配置属性,完成点击next
2.3 选择依赖,也可以不选择,稍后在pom文件里添加
2.4 项目启动类
3. 添加项目配置
3.1 项目启动类添加 @EnableScheduling 注解开启定时任务
package com.liyh;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
@EnableScheduling
@SpringBootApplication
public class SpringbootTriggerApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootTriggerApplication.class, args);
}
}
3.2 Pom文件添加依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.22</version>
</dependency>
</dependencies>
3.3 修改application.yml配置
# 配置服务端口
server:
port: 8017
# 配置Cron表达式,每10秒执行一次
trigger:
cron: 0/10 * * * * ?
4. 第一种方式:CronTrigger
4.1 编写ScheduleTask任务类
package com.liyh.task;
import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.TriggerContext;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;
import java.text.SimpleDateFormat;
import java.util.Date;
/**
* 定时任务
*
* @author liyh
*/
@Data
@Component
public class ScheduleTask implements SchedulingConfigurer {
@Value("${trigger.cron}")
private String cron;
private SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
// 动态使用cron表达式设置循环间隔
taskRegistrar.addTriggerTask(new Runnable() {
@Override
public void run() {
System.out.println("开始执行定时任务: " + simpleDateFormat.format(new Date()));
}
}, new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
// 使用CronTrigger触发器,可动态修改cron表达式来操作循环规则
CronTrigger cronTrigger = new CronTrigger(cron);
Date nextExecutionTime = cronTrigger.nextExecutionTime(triggerContext);
return nextExecutionTime;
}
});
}
}
4.2 编写TestController
package com.liyh.controller;
import com.liyh.task.ScheduleTask;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* 测试接口
*
* @author liyh
*/
@RestController
@RequestMapping("/test")
public class TestController {
@Autowired
private ScheduleTask scheduleTask;
@GetMapping("/updateCron")
public String updateCron(String cron) {
System.out.println("修改新的cron表达式:" + cron);
scheduleTask.setCron(cron);
return "修改成功";
}
}
4.3 启动项目测试,按照配置的Cron表达式每10秒执行一次
4.4 调用接口修改Cron表达式
http://127.0.0.1:8017/test/updateCron?cron=0/20 * * * * ?
5. 第二种方式:PeriodicTrigger
除了上面的借助cron表达式的方法,还有另一种触发器,区别于CronTrigger触发器,该触发器可随意设置循环间隔时间,不像cron表达式只能定义小于等于间隔59秒。
5.1 修改ScheduleTask任务类
package com.liyh.task;
import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.TriggerContext;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.scheduling.support.PeriodicTrigger;
import org.springframework.stereotype.Component;
import java.text.SimpleDateFormat;
import java.util.Date;
/**
* 定时任务
*
* @author liyh
*/
@Data
@Component
public class ScheduleTask implements SchedulingConfigurer {
@Value("${trigger.cron}")
private String cron;
// 每5秒执行一次
private Long timer = 5000L;
private SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
// 动态使用cron表达式设置循环间隔
taskRegistrar.addTriggerTask(new Runnable() {
@Override
public void run() {
System.out.println("开始执行定时任务: " + simpleDateFormat.format(new Date()));
}
}, new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
// 使用CronTrigger触发器,可动态修改cron表达式来操作循环规则
// CronTrigger cronTrigger = new CronTrigger(cron);
// Date nextExecutionTime = cronTrigger.nextExecutionTime(triggerContext);
// 使用PeriodicTrigger触发器,可随意设置循环间隔时间,单位为毫秒
PeriodicTrigger periodicTrigger = new PeriodicTrigger(timer);
Date nextExecutionTime = periodicTrigger.nextExecutionTime(triggerContext);
return nextExecutionTime;
}
});
}
}
5.2 修改TestController
package com.liyh.controller;
import com.liyh.task.ScheduleTask;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* 测试接口
*
* @author liyh
*/
@RestController
@RequestMapping("/test")
public class TestController {
@Autowired
private ScheduleTask scheduleTask;
@GetMapping("/updateCron")
public String updateCron(String cron) {
System.out.println("修改新的cron表达式:" + cron);
scheduleTask.setCron(cron);
return "修改成功";
}
@GetMapping("/updateTimer")
public String updateTimer(Long timer) {
System.out.println("修改新的timer执行时间:" + timer);
scheduleTask.setTimer(timer);
return "修改成功";
}
}
5.3 启动项目测试,按照配置的时间每5秒执行一次
5.4 调用接口修改Trimer执行时间
http://127.0.0.1:8017/test/updateTimer?timer=10000