在Spring框架中集成Quartz实现任务调度

  在各种企业应用中经常遇到任务调度的需求，Sun JDK 本身提供的java.util.Timer和TimerTask提供了简单的调度功能，允许用户按照一个固定的时间间隔，周期运行任务。Quartz是开源任务调度运用最为广泛的框架，它提供了强大的任务调度机制，允许开发人员灵活地定义触发器的调度时间表，对触发器和任务进行关联映射，并且Quartz提供了调度运行环境的持久化机制，可以保存并恢复调度现场。

 

  1）Quartz中的一些核心概念

  Job：一接口，只有一个void excute (JobExecutionContext context) 方法，开发者可以通过实现该接口来定义运行任务，context提供了上下文的各种信息。

  JobDetail：接收一个Job实现类，在运行时通过newInstance()的反射机制实例化Job。

  Trigger：描述触发Job执行的时间触发规则。有SimpleTrigger和CronTrigger两个子类，其中CronTrigger定义更为灵活，通过Cron表达式定义各种复杂时间规则的调度方案。

  Scheduler：代表一个Quartz的独立运行容器，Trigger和JobDetail在Scheduler中注册，两者在Scheduler中拥有各自的组与名称，Trigger的组和名称必须唯一，JobDetail的组和名称也必须唯一。

 

  2）在Spring中集成Quartz

  Spring为创建Quartz的Scheduler、Trigger和JobDetail提供了便利的FactoryBean类以便在Spring容器中使用依赖注入的优点，此外Spring提供工具类可以直接将Spring中的Bean包装成合法的任务（Spring提供了一个MethodInvokingJobDetailFactoryBean，通过这个FactoryBean类可以将Spring容器中的Bean包装成Quartz任务），Spring进一步降低了Quartz的使用难度。

 

  3）一个简单的Demo

  a. 新建一Web项目，带入所需的Quartz包和Spring包，项目目录如图-1所示：

 

           图-1

  b. 配置web.xml

1. <?xml version="1.0" encoding="UTF-8"?>
2. <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
5.         http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
6.     <context-param>
7.         <param-name>contextConfigLocation</param-name>
8.         <param-value>classpath:/applicationContext.xml</param-value>
9.     </context-param>
10.     
11.     <listener>
12.         <listener-class>
13.             org.springframework.web.context.ContextLoaderListener
14.         </listener-class>
15.     </listener>
16.     <listener>
17.         <listener-class>
18.             org.springframework.web.util.IntrospectorCleanupListener
19.         </listener-class>
20.     </listener>
21.     <listener>
22.         <listener-class>
23.             org.springframework.web.context.request.RequestContextListener
24.         </listener-class>
25.     </listener>
26.     
27.     <welcome-file-list>
28.         <welcome-file>index.jsp</welcome-file>
29.     </welcome-file-list>
30. </web-app>

  c. 配置applicationContext.xml

1. <?xml version="1.0" encoding="UTF-8"?>
3. <beans xmlns="http://www.springframework.org/schema/beans"
4.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5.        xmlns:jee="http://www.springframework.org/schema/jee"
6.        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
7.            http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-2.0.xsd">
8.     
9.     <bean id="MyJobDetail" class="org.springframework.scheduling.quartz.JobDetailBean">
10.         <property name="jobClass" value="com.demo.quartz.MyJob"/>
11.         <property name="jobDataAsMap">
12.             <map>
13.                 <entry key="size" value="10"></entry>
14.             </map>
15.         </property>
16.         <property name="applicationContextJobDataKey" value="applicationContext"/>
17.     </bean>
18.     
19.     <bean id="MyJobScheduledTask" class="org.springframework.scheduling.quartz.CronTriggerBean">
20.         <property name="jobDetail" ref="MyJobDetail"/>
21.         <property name="cronExpression" value="0 19 10 6 * ? *"></property>
22.     </bean>
23.     
24.     <bean id="HiJobDetail" class="org.springframework.scheduling.quartz.JobDetailBean">
25.         <property name="jobClass" value="com.demo.quartz.HiJob"/>
26.         <property name="jobDataAsMap">
27.             <map>
28.                 <entry key="size" value="10"></entry>
29.             </map>
30.         </property>
31.         <property name="applicationContextJobDataKey" value="applicationContext"/>
32.     </bean>
33.     
34.     <bean id="HiJobScheduledTask" class="org.springframework.scheduling.quartz.SimpleTriggerBean">
35.         <property name="startDelay" value="10000"/>
36.         <property name="repeatInterval" value="2000"/>
37.         <property name="jobDetail" ref="HiJobDetail"/>
38.     </bean>
39.     
40.     <bean id="QuartzJobFactory" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
41.         <property name="triggers">
42.             <list>
43.                 <ref bean="MyJobScheduledTask"/>
44.                 <!--  <ref bean="HiJobScheduledTask"/> -->
45.             </list>
46.         </property>
47.         <!-- 设置是否Spring容器初始化后马上启动Scheduler，默认为true。如果设置为false则需要手工启动Scheduler -->
48.         <property name="autoStartup" value="true"/>
49.     </bean>
50.     
51. </beans>

  d. HiJob类

1. package com.demo.quartz;
3. import java.util.Date;
5. import org.quartz.Job;
6. import org.quartz.JobExecutionContext;
7. import org.quartz.JobExecutionException;
9. public class HiJob implements Job  {
11.     public void execute(JobExecutionContext context)
12.             throws JobExecutionException {
13.         System.out.println("This is HiJob, Run time is " + new Date());
14.     }
16. }

1. package com.demo.quartz;
3. import java.util.Date;
5. import org.quartz.Job;
6. import org.quartz.JobExecutionContext;
7. import org.quartz.JobExecutionException;
9. public class MyJob implements Job {
11.     public void execute(JobExecutionContext context)
12.             throws JobExecutionException {
13.         System.out.println("This is MyJob, Run time is " + new Date());
14.     }
16. }

  f. Client测试类

1. package com.demo.quartz;
3. import org.quartz.Scheduler;
4. import org.quartz.SchedulerException;
5. import org.springframework.context.ApplicationContext;
6. import org.springframework.context.support.ClassPathXmlApplicationContext;
8. public class Client {
10.     /**
11.      * @param args
12.      */
13.     public static void main(String[] args) {
14.         
15.         ApplicationContext context = 
16.             new ClassPathXmlApplicationContext("applicationContext.xml");
17.         Scheduler a = (Scheduler) context.getBean("QuartzJobFactory");
18.         try {
19.             a.start();
20.         } catch (SchedulerException e) {
21.             e.printStackTrace();
22.         }
23.     }
25. }

  在Spring中集成Quartz极大地方便了任务调度功能的实现，并且通过SchedulerFactoryBean能够和Spring容器的生命周期关联，在Spring容器启动时，启动调度器。

 

  e. MyJob类