Spring+Quartz实现定时任务(转)

转自：http://blog.csdn.net/u010397369/article/details/17465649

在我们进行软件项目开发的过程中，相信大家在很多时候都会遇到如下业务场景：每天、每周或每月生成相应的业务报表；每天统计系统注册人数；定期清理平台长久不登录的用户等等。遇到这种业务场景需要怎样去处理？人为定时去数据库操作来统计？别开玩笑了，这种事情哪用得着人来做，如果像这种任务还需要专人每天都去做统计，那估计很多人就要疯掉了。针对于这种业务情况，采用定时任务是个非常不错的选择。在Java领域中，定时任务的开源工具也非常多，小到一个Timer类，大到Quartz框架。总体来说，个人比较喜欢的还是Quartz，功能强大而且使用方便。接下来我们就看一下如何通过spring和Quartz来实现业务系统中的定时任务。

Spring整合Quartz实现定时任务步骤很简单，大致需要经过如下几步：创建任务（Job）、配置JobDetail、配置触发器（Trigger）、配置SchedulerFactoryBean

好了，废话不多说了，下面进入正题。

首先使用Maven创建一个web项目并引入Spring和quartz的依赖（习惯使用这种开发模式了，当然不使用Maven也可以）
需要引入的依赖包如下：

[html]  view plain  copy

 

 

1. <dependency>  
2.     <groupId>org.springframework</groupId>  
3.     <artifactId>spring-context</artifactId>  
4.     <version>3.2.6.RELEASE</version>  
5. </dependency>  
6. <dependency>  
7.     <groupId>org.springframework</groupId>  
8.     <artifactId>spring-context-support</artifactId>  
9.     <version>3.2.6.RELEASE</version>  
10. </dependency>  
11. <dependency>  
12.     <groupId>org.springframework</groupId>  
13.     <artifactId>spring-web</artifactId>  
14.     <version>3.2.6.RELEASE</version>  
15. </dependency>  
16. <dependency>  
17.     <groupId>org.springframework</groupId>  
18.     <artifactId>spring-tx</artifactId>  
19.     <version>3.2.6.RELEASE</version>  
20. </dependency>  
21. <dependency>  
22.     <groupId>org.quartz-scheduler</groupId>  
23.     <artifactId>quartz</artifactId>  
24.     <version>2.2.1</version>  
25. </dependency>  
26. <dependency>  
27.     <groupId>org.quartz-scheduler</groupId>  
28.     <artifactId>quartz-jobs</artifactId>  
29.     <version>2.2.1</version>  
30. </dependency>  

此处我们使用的是Spring3.2.6+Quartz2.2.1版本进行实验。
增加完Spring和Quartz的依赖包之后，就需要创建Spring配置文件，并在web.xml文件中引入Spring支持。

[html]  view plain  copy

 

 

1. <listener>  
2.     <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
3. </listener>  
4. <context-param>  
5.     <param-name>contextConfigLocation</param-name>  
6.     <param-value>/WEB-INF/classes/applicationContext.xml</param-value>  
7. </context-param>  

好了，到现在为止，基本的环境算是搭建好了，接下来我们就要开始Spring+Quartz实现定时任务了。

一、创建任务（Job）

 

Spring+Quartz实现Job有两种方式：一种是继承org.springframework.scheduling.quartz.QuartzJobBean类来实现Job任务，并实现里面的抽象方法executeInternal；另一种是不继承任何类，创建普通的Java类，然后自己指定任务的执行方法（个人感觉此种方式较好，实现起来方便而且大大降低了系统的业务的耦合性）。

我们先来看一下继承QuartzJobBean类的这种形式，创建一个任务类ExampleJob，具体代码如下：

 

[java]  view plain  copy

 

 

1. package com.mhy.quartz;  
2. /** 
3.  * 继承QuartzJobBean形式的定时任务 
4.  */  
5.   
6.   
7. import java.text.SimpleDateFormat;  
8. import java.util.Date;  
9.   
10. import org.quartz.JobExecutionContext;  
11. import org.quartz.JobExecutionException;  
12. import org.springframework.scheduling.quartz.QuartzJobBean;  
13.   
14. /** 
15.  * @author [email protected] 
16.  * @date 2013年12月21日 
17.  */  
18. public class ExampleJob extends QuartzJobBean {  
19.       
20.     private int timeout;  
21.   
22.     @Override  
23.     protected void executeInternal(JobExecutionContext context)  
24.             throws JobExecutionException {  
25.         System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + "执行ExampleJob的定时任务");  
26.     }  
27.       
28.     public int getTimeout() {  
29.         return timeout;  
30.     }  
31.   
32.     public void setTimeout(int timeout) {  
33.         this.timeout = timeout;  
34.     }  
35.   
36. }  

为了演示方便，executeInternal方法中没有写复杂的业务逻辑，只简单的输出一句话，真正的生产环境中在该方法中实现你所需要的业务逻辑即可。

 

二、在Spring配置文件中配置JobDetail

 

[html]  view plain  copy

 

 

1. <bean name="exampleJobDetail" class="org.springframework.scheduling.quartz.JobDetailBean">  
2.     <property name="jobClass" value="com.mhy.quartz.ExampleJob" />  
3.     <property name="jobDataAsMap">  
4.         <map>  
5.             <entry key="timeout" value="5" />  
6.         </map>  
7.     </property>  
8. </bean>  

 

三、配置触发器（Trigger）

Spring提供了两种触发器，如下：
1、org.springframework.scheduling.quartz.SimpleTriggerFactoryBean（此种方式是很隔多长时间进行触发一次，比如每隔24小时触发一次）
2、org.springframework.scheduling.quartz.CronTriggerFactoryBean（此种方式是在指定的时间进行触发，比如只在周一进行触发。不过根据配置也很方便的实现类似SimpleTriggerFactoryBean形式的定时任务）
Spring所提供的这两种触发器方式和前面提到的任务创建方式均可以相互之间混用，很灵活。
这里我们先使用SimpleTriggerFactoryBean这个trigger来配置

 

[html]  view plain  copy

 

 

1. <bean id="exampleJobTrigger"  
2.     class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean">  
3.     <property name="jobDetail" ref="exampleJobDetail" />  
4.     <!-- 延迟触发时间，延迟10秒进行触发 -->  
5.     <property name="startDelay" value="10000" />  
6.     <!-- 重复触发的时间间隔，5秒 -->  
7.     <property name="repeatInterval" value="5000" />  
8. </bean>  

四、配置SchedulerFactoryBean

[html]  view plain  copy

 

 

1. <bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">  
2.     <property name="triggers">  
3.         <list>  
4.             <ref bean="exampleJobTrigger" />  
5.         </list>  
6.     </property>  
7. </bean>  

好了，到现在为止，一个简单的定时任务就完成了，下面我们来启动一下web项目，看运行结果如何。

 

很不幸的是运行失败了，这是为啥呢？别着急，慢慢看看异常信息（学会分析异常信息也是程序员重要的能力之一噢）。从异常信息中我们可以看出，JobDetailBean引用了一个接口来作为父类了。既然是这样的话，那我们就需要看一下JobDetailBean的源码了。

从源码中我们可以看到Spring的JobDetailBean继承了Quartz的JobDetail，接下来我们就要看Quartz的JobDetail这个源码了。

在Quartz中JobDetail竟然是一个接口。是不是搞错了，你肯定要问了。这是为什么呢，为什么呢，为什么呢？哈哈，这个就得谈到Quartz的历史问题了。Quartz从1.X升级到2.X之后，JobDetail由类修改为接口了，为啥要改？那你得去问Quartz作者了，嘿嘿。那如果再继续采用这种模式的话那肯定会错喽。那我们对它就没有法子了么？怎么可能。处理它很简单啊：一、把Quartz降到1.X版本；二、更改Job的实现方式。

首先我们来试试使用1.X版本的Quartz

可以看到在Quartz1.X版本中，JobDetail还是一个类。接下来我们再启动一下web项目看看运行结果何如。

可以看到，在更换Quartz版本为1.X之后，定时任务正常运行了。

看到这，想必大家就要问了，其他方式呢，总不能让我们一直使用Quartz1.X版本吧？当然不是，我们还有很多办法，大家慢慢往下看。

第二部分：实现Spring3+Quartz2的定时任务。

首先创建一个基本的Java类来做为Job任务类，代码如下：

 

[java]  view plain  copy

 

 

1. /** 
2.  * 单独Job类形式 
3.  */  
4. package com.mhy.quartz;  
5.   
6. import java.text.SimpleDateFormat;  
7. import java.util.Date;  
8.   
9. /** 
10.  * @author [email protected] 
11.  * @date 2013年12月21日 
12.  */  
13. public class ExampleJob2 {  
14.   
15.     /** 
16.      * 执行定时统计任务 
17.      * 自行指定方法 
18.      */  
19.     public void execute(){  
20.         System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + "执行ExampleJob2");  
21.     }  
22. }  

接下来是在Spring配置文件中配置JobDetail、Trigger、SchedulerFactoryBean

 

 

[html]  view plain  copy

 

 

1. <bean id="exampleJob2" class="com.mhy.quartz.ExampleJob2"></bean>  
2. <bean id="exampleJob2Detail"  
3.     class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">  
4.     <!-- 指定任务类 -->  
5.     <property name="targetObject" ref="exampleJob2" />  
6.     <!-- 指定任务执行的方法 -->  
7.     <property name="targetMethod" value="execute" />  
8. </bean>  
9. <bean id="exampleJob2Trigger"  
10.     class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">  
11.     <property name="jobDetail" ref="exampleJob2Detail" />  
12.     <!-- 每10秒运行一次 -->  
13.     <property name="cronExpression" value="0/10 * * * * ?" />  
14. </bean>  
15.   
16. <bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">  
17.     <property name="triggers">  
18.         <list>  
19.             <!-- <ref bean="exampleJobTrigger" /> -->  
20.             <ref bean="exampleJob2Trigger" />  
21.         </list>  
22.     </property>  
23. </bean>  

好了，配置完之后我们再启动一下程序，看看定时任务时否运行良好（这里我们使用的Trigger是CronTriggerFactoryBean，当然也可以使用SimpleTriggerFactoryBean）

关于Trigger中时间如何配置，quartz官网描述的很清楚，大家可以参考如下网址：http://quartz-scheduler.org/documentation/quartz-2.2.x/tutorials/crontrigger

 

OK，没有问题，好了，关于Spring+Quartz实现定时任务暂就告一段落，欢迎大家多多交流，有不当之后还请大家指正出来。
本示例对应的代码下载地址为：http://download.csdn.net/detail/u010397369/6807997