quartz与springboot整合无法暂停job问题

很多项目中都会用到定时任务的场景。起初项目中只是简单的使用了spring提供的@Scheduled注解。随着定时任务越来越多,我们需要对定时任务进行可视化管理,于是就单独建立了一个工程,用quartz进行定时任务管理。

问题起因-无法暂停job

同事在调试的时候发现通过接口添加的定时任务可以暂停、恢复。而原有的定时任务无法暂停。于是就引起我的好奇心,协助排查。

初步确认原因

先说明,由于我们目前使用的springboot版本为1.0,所以需要自行整合。到2.0时可以直接引入spring-boot-starter-quartz来实现自动装载,具体可看QuartzAutoConfiguration自动配置类。
下面是暂停任务的方法:
quartz与springboot整合无法暂停job问题

表面上看并没有什么特别问题。根据同事描述的场景我初步推测原有的任务与接口加入的任务应该不是由一个Scheduler管理。
下面分别是定时任务job中的Scheduler与接口中的Scheduler,很明显不是一个Scheduler,A-job所属A-Scheduler但是用B-Scheduler去暂停显然不行。
quartz与springboot整合无法暂停job问题
quartz与springboot整合无法暂停job问题
回头看来其实中数据库中也能看出原因:
quartz与springboot整合无法暂停job问题
SCHED_NAME都不一样。

为什么会出来两个Scheduler

既然知道了是因为不同Scheduler导致的,那么为什么会出来两个Scheduler?
首先先上配置类:
quartz与springboot整合无法暂停job问题

厉害的人可能一眼就看出问题,但是我水平有限还是花了比较多的时间才发现问题。
我是通过找到org.quartz.Scheduler接口的实现类org.quartz.impl.StdScheduler再找到他的创建工厂类org.quartz.impl.StdSchedulerFactory,因为要与数据库做持久化所以实现类肯定是这个。阅读StdSchedulerFactory,发现有个叫instantiate的初始化的方法,应该就是通过他来进行初始化,所以再方法上打个断点进行调试。
quartz与springboot整合无法暂停job问题

果然该方法进入两次,通过调试发现两处入口。

  • SchedulerFactoryBean的afterPropertiesSet方法。
    quartz与springboot整合无法暂停job问题

SchedulerFactoryBean实现了InitializingBean接口,InitializingBean接口不陌生,就是为bean做初始化用的。
quartz与springboot整合无法暂停job问题

图中480行就是创建Scheduler的地方。进入方法
quartz与springboot整合无法暂停job问题

可以看出他会再SchedulerRepository中先获取,如果获取不到就创建一个Scheduler。(PS:SchedulerRepository中可以或得到所有的Scheduler)通过调试这里创建了一个叫schedulerFactoryBean的Scheduler。

  • SchedulerFactoryBean的afterPropertiesSet方法。QuartzInitializerListener的contextInitialized方法
    quartz与springboot整合无法暂停job问题

QuartzInitializerListener实现了ServletContextListener接口,该接口有两个方法分别contextInitialized与contextDestroyed分别是Servlet容器初始化及销毁时执行。
查看contextInitialized方法:
quartz与springboot整合无法暂停job问题
quartz与springboot整合无法暂停job问题

可以看到里面也创建了一个Scheduler,通过调试知道该Scheduler名字为QuartzScheduler(默认名)

问题原因

所以为什么会出来两个Scheduler,是因为配置了两个。
quartz与springboot整合无法暂停job问题

这里我选择去掉QuartzInitializerListener。
调整后的配置:
quartz与springboot整合无法暂停job问题

与配置中心Apollo结合

因为线上线下数据库配置不一样。每次部署时都要替换quartz.properties文件非常麻烦。之前尝试过与apollo整合,当发现启动时还是会用到quartz.properties文件,一直找不到原因,通过上文排查也随便解决了这个问题是因为QuartzInitializerListener这里默认用到了。而schedulerFactoryBean说用到配置可以指定。
将数据库相关信息方入Apollo,通过@Value注解获取即可。
quartz与springboot整合无法暂停job问题


ps:同事也是网上找篇文章然后照搬下来,网上的文章水平参差不齐,照搬时还是要货比三家要有自己的判断。

上一篇:MVC 5 起航 - 第一章


下一篇:近日,OpenStack基金会宣布了第九次用户调查结果。 OpenStack用户调查是迄今为止全球