定時任務(wù)是一個比較常見的功能,在某些情況下,需要重新啟動或者是重設(shè)Scheduler Job,但是官方的API上都沒有提供類似restart的方法,那該如何完成此需求呢?
Spring Quartz
Spring Quartz是一整套完整的Cron Job架構(gòu),可以完成復(fù)雜的任務(wù)調(diào)度需求,支持任務(wù)持久化,事務(wù)化,甚至分布式。如果是基于Spring Quartz做的Scheduler,那么重啟比較簡單,Task的管理類Scheduler提供了非常多的方法,如scheduleJob,unscheduleJob,rescheduleJob,deleteJob,addJob等,通過這些方法的組合就以達到重啟的目的,參考此回答。
Spring Scheduler
Spring Scheduler相對于Spring Quartz來說更簡單,不需要額外引入Quartz的包,能夠?qū)崿F(xiàn)簡單的任務(wù)調(diào)度功能。它內(nèi)部基于JDK的定時任務(wù)線程池ScheduledExecutorService實現(xiàn),由類ScheduledTaskRegistrar來負責(zé)定時任務(wù)的注冊,該類定義了一些操作task的方法。類TaskScheduler負責(zé)對JDK類ScheduledExecutorService的包裝

Spring創(chuàng)建Schedle有兩種比較常見的方式:
- 標(biāo)注@Scheduled注解
- 實現(xiàn)SchedulingConfigurer接口
實現(xiàn)SchedulingConfigurer接口的方式
SchedulingConfigurer接口只有一個方法,用來做定時任務(wù)的定制化。以下是一個簡單例子
@Configuration
@EnableScheduling //開啟定時任務(wù)
public class DynamicScheduleTask implements SchedulingConfigurer {
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
// 手動配置,添加任務(wù)
taskRegistrar.addTriggerTask(...);
taskRegistrar.scheduleCronTask(...);
}
}
用這種方式,因為可以拿到任務(wù)注冊類ScheduledTasksRegistrar,重啟任務(wù)也比較簡單。
ScheduledTasksRegistrar提供了getScheduledTasks方法,可以拿到所有注冊上來的任務(wù)信息,ScheduledTask包裝了Task的Future信息。只要遍歷這些task,逐個調(diào)用cancel方法,即可停止任務(wù)。
Set<ScheduledTask> tasks = taskRegistrar.getScheduledTasks();
for (ScheduledTask task : tasks) {
task.cancel();
}
然后再通過ScheduledTaskRegistrar重新設(shè)置任務(wù)即可。
標(biāo)注@Scheduled注解的方式
用注解的方式配置定時任務(wù),這種方法很方便,使用也比較廣泛,只需在任務(wù)入口方法上添加一個注解,如
@Configuration
@EnableScheduling
public class ScheduleTask {
// execute every 10 sec
@Scheduled(cron = "0/10 * * * * ?")
private void configureTasks() {
System.out.println("task executing...");
}
}
這種方式使用簡單,是因為Spring屏蔽了很多實現(xiàn)細節(jié)。SchedulingConfiguration會創(chuàng)建一個ScheduledAnnotationBeanPostProcessor,在這個BeanPostProcessor里面會新建一個ScheduledTasksRegistrar,然后自動完成任務(wù)的配置。

在這種方案里面要實現(xiàn)重啟,有一個大困難:無法拿到ScheduledTasksRegistrar:
@Configuration
@Role(2)
public class SchedulingConfiguration {
@Bean(name = {"org.springframework.context.annotation.internalScheduledAnnotationProcessor"})
@Role(2)
public ScheduledAnnotationBeanPostProcessor scheduledAnnotationProcessor() {
// 創(chuàng)建基于Annotation配置的BeanPostProcessor
return new ScheduledAnnotationBeanPostProcessor();
}
}
public class ScheduledAnnotationBeanPostProcessor implements ScheduledTaskHolder, MergedBeanDefinitionPostProcessor, DestructionAwareBeanPostProcessor, Ordered, EmbeddedValueResolverAware, BeanNameAware, BeanFactoryAware, ApplicationContextAware, SmartInitializingSingleton, ApplicationListener<ContextRefreshedEvent>, DisposableBean {
private final ScheduledTaskRegistrar registrar;
// 默認的構(gòu)造方法中,新建類了一個ScheduledTaskRegistrar
// 然而并沒有將之注冊到Spring Context里面,所以沒法拿到它
public ScheduledAnnotationBeanPostProcessor() {
this.registrar = new ScheduledTaskRegistrar();
}
}
當(dāng)然也可以先拿到ScheduledAnnotationBeanPostProcessor,然后通過反射獲取私有屬性registrar,之后做法同上一種方案,這種比較hacker的做法這里不考慮。那在這種情況下該怎么重啟呢?
看了一下ScheduledAnnotationBeanPostProcessor的源碼,這個類實現(xiàn)在工程啟動的時候調(diào)用ScheduledTasksRegistrar去注冊并啟動定時任務(wù),在工程關(guān)閉的時候會關(guān)閉并銷毀定時任務(wù):
// 該類初始化之后調(diào)用
// 這個Bean變量,一般是標(biāo)記了@Scheduled的Task類
public Object postProcessAfterInitialization(Object bean, String beanName) {
if (!(bean instanceof AopInfrastructureBean) && !(bean instanceof TaskScheduler) && !(bean instanceof ScheduledExecutorService)) {
Class<?> targetClass = AopProxyUtils.ultimateTargetClass(bean);
// 找到標(biāo)注了@Scheduled的方法
Map<Method, Set<Scheduled>> annotatedMethods = MethodIntrospector.selectMethods(targetClass, (method) -> {
Set<Scheduled> scheduledMethods = AnnotatedElementUtils.getMergedRepeatableAnnotations(method, Scheduled.class, Schedules.class);
return !scheduledMethods.isEmpty() ? scheduledMethods : null;
});
// 遍歷方法,配置定時任務(wù)
annotatedMethods.forEach((method, scheduledMethods) -> {
scheduledMethods.forEach((scheduled) -> {
// 真正配置定時任務(wù)的地方
this.processScheduled(scheduled, method, bean);
});
});
return bean;
} else {
return bean;
}
}
// 該類銷毀之前調(diào)用
public void postProcessBeforeDestruction(Object bean, String beanName) {
Set tasks;
// 將定時任務(wù)從Collection中移除
synchronized(this.scheduledTasks) {
tasks = (Set)this.scheduledTasks.remove(bean);
}
// cancel task
if (tasks != null) {
Iterator var4 = tasks.iterator();
while(var4.hasNext()) {
ScheduledTask task = (ScheduledTask)var4.next();
task.cancel();
}
}
}
有沒有發(fā)現(xiàn),如果要重啟task,其實只要調(diào)用一下這兩個方法就可以了!以下是實現(xiàn)的具體邏輯
public class SchedulerServiceImpl {
// 得到BeanPostProcessor
@Autowired
private ScheduledAnnotationBeanPostProcessor postProcessor;
public void restartAllTasks() {
// 拿到所有的task(帶包裝)
Set<ScheduledTask> tasks = postProcessor.getScheduledTasks();
Set<Object> rawTasks = new HashSet<>(tasks.size());
for (ScheduledTask task : tasks) {
Task t = task.getTask();
ScheduledMethodRunnable runnable = (ScheduledMethodRunnable) t.getRunnable();
Object taskObject = runnable.getTarget();
// 將task所關(guān)聯(lián)的對象放到Set中(就是帶@Scheduled方法的類)
rawTasks.add(taskObject);
}
// 調(diào)用postProcessBeforeDestruction()方法,將task移除并cancel
for (Object obj : rawTasks) {
postProcessor.postProcessBeforeDestruction(obj, "scheduledTasks");
}
// 調(diào)用postProcessAfterInitialization()方法重新schedule task
for (Object obj : rawTasks) {
postProcessor.postProcessAfterInitialization(obj, "scheduledTasks");
}
}
}
想不到,原以為最復(fù)雜的情況,只需要調(diào)用Spring提供的方法就能完成目的。可見Spring設(shè)計得多巧妙。