Springboot⾃带定时任务实现动态配置Cron参数⽅式⽬录
Springboot⾃带定时任务实现动态配置Cron参数
SpringBoot定时任务的四种实现⽅式(主要)
spring动态配置cron表达式,不需要停服
SchedulingConfigurer接⼝实现动态加载cron表达式
Springboot⾃带定时任务实现动态配置Cron参数
同学们,我今天分享⼀下SpringBoot动态配置Cron参数。场景是这样⼦的:后台管理界⾯对定时任务进⾏管理,可动态修改执⾏时间,然后保存⼊库,每次任务执⾏前从库⾥查询时间,以达到动态修改Cron参数的效果。好,咱们⼀起来看看是怎么回事。
SpringBoot定时任务的四种实现⽅式(主要)
Timer:这是java⾃带的java.util.Timer类,这个类允许你调度⼀个java.util.TimerTask任务。使⽤这种⽅式可以让你的程序按照某⼀个频度执⾏,但不能在指定时间运⾏。⼀般⽤的较少。
ScheduledExecutorService:也jdk⾃带的⼀个类;是基于线程池设计的定时任务类,每个调度任务都会分配到线程池中的⼀个线程去执⾏,也就是说,任务是并发执⾏,互不影响。
Spring Task:Spring3.0以后⾃带的task,可以将它看成⼀个轻量级的Quartz,⽽且使⽤起来⽐Quartz简单许多。
Quartz:这是⼀个功能⽐较强⼤的的调度器,可以让你的程序在指定时间执⾏,也可以按照某⼀个频度执⾏,配置起来稍显复杂。
1.1使⽤Timer
这是让你按照固定的频率去执⾏⼀个任务,不能指定时间。
public class TestTimer {
public static void main(String[] args) {
TimerTask timerTask = new TimerTask() {
@Override
public void run() {
System.out.println("task run:"+ new Date());
}
};
Timer timer = new Timer();
//安排指定的任务在指定的时间开始进⾏重复的固定延迟执⾏。这⾥是每3秒执⾏⼀次
timer.schedule(timerTask,10,3000);
}
}
1.2使⽤ScheduledExecutorService和timer类似
public class TestScheduledExecutorService {
public static void main(String[] args) {
ScheduledExecutorService service = wSingleThreadScheduledExecutor();
// 参数:1、任务体 2、⾸次执⾏的延时时间
// 3、任务执⾏间隔 4、间隔时间单位
service.scheduleAtFixedRate(()->System.out.println("task ScheduledExecutorService "+new Date()), 0, 3, TimeUnit.SECONDS);
}
}
1.3使⽤Spring Task
我们主要讲解它的动态配置使⽤⽅法。
在刚开始使⽤的时候,我们更改⼀个任务的执⾏时间,⼀般是这样的:修改定时任务的执⾏周期,把服务停下来,改下任务的cron参数,再重启服务就搞搞定了。这种⽅式很简单,没有可说的,但是有没有
⼀种可能,在不停服务的情况下,就可以动态的修改任务的cron参数呢?那是必须有!
刚刚提到的⽅法⾥,我们在主类上⾯加@EnableScheduling注解,在任务⽅法前⾯加上@Scheduled(cron =“0/5 * * * * *”)注解定义执⾏时间,但是动态配置的步骤就有点不⼀样:
1. 在定时任务类上增加@EnabledScheduling注解,并实现SchedulingConfigurer接⼝。
2. 设置⼀个静态的cron,⽤于存放任务执⾏周期参数。
3. 从数据库获取Cron参数,⽤于模拟实际业务中外部原因修改了任务执⾏周期。
4. 设置任务触发器,触发任务执⾏。
import java.util.Date;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.TriggerContext;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.fig.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
@Component
@EnableScheduling
public class TaskCronChange implements SchedulingConfigurer{
public static String cron;
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
//项⽬部署时,会在这⾥执⾏⼀次,从数据库拿到cron表达式
cron = CronTime();
Runnable task = new Runnable() {
@Override
public void run() {
//任务逻辑代码部分.
System.out.println("I am going:" + w());
}
};
Trigger trigger = new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
/
/任务触发,可修改任务的执⾏周期.
//每⼀次任务触发,都会执⾏这⾥的⽅法⼀次,重新获取下⼀次的执⾏时间
cron = CronTime();
CronTrigger trigger = new CronTrigger(cron);
Date nextExec = ExecutionTime(triggerContext);
return nextExec;
}
};
taskRegistrar.addTriggerTask(task, trigger);
}
}
因为是要任务执⾏⼀次的时候才会去修改时间的cron表达式,所以改了cron后,要在下下次任务执⾏时才会⽣效。
这⾥核⼼的主要是使⽤到了ScheduledTaskRegistrar这个类有⼀个⽅法addTriggerTask(Runnable,Trigger)两个参数,⼀个Runnable,⼀个是Trigger,在Runnable中执⾏业务逻辑代码,在Trigger修改定时任务的执⾏周期。
1.4整合Quartz
在SpringBoot版本是2.0.0以后的,则在spring-boot-starter中已经包含了quart的依赖,则可以直接使⽤spring-boot-starter-quartz依赖,如果是低于2.0.0版本的,需要额外添加quartz的依赖。
spring动态配置cron表达式,不需要停服
spring做定时任务调度时有常⽤的两种⽅式,分别是基于配置⽂件的quartz和基于注解的@Scheduler。
quartz需要较多的配置⽂件,个⼈感觉⽐较⿇烦,@Scheduler注解只需要简单的配置即可,但是这两种发⽅法不能动态加载cron表达式,每次更改调度规则都需要重启服务。
本⽂介绍⼀种不需要重启服务的动态加载cron表达式的⽅法。
SchedulingConfigurer接⼝实现动态加载cron表达式
代码⽰例如下:
@Component
@EnableScheduling
public class Test implements SchedulingConfigurer {
@Override
public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
spring framework版本//创建⼀个线程池调度器,默认是单线程执⾏
ScheduledExecutorService executorService = wScheduledThreadPool(100); scheduledTaskRegistrar.setScheduler(executorService);
//增加任务
scheduledTaskRegistrar.addTriggerTask(new Task("test1"),new Trig("cronExpess1"));
scheduledTaskRegistrar.addTriggerTask(new Task("test2"),new Trig("cronExpess2"));
scheduledTaskRegistrar.addTriggerTask(new Task("test3"),new Trig("cronExpess2"));
}
}
/**
* 业务类
*/
class Task implements Runnable{
String task;
public Task(String task){
this.task = task;
}
//具体业务
@Override
public void run() {
System.out.println(task+":"+w()+","+Thread.currentThread().getName()); }
}
/**
* 调度类
*/
class Trig implements Trigger{
private String cronExpress;
public Trig(String cronExpress){
}
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
String cron = null;
try {
//每次调度时加载cron表达式
cron = new Config().getCrons().get(cronExpress);
} catch (IOException e) {
e.printStackTrace();
}
CronTrigger cronTrigger = new CronTrigger(cron);
ExecutionTime(triggerContext);
}
}
/**
* 加载cron表达式
*/
class Config{
private static Map<String,String> cronMap;
private static long preModifyTime;
private String cronFile = "config/application.properties";
public Map<String,String> getCrons() throws IOException {
File file = new File(cronFile);
long nowModifyTime = file.lastModified();
if (cronMap != null && nowModifyTime == preModifyTime){
return cronMap;
}else {
cronMap = new HashMap<>();
BufferedReader br = new BufferedReader(new FileReader(file));
String line = null;
while ((line = br.readLine()) != null){
String[] s = line.split("=");
cronMap.put(s[0].trim(),s[1].trim());
}
preModifyTime = nowModifyTime;
return cronMap;
}
}
}
配置⽂件:
cronExpess1 = 0/5 * * * * *
cronExpess2 = 0/10 * * * * *
运⾏结果(为了查看⽅便,只运⾏⼀个任务):
以上为个⼈经验,希望能给⼤家⼀个参考,也希望⼤家多多⽀持。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论