提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档
文章目录
实现的效果
通过接口调用,在不重启服务的前提下,动态修改定时任务的执行时间。
一、依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.20</version>
<scope>provided</scope>
</dependency>
</dependencies>
二、启动类代码
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
/**
* @author yuanchangliang
* @date 2022/9/30
*/
@EnableScheduling
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
System.out.println("\n\n\n ★★★★ 动态修改定时任务 启动成功 ★★★★\n\n\n");
}
}
三、定时任务代码
代码如下(示例):
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
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.time.LocalDateTime;
import java.util.Date;
/**
* 定时任务
* @author yuanchangliang
* @date 2022/9/30
*/
@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(this::doCorn, triggerContext -> {
// 使用CronTrigger触发器,可动态修改cron表达式来操作循环规则
CronTrigger cronTrigger = new CronTrigger(cron);
return cronTrigger.nextExecutionTime(triggerContext);
});
}
public void doCorn(){
log.info("Current time: {}", LocalDateTime.now());
}
}
四、corn表达式所在的配置文件:task-config.ini
内容如下(示例):
printTime.cron=0/10 * * * * ?
首先创建一个定时(间隔)任务的配置文件,用于定义每个任务的间隔时间。我这里取名就叫task-config.ini了,放置于resources路径下
五、用于动态修改定时任务执行时间的接口:TestController.java
import lombok.extern.slf4j.Slf4j;
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 yuanchangliang
* @date 2022/9/30
*/
@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
private final ScheduleTask scheduleTask;
@Autowired
public TestController(ScheduleTask scheduleTask) {
this.scheduleTask = scheduleTask;
}
@GetMapping("/updateCron")
public String updateCron(String cron) {
log.info("new cron :{}", cron);
scheduleTask.setCron(cron);
return "ok";
}
}
六、启动项目后,执行结果如下:
七、调用对外的修改定时任务的接口,执行结果如下:
八 、项目结构
九、缺陷
如果重启服务,将会重新读取配置文件中的cron表达式,所以通过接口进行修改定时任务的执行时间,只能在此次运行生效,重启即会重新读取读取配置文件中的配置。