概述
各种企业应用几乎都会碰到任务调度的需求,就拿论坛来说:每隔半个小时生成精华文章的RSS文件,每天凌晨统计论坛用户的积分排名,每隔30分钟执行锁定 用户解锁任务。对于一个典型的MIS系统来说,在每月1号凌晨统计上个月各部门的业务数据生成月报表,每半个小时查询用户是否已经有快到期的待处理业 务……,这样的例子俯拾皆是,不胜枚举。
Quartz 在开源任务调度框架中的翘首,它提供了强大任务调度机制,难能可贵的是它同时保持了使用的简单性。Quartz 允许开发人员灵活地定义触发器的调度时间表,并可以对触发器和任务进行关联映射。此外,Quartz提供了调度运行环境的持久化机制,可以保存并恢复调度 现场,即使系统因故障关闭,任务调度现场数据并不会丢失。此外,Quartz还提供了组件式的侦听器、各种插件、线程池等功能。
Spring为创建Quartz的Scheduler、Trigger和JobDetail提供了便利的FactoryBean类,以便能够在 Spring 容器中享受注入的好处。此外Spring还提供了一些便利工具类直接将Spring中的Bean包装成合法的任务。Spring进一步降低了使用 Quartz的难度,能以更具Spring风格的方式使用Quartz。概括来说它提供了两方面的支持:
1)为Quartz的重要组件类提供更具Bean风格的扩展类;
2)提供创建Scheduler的BeanFactory类,方便在Spring环境下创建对应的组件对象,并结合Spring容器生命周期进行启动和停止的动作。
创建JobDetail
你可以直接使用Quartz的JobDetail在Spring中配置一个JobDetail Bean,但是JobDetail使用带参的构造函数,对于习惯通过属性配置的Spring用户来说存在使用上的不便。为此Spring通过扩展 JobDetail提供了一个更具Bean风格的JobDetailBean。此外,Spring提供了一个 MethodInvokingJobDetailFactoryBean,通过这个FactoryBean可以将Spring容器中Bean的方法包装成 Quartz任务,这样开发者就不必为Job创建对应的类。
JobDetailBean
JobDetailBean扩展于Quartz的JobDetail。使用该Bean声明JobDetail时,Bean的名字即是任务的名字,如果没有指定所属组,即使用默认组。除了JobDetail中的属性外,还定义了以下属性:
● jobClass:类型为Class,实现Job接口的任务类;
● beanName:默认为Bean的id名,通过该属性显式指定Bean名称,它对应任务的名称;
● jobDataAsMap:类型为Map,为任务所对应的JobDataMap提供值。之所以需要提供这个属性,是因为除非你手工注册一 个编辑器,你不能直接配置JobDataMap类型的值,所以Spring通过jobDataAsMap设置JobDataMap的值;
●applicationContextJobDataKey:你可以将Spring ApplicationContext的引用保存到JobDataMap中,以便在Job的代码中访 问ApplicationContext。为了达到这个目的,你需要指定一个键,用以在jobDataAsMap中保存 ApplicationContext,如果不设置此键,JobDetailBean就不将ApplicationContext放入到 JobDataMap中;
●jobListenerNames:类型为String[],指定注册在Scheduler中的JobListeners名称,以便让这些监听器对本任务的事件进行监听。
下面配置片断使用JobDetailBean在Spring中配置一个JobDetail:
< bean name = " jobDetail " class = " org.springframework.scheduling.quartz.JobDetailBean " >
< property name = " jobClass " value = " com.baobaotao.quartz.MyJob " />
< property name = " jobDataAsMap " > ①
< map >
< entry key = " size " value = " 10 " />
</ map >
</ property >
< property name = " applicationContextJobDataKey " value = " applicationContext " /> ②
</ bean >
![]()
这样,MyJob在运行时就可以通过JobDataMap访问到size和ApplicationContext了。来看一下MyJob的代码,如代码清单 8所示:
代码清单 8 MyJob
package com.baobaotao.quartz;
…
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.context.ApplicationContext;
public class MyJob implements Job {
public void execute(JobExecutionContext jctx) throws JobExecutionException {
Map dataMap = jctx.getJobDetail().getJobDataMap();①获取JobDetail关联的JobDataMap
String size = (String)dataMap. get ( " size " );②
ApplicationContext ctx = (ApplicationContext)dataMap. get ( " applicationContext " );③
System. out .println( " size: " + size);
dataMap.put( " size " ,size + " 0 " );④对JobDataMap所做的更改是否被会持久,取决于任务的类型
// do sth...
}
}
![]()
MethodInvokingJobDetailFactoryBean
通常情况下,任务都定义在一个业务类方法中。这时,为了满足Quartz Job接口的规定,还需要定义一个引用业务类方法的实现类。为了避免创建这个只包含一行调用代码的Job实现类,Spring为我们提供了 MethodInvokingJobDetailFactoryBean,借由该FactoryBean,我们可以将一个Bean的某个方法封装成满足 Quartz要求的Job。来看一个具体的例子:
< bean id = " jobDetail_1 "
class = " org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean " >
< property name = " targetObject " ref = " myService " /> ① 引用一个Bean
< property name = " targetMethod " value = " doJob " /> ② 指定目标Bean的方法
< property name = " concurrent " value = " false " /> ③ 指定最终封装出的任务是否有状态
< bean id = " myService " class = " com.baobaotao.service.MyService " />
![]()
MyService服务类拥有一个doJob()方法,它的代码如下所示:
package com.baobaotao.service;
public class MyService {
public void doJob() {①被封装成任务的目标方法
System. out .println( " in MyService.dojob(). " );
}
}
![]()
Quartz中另一个重要的组件就是Trigger,Spring按照相似的思路分别为SimpleTrigger和CronTrigger提供了更具 Bean风格的SimpleTriggerBean和CronTriggerBean扩展类,通过这两个扩展类更容易在Spring中以Bean的方式配 置Trigger。
SimpleTriggerBean
默认情况下,通过SimpleTriggerBean配置的Trigger名字即为Bean的名字,并属于默认组Trigger组。SimpleTriggerBean在SimpleTrigger的基础上,新增了以下属性:
● jobDetail:对应的JobDetail;
● beanName:默认为Bean的id名,通过该属性显式指定Bean名称,它对应Trigger的名称;
● jobDataAsMap:以Map类型为Trigger关联的JobDataMap提供值;
● startDelay:延迟多少时间开始触发,单位为毫秒,默认为0;
● triggerListenerNames:类型为String[],指定注册在Scheduler中的TriggerListener名称,以便让这些监听器对本触发器的事件进行监听。
下面的实例使用SimpleTriggerBean定义了一个Trigger,该Trigger和jobDetail相关联,延迟10秒后启动,时间间隔为20秒,重复执行100次。此外,我们还为Trigger设置了JobDataMap数据:
< bean id = " simpleTrigger " class = " org.springframework.scheduling.quartz.SimpleTriggerBean " >
< property name = " jobDetail " ref = " jobDetail " />
< property name = " startDelay " value = " 1000 " />
< property name = " repeatInterval " value = " 2000 " />
< property name = " repeatCount " value = " 100 " />
< property name = " jobDataAsMap " > ①
< map >
< entry key = " count " value = " 10 " />
</ map >
</ property >
</ bean >
![]()
package com.baobaotao.quartz;
…
public class MyJob implements StatefulJob {
public void execute(JobExecutionContext jctx) throws JobExecutionException {
Map dataMap = jctx.getTrigger().getJobDataMap();①获取Trigger的JobDataMap
String count = dataMap. get ( " count " );
dataMap.put(“count”,” 30 ”) ② 对JobDataMap的更改不会被持久,不影响下次的执行
…
}
}
![]()
CronTriggerBean扩展于CronTrigger,触发器的名字即为Bean的名字,保存在默认组中。在CronTrigger的基础上,新 增的属性和SimpleTriggerBean大致相同,配置的方法也和SimpleTriggerBean相似,下面给出一个简单的例子:
< bean id = " checkImagesTrigger " class = " org.springframework.scheduling.quartz.CronTriggerBean " >
< property name = " jobDetail " ref = " jobDetail " />
< property name = " cronExpression " value = " 0/5 * * * * ? " />
</ bean >
![]()
创建Scheduler
Quartz的SchedulerFactory是标准的工厂类,不太适合在Spring环境下使用。此外,为了保证Scheduler能够感知 Spring容器的生命周期,完成自动启动和关闭的操作,必须让Scheduler和Spring容器的生命周期相关联。以便在Spring容器启动后, Scheduler自动开始工作,而在Spring容器关闭前,自动关闭Scheduler。为此,Spring提供 SchedulerFactoryBean,这个FactoryBean大致拥有以下的功能:
1)以更具Bean风格的方式为Scheduler提供配置信息;
2)让Scheduler和Spring容器的生命周期建立关联,相生相息;
3)通过属性配置部分或全部代替Quartz自身的配置文件。
来看一个SchedulerFactoryBean配置的例子:
代码清单 9 SchedulerFactoryBean配置
< bean id = " scheduler " class = " org.springframework.scheduling.quartz.SchedulerFactoryBean " >
< property name = " triggers " > ①注册多个Trigger
< list >
< ref bean = " simpleTrigger " />
</ list >
</ property >
< property name = " schedulerContextAsMap " > ②以Map类型设置SchedulerContext数据
< map >
< entry key = " timeout " value = " 30 " />
</ map >
</ property >
![]()
<property name="configLocation" value="classpath:com/baobaotao/quartz/quartz.properties" />
</bean>
SchedulerFactoryBean的triggers属性为Trigger[]类型,可以通过该属性注册多个Trigger,在①处,我们注册了 一个Trigger。Scheduler拥有一个类似于ServletContext的SchedulerContext。 SchedulerFactoryBean允许你以Map的形式设置SchedulerContext的参数值,如②所示。默认情况下,Quartz在类 路径下查询quartz.properties配置文件,你也可以通过configLocation属性显式指定配置文件位置,如③所示。
除了实例中所用的属性外,SchedulerFactoryBean还拥有一些常见的属性:
●calendars:类型为Map,通过该属性向Scheduler注册Calendar;
●jobDetails:类型为JobDetail[],通过该属性向Scheduler注册JobDetail;
●autoStartup:SchedulerFactoryBean在初始化后是否马上启动Scheduler,默认为true。如果设置为false,需要手工启动Scheduler;
●startupDelay:在SchedulerFactoryBean初始化完成后,延迟多少秒启动Scheduler,默认为0,表示马上启动。如 果并非马上拥有需要执行的任务,可通过startupDelay属性让Scheduler延迟一小段时间后启动,以便让Spring能够更快初始化容器中 剩余的Bean。
●dataSource:当需要使用数据库来持久化任务调度数据时,你可以在Quartz中配置数据源,也可以直接在Spring中通过 dataSource指定一个Spring管理的数据源。如果指定了该属性,即使quartz.properties中已经定义了数据源,也会被此 dataSource覆盖;
●transactionManager:可以通过该属性设置一个Spring事务管理器。在设置dataSource时,Spring强烈推荐你使用一个事务管理器,否则数据表锁定可能不能正常工作;
●nonTransactionalDataSource:在全局事务的情况下,如果你不希望Scheduler执行化数据操作参与到全局事务中,则可以通过该属性指定数据源。在Spring本地事务的情况下,使用dataSource属性就足够了;
●quartzProperties:类型为Properties,允许你在Spring中定义Quartz的属性。其值将覆盖 quartz.properties配置文件中的设置,这些属性必须是Quartz能够识别的合法属性,在配置时,你可以需要查看Quartz的相关文 档。下面是一个配置quartzProperties属性的例子:
< bean id = " scheduler " class = " org.springframework.scheduling.quartz.SchedulerFactoryBean " >
…
< property name = " quartzProperties " >
< props >
< prop key = " org.quartz.threadPool.class " > ①Quartz属性项1
org.quartz.simpl.SimpleThreadPool
</ prop >
< prop key = " org.quartz.threadPool.threadCount " > 10 </ prop > ①Quartz属性项2
</ props >
</ property >
</ bean >
![]()
小结
Spring为Quartz的JobDetail和Trigger提供了更具Bean风格的支持类,这使我们能够更地方便地在Spring中通过配置定制 这些组件实例。Spring的SchedulerFactoryBean让我们可以脱离Quartz自身的配置体系,而以更具Spring风格的方式定义 Scheduler。此外,还可以享受Scheduler生命周期和Spring 容器生命周期绑定的好处。