Spring下使用Quartz任务调度

Spring下使用Quartz任务调度

先介绍一下Quartz
Quartz是一个功能强大的任务调度器,可以任意指定周期性的任务,还可以支持将任务存储到数据库中.
Quartz实现任务调度的几个关键概念:
(1) Job:定义一个任务,Job只管执行,不管什么时候执行,也不管执行多少次;
(2) Trigger:定义一个触发器,表示应当如何触发一个Job的执行,Quartz提供了许多简单的Trigger,可以实现某一时刻触发,周期性触发等多种触发方式,并且一个Job可以和多个Trigger关联,这样能更加灵活地执行Job.
(3) Scheduler:真正调度任务的调度器,通过scheduleJob(Job,Trigger)方法就把一个关联了Trigger的Job对象放入了调度器中执行.


在IDE中创建测试例子,本例子是实现日志发送
要导入spring.jar,quartz-1.6.4.jar包中;

Spring提供了两种方式来封装Quartz的Job
一种是直接派生自QuartzJobBean;
另一种是完全用最简单的POJO实现;


实现方式一:

我们先来看看直接派生自QuartzJobBean如何实现

实现方式一中的 步骤一
定义一个Report对象,如下:

package example.chapter9;

import java.util.Date;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;

public class Report extends QuartzJobBean {

    private String name;

    public void setName(String name) {
        this.name = name;
    }

    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        System.out.println("Send report to " + name + " at " + new Date());
        try {
            Thread.sleep(1000);
        }
        catch(InterruptedException e) {
            e.printStackTrace();
        }
    }

}

实现方式一中的 步骤二
在XML配置文件中将Report包装为JobDetailBean,如下:
    <bean id="reportJob" class="org.springframework.scheduling.quartz.JobDetailBean">
        <property name="jobClass" value="example.chapter9.Report" />
        <property name="jobDataAsMap">
            <map>
                <entry key="name" value="Micheal" />
            </map>
        </property>
    </bean>

    Spring会自动将jobDataMap属性中注入的Map按照key注入到Report对象的相应属性中


实现方式二:
再来看看另一种完全用最简单的POJO如何实现:

实现方式二中的 步骤一
设计一个检查磁盘空间的CheckDiskFreeSpace对象:

package example.chapter9;

import java.util.Date;

public class CheckDiskFreeSpace {

    public void check() {
        // get disk free space:
        long freeSpace = Math.random() > 0.5 ? 100000000 : 200000000;
        System.out.println("Check disk free space at " + new Date());
        if(freeSpace<100*1024*1024) { // <100MB
            System.out.println("Warning! Low disk free space...");
        }
    }
}

实现方式二 步骤二
其中check()方法是执行方法,下一步是在XML配置中将其也包装为JobDetailBean,如下:
    <bean id="checkDiskFreeSpace" class="example.chapter9.CheckDiskFreeSpace" />

    <bean id="checkDiskJob" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
        <property name="targetObject" ref="checkDiskFreeSpace" />
        <property name="targetMethod" value="check" />
        <property name="concurrent" value="false" />
    </bean>

    其中concurrent属性指定了这个checkDiskJob是否能同时执行,默认为true.若设置为false,如果当前有一个checkDiskJob正在执行,则不启动相同的checkDiskJob.如果一个Job执行时间较长,执行频率高,定义为false可以避免多个相同的Job同时执行.


步骤三
    下一步是定义Trigger,它定义了在何时触发Job的执行.
    Spring封装了两种常用的TriggerBean:
        一种是SimpleTriggerBean,可以周期性地执行Job;
        另一种是CronTriggerBean功能更为强大,能指定何时执行Job.
   
    为了让CheckDiskJob能每隔5分钟执行一次,配置如下
        <!-- 周期性运行checkDiskJob -->
        <bean id="repeatTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean">
        <property name="jobDetail" ref="checkDiskJob" />
        <!-- 1分钟后启动 -->
        <property name="startDelay" value="60000" />
        <!-- 5分钟检查一次 -->
        <property name="repeatInterval" value="300000" />
        </bean>


    为了让reportJob能在周一到周五中午12:00执行,配置如下:
        <!-- 定时运行reportJob -->
        <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">
        <property name="jobDetail" ref="reportJob" />
        <!-- 每周周一至周五中午12:00执行 -->
        <property name="cronExpression" value="0 0 12 ? * MON-FRI" />
        </bean>

步骤四
    在配置文件中加一下Scheduler,如下
        <!-- 启动调度器 -->

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


最后,编写一下main()文件启动测试
package example.chapter9;

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {

    public static void main(String[] args) {
        new ClassPathXmlApplicationContext("config.xml");
    }

}


config.xml配置文件完整内容如下

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd"
>
    <!-- Job -->

    <bean id="reportJob" class="org.springframework.scheduling.quartz.JobDetailBean">
        <property name="jobClass" value="example.chapter9.Report" />
        <property name="jobDataAsMap">
            <map>
                <entry key="name" value="Micheal" />
            </map>
        </property>
    </bean>

    <bean id="checkDiskFreeSpace" class="example.chapter9.CheckDiskFreeSpace" />

    <bean name="checkDiskJob" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
        <property name="targetObject" ref="checkDiskFreeSpace" />
        <property name="targetMethod" value="check" />
        <property name="concurrent" value="false" />
    </bean>

    <!-- Trigger -->

    <!-- 周期性运行checkDiskJob -->
    <bean id="repeatTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean">
        <property name="jobDetail" ref="checkDiskJob" />
        <!-- 1分钟后启动 -->
        <property name="startDelay" value="60000" />
        <!-- 5分钟检查一次 -->
        <property name="repeatInterval" value="300000" />
    </bean>

    <!-- 定时运行reportJob -->
    <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">
        <property name="jobDetail" ref="reportJob" />
        <!-- 每周周一至周五中午12:00执行 -->
        <property name="cronExpression" value="0 0 12 ? * MON-FRI" />
    </bean>

    <!-- 启动调度器 -->

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

</beans>




介绍一下cronExpression表达示的写法

一个cronExpression表达式是一个由六至七个字段组成由空格分隔的字符串，其中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/5 * * * ?"            每隔5分钟执行一次
"10 0/5 * * * ?"        每隔5分钟,在10秒时执行一次,如00:10,05:10
"0 30 10-12 ? * WED,FRI"    每周三和每五在10:30,11:30,12:30执行
"0 0/30 9-17 1-5,10 * ?"    每月1号到5号,以及10号这几天,每天从9:00到17:00每隔30分钟执行一次
"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触发