Quartz經典入門案列

1、Quartz簡介 

    Quartz是一個開放源碼項目，專一於任務調度器，提供了極爲普遍的特性如持久化任務，集羣和分佈式任務等。Spring對Quartz的集成與其對JDK Timer的集成在任務、觸發器和調度計劃的聲明式配置方面等都很是類似。 

    Quartz的核心由兩個接口和兩個類組成：Job和Scheduler接口，JobDetail和Trigger類。不一樣於JDK Timer，任務不是從實現一個Job接口的類實例開始運行，實際上Quartz在須要的時候才建立job類實例。能夠使用JobDetail類來包裝任 務狀態，並傳遞一個信息給Job，或在一個Job的屢次執行過程之間保存信息。 

2、Quartz任務調度 

1. 簡單任務調度 

    在Quartz中建立一個任務並執行，只須要實現Job接口類，在其execute()方法中處理你的業務邏輯。下面舉例說明。 

HelloWorldJob.java 

package com.learnworld.quartz;

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

public class HelloWorldJob implements Job {

    public void execute(JobExecutionContext context) throws JobExecutionException {
                  //實現你的業務邏輯
        System.out.println("Hello!");

    }
}

HelloScheduling.java 

package com.learnworld.quartz;

import java.util.Date;

import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SimpleTrigger;
import org.quartz.Trigger;
import org.quartz.impl.StdSchedulerFactory;

public class HelloScheduling {
    public static void main(String[] args) throws Exception {

        Scheduler scheduler = new StdSchedulerFactory().getScheduler();
        scheduler.start();

        JobDetail jobDetail = new JobDetail("helloWorldJob",
                Scheduler.DEFAULT_GROUP, HelloWorldJob.class);

        Trigger trigger = new SimpleTrigger("simpleTrigger",
                Scheduler.DEFAULT_GROUP, new Date(), null,
                SimpleTrigger.REPEAT_INDEFINITELY, 1000);

        scheduler.scheduleJob(jobDetail, trigger);

    }
}

須要說明幾點: 

    1)開始使用StdSchedulerFactory來獲取Scheduler的實例。每個scheduler能夠被啓動(start)、停止 (stop)和暫停(pause)。若是一個scheduler沒有被啓動或已經被暫停，則沒有觸發器會被啓用，因此首先使用start()方法啓動 scheduler。 

    2)建立JobDetail實例。它的構造參數有三個，第一個是任務名，任務名能夠被用做參數來應用須要暫停的任務；第二個是組名，組名能夠用來引用一組被集合在一塊兒的任務，這裏採用缺省組名，每個任務名在組內必須是惟一的；第三個參數是實現了特定任務的類。 

    3)建立Trigger實例。咱們使用SimpleTrigger類，它提供了相似JDK Timer風格的觸發器行爲。它的構造參數有六個，第一個和第二個爲觸發器名和組名，和上面相似；第三個爲任務開始時間；第四個爲結束時間，若是設置爲 空，表示不存在結束時間；第五個爲重複次數，容許你指的觸發器被觸發的最大次數，使用REPEAT_INDEFINITELY容許觸發器能夠被觸發無限 次；第六個是觸發器運行的時間間隔，是毫秒數。 

    4)最後經過scheduler.scheduleJob()方法調度任務。 

2. 使用JobDetail傳遞數據 

    每一個JobDetail實例都有關聯的JobDataMap實例，它實現了Map接口並容許經過鍵值來傳遞任務相關的數據。任務也能夠修改JobDataMap中的數據，在同一任務的屢次執行之間傳遞數據。下面舉例說明。 

MessageJob.java 

package com.learnworld.quartz;

import java.util.Map;

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

public class MessageJob implements Job {

    public void execute(JobExecutionContext context) throws JobExecutionException {

        Map properties = context.getJobDetail().getJobDataMap();

        System.out.println("Previous Fire Time: " + context.getPreviousFireTime());
        System.out.println("Current Fire Time: " + context.getFireTime());
        System.out.println("Next Fire Time: " + context.getNextFireTime());
        System.out.println(properties.get("message"));

    }
}

MessageScheduling.java 

package com.learnworld.quartz;

import java.util.Date;
import java.util.Map;

import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SimpleTrigger;
import org.quartz.Trigger;
import org.quartz.impl.StdSchedulerFactory;

public class MessageScheduling {
    public static void main(String[] args) throws Exception {

        Scheduler scheduler = new StdSchedulerFactory().getScheduler();
        scheduler.start();

        JobDetail jobDetail = new JobDetail("messageJob",
                Scheduler.DEFAULT_GROUP, MessageJob.class);

        Map map = jobDetail.getJobDataMap();
        map.put("message", "This is a message from Quartz");

        Trigger trigger = new SimpleTrigger("simpleTrigger",
                Scheduler.DEFAULT_GROUP, new Date(), new Date("Sat, 12 Aug 2011 13:30:00 GMT+0430"),
                SimpleTrigger.REPEAT_INDEFINITELY, 5000);

        scheduler.scheduleJob(jobDetail, trigger);

    }
}

3. 使用CronTrigger 

   上面提到了SimpleTrigger類，它提供了相似JDK Timer風格的觸發器功能。Quartz的出色在於它使用CronTrigger提供了對複雜觸發器的支持。 

    一個CronTrigger表達式，包含六個必須組件和一個可選組件。關於cron表達式，能夠參考這篇文檔:http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html 

   下面舉例說明CronTrigger的使用。 

CronWithCalendarScheduling.java 

package com.learnworld.quartz;

import java.util.Calendar;
import java.util.Date;
import java.util.Map;

import org.quartz.CronTrigger;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SimpleTrigger;
import org.quartz.Trigger;
import org.quartz.impl.StdSchedulerFactory;
import org.quartz.impl.calendar.HolidayCalendar;

public class CronWithCalendarScheduling {
    public static void main(String[] args) throws Exception {

        Calendar cal = Calendar.getInstance();
        cal.set(2010, Calendar.OCTOBER, 31);

        HolidayCalendar calendar  = new HolidayCalendar();
        calendar.addExcludedDate(cal.getTime());

        Scheduler scheduler = new StdSchedulerFactory().getScheduler();
        scheduler.start();

        scheduler.addCalendar("calendar", calendar, true, false);

        JobDetail jobDetail = new JobDetail("messageJob",
                Scheduler.DEFAULT_GROUP, MessageJob.class);

        Map map = jobDetail.getJobDataMap();
        map.put("message", "This is a message from Quartz");

        String cronExpression = "3/5 * 17,18,19,20 * * ?";

        Trigger trigger = new CronTrigger("cronTrigger",
                Scheduler.DEFAULT_GROUP, cronExpression);

        scheduler.scheduleJob(jobDetail, trigger);
    }
}

須要說明幾點： 

    1)建立了HolidayCalendar實例，使用addExcluderData()方法排除了2010年10月31日。再使用addCalendar()方法，將這個Calendar加入到Scheduler中。 

    2)這個cron表達式的含義是，天天17:00-20:59之間每一分鐘的第三秒開始運行，每五秒執行一次。 

三. Spring對Quartz調度的支持 

    Spring對Quartz集成與其對JDK Timer調度集成相似，你能夠在配置文件中配置任務調度。僅須要在程序里加載ApplicationContext，Spring會自動啓動調度器。 

quartz.xml 

<?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="job"
        class="org.springframework.scheduling.quartz.JobDetailBean">
        <property name="jobClass">
            <value> com.learnworld.quartz.MessageJob </value>
        </property>
        <property name="jobDataAsMap">
            <map>
                <entry key="message">
                    <value>This is a message from Spring Quartz configuration!</value>
                </entry>
            </map>
        </property>
    </bean>
    <bean id="trigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean">
        <property name="startDelay">
            <value>1000</value>
        </property>
        <property name="repeatInterval">
            <value>3000</value>
        </property>
        <property name="jobDetail">
            <ref local="job" />
        </property>
    </bean>

    <bean id="schdulerFactory" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
        <property name="triggers">
            <list>
                <ref local="trigger" />
            </list>
        </property>
    </bean>
</beans>

SimpleSpringQuartzIntegration.java 

package com.learnworld.quartz;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.FileSystemXmlApplicationContext;

public class SimpleSpringQuartzIntegration {

    public static void main(String[] args) {

        ApplicationContext ac = new FileSystemXmlApplicationContext("src/conf/quartz.xml");
    }

}

須要說明幾點： 

    1)採用JobDetailBean類，它擴展了JobDetai類，採用可聲明方式配置任務數據。缺省狀況下，採用<bean>標籤的id做爲任務名，使用缺省組做爲組名，經過jobDataAsMap做爲配置任務數據。 

    2)創建觸發器。能夠選擇SimpleTriggerBean或CronTriggerBean類。SimpleTriggerBean缺省狀況下把可重複執行次數設爲無限。 

    3)建立schedulerFactory。缺省狀況下，SchedulerFactoryBean建立一個StdSchedulerFactory的實 例，後者建立Scheduler的實現。能夠經過設置schedulerFactoryClass屬性來覆蓋這個行爲，須要繼承 SchedulerFactory接口來實現你本身的版本。

引入的jar包：