基于Spingboot+maven+Quartz实现定时任务动态管理的demo

描述

该demo为动态创建定时任务demo。
demo内容：动态管理定时任务（运行、暂停、删除、查询状态、更新表达式等等）
demo目标：主要是支持根据传入不同的参数或者不同的job任务类，动态创建、管理多个定时任务。
demo原理：创建定时任务工厂，并给出manager管理类，通过定时任务的id及其组名（groupId）控制该定时任务的操作。
demo主要内容：
注：1、可以自定义job任务，在job实体创建（JobDetail）中绑定自定义的job，但是该功能需要自己定义多个job
2、可以通过传递参数，在每一个job的execute方法中去调用后续的操作。

实施

• 1、创建项目
  参考eclipse创建maven项目，集成springboot.
• 2、maven集成springboot、quartz
  （1）修改pom文件

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>quartz</groupId><artifactId>quartzDemo</artifactId><version>0.0.1-SNAPSHOT</version><packaging>jar</packaging><name>quartzDemo</name><url>http://maven.apache.org</url><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding><java.version>1.8</java.version><maven.compiler.source>${java.version}</maven.compiler.source><maven.compiler.target>${java.version}</maven.compiler.target></properties><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.2.5.RELEASE</version><relativePath /> <!-- lookup parent from repository --></parent><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!--quartz定时调度依赖--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-quartz</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId></dependency><dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>1.2.0</version></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><scope>runtime</scope></dependency><dependency><groupId>com.alibaba</groupId><artifactId>druid-spring-boot-starter</artifactId><version>1.1.10</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>org.apache.commons</groupId><artifactId>commons-lang3</artifactId><version>3.4</version></dependency><dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.75</version></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><fork>true</fork></configuration></plugin></plugins></build></project>

修改后记得maven update一下，否则会报错，报错如下图。

• 3、配置quartz获取job的实例配置
  这个对象Spring会帮我们自动注入进来,也属于Spring技术范畴。
  但是为什么需要再写这个类呢，在我写的这个demo中，大家可以将此类删掉，发现程序也可以正确运行，可是我为什么还是加上呢。
  在jobDetail的创建中会执行Job对象的实例化，这时候我们将spring的东西注入进来，肯定是行不通的，所以需要这个类。
  JobFactory.java：

@Component
public class JobFactory extends AdaptableJobFactory {@Autowiredprivate AutowireCapableBeanFactory capableBeanFactory;@Overrideprotected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {//调用父类的方法Object jobInstance = super.createJobInstance(bundle);//进行注入capableBeanFactory.autowireBean(jobInstance);return jobInstance;}
}

• 4、配置quartz的工厂配置
  新增配置文档QuartzConfigration.java，增加工厂配置，并创建Scheduler的实例：

@Configuration
public class QuartzConfigration {@Autowiredprivate JobFactory jobFactory;@Beanpublic SchedulerFactoryBean schedulerFactoryBean() {SchedulerFactoryBean schedulerFactoryBean = new SchedulerFactoryBean();try {schedulerFactoryBean.setOverwriteExistingJobs(true);schedulerFactoryBean.setQuartzProperties(quartzProperties());schedulerFactoryBean.setJobFactory(jobFactory);} catch (Exception e) {e.printStackTrace();}return schedulerFactoryBean;}// 指定quartz.properties，可在配置文件中配置相关属性@Beanpublic Properties quartzProperties() throws IOException {PropertiesFactoryBean propertiesFactoryBean = new PropertiesFactoryBean();propertiesFactoryBean.setLocation(new ClassPathResource("/config/quartz.properties"));propertiesFactoryBean.afterPropertiesSet();return propertiesFactoryBean.getObject();}// 创建schedule@Bean(name = "scheduler")public Scheduler scheduler() {return schedulerFactoryBean().getScheduler();}
}

• 5、添加自定义配置（可创建空白文件）
  添加配置文件，可以使用空白的quartz.properties文件。
  

# 固定前缀org.quartz
# 主要分为scheduler、threadPool、jobStore、plugin等部分
#
#
#org.quartz.scheduler.instanceName = DefaultQuartzScheduler#如果您希望Quartz Scheduler通过RMI作为服务器导出本身，则将“rmi.export”标志设置为true。
#在同一个配置文件中为'org.quartz.scheduler.rmi.export'和'org.quartz.scheduler.rmi.proxy'指定一个'true'值是没有意义的,如果你这样做，'export '选项将被忽略
org.quartz.scheduler.rmi.export = false
#如果要连接（使用）远程服务的调度程序，则将“org.quartz.scheduler.rmi.proxy”标志设置为true。您还必须指定RMI注册表进程的主机和端口 - 通常是“localhost”端口1099。
org.quartz.scheduler.rmi.proxy = falseorg.quartz.scheduler.wrapJobExecutionInUserTransaction = false# 实例化ThreadPool时，使用的线程类为SimpleThreadPool
org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool# threadCount和threadPriority将以setter的形式注入ThreadPool实例
# 并发个数  如果你只有几个工作每天触发几次 那么1个线程就可以,如果你有成千上万的工作，每分钟都有很多工作 那么久需要50-100之间.
# 只有1到100之间的数字是非常实用的
org.quartz.threadPool.threadCount = 5# 优先级 默认值为5
org.quartz.threadPool.threadPriority = 5#可以是“true”或“false”，默认为false。
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true#在被认为“misfired”(失火)之前，调度程序将“tolerate(容忍)”一个Triggers(触发器)将其下一个启动时间通过的毫秒数。默认值（如果您在配置中未输入此属性）为60000（60秒）
org.quartz.jobStore.misfireThreshold = 5000# 默认存储在内存中,RAMJobStore快速轻便，但是当进程终止时，所有调度信息都会丢失。
#org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore#持久化
org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX#您需要为JobStore选择一个DriverDelegate才能使用。DriverDelegate负责执行特定数据库可能需要的任何JDBC工作。
# StdJDBCDelegate是一个使用“vanilla”JDBC代码（和SQL语句）来执行其工作的委托,用于完全符合JDBC的驱动程序
org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate#可以将“org.quartz.jobStore.useProperties”配置参数设置为“true”（默认为false），以指示JDBCJobStore将JobDataMaps中的所有值都作为字符串，
# 因此可以作为名称 - 值对存储而不是在BLOB列中以其序列化形式存储更多复杂的对象。从长远来看，这是更安全的，因为您避免了将非String类序列化为BLOB的类版本问题。
org.quartz.jobStore.useProperties=true#表前缀
org.quartz.jobStore.tablePrefix = QRTZ_#您需要设置JobStore应该使用哪个DataSource。
org.quartz.jobStore.dataSource = qzDSorg.quartz.dataSource.qzDS.driver = com.mysql.jdbc.Driverorg.quartz.dataSource.qzDS.URL = jdbc:mysql://localhost:3306/quartz?useUnicode=true&characterEncoding=utf8&serverTimezone=UTCorg.quartz.dataSource.qzDS.user = rootorg.quartz.dataSource.qzDS.password = 123456org.quartz.dataSource.qzDS.maxConnections = 10#设置为“true”以打开群集功能。如果您有多个Quartz实例使用同一组数据库表，则此属性必须设置为“true”，否则您将遇到破坏。
#org.quartz.jobStore.isClustered=false#配置集群参见:  https://www.w3cschool.cn/quartz_doc/quartz_doc-3x7u2doc.html

• 6、编写管理类QuartzManager
  通过获取Scheduler示例，对定时任务进行操作。
  已有的操作有：
  （1）添加任务；
  （2）暂停任务；
  （3）恢复任务；
  （4）删除任务；
  （5）获取所有计划中的任务列表；
  （6）所有正在运行的job列表（该job任务处于执行其内部流程的才算是正在运行）；
  （7）立即执行任务；
  （8）更新任务定时的时间表达式；

@Service
public class QuartzManager {public final Logger log = LoggerFactory.getLogger(this.getClass());@Autowiredprivate Scheduler scheduler;/*** 添加任务* @param object 传入的数据，该数据可以传递到job的执行内容里面，具体该内容的实际运用，到DateTimeJob.executeInternal中去查看*/public void addJob(JSONObject object) {try {JobDataMap jobDataMap=new JobDataMap();jobDataMap.put("data",object.getString("jobname")+object.getString("jobgroup")+object.getString("jobCronExpression"));//        	可以自定义job任务，在job实体创建（JobDetail）中绑定自定义的job，但是该功能需要自己定义多个job
//          // 传入class类型的包地址：如：com.utils.QuartzManager
//          Class<? extends Job> jobClass = (Class<? extends Job>) (Class.forName(className).newInstance()
//                  .getClass());
//          JobDetail jobDetail = JobBuilder.newJob(jobClass).withIdentity(task.getJobName(), task.getJobGroup())// 任务名称和组构成任务key
//                  .build();//可以通过传递参数，在每一个job的execute方法中去调用后续的操作// 指明job的名称，所在组的名称，以及绑定job类JobDetail jobDetail = JobBuilder.newJob(DateTimeJob.class).withIdentity(object.getString("jobname"), object.getString("jobgroup"))// 任务名称和组构成任务key.usingJobData(jobDataMap) //存入数据.build();// 定义调度触发规则// 使用cornTrigger规则Trigger trigger = TriggerBuilder.newTrigger().withIdentity(object.getString("jobname"), object.getString("jobgroup"))// 触发器key.startAt(DateBuilder.futureDate(1, IntervalUnit.SECOND)).withSchedule(CronScheduleBuilder.cronSchedule(object.getString("jobCronExpression"))).build();// 把作业和触发器注册到任务调度中scheduler.scheduleJob(jobDetail, trigger);// 启动if (!scheduler.isShutdown()) {scheduler.start();}} catch (Exception e) {e.printStackTrace();}}/*** 暂停一个job任务* @param jobName 任务名称* @param jobGroup 任务组* @throws SchedulerException*/public void pauseJob(String jobName, String jobGroup) throws SchedulerException {JobKey jobKey = JobKey.jobKey(jobName, jobGroup);scheduler.pauseJob(jobKey);}/*** 恢复一个job* @param jobName 任务名称* @param jobGroup 任务组* @throws SchedulerException*/public void resumeJob(String jobName, String jobGroup) throws SchedulerException {JobKey jobKey = JobKey.jobKey(jobName, jobGroup);scheduler.resumeJob(jobKey);}/*** 删除一个job* @param jobName 任务名称* @param jobGroup 任务组* @throws SchedulerException*/public void deleteJob(String jobName, String jobGroup) throws SchedulerException {JobKey jobKey = JobKey.jobKey(jobName, jobGroup);scheduler.deleteJob(jobKey);}/*** 获取所有计划中的任务列表* * @return* @throws SchedulerException*/public List<JSONObject> getAllJob() throws SchedulerException {GroupMatcher<JobKey> matcher = GroupMatcher.anyJobGroup();Set<JobKey> jobKeys = scheduler.getJobKeys(matcher);List<JSONObject> jobList = new ArrayList<JSONObject>();for (JobKey jobKey : jobKeys) {List<? extends Trigger> triggers = scheduler.getTriggersOfJob(jobKey);for (Trigger trigger : triggers) {JSONObject job = new JSONObject();job.put("jobName", jobKey.getName());job.put("jobGroup", jobKey.getGroup());job.put("jobDescription", "触发器:"+trigger.getKey());Trigger.TriggerState triggerState = scheduler.getTriggerState(trigger.getKey());job.put("jobStatus", triggerState.name());if (trigger instanceof CronTrigger) {CronTrigger cronTrigger = (CronTrigger) trigger;String cronExpression = cronTrigger.getCronExpression();job.put("jobCronExpression", cronExpression);}jobList.add(job);}}return jobList;}/*** 所有正在运行的job* * @return* @throws SchedulerException*/public List<JSONObject> getRunningJob() throws SchedulerException {List<JobExecutionContext> executingJobs = scheduler.getCurrentlyExecutingJobs();List<JSONObject> jobList = new ArrayList<JSONObject>(executingJobs.size());for (JobExecutionContext executingJob : executingJobs) {JSONObject job = new JSONObject();JobDetail jobDetail = executingJob.getJobDetail();JobKey jobKey = jobDetail.getKey();Trigger trigger = executingJob.getTrigger();job.put("jobName", jobKey.getName());job.put("jobGroup", jobKey.getGroup());job.put("jobDescription", "触发器:"+trigger.getKey());Trigger.TriggerState triggerState = scheduler.getTriggerState(trigger.getKey());job.put("jobStatus", triggerState.name());if (trigger instanceof CronTrigger) {CronTrigger cronTrigger = (CronTrigger) trigger;String cronExpression = cronTrigger.getCronExpression();job.put("jobCronExpression", cronExpression);}jobList.add(job);}return jobList;}/*** 立即执行job* @param jobName 任务名称* @param jobGroup 任务组* @throws SchedulerException*/public void runJobNow(String jobName, String jobGroup) throws SchedulerException {JobKey jobKey = JobKey.jobKey(jobName, jobGroup);scheduler.triggerJob(jobKey);}/*** 更新job时间表达式* @param jobName 任务名称* @param jobGroup 任务组* @param cronExpression 定时cron表达式* @throws SchedulerException*/public void updateJobCron(String jobName, String jobGroup, String cronExpression) throws SchedulerException {TriggerKey triggerKey = TriggerKey.triggerKey(jobName, jobGroup);CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cronExpression);trigger = trigger.getTriggerBuilder().withIdentity(triggerKey).withSchedule(scheduleBuilder).build();scheduler.rescheduleJob(triggerKey, trigger);}
}

• 7、完成job类
  service：TaskService.java

@Service
public class TaskService{@AutowiredQuartzManager quartzManager;public void initSchedule() throws SchedulerException {// 这里获取任务信息数据//List<TaskDO> jobList = taskMapper.list();for (int i=8; i<11;i++) {JSONObject object = new JSONObject();object.put("jobname", "name"+i);object.put("jobgroup", "group"+i);object.put("jobCronExpression", "0/"+i+" * * * * ?");quartzManager.addJob(object);}}}

controller：TestController.java

@RestController
public class TestController {@Resourceprivate TaskService taskService;@AutowiredQuartzManager quartzManager;@GetMapping(value = "/testaddjob")public void test() {try {taskService.initSchedule();} catch (SchedulerException e) {// TODO Auto-generated catch blocke.printStackTrace();}}}

样例中只写了运行定时的用例，其余用例调用manager中的方法即可