spring schedule實現動態配置執行時間
spring schedule 動態配置執行時間
之前saas平臺實現動態修改定時任務的時間，都是通過xx-job這樣的框架來實現，這樣我們可以單獨一個服務來管理我們整個saas平臺的定時任務，但是最近給銀行做的一個小項目，需要本地化部署，所以我不想弄很多的服務，並且他們並沒有要求修改以後即時生效，所以我直接采用瞭 spring schedule結合mysql動態配置執行時間。
之前我們用的schedule通過註解的方式，隻能用靜態的corn表達式，如果想實現動態的需要實現SchedulingConfigurer，並且通過註解@EnableScheduling。如下：
package com.zqf.marketing.task;
import com.zqf.db.marketingrobot.sys.model.RobotSysSwitch;
import com.zqf.marketing.sys.service.SwitchService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Lazy;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.TriggerContext;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Service;
import java.util.Date;
/**
* @author zhenghao
* @description
* @date 2019/1/22 21:50
*/
@Lazy(false)
@Service
@EnableScheduling
public class TestTaskService implements SchedulingConfigurer {
private static Logger log = LoggerFactory.getLogger(TestTaskService.class);
@Autowired
private SwitchService switchService;
private String SpringDynamicCronTask() {
String cron = "0/5 * * * * ?";
//從數據庫獲得配置的corn表達式
RobotSysSwitch switchById = switchService.getSwitchById(5L);
cron = switchById.getSwitchFlag();
log.info(cron);
return cron;
}
@Override
public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
scheduledTaskRegistrar.addTriggerTask(new Runnable() {
@Override
public void run() {
// 任務邏輯
log.info("task_task_tak");
}
}, new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
String s = SpringDynamicCronTask();
// 任務觸發，可修改任務的執行周期
CronTrigger trigger = new CronTrigger(s);
Date nextExec = trigger.nextExecutionTime(triggerContext);
return nextExec;
}
});
}
}
這樣我們就可以動態的修改task的執行時間，生效時間為，上一個任務的執行周期，也可以滿足我們現在需求，這樣就可以實習項目更加的靈活！
@schedule註解動態配置時間間隔
動態配置時間間隔是通過自己實現的任務註冊到任務調度實現的，並在每次調度的時候更改下次調度時間間隔，如果任務阻塞或者掛掉瞭就不會再被調度瞭，如果設置時間過長，到下次調度就需要等待很長時間。
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.TriggerContext;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.PeriodicTrigger;
import org.springframework.stereotype.Component;
import java.util.Date;
@Component
@EnableScheduling
public class DynamicScheduleTaskSecond implements SchedulingConfigurer {
private static final long WEEK_MILLIS = 604800000;
private static final long MIN_MILLIS = 1000;
private static long period = 1000;
static long l = System.currentTimeMillis();
@Autowired
SetPeriod setPeriod;
public static long getPeriod() {
return period;
}
public static void setPeriod(long period) {
DynamicScheduleTaskSecond.period = period;
}
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
taskRegistrar.addTriggerTask(new Runnable() {
@Override
public void run() {
try {
setPeriod.update(period);
System.out.println("abc");
Long last = System.currentTimeMillis() - l;
l = System.currentTimeMillis();
System.out.println(last);
} catch (Exception e) {
e.printStackTrace();
}
}
}, new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
if (period < MIN_MILLIS || period > WEEK_MILLIS)
period = MIN_MILLIS;
PeriodicTrigger periodicTrigger = new PeriodicTrigger(period);
Date nextExecDate = periodicTrigger.nextExecutionTime(triggerContext);
return nextExecDate;
}
});
}
}
import org.springframework.stereotype.Component;
@Component
public class SetPeriod {
private static Long maxPeriod = 1000l;
public void update(Long period) {
maxPeriod += 1000;
setScheduleConfig(maxPeriod);
}
public boolean setScheduleConfig(Long period) {
DynamicScheduleTaskSecond.setPeriod(period);
return true;
}
}
上面是實現動態調度的一個簡單實例，下面說一下基本原理。
動態調度功能主要是實現SchedulingConfigurer函數式接口，接口中的方法configureTasks的參數是重點。
@FunctionalInterface
public interface SchedulingConfigurer {
/**
* Callback allowing a {@link org.springframework.scheduling.TaskScheduler
* TaskScheduler} and specific {@link org.springframework.scheduling.config.Task Task}
* instances to be registered against the given the {@link ScheduledTaskRegistrar}.
* @param taskRegistrar the registrar to be configured.
*/
void configureTasks(ScheduledTaskRegistrar taskRegistrar);
}
看名字 ScheduledTaskRegistrar就知道是一個調度任務註冊類，調用這個類的addTriggerTask方法需要兩個參數
public void addTriggerTask(Runnable task, Trigger trigger) {
this.addTriggerTask(new TriggerTask(task, trigger));
}
一個是任務線程這個最後說，先說一下第二個Trigger，這是一個設置任務觸發時間的接口，具體的實現有兩個類，一個是CronTrigger對應的就是cron類型的時間設置，一個是PeriodicTrigger對應的就是FixDelay和FixRate兩種方式的時間設置，實例中使用的是後者。
public interface Trigger {
@Nullable
Date nextExecutionTime(TriggerContext var1);
}
接口方法參數是一個TriggerContext，這個參數就是任務觸發的上下文，裡面保存著上一次任務開始時間和結束時間和實際執行用時，自己需要實現這個nextExecutionTime方法根據上一次任務執行時間來返回一個新的Date時間，new一個新的periodicTrigger對象初始化period時間間隔為新的時間間隔用nextExecutionTime方法就可以瞭根據上下文時間返回一個新的任務調度時間瞭，但是period的時間不能太長也不能太短最好設置一個區間，這樣可以避免很多粗心的錯誤導致的麻煩，到此完美解決動態設置任務調度時間間隔功能。
再說一下第一個線程任務中的需要做的事，執行的任務需要在其他的具體類中實現，然後在這個線程中調用，然後每次在調度任務的時候就要根據時間業務重新設置時間間隔，比如讀配置後改變時間間隔，也就是調度和具體的任務形成一個環，調度執行具體的任務後，具體的任務在設置調度的時間間隔。
以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。
推薦閱讀：
- Spring Task 動態修改任務執行計劃cron方式
- Spring Schedule Task動態改寫Cron配置方式
- 使用spring-task定時任務動態配置修改執行時間
- SpringBoot設置動態定時任務的方法詳解
- Springboot自帶定時任務實現動態配置Cron參數方式