Spring and Quartz

概述
    各种企业应用几乎都会碰到任务调度的需求，就拿论坛来说：每隔半个小时生成精华文章的 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>

 

    JobDetailBean 封装了MyJob 任务类，并为Job 对应JobDataMap 设置了一个size 的数据。此外，通过指定 applicationContextJobDataKey 让Job 的JobDataMap 持有Spring ApplicationContext 的引用。
这样，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...

}

}

 

在② 处获取size 值，在③ 处还可以根据键“applicationContext” 获取ApplicationContext ，有了 ApplicationContext 的引用，Job 就可以毫无障碍访问Spring 容器中的任何Bean 了。MyJob 可以在execute() 方法中 对JobDataMap 进行更改，如④ 所示。如果MyJob 实现Job 接口，这个更改对于下一次执行是不可见的，如果MyJob 实现 StatefulJob 接口，这种更改对下一次执行是可见的。

ethodInvokingJobDetailFactoryBean
    通常情况下，任务都定义在一个业务类方法中。这时，为了满足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"/>

 

    jobDetail_1 将MyService#doJob() 封装成一个任务，同时通过concurrent 属性指定任务的类型，默认情况下封装为无状态 的任务，如果希望目标封装为有状态的任务，仅需要将concurrent 设置为false 就可以了。Spring 通过名为concurrent 的属性指定 任务的类型，能够更直接地描述到任务执行的方式（有状态的任务不能并发执行，无状态的任务可并发执行），对于不熟悉Quartz 内部机制的用户来说，比起 statefule ，concurrent 显然更简明达意些。
MyService 服务类拥有一个doJob() 方法，它的代码如下所示：

package com.baobaotao.service;

public class MyService ...{

public void doJob()...{① 被封装成任务的目标方法

System.out.println("in MyService.dojob().");

}

}

 

    doJob() 方法即可以是static ，也可以是非static 的，但不能拥有方法入参。通过MethodInvokingJobDetailFactoryBean 产生的JobDetail 不能被序列化，所以不能被持久化到数据库 中的，如果希望使用持久化任务，则你只能创建正规的Quartz 的Job 实现类了。

创建Trigger
    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>

 

    需要特别注意的是，① 处配置的JobDataMap 是Trigger 的JobDataMap ，任务执行时必须通过以下方式获取配置的值：

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
    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>

 

    ③ 显式指定Quartz 的配置文件地址
   <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 。

●SchedulerFactoryBean 的一个重要功能是允许你将Quartz 配置文件中的信息转移到Spring 配置文件中，带来的好处是，配置信息的集中化管理，同时我们不必熟悉多种框架的配置文件结构。回忆一个Spring 集成JPA 、Hibernate 框架，就知道这是Spring 在集成第三方框架经常采用的招数之一。SchedulerFactoryBean 通过以下属性代替框架的自身配置文件：
    ●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>

 

    在实际应用中，我们并不总是在程序部署的时候就可能确定需要哪些任务，往往需要在运行期根据业务数据动态产生触发器和任务。你完全可以在运行期通过代码调用SchedulerFactoryBean 获取Scheduler 实例，进行动态的任务注册和调度。

    小结
    Spring 为Quartz 的JobDetail 和Trigger 提供了更具Bean 风格的支持类，这使我们能够更地方便地在Spring 中通过配置定制 这些组件实例。Spring 的SchedulerFactoryBean 让我们可以脱离Quartz 自身的配置体系，而以更具Spring 风格的方式定义 Scheduler 。此外，还可以享受Scheduler 生命周期和Spring 容器生命周期绑定的好处。