原文地址:http://www.iteye.com/topic/399980
在項目中有一個需求,需要靈活配置調度任務時間,並能自由啟動或停止調度。
有關調度的實現我就第一就想到了Quartz這個開源調度組件,因為很多項目使用過,Spring結合Quartz靜態配置調度任務時間,非常easy。比如:每天凌晨幾點定時運行一個程序,這只要在工程中的spring配置文件中配置好spring整合quartz的幾個屬性就好。
Spring配置文件
<bean id="jobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
<property name="targetObject" ref="simpleService" />
<property name="targetMethod" value="test" />
</bean>
<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">
<property name="jobDetail" ref="jobDetail" />
<property name="cronExpression" value="0 0/50 * ? * * *" />
</bean>
<bean id="schedulerTrigger" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
<property name="triggers">
<list>
<ref bean="cronTrigger"/>
</list>
</property>
</bean>
這種配置就是對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,完成后目錄如下
三、配置數據庫連接池
配置jdbc.properties文件
jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/quartz?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true
jdbc.username=root
jdbc.password=kfs
cpool.checkoutTimeout=5000
cpool.minPoolSize=10
cpool.maxPoolSize=25
cpool.maxIdleTime=7200
cpool.acquireIncrement=5
cpool.autoCommitOnClose=true
配置applicationContext.xml文件
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:jee="http://www.springframework.org/schema/jee"
xsi:schemaLocation="
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd
http://www.springframework.org/schema/jee
http://www.springframework.org/schema/jee/spring-jee-2.5.xsd" >
<context:component-scan base-package="com.sundoctor"/>
<!-- 屬性文件讀入 -->
<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="locations">
<list>
<value>classpath:jdbc.properties</value>
</list>
</property>
</bean>
<!-- 數據源定義,使用c3p0 連接池 -->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource" destroy-method="close">
<property name="driverClass" value="${jdbc.driverClassName}" />
<property name="jdbcUrl" value="${jdbc.url}" />
<property name="user" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
<property name="initialPoolSize" value="${cpool.minPoolSize}"/>
<property name="minPoolSize" value="${cpool.minPoolSize}" />
<property name="maxPoolSize" value="${cpool.maxPoolSize}" />
<property name="acquireIncrement" value="${cpool.acquireIncrement}" />
<property name="maxIdleTime" value="${cpool.maxIdleTime}"/>
</bean>
</beans>
這里只是配置了數據連接池,我使用c3p0 連接池,還沒有涉及到Quartx有關配置,下面且聽我慢慢道來。
四、實現動態定時任務
什么是動態定時任務:是由客戶制定生成的,服務端只知道該去執行什么任務,但任務的定時是不確定的(是由客戶制定)。
這樣總不能修改配置文件每定制個定時任務就增加一個trigger吧,即便允許客戶修改配置文件,但總需要重新啟動web服務啊,研究了下Quartz在Spring中的動態定時,發現
<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean" >
<property name="jobDetail" ref="schedulerJobDetail"/>
<property name="cronExpression">
<value>0/10 * * * * ?</value>
</property>
中cronExpression是關鍵,如果可以動態設置cronExpression的值,就可以順利解決問題了。這樣我們就不能直接使用org.springframework.scheduling.quartz.CronTriggerBean,需要自己實現一個動態調度服務類,在其中構建CronTrigger或SimpleTrigger,動態配置時間。
動態調度服務接口:
- package com.sundoctor.quartz.service;
- import java.util.Date;
- import org.quartz.CronExpression;
- public interface SchedulerService {
- /**
- * 根據 Quartz Cron Expression 調試任務
- * @param cronExpression Quartz Cron 表達式,如 "0/10 * * ? * * *"等
- */
- void schedule(String cronExpression);
- /**
- * 根據 Quartz Cron Expression 調試任務
- * @param name Quartz CronTrigger名稱
- * @param cronExpression Quartz Cron 表達式,如 "0/10 * * ? * * *"等
- */
- void schedule(String name,String cronExpression);
- /**
- * 根據 Quartz Cron Expression 調試任務
- * @param cronExpression Quartz CronExpression
- */
- void schedule(CronExpression cronExpression);
- /**
- * 根據 Quartz Cron Expression 調試任務
- * @param name Quartz CronTrigger名稱
- * @param cronExpression Quartz CronExpression
- */
- void schedule(String name,CronExpression cronExpression);
- /**
- * 在startTime時執行調試一次
- * @param startTime 調度開始時間
- */
- void schedule(Date startTime);
- /**
- * 在startTime時執行調試一次
- * @param name Quartz SimpleTrigger 名稱
- * @param startTime 調度開始時間
- */
- void schedule(String name,Date startTime);
- /**
- * 在startTime時執行調試,endTime結束執行調度
- * @param startTime 調度開始時間
- * @param endTime 調度結束時間
- */
- void schedule(Date startTime,Date endTime);
- /**
- * 在startTime時執行調試,endTime結束執行調度
- * @param name Quartz SimpleTrigger 名稱
- * @param startTime 調度開始時間
- * @param endTime 調度結束時間
- */
- void schedule(String name,Date startTime,Date endTime);
- /**
- * 在startTime時執行調試,endTime結束執行調度,重復執行repeatCount次
- * @param startTime 調度開始時間
- * @param endTime 調度結束時間
- * @param repeatCount 重復執行次數
- */
- void schedule(Date startTime,Date endTime,int repeatCount);
- /**
- * 在startTime時執行調試,endTime結束執行調度,重復執行repeatCount次
- * @param name Quartz SimpleTrigger 名稱
- * @param startTime 調度開始時間
- * @param endTime 調度結束時間
- * @param repeatCount 重復執行次數
- */
- void schedule(String name,Date startTime,Date endTime,int repeatCount);
- /**
- * 在startTime時執行調試,endTime結束執行調度,重復執行repeatCount次,每隔repeatInterval秒執行一次
- * @param startTime 調度開始時間
- * @param endTime 調度結束時間
- * @param repeatCount 重復執行次數
- * @param repeatInterval 執行時間隔間
- */
- void schedule(Date startTime,Date endTime,int repeatCount,long repeatInterval) ;
- /**
- * 在startTime時執行調試,endTime結束執行調度,重復執行repeatCount次,每隔repeatInterval秒執行一次
- * @param name Quartz SimpleTrigger 名稱
- * @param startTime 調度開始時間
- * @param endTime 調度結束時間
- * @param repeatCount 重復執行次數
- * @param repeatInterval 執行時間隔間
- */
- void schedule(String name,Date startTime,Date endTime,int repeatCount,long repeatInterval);
- }
動態調度服務實現類:
- 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(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(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,在以前的靜態配置中
<bean id="jobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
<property name="targetObject" ref="simpleService" />
<property name="targetMethod" value="testMethod" />
</bean>
中使用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,如下:
- 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如下:
- 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){
- //這里執行定時調度業務
- logger.info(triggerName);
- }
- public void testMethod2(){
- logger.info("testMethod2");
- }
- }
SimpleService主要執行定時調度業務,在這里我只是簡單打印一下log日志。SimpleService需要實現java.io.Serializable接口,否則會報
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文件:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN 2.0//EN" "http://www.springframework.org/dtd/spring-beans-2.0.dtd">
<beans>
<bean name="quartzScheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
<property name="dataSource">
<ref bean="dataSource" />
</property>
<property name="applicationContextSchedulerContextKey" value="applicationContextKey" />
<property name="configLocation" value="classpath:quartz.properties"/>
</bean>
<bean id="jobDetail" class="org.springframework.scheduling.quartz.JobDetailBean">
<property name="jobClass">
<value>com.sundoctor.example.service.MyQuartzJobBean</value>
</property>
<property name="jobDataAsMap">
<map>
<entry key="simpleService">
<ref bean="simpleService" />
</entry>
</map>
</property>
</bean>
</beans>
quartzScheduler中沒有了
<property name="triggers">
<list>
...
</list>
/property>
配置,通過SchedulerService動態加入CronTrigger或SimpleTrigger。
在紅色的
<property name="jobDataAsMap">
<map>
<entry key="simpleService">
<ref bean="simpleService" />
</entry>
</map>
</property>
中需要注入調度業務類,否則會報空指指錯誤。
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
#org.quartz.jobStore.useProperties = true
org.quartz.jobStore.tablePrefix = QRTZ_
org.quartz.jobStore.isClustered = false
org.quartz.jobStore.maxMisfiresToHandleAtATime=1
這里面沒有數據源相關的配置部分,采用spring注入datasource的方式已經進行了配置。
六、測試
運行如下測試類
- 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 {
- /**
- * @param args
- */
- 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名稱打印出來。
這樣通過SchedulerService就可以動態配置調度時間。其實SchedulerService 還可擴展,比如可以注入多個JobDetail,調度不同的JobDetail。