最新 Spring 4.2.2 集成 Quartz Scheduler 2.2.2 任务调度示例

参考http://blog.csdn.net/defonds/article/details/49496895

本文将演示如何通过 Spring 使用 Quartz Scheduler 进行任务调度。Spring 为简化 Quartz 的操作提供了相关支持类。
本文示例使用的相关工具如下：

• Spring 4.2.2 (发布于 2015 年 10 月)
• Quartz Scheduler 2.2.2 (发布于 2015 年 10 月)
• Maven 3
• JDK 1.7
• Eclipse Luna Service Release 1 (4.4.1)

步骤 1：新建 Maven 项目

这一步如果不知道怎么做可以参考博客《使用 Eclipse 的 Maven 2 插件开发一个 JEE 项目》。

步骤 2：第三方依赖包的引入

Maven pom.xml 编辑如下：

1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3. <modelVersion>4.0.0</modelVersion>
4. <groupId>settle</groupId>
5. <artifactId>spring-quartz</artifactId>
6. <version>1.0.0</version>
7. <packaging>jar</packaging>
8. <name>spring-quartz</name>
9. <url>http://maven.apache.org</url>
10. <properties>
11. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
12. <springframework.version>4.2.2.RELEASE</springframework.version>
13. <quartz.version>2.2.2</quartz.version>
14. </properties>
15. <dependencies>
16. <dependency>
17. <groupId>org.springframework</groupId>
18. <artifactId>spring-core</artifactId>
19. <version>${springframework.version}</version>
20. </dependency>
21. <dependency>
22. <groupId>org.springframework</groupId>
23. <artifactId>spring-context-support</artifactId>
24. <version>${springframework.version}</version>
25. </dependency>
26. <!-- Transaction dependency is required with Quartz integration -->
27. <dependency>
28. <groupId>org.springframework</groupId>
29. <artifactId>spring-tx</artifactId>
30. <version>${springframework.version}</version>
31. </dependency>
32. <!-- Quartz framework -->
33. <dependency>
34. <groupId>org.quartz-scheduler</groupId>
35. <artifactId>quartz</artifactId>
36. <version>${quartz.version}</version>
37. </dependency>
38. </dependencies>
39. </project>

步骤 3：Quartz Scheduler 配置作业

有两种方式在 Spring 中使用 Quartz 来配置一个作业。
A：使用 MethodInvokingJobDetailFactoryBean
这种方式在你想要调用特定 bean 的一个方法的时候很是方便，比另一种方法要简单的多。

1. <!-- For times when you just need to invoke a method on a specific object -->
2. <bean id="simpleJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
3. <property name="targetObject" ref="myBean" />
4. <property name="targetMethod" value="printMessage" />
5. </bean>

以上作业配置简单调用了 myBean 的 printMessage 方法，myBean 是一个简单的 POJO。
B：使用 JobDetailFactoryBean
如果你需要更高级的设置，需要给作业传递数据，想更加灵活的话就使用这种方式。

1. <!-- For times when you need more complex processing, passing data to the scheduled job -->
2. <bean name="firstComplexJobDetail"    class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
3. <property name="jobClass" value="com.defonds.scheduler.jobs.FirstScheduledJob" />
4. <property name="jobDataMap">
5. <map>
6. <entry key="anotherBean" value-ref="anotherBean" />
7. </map>
8. </property>
9. <property name="durability" value="true" />
10. </bean>

jobClass 关联到一个继承自 QuartzJobBean 的类，它实现了 Quartz 作业接口。调用到这个作业的时候，它的 executeInternal 将被执行。
jobDataMap 允许我们给相关作业 bean 传递一些数据。在这个例子里，我们将 ScheduledJob 将要使用到的 'anotherBean' 传递给它。
以下是引用 jobclass(FirstScheduledJob)的具体实现。
com.defonds.scheduler.jobs.FirstScheduledJob

1. /**
2. * File Name：ScheduledJob.java
3. *
4. * Copyright Defonds Corporation 2015
5. * All Rights Reserved
6. *
7. */
8. package com.defonds.scheduler.jobs;
9. import org.quartz.JobExecutionContext;
10. import org.quartz.JobExecutionException;
11. import org.springframework.scheduling.quartz.QuartzJobBean;
12. import com.defonds.scheduler.util.AnotherBean;
13. /**
14. *
15. * Project Name：spring-quartz
16. * Type Name：ScheduledJob
17. * Type Description：
18. * Author：Defonds
19. * Create Date：2015-10-29
20. * @version
21. *
22. */
23. public class FirstScheduledJob extends QuartzJobBean {
24. private AnotherBean anotherBean;
25. @Override
26. protected void executeInternal(JobExecutionContext arg0)
27. throws JobExecutionException {
28. System.out.println("I am FirstScheduledJob");
29. this.anotherBean.printAnotherMessage();
30. }
31. public void setAnotherBean(AnotherBean anotherBean) {
32. this.anotherBean = anotherBean;
33. }
34. }

步骤 4：配置 Quartz 调度时要使用到的触发器

触发器用来定义调度器何时将会执行你的调度任务的那个时间。有两种可能的触发器类型：
A：简单触发器，使用 SimpleTriggerFactoryBean
你可以定义作业的启动时间、触发器之间的延迟时间以及 repeatInterval(频率)。

1. <!-- Run the job every 2 seconds with initial delay of 1 second -->
2. <bean id="simpleTrigger"  class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean">
3. <property name="jobDetail" ref="simpleJobDetail" />
4. <property name="startDelay" value="1000" />
5. <property name="repeatInterval" value="2000" />
6. </bean>

B：计划触发器，使用 CronTriggerFactoryBean
这种类型更加灵活，允许你针对特定实例选择计划方案以及将来要执行的频率。

1. <!-- Run the job every 5 seconds -->
2. <bean id="cronTrigger"  class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
3. <property name="jobDetail" ref="firstComplexJobDetail" />
4. <!--<property name="cronExpression" value="0/5 * * ? * SAT-SUN" />-->
5. <property name="cronExpression" value="0/5 * * ? * *" />
6. </bean>

步骤 5：配置创建定配置 Quartz 调度器的 SchedulerFactoryBean

SchedulerFactoryBean 将 jobDetails 和 triggers 整合在一起以配置 Quartz 调度器。

1. <!-- Scheduler factory bean to glue together jobDetails and triggers to Configure Quartz Scheduler -->
2. <bean  class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
3. <property name="jobDetails">
4. <list>
5. <ref bean="simpleJobDetail" />
6. <ref bean="firstComplexJobDetail" />
7. <ref bean="secondComplexJobDetail" />
8. </list>
9. </property>
10. <property name="triggers">
11. <list>
12. <ref bean="simpleTrigger" />
13. <ref bean="cronTrigger" />
14. <ref bean="secondCronTrigger" />
15. </list>
16. </property>
17. </bean>

下面贴出我们示例的完整的上下文文件。
src/main/resources/quartz-context.xml

1. <?xml version="1.0" encoding="UTF-8"?>
2. <beans xmlns="http://www.springframework.org/schema/beans"
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
4. xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
5. http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">
6. <context:component-scan base-package="com.defonds.scheduler" />
7. <!-- For times when you just need to invoke a method on a specific object -->
8. <bean id="simpleJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
9. <property name="targetObject" ref="myBean" />
10. <property name="targetMethod" value="printMessage" />
11. </bean>
12. <!-- For times when you need more complex processing, passing data to the scheduled job -->
13. <bean name="firstComplexJobDetail"    class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
14. <property name="jobClass" value="com.defonds.scheduler.jobs.FirstScheduledJob" />
15. <property name="jobDataMap">
16. <map>
17. <entry key="anotherBean" value-ref="anotherBean" />
18. </map>
19. </property>
20. <property name="durability" value="true" />
21. </bean>
22. <!-- Always run at 20:00 everyday -->
23. <bean name="secondComplexJobDetail"    class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
24. <property name="jobClass" value="com.defonds.scheduler.jobs.SecondScheduledJob" />
25. <property name="durability" value="true" />
26. </bean>
27. <!-- Run the job every 2 seconds with initial delay of 1 second -->
28. <bean id="simpleTrigger"  class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean">
29. <property name="jobDetail" ref="simpleJobDetail" />
30. <property name="startDelay" value="1000" />
31. <property name="repeatInterval" value="2000" />
32. </bean>
33. <!-- Run the job every 5 seconds -->
34. <bean id="cronTrigger"  class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
35. <property name="jobDetail" ref="firstComplexJobDetail" />
36. <!--<property name="cronExpression" value="0/5 * * ? * SAT-SUN" />-->
37. <property name="cronExpression" value="0/5 * * ? * *" />
38. </bean>
39. <!-- Always run at 20:00 everyday -->
40. <bean id="secondCronTrigger"  class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
41. <property name="jobDetail" ref="secondComplexJobDetail" />
42. <property name="cronExpression" value="0 0 20 ? * *" />
43. </bean>
44. <!-- Scheduler factory bean to glue together jobDetails and triggers to Configure Quartz Scheduler -->
45. <bean  class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
46. <property name="jobDetails">
47. <list>
48. <ref bean="simpleJobDetail" />
49. <ref bean="firstComplexJobDetail" />
50. <ref bean="secondComplexJobDetail" />
51. </list>
52. </property>
53. <property name="triggers">
54. <list>
55. <ref bean="simpleTrigger" />
56. <ref bean="cronTrigger" />
57. <ref bean="secondCronTrigger" />
58. </list>
59. </property>
60. </bean>
61. </beans>

步骤 6：创建本文用到的几个简单 POJO 任务 Bean

com.defonds.scheduler.jobs.MyBean

1. /**
2. * File Name：MyBean.java
3. *
4. * Copyright Defonds Corporation 2015
5. * All Rights Reserved
6. *
7. */
8. package com.defonds.scheduler.jobs;
9. import org.springframework.stereotype.Component;
10. /**
11. *
12. * Project Name：spring-quartz
13. * Type Name：MyBean
14. * Type Description：
15. * Author：Defonds
16. * Create Date：2015-10-29
17. * @version
18. *
19. */
20. @Component("myBean")
21. public class MyBean {
22. public void printMessage() {
23. System.out.println("I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean");
24. }
25. }

com.defonds.scheduler.util.AnotherBean

1. /**
2. * File Name：AnotherBean.java
3. *
4. * Copyright Defonds Corporation 2015
5. * All Rights Reserved
6. *
7. */
8. package com.defonds.scheduler.util;
9. import org.springframework.stereotype.Component;
10. /**
11. *
12. * Project Name：spring-quartz
13. * Type Name：AnotherBean
14. * Type Description：
15. * Author：Defonds
16. * Create Date：2015-10-29
17. * @version
18. *
19. */
20. @Component("anotherBean")
21. public class AnotherBean {
22. public void printAnotherMessage(){
23. System.out.println("I am AnotherBean. I am called by Quartz jobBean using CronTriggerFactoryBean");
24. }
25. }

com.defonds.scheduler.jobs.SecondScheduledJob

1. /**
2. * File Name：SecondScheduledJob.java
3. *
4. * Copyright Defonds Corporation 2015
5. * All Rights Reserved
6. *
7. */
8. package com.defonds.scheduler.jobs;
9. import org.quartz.JobExecutionContext;
10. import org.quartz.JobExecutionException;
11. import org.springframework.scheduling.quartz.QuartzJobBean;
12. /**
13. *
14. * Project Name：spring-quartz
15. * Type Name：SecondScheduledJob
16. * Type Description：
17. * Author：Defonds
18. * Create Date：2015-10-29
19. * @version
20. *
21. */
22. public class SecondScheduledJob extends QuartzJobBean {
23. @Override
24. protected void executeInternal(JobExecutionContext arg0)
25. throws JobExecutionException {
26. System.out.println("I am SecondScheduledJob");
27. }
28. }

为了演示多个执行计划的一起调度，我们写了两个 JobDetailFactoryBean，于是就有了 SecondScheduledJob。

步骤 7：创建执行程序的 Main 类

1. /**
2. * File Name：AppMain.java
3. *
4. * Copyright Defonds Corporation 2015
5. * All Rights Reserved
6. *
7. */
8. package com.defonds.scheduler;
9. import org.springframework.context.support.AbstractApplicationContext;
10. import org.springframework.context.support.ClassPathXmlApplicationContext;
11. /**
12. *
13. * Project Name：spring-quartz
14. * Type Name：AppMain
15. * Type Description：
16. * Author：Defonds
17. * Create Date：2015-10-29
18. * @version
19. *
20. */
21. public class AppMain {
22. public static void main(String args[]){
23. AbstractApplicationContext context = new ClassPathXmlApplicationContext("quartz-context.xml");
24. }
25. }

这时整个项目目录结构如下图所示：

执行这个 Main 类，输出结果如下：
I am FirstScheduledJob
I am AnotherBean. I am called by Quartz jobBean using CronTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am FirstScheduledJob
I am AnotherBean. I am called by Quartz jobBean using CronTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am FirstScheduledJob
I am AnotherBean. I am called by Quartz jobBean using CronTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am FirstScheduledJob
I am AnotherBean. I am called by Quartz jobBean using CronTriggerFactoryBean
I am SecondScheduledJob
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am FirstScheduledJob
I am AnotherBean. I am called by Quartz jobBean using CronTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am FirstScheduledJob
I am AnotherBean. I am called by Quartz jobBean using CronTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean
可以看到，简单触发器调用的作业每隔两秒执行一次，而计划触发器一的则是每隔五秒钟执行一次，计划触发器二则是固定只执行了一次(晚上八点整，红色字体部分)。

后记

• 大多数情况下都会使用 JobDetailFactoryBean 进行任务调度配置；
• 每个 JobDetailFactoryBean 都有一个触发器与之匹配。配置多个调度计划，需要配置多个这种匹配对；
• 由触发器指向 JobDetailFactoryBean；

本文完整 Eclipse 下的开发项目示例已上传 CSDN 资源，有兴趣的朋友可以去下载下来参考：http://download.csdn.net/detail/defonds/9224893。

参考资料

• Spring 4 + Quartz Scheduler Integration Example