Spring中正确使用Quartz和CronExpression

转载 http://xiaolele.iteye.com/blog/368922
关键字: spring中正确使用quartz和cronexpression
Quartz作为企业级任务调度框架以其灵活的使用方式、强大的功能已经得到广泛应用，作为一向喜欢将业内流行的工具纳入支持的Spring自然已经内置了对Quartz的支持，使得Quartz中最常使用的SimpleTrigger和CronTrigger的使用得到了最大简化，分别对应Spring的org.springframework.scheduling.quartz.SimpleTriggerBean和org.springframework.scheduling.quartz.CronTriggerBean，这两个类用起来非常方便，其中SimpleTrigger更类似于JDK中的Timer，它只是简单的以某个时间间隔来执行某个任务而已，比较简陋，而CronTrigger功能则十分强大，可以设定制定任务在任意指定时刻内调用，其使用Unix中的Cron Expression来制定调度策略，十分灵活，不过Cron Expression可能需要用点时间来学习，不过一旦掌握会觉得真的很不错，掌握了这两种Trigger基本上就可以应付实现大多数J2EE应用中的时间任务调度服务了。
     下面举一个简单例子说明一下在Spring1.2.5中使用Quartz1.5的方式（所需要的包在Spring1.2.5的发行版中的lib目录下可以找到，将其拷贝到工程的类路径中）。
     首先建立两个要调度的任务，他们都必须继承自org.springframework.scheduling.quartz.QuartzJobBean，而业务逻辑都是放在executeInternal方法中，指定的任务逻辑实现之后，需要将其注入到一个JobDetailBean中，JobDetailBean可以看作为一个具体任务的设置它指定了要执行的任务和执行任务的时间策略，JobDetailBean不用实现，只需要在Spring的配置文件中设置便可：
package com.peuo.albumSys.scheduling;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;
import org.apache.log4j.Logger;
import com.peuo.albumSys.business.IAlbumSysService;
import com.peuo.albumSys.domainobj.User;
import com.peuo.albumSys.domainobj.Album;

public class ScheduledQueryUsers extends QuartzJobBean {
     private static Logger log = Logger.getLogger(ScheduledQueryUsers.class);
   
     private IAlbumSysService service = null;
   
     public void setService(IAlbumSysService service) {
         this.service = service;
     }
   
   
     protected void executeInternal(JobExecutionContext ctx)
             throws JobExecutionException {
         log.debug("Now entering method executeInternal()...");
         List users = service.findAllUser();
         StringBuffer str = new StringBuffer();
         for(int i = 0; i < users.size(); i++){
             User user = (User)users.get(i);
             str.append("\nUser[" + i + "] = " + user.getUserName());
             Set albums = user.getAlbumSet();
             Iterator it = albums.iterator();
             str.append("(Albums:");
             while(it.hasNext()){
                 str.append(((Album)it.next()).getAlbumName()).append(";");
             }
         }
         log.debug(str.toString());
     }
}
 

package com.peuo.albumSys.scheduling;

import java.util.Date;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

import org.springframework.scheduling.quartz.QuartzJobBean;

import org.apache.log4j.Logger;

import com.peuo.albumSys.business.IAlbumSysService;
import com.peuo.albumSys.domainobj.Album;
import com.peuo.albumSys.domainobj.Photo;


public class ScheduledAddPhoto extends QuartzJobBean {
     private static Logger log = Logger.getLogger(ScheduledAddPhoto.class);
   
     private IAlbumSysService service = null;
     private static int count = 0;
   
     protected void executeInternal(JobExecutionContext arg0)
             throws JobExecutionException {
         Date now = new Date(System.currentTimeMillis());
         Photo newPhoto = new Photo();
         newPhoto.setAlbum(new Album(new Integer(1)));
         newPhoto.setPhotoName( now.toString());
         newPhoto.setPhotoUrl("Photo url" + ++count);
         service.addPhoto(newPhoto);
         log.debug("New photo added : name =" + newPhoto.getPhotoName() +"; url = " + newPhoto.getPhotoUrl());
     }

   
     public IAlbumSysService getService() {
         return service;
     }
   
     public void setService(IAlbumSysService service) {
         this.service = service;
     }
}
然后在Spring的配置文件中分别设置一个SimpleTriggerBean和CronTriggerBean来调用上面两个任务，配置如下：



<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">

<beans>

……………………………………………………………………………………………………

    <bean id="queryUserJob" class="org.springframework.scheduling.quartz.JobDetailBean">
     <property name="jobClass">
      <value>com.peuo.albumSys.scheduling.ScheduledQueryUsers</value>
     </property>
     <property name="jobDataAsMap">
      <map>
       <entry key="service">
        <ref local="albumSysService"/>
     </entry>
      </map>
     </property>
    </bean>
  
    <bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean">
     <property name="jobDetail">
      <ref local="queryUserJob"/>
     </property>
     <property name="startDelay">
      <value>15000</value>
     </property>
     <property name="repeatInterval">
      <value>60000</value>
     </property>
     <property name="repeatCount">
      <value>-1</value>
     </property>
    </bean>
  
<bean id="addPhotoJob" class="org.springframework.scheduling.quartz.JobDetailBean">
   <property name="jobClass">
    <value>com.peuo.albumSys.scheduling.ScheduledAddPhoto</value>
   </property>
<property name="jobDataAsMap">
    <map>
     <entry key="service">
      <ref local="albumSysService" />
     </entry>
    </map>
   </property>
</bean>

<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">
   <property name="jobDetail">
    <ref local="addPhotoJob"/>
   </property>
   <property name="cronExpression">
    <value>0 20 19 * * ?</value>
   </property>
</bean>

    <bean id="sfb" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
     <property name="triggers">
      <list>
       <ref local="simpleTrigger"/>
     <ref local="cronTrigger"/>
      </list>
     </property>
    </bean>

上面红色标出的部分可以看出，Spring对于将QuartzJob注入JobDetailBean的方式有点特殊，你需要将要注入给QuartzJob的某个属性注入到JobDetailBean的jobDataAsMap中，这不同于Spring平时直接对某个Bean的属性直接注入的方式，这主要是因为Quartz执行一个任务（JOB或者叫作业）的时候会提供给任务一个JobExecutionContext的任务执行上下文，从这个上下文中可以获得Job的环境设置，具体的可以看一下Quartz的API文档就明白了，反正只要记住这里的注入方式比较特殊就行了。

以上配置文件分别设置了一个SimpleTriggerBean和CronTriggerBean，前者将会在程序执行15秒之后开始不断以间隔一分钟的方式不断查询当前用户信息并显示出来，后者则指定每天的19：20分执行向ID为1的用户的相册内添加一张照片的任务，其Cron Expression为0 20 19 * * ?。

从以上可以看出，Spring大大简化了对Quartz任务时间调度框架的使用，将其完美的融合入了Spring提供的IoC容器，只是其注入方式需要注意，还有就是Cron Expression一定要掌握，这个是Quartz真正的强大之处。

 

网上似乎对Cron表达式的中文介绍相当少，我干脆就把Quartz中的doc翻译一下，各位需要的朋友可以快速了解一下大致用法：

一个Cron-表达式是一个由六至七个字段组成由空格分隔的字符串，其中6个字段是必须的而一个是可选的，如下：

字段名    允许的值    允许的特殊字符
秒    0-59    , - * /
分    0-59    , - * /
小时    0-23    , - * /
日    1-31    , - * ? / L W C
月    1-12 or JAN-DEC    , - * /
周几    1-7 or SUN-SAT    , - * ? / L C #
年 (可选字段)    empty, 1970-2099    , - * /



'*' 字符可以用于所有字段，在“分”字段中设为"*"表示"每一分钟"的含义。

'?' 字符可以用在“日”和“周几”字段. 它用来指定 '不明确的值'. 这在你需要指定这两个字段中的某一个值而不是另外一个的时候会被用到。在后面的例子中可以看到其含义。

'-' 字符被用来指定一个值的范围，比如在“小时”字段中设为"10-12"表示"10点到12点".

',' 字符指定数个值。比如在“周几”字段中设为"MON,WED,FRI"表示"the days Monday, Wednesday, and Friday".

'/' 字符用来指定一个值的的增加幅度. 比如在“秒”字段中设置为"0/15"表示"第0, 15, 30, 和 45秒"。而 "5/15"则表示"第5, 20, 35, 和 50". 在'/'前加"*"字符相当于指定从0秒开始. 每个字段都有一系列可以开始或结束的数值。对于“秒”和“分”字段来说，其数值范围为0到59，对于“小时”字段来说其为0到23, 对于“日”字段来说为0到31, 而对于“月”字段来说为1到12。"/"字段仅仅只是帮助你在允许的数值范围内从开始"第n"的值。 因此对于“月”字段来说"7/6"只是表示7月被开启而不是“每六个月”, 请注意其中微妙的差别。

'L'字符可用在“日”和“周几”这两个字段。它是"last"的缩写, 但是在这两个字段中有不同的含义。例如,“日”字段中的"L"表示"一个月中的最后一天" —— 对于一月就是31号对于二月来说就是28号（非闰年）。而在“周几”字段中, 它简单的表示"7" or "SAT"，但是如果在“周几”字段中使用时跟在某个数字之后, 它表示"该月最后一个星期×" —— 比如"6L"表示"该月最后一个周五"。当使用'L'选项时,指定确定的列表或者范围非常重要，否则你会被结果搞糊涂的。

'W' 可用于“日”字段。用来指定历给定日期最近的工作日(周一到周五) 。比如你将“日”字段设为"15W"，意为: "离该月15号最近的工作日"。因此如果15号为周六，触发器会在14号即周五调用。如果15号为周日, 触发器会在16号也就是周一触发。如果15号为周二,那么当天就会触发。然而如果你将“日”字段设为"1W", 而一号又是周六, 触发器会于下周一也就是当月的3号触发,因为它不会越过当月的值的范围边界。'W'字符只能用于“日”字段的值为单独的一天而不是一系列值的时候。

'L'和'W'可以组合用于“日”字段表示为'LW'，意为"该月最后一个工作日"。

'#' 字符可用于“周几”字段。该字符表示“该月第几个周×”，比如"6#3"表示该月第三个周五( 6表示周五而"#3"该月第三个)。再比如: "2#1" = 表示该月第一个周一而 "4#5" = 该月第五个周三。注意如果你指定"#5"该月没有第五个“周×”，该月是不会触发的。

'C' 字符可用于“日”和“周几”字段，它是"calendar"的缩写。它表示为基于相关的日历所计算出的值（如果有的话）。如果没有关联的日历, 那它等同于包含全部日历。“日”字段值为"5C"表示"日历中的第一天或者5号以后"，“周几”字段值为"1C"则表示"日历中的第一天或者周日以后"。

对于“月份”字段和“周几”字段来说合法的字符都不是大小写敏感的。

下面是一些完整的例子:

表达式    含义
"0 0 12 * * ?"    每天中午十二点触发
"0 15 10 ? * *"    每天早上10：15触发
"0 15 10 * * ?"    每天早上10：15触发
"0 15 10 * * ? *"    每天早上10：15触发
"0 15 10 * * ? 2005"    2005年的每天早上10：15触发
"0 * 14 * * ?"    每天从下午2点开始到2点59分每分钟一次触发
"0 0/5 14 * * ?"    每天从下午2点开始到2：55分结束每5分钟一次触发
"0 0/5 14,18 * * ?"    每天的下午2点至2：55和6点至6点55分两个时间段内每5分钟一次触发
"0 0-5 14 * * ?"    每天14:00至14:05每分钟一次触发
"0 10,44 14 ? 3 WED"    三月的每周三的14：10和14：44触发
"0 15 10 ? * MON-FRI"    每个周一、周二、周三、周四、周五的10：15触发
"0 15 10 15 * ?"    每月15号的10：15触发
"0 15 10 L * ?"    每月的最后一天的10：15触发
"0 15 10 ? * 6L"    每月最后一个周五的10：15触发
"0 15 10 ? * 6L"    每月最后一个周五的10：15触发
"0 15 10 ? * 6L 2002-2005"    2002年至2005年的每月最后一个周五的10：15触发
"0 15 10 ? * 6#3"    每月的第三个周五的10：15触发



请注意'?' 和'*' 在“日”和“周几”字段中的用法!