Quartz在Spring中如何动态配置时间

Quartz在Spring中如何动态配置时间

在项目中有一个需求，需要灵活配置调度任务时间，并能自由启动或停止调度。

有关调度的实现我就第一就想到了Quartz这个开源调度组件，因为很多项目使用过，Spring 结合Quartz静态配置调度任务时间，非常easy。比如：每天凌晨几点定时运行一个程序，这只要在工程中的spring配置文件中配置好spring整合quartz的几个属性就好。

Spring配置文件

引用

这种配置就是对quartz的一种简单的使用了，调度任务会在spring启动的时候加载到内存中，按照cronTrigger中定义的cronExpression定义的时间按时触发调度任务。但是这是quartz 使用“内存”方式的一种配置，也比较常见，当然对于不使用spring的项目，也可以单独整合quartz。方法也比较简单，可以从quartz的doc中找到配置方式，或者看一下《Quartz Job Scheduling Framework 》。

但是对于想持久化调度任务的状态，并且灵活调整调度时间的方式来说，上面的内存方式就不能满足要求了，正如本文开始我遇到的情况，需要采用数据库方式集成Quartz，这部分集成其实在《Quartz Job Scheduling Framework 》中也有较为详细的介绍，当然doc文档中也有，但是缺乏和spring集成的实例。

一、需要构建Quartz数据库表，建表脚本在Quartz发行包的docs\dbTables目录，里面有各种数据库建表脚本，我采用的Quartz 1.6.5版本，总共12张表，不同版本，表个数可能不同。我用mysql数据库，执行了Quartz发行包的docs\dbTables\tables_mysql_innodb.sql建表。

二、建立java project，完成后目录如下

project，完成后目录如下

三、配置数据库连接池

配置jdbc.properties文件

引用

jdbc.driverClassName=com.mysql.jdbc.Driver

jdbc.url=jdbc:mysql://localhost:3306/quartz?useUnicode=true&characterEncoding=UTF-8&auto Reconnect=true

https://www.360docs.net/doc/9214871218.html,ername=root

jdbc.password=kfs

cpool.checkoutTimeout=5000

cpool.minPoolSize=10

cpool.maxPoolSize=25

cpool.maxIdleTime=7200

cpool.acquireIncrement=5

cpool.autoCommitOnClose=true

配置applicationContext.xml文件

引用

xmlns:xsi="https://www.360docs.net/doc/9214871218.html,/2001/XMLSchema-instance"

xmlns:aop="https://www.360docs.net/doc/9214871218.html,/schema/aop"

xmlns:tx="https://www.360docs.net/doc/9214871218.html,/schema/tx"

xmlns:context="https://www.360docs.net/doc/9214871218.html,/schema/context"

xmlns:jee="https://www.360docs.net/doc/9214871218.html,/schema/jee"

xsi:schemaLocation="

https://www.360docs.net/doc/9214871218.html,/schema/context https://www.360docs.net/doc/9214871218.html,/schema/context/spring-context-2.5.xsd

https://www.360docs.net/doc/9214871218.html,/schema/beans https://www.360docs.net/doc/9214871218.html,/schema/beans/spring-beans-2.5.xsd

https://www.360docs.net/doc/9214871218.html,/schema/tx https://www.360docs.net/doc/9214871218.html,/schema/tx/spring-tx-2.5.xsd

https://www.360docs.net/doc/9214871218.html,/schema/aop https://www.360docs.net/doc/9214871218.html,/schema/aop/spring-aop-2.5.xsd

https://www.360docs.net/doc/9214871218.html,/schema/jee

https://www.360docs.net/doc/9214871218.html,/schema/jee/spring-jee-2.5.xsd" >

classpath:jdbc.properties

这里只是配置了数据连接池，我使用c3p0 连接池，还没有涉及到Quartx有关配置，下面且听我慢慢道来。

四、实现动态定时任务

什么是动态定时任务：是由客户制定生成的，服务端只知道该去执行什么任务，但任务的定时是不确定的（是由客户制定）。

这样总不能修改配置文件每定制个定时任务就增加一个trigger吧，即便允许客户修改配置文件，但总需要重新启动web服务啊，研究了下Quartz在Spring中的动态定时，发现

引用

0/10 * * * * ?

中cronExpression是关键，如果可以动态设置cronExpression的值，就可以顺利解决问题了。这样我们就不能直接使用org.springframework.scheduling.quartz.CronTriggerBean，需要自己实现一个动态调度服务类，在其中构建CronTrigger或SimpleTrigger，动态配置时间。

动态调度服务接口：

Java代码

package com.sundoctor.quartz.service;

import java.util.Date;

import org.quartz.CronExpression;

public interface SchedulerService {

void schedule(String cronExpression);

void schedule(String name,String cronExpression);

void schedule(CronExpression cronExpression);

void schedule(String name,CronExpression cronExpression);

void schedule(Date startTime);

void schedule(String name,Date startTime);

void schedule(Date startTime,Date endTime);

void schedule(String name,Date startTime,Date endTime);

void schedule(Date startTime,Date endTime,int repeatCount);

void schedule(String name,Date startTime,Date endTime,int repeatCount);

void schedule(Date startTime,Date endTime,int repeatCount,long repeatInterval) ;

void schedule(String name,Date startTime,Date endTime,int repeatCount,long repeatInterval);

}

package com.sundoctor.quartz.service; import java.util.Date; import org.quartz.CronExpression; public interface SchedulerService { void schedule(String cronExpression); void schedule(String name,String cronExpression); void schedule(CronExpression cronExpression); void schedule(String name,CronExpression cronExpression); void schedule(Date startTime); void schedule(String name,Date startTime); void schedule(Date startTime,Date endTime); void schedule(String name,Date startTime,Date endTime); void schedule(Date startTime,Date endTime,int repeatCount); void schedule(String name,Date startTime,Date endTime,int repeatCount); void schedule(Date startTime,Date endTime,int repeatCount,long repeatInterval) ; void schedule(String name,Date startTime,Date endTime,int repeatCount,long repeatInterval); }

动态调度服务实现类：

Java代码

package com.sundoctor.quartz.service;

import java.text.ParseException;

import java.util.Date;

import java.util.UUID;

import org.quartz.CronExpression;

import org.quartz.CronTrigger;

import org.quartz.JobDetail;

import org.quartz.Scheduler;

import org.quartz.SchedulerException;

import org.quartz.SimpleTrigger;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.beans.factory.annotation.Qualifier;

import org.springframework.stereotype.Service;

@Service("schedulerService")

public class SchedulerServiceImpl implements SchedulerService {

private Scheduler scheduler;

private JobDetail jobDetail;

@Autowired

public void setJobDetail(@Qualifier("jobDetail") JobDetail jobDetail) {

this.jobDetail = jobDetail;

}

@Autowired

public void setScheduler(@Qualifier("quartzScheduler") Scheduler scheduler) { this.scheduler = scheduler;

}

@Override

public void schedule(String cronExpression) {

schedule(null, cronExpression);

}

@Override

public void schedule(String name, String cronExpression) {

try {

schedule(name, new Cronexpression_r(cronExpression));

} catch (ParseException e) {

throw new RuntimeException(e);

}

}

@Override

public void schedule(CronExpression cronExpression) {

schedule(null, cronExpression);

}

@Override

public void schedule(String name, CronExpression cronExpression) {

if (name == null || name.trim().equals("")) {

name = UUID.randomUUID().toString();

}

try {

scheduler.addJob(jobDetail, true);

CronTrigger cronTrigger = new CronTrigger(name, Scheduler.DEFAULT_GROUP, jobDet ail.getName(),

Scheduler.DEFAULT_GROUP);

cronTrigger.setCronexpression_r(cronExpression);

scheduler.scheduleJob(cronTrigger);

scheduler.rescheduleJob(name, Scheduler.DEFAULT_GROUP, cronTrigger);

} catch (SchedulerException e) {

throw new RuntimeException(e);

}

}

@Override

public void schedule(Date startTime) {

schedule(startTime, null);

}

@Override

public void schedule(String name, Date startTime) {

schedule(name, startTime, null);

}

@Override

public void schedule(Date startTime, Date endTime) {

schedule(startTime, endTime, 0);

}

@Override

public void schedule(String name, Date startTime, Date endTime) {

schedule(name, startTime, endTime, 0);

}

@Override

public void schedule(Date startTime, Date endTime, int repeatCount) {

schedule(null, startTime, endTime, 0);

}

@Override

public void schedule(String name, Date startTime, Date endTime, int repeatCount) {

schedule(name, startTime, endTime, 0, 0L);

}

@Override

public void schedule(Date startTime, Date endTime, int repeatCount, long repeatInterval) {

schedule(null, startTime, endTime, repeatCount, repeatInterval);

}

@Override

public void schedule(String name, Date startTime, Date endTime, int repeatCount, long repeatIn terval) {

if (name == null || name.trim().equals("")) {

name = UUID.randomUUID().toString();

}

try {

scheduler.addJob(jobDetail, true);

SimpleTrigger SimpleTrigger = new SimpleTrigger(name, Scheduler.DEFAULT_GROUP, jobDetail.getName(),

Scheduler.DEFAULT_GROUP, startTime, endTime, repeatCount, repeatInterval);

scheduler.scheduleJob(SimpleTrigger);

scheduler.rescheduleJob(name, Scheduler.DEFAULT_GROUP, SimpleTrigger);

} catch (SchedulerException e) {

throw new RuntimeException(e);

}

}

}

package com.sundoctor.quartz.service; import java.text.ParseException; import java.util.Date; import java.util.UUID; import org.quartz.CronExpression; import org.quartz.CronTrigger; import org.quartz.JobDetail; import org.quartz.Scheduler; import org.quartz.SchedulerException; import

org.quartz.SimpleTrigger; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.stereotype.Service; @Service("schedulerService") public class SchedulerServiceImpl implements SchedulerService { private Scheduler scheduler; private JobDetail jobDetail; @Autowired public void setJobDetail(@Qualifier("jobDetail") JobDetail jobDetail) { this.jobDetail = jobDetail; } @Autowired public void setScheduler(@Qualifier("quartzScheduler") Scheduler scheduler) { this.scheduler = scheduler; } @Override public void schedule(String cronExpression) { schedule(null, cronExpression); } @Override public void schedule(String name, String cronExpression) { try { schedule(name, new Cronexpression_r(cronExpression)); } catch (ParseException e) { throw new RuntimeException(e); } } @Override public void schedule(CronExpression cronExpression) { schedule(null, cronExpression); } @Override public void schedule(String name, CronExpression cronExpression) { if (name == null || name.trim().equals("")) { name = UUID.randomUUID().toString(); } try { scheduler.addJob(jobDetail, true); CronTrigger cronTrigger = new CronTrigger(name, Scheduler.DEFAULT_GROUP, jobDetail.getName(), Scheduler.DEFAULT_GROUP); cronTrigger.setCronexpression_r(cronExpression); scheduler.scheduleJob(cronTrigger); scheduler.rescheduleJob(name, Scheduler.DEFAULT_GROUP, cronTrigger); } catch (SchedulerException e) { throw new RuntimeException(e); } } @Override public void schedule(Date startTime) { schedule(startTime, null); } @Override public void schedule(String name, Date startTime) { schedule(name, startTime, null); } @Override public void schedule(Date startTime, Date endTime) { schedule(startTime, endTime, 0); } @Override public void schedule(String name, Date startTime, Date endTime) { schedule(name, startTime, endTime, 0); } @Override public void schedule(Date startTime, Date endTime, int repeatCount) { schedule(null, startTime, endTime, 0); } @Override public void schedule(String name, Date startTime, Date endTime, int repeatCount) { schedule(name, startTime, endTime, 0, 0L); } @Override public void schedule(Date startTime, Date endTime, int repeatCount, long repeatInterval) { schedule(null, startTime, endTime, repeatCount, repeatInterval); } @Override public void schedule(String name, Date startTime, Date endTime, int repeatCount, long repeatInterval) { if (name == null || name.trim().equals("")) { name = UUID.randomUUID().toString(); } try { scheduler.addJob(jobDetail, true); SimpleTrigger SimpleTrigger = new SimpleTrigger(name, Scheduler.DEFAULT_GROUP, jobDetail.getName(), Scheduler.DEFAULT_GROUP, startTime, endTime, repeatCount, repeatInterval); scheduler.scheduleJob(SimpleTrigger); scheduler.rescheduleJob(name, Scheduler.DEFAULT_GROUP, SimpleTrigger); } catch (SchedulerException e) { throw new RuntimeException(e); } } }

SchedulerService 只有一个多态方法schedule，SchedulerServiceImpl实现SchedulerService接口，注入org.quartz.Schedulert和org.quartz.JobDetail，schedule方法可以动态配置org.quartz.CronExpression或org.quartz.SimpleTrigger调度时间。

五、实现自己的org.quartz.JobDetail

在上一步中SchedulerServiceImpl需要注入org.quartz.JobDetail，在以前的静态配置中

引用

中使用org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean。在这里使用org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean。会报

引用

Caused by: java.io.NotSerializableException: Unable to serialize JobDataMap for insertion into database because the value of property 'methodInvoker' is not serializable: org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean

at org.quartz.impl.jdbcjobstore.StdJDBCDelegate.serializeJobData(StdJDBCDelegate.java:3358) at org.quartz.impl.jdbcjobstore.StdJDBCDelegate.insertJobDetail(StdJDBCDelegate.java:515)

at org.quartz.impl.jdbcjobstore.JobStoreSupport.storeJob(JobStoreSupport.java:1102)

... 11 more

异常，google了一下，没有找到解决方法。所以在这里不能使用org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean。，不能pojo了，需要使用org.springframework.scheduling.quartz.JobDetailBean和org.springframework.scheduling.quartz.QuartzJobBean实现自己的QuartzJobBean，如下：Java代码

package com.sundoctor.example.service;

import org.quartz.JobExecutionContext;

import org.quartz.JobExecutionException;

import org.quartz.Trigger;

import org.springframework.scheduling.quartz.QuartzJobBean;

public class MyQuartzJobBean extends QuartzJobBean {

private SimpleService simpleService;

public void setSimpleService(SimpleService simpleService) {

this.simpleService = simpleService;

}

@Override

protected void executeInternal(JobExecutionContext jobexecutioncontext) throws JobExecution Exception {

Trigger trigger = jobexecutioncontext.getTrigger();

String triggerName = trigger.getName();

simpleService.testMethod(triggerName);

}

}

package com.sundoctor.example.service; import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException; import org.quartz.Trigger; import org.springframework.scheduling.quartz.QuartzJobBean; public class MyQuartzJobBean extends QuartzJobBean { private SimpleService simpleService; public void setSimpleService(SimpleService simpleService) { this.simpleService = simpleService; } @Override protected void executeInternal(JobExecutionContext jobexecutioncontext) throws JobExecutionException { Trigger trigger = jobexecutioncontext.getTrigger(); String triggerName = trigger.getName(); simpleService.testMethod(triggerName); } }

MyQuartzJobBean继承org.springframework.scheduling.quartz.QuartzJobBean，注入的SimpleService如下：

Java代码

package com.sundoctor.example.service;

import java.io.Serializable;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.stereotype.Service;

@Service("simpleService")

public class SimpleService implements Serializable{

private static final long serialVersionUID = 122323233244334343L;

private static final Logger logger = LoggerFactory.getLogger(SimpleService.class);

public void testMethod(String triggerName){

//这里执行定时调度业务

https://www.360docs.net/doc/9214871218.html,(triggerName);

}

public void testMethod2(){

https://www.360docs.net/doc/9214871218.html,("testMethod2");

}

}

package com.sundoctor.example.service; import java.io.Serializable; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Service; @Service("simpleService") public class SimpleService implements Serializable{ private static final long serialVersionUID = 122323233244334343L; private static final Logger logger =

LoggerFactory.getLogger(SimpleService.class); public void testMethod(String triggerName){ //这里执行定时调度业务https://www.360docs.net/doc/9214871218.html,(triggerName); } public void testMethod2(){ https://www.360docs.net/doc/9214871218.html,("testMethod2"); } }

SimpleService主要执行定时调度业务，在这里我只是简单打印一下log日志。SimpleService 需要实现java.io.Serializable接口，否则会报

引用

Caused by: java.io.InvalidClassException: com.sundoctor.example.service.SimpleService; class invalid for deserialization

at java.io.ObjectStreamClass.initNonProxy(ObjectStreamClass.java:587)

at java.io.ObjectInputStream.readNonProxyDesc(ObjectInputStream.java:1583)

at java.io.ObjectInputStream.readClassDesc(ObjectInputStream.java:1496)

at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:1732)

... 64 more

异常。

配置applicationContext-quartz.xml文件：

引用

com.sundoctor.example.service.MyQuartzJobBean

quartzScheduler中没有了

引用

...

/property>

配置，通过SchedulerService动态加入CronTrigger或SimpleTrigger。

在红色的

引用

中需要注入调度业务类，否则会报空指指错误。

dataSource：项目中用到的数据源，里面包含了quartz用到的12张数据库表；applicationContextSchedulerContextKey：是org.springframework.scheduling.quartz.SchedulerFactoryBean这个类中把spring上下文以key/value的方式存放在了quartz的上下文中了，可以用applicationContextSchedulerContextKey所定义的key得到对应的spring上下文；configLocation：用于指明quartz的配置文件的位置，如果不用spring配置quartz的话，本身quartz是通过一个配置文件进行配置的，默认名称是quartz.properties，里面配置的参数在quartz的doc文档中都有介绍，可以调整quartz，我在项目中也用这个文件部分的配置了一些属性，代码如下：

引用

org.quartz.scheduler.instanceName = DefaultQuartzScheduler

org.quartz.scheduler.rmi.export = false

org.quartz.scheduler.rmi.proxy = false

org.quartz.scheduler.wrapJobExecutionInUserTransaction = false

org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool

org.quartz.threadPool.threadCount = 10

org.quartz.threadPool.threadPriority = 5

org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true

org.quartz.jobStore.misfireThreshold = 60000

#org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore

org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX

#org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.HSQLDBDelegate org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate

#https://www.360docs.net/doc/9214871218.html,eProperties = true

org.quartz.jobStore.tablePrefix = QRTZ_

org.quartz.jobStore.isClustered = false

org.quartz.jobStore.maxMisfiresToHandleAtATime=1

这里面没有数据源相关的配置部分，采用spring注入datasource的方式已经进行了配置。

六、测试

运行如下测试类

Java代码

package com.sundoctor.example.test;

import java.text.ParseException;

import java.text.SimpleDateFormat;

import java.util.Date;

import org.springframework.context.ApplicationContext;

import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.sundoctor.quartz.service.SchedulerService;

public class MainTest {

public static void main(String[] args) {

ApplicationContext springContext = new ClassPathXmlApplicationContext(new String[]{"cl asspath:applicationContext.xml","classpath:applicationContext-quartz.xml"});

SchedulerService schedulerService = (SchedulerService)springContext.getBean("schedulerS

ervice");

//执行业务逻辑...

//设置调度任务

//每10秒中执行调试一次

schedulerService.schedule("0/10 * * ? * * *");

Date startTime = parse("2009-06-01 22:16:00");

Date endTime = parse("2009-06-01 22:20:00");

//2009-06-01 21:50:00开始执行调度

schedulerService.schedule(startTime);

//2009-06-01 21:50:00开始执行调度，2009-06-01 21:55:00结束执行调试

//schedulerService.schedule(startTime,endTime);

//2009-06-01 21:50:00开始执行调度，执行5次结束

//schedulerService.schedule(startTime,null,5);

//2009-06-01 21:50:00开始执行调度，每隔20秒执行一次，执行5次结束

//schedulerService.schedule(startTime,null,5,20);

//等等，查看com.sundoctor.quartz.service.SchedulerService

}

private static Date parse(String dateStr){

SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

try {

return format.parse(dateStr);

} catch (ParseException e) {

throw new RuntimeException(e);

}

}

}

package com.sundoctor.example.test; import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.Date; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; import com.sundoctor.quartz.service.SchedulerService; public class MainTest { public static void main(String[] args) { ApplicationContext springContext = new ClassPathXmlApplicationContext(new

String[]{"classpath:applicationContext.xml","classpath:applicationContext-quartz.xml"});

SchedulerService schedulerService = (SchedulerService)springContext.getBean("schedulerService"); //执行业务逻辑... //设置调度任务//每10秒中执行调试一次schedulerService.schedule("0/10 * * ? * * *"); Date startTime = parse("2009-06-01 22:16:00"); Date endTime = parse("2009-06-01 22:20:00"); //2009-06-01 21:50:00开始执行调度schedulerService.schedule(startTime); //2009-06-01 21:50:00开始执行调度，2009-06-01 21:55:00结束执行调试//schedulerService.schedule(startTime,endTime); //2009-06-01 21:50:00开始执行调度，执行5次结束//schedulerService.schedule(startTime,null,5); //2009-06-01 21:50:00开始执行调度，每隔20秒执行一次，执行5次结束//schedulerService.schedule(startTime,null,5,20); //等等，查看com.sundoctor.quartz.service.SchedulerService } private static Date parse(String dateStr){ SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); try { return format.parse(dateStr); } catch (ParseException e) { throw new RuntimeException(e); } } }

输出

引用

[2009-06-02 00:08:50]INFO com.sundoctor.example.service.SimpleService(line:17) -2059c26f-9462-49fe-b4ce-be7e7a29459f

[2009-06-02 00:10:20]INFO com.sundoctor.example.service.SimpleService(line:17) -2059c26f-9462-49fe-b4ce-be7e7a29459f

[2009-06-02 00:10:30]INFO com.sundoctor.example.service.SimpleService(line:17) -2059c26f-9462-49fe-b4ce-be7e7a29459f

[2009-06-02 00:10:40]INFO com.sundoctor.example.service.SimpleService(line:17) -2059c26f-9462-49fe-b4ce-be7e7a29459f

[2009-06-02 00:10:50]INFO com.sundoctor.example.service.SimpleService(line:17) -2059c26f-9462-49fe-b4ce-be7e7a29459f

[2009-06-02 00:11:00]INFO com.sundoctor.example.service.SimpleService(line:17) -2059c26f-9462-49fe-b4ce-be7e7a29459f

[2009-06-02 00:11:10]INFO com.sundoctor.example.service.SimpleService(line:17) -2059c26f-9462-49fe-b4ce-be7e7a29459f

这样只是简单的将quartz trigger名称打印出来。