概述

Spring為建立Quartzde Scheduler、Trigger和JobDetail提供了方便的FactoryBean類，以便能夠在Spring容器中享受注入的好處。

此外，Spring還通了一些便利的工具類，用於直接將Spring中的Bean包裝成合法的任務。

Spring進一步降低了使用Quartz的難度，能夠以更加Spring風格的方式使用Quartz，主要體現在如下兩點

• 為Quartz的重要元件提供更具Bean風格的擴充套件類

• 提供建立Scheduler的BeanFactory類，方便在Spring環境下建立對應的元件物件，並結合Spring容器生命週期執行啟動和停止的動作

Maven依賴

主要的兩個依賴如下:

<dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>${spring.version}</version>
</dependency>

<dependency>
            <groupId
 
>org.quartz-scheduler</groupId>
            <artifactId>quartz</artifactId>
            <version>2.2.3</version> 
</dependency>

spring-context-support包主要是Spring集成了很多有用的第三方庫，我們在使用第三方的東西的時候一般都需要引入該依賴。

步驟

Spring通過xml的方式整合Quartz,主要有兩種方式

1. JobDteail通過JobDetailBean實現

2. JobDteail通過MethodInvokeJobDetailFactoryBean實現(推薦)

1 建立JobDteail

Spring通過擴充套件JobDetail提供了一個更具Bean風格的JobDetailFactoryBean,此外Spring還提供了了一個 MethodInvokingJobDetailFactoryBean，通過這個FactoryBean可以將Spring容器中的Bean的方法包裝成Quartz任務，這樣我們就不必為Job建立對應的類。

案例中會分別講述兩種實現方式的區別

2 建立Trigger

Quartz中另外一個重要的元件就是Trigger，Spring按照相似的思路分別為SimpleTrigger和CronTrigger提供了更具Bean風格的CronTriggerFactoryBean和SimpleTriggerFactoryBean擴充套件類。

3 建立Scheduler

Quartz的SchedulerFactory是標準的工廠類，不太適合在Spring中使用。 此外為了保證Scheduler能夠感知Spring容器的生命週期，在Spring容器啟動後，Scheduler自動開始工作，而在Spring容器關閉前，自動關閉Scheduler。為此Spring提供了SchedulerFactoryBean.

示例-MethodInvokingJobDetailFactoryBean

因為下面的案例中我們使用MethodInvokingJobDetailFactoryBean，所以下面的這個Job無需繼承任何類或者實現任何介面

模擬業務類

配置成一個普通的java類即可

package com.xgj.quartz.quartzWithSpring.xml;


/**
 * 
 * 
 * @ClassName: MyJob
 * 
 * @Description: 不用繼承Quartz的Job介面
 * 
 * @author: Mr.Yang
 * 
 * @date: 2017年11月10日 下午10:17:26
 */
public class MyJob {

    public void execute() {
        System.out.println("Quartz Spring XML 配置 - MyJob");
    }

}

Spring整合Quartz的配置檔案

<?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="myJob" class="com.xgj.quartz.quartzWithSpring.xml.MyJob"></bean>

    <!-- 配置JobDetail -->
    <bean id="springQtzJobMethod" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
        <!-- 執行目標job -->
        <property name="targetObject" ref="myJob"></property>

        <!-- 要執行的方法 -->
        <property name="targetMethod" value="execute"></property>
    </bean>

    <!-- 配置tirgger觸發器 -->
    <bean id="cronTriggerFactoryBean" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
        <!-- jobDetail -->
        <property name="jobDetail" ref="springQtzJobMethod"></property>

        <!-- cron表示式，執行時間  每5秒執行一次 -->
        <property name="cronExpression" value="0/5 * * * * ?"></property>
    </bean>

    <!-- 配置排程工廠 -->
    <bean id="springJobSchedulerFactoryBean" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
        <property name="triggers">
            <list>
                <ref bean="cronTriggerFactoryBean"></ref>
            </list>
        </property>

    </bean>
</beans>

除了使用CronTrigger也可以使用SimpleTrigger配置，示例程式碼如下

<bean id="simpleTrigger"  class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean">
    <!--配置具體要執行的jobDetail-->
    <property name="jobDetail" ref="simpleJobDetail" />
    <!--初始延遲時間 1s-->
    <property name="startDelay" value="1000" />
    <!--間隔執行時間每2s執行一次-->
    <property name="repeatInterval" value="2000" />
</bean>

測試類

package com.xgj.quartz.quartzWithSpring.xml;

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class SpringQuartzXmlTest {

    public static void main(String[] args) {
        // 啟動Spring 容器
        ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext(
                        "classpath:com/xgj/quartz/quartzWithSpring/xml/application.xml");
        System.out.println("initContext successfully");
    }
}

在排程器中，有一個lazy-init引數,如果lazy-init=’false’,則容器啟動時就會執行排程程式;如果lazy-init=’true’,則需要例項化該bean才能執行排程程式；

<bean id="springJobSchedulerFactoryBean" class="org.springframework.scheduling.quartz.SchedulerFactoryBean" lazy-init="true">

執行結果

2017-11-11 02:03:41,399  INFO [main] (AbstractApplicationContext.java:583) - Refreshing org[email protected]174580e6: startup date [Sat Nov 11 02:03:41 BOT 2017]; root of context hierarchy
2017-11-11 02:03:41,481  INFO [main] (XmlBeanDefinitionReader.java:317) - Loading XML bean definitions from class path resource [com/xgj/quartz/quartzWithSpring/xml/application.xml]
INFO  StdSchedulerFactory - Using default implementation for ThreadExecutor
INFO  SchedulerSignalerImpl - Initialized Scheduler Signaller of type: class org.quartz.core.SchedulerSignalerImpl
INFO  QuartzScheduler - Quartz Scheduler v.2.2.3 created.
INFO  RAMJobStore - RAMJobStore initialized.
INFO  QuartzScheduler - Scheduler meta-data: Quartz Scheduler (v2.2.3) 'springJobSchedulerFactoryBean' with instanceId 'NON_CLUSTERED'
  Scheduler class: 'org.quartz.core.QuartzScheduler' - running locally.
  NOT STARTED.
  Currently in standby mode.
  Number of jobs executed: 0
  Using thread pool 'org.quartz.simpl.SimpleThreadPool' - with 10 threads.
  Using job-store 'org.quartz.simpl.RAMJobStore' - which does not support persistence. and is not clustered.

INFO  StdSchedulerFactory - Quartz scheduler 'springJobSchedulerFactoryBean' initialized from an externally provided properties instance.
INFO  StdSchedulerFactory - Quartz scheduler version: 2.2.3
INFO  QuartzScheduler - JobFactory set to: org.springframework.[email protected]7fe0dbb6
2017-11-11 02:03:42,862  INFO [main] (DefaultLifecycleProcessor.java:343) - Starting beans in phase 2147483647
2017-11-11 02:03:42,862  INFO [main] (SchedulerFactoryBean.java:645) - Starting Quartz Scheduler now
INFO  QuartzScheduler - Scheduler springJobSchedulerFactoryBean_$_NON_CLUSTERED started.
initContext successfully
Quartz Spring XML 配置 - MyJob
Quartz Spring XML 配置 - MyJob
Quartz Spring XML 配置 - MyJob
Quartz Spring XML 配置 - MyJob
Quartz Spring XML 配置 - MyJob
.......
.......
.......
.......

示例-JobDetailFactoryBean

業務Job模擬類

package com.xgj.quartz.quartzWithSpring.xml2;

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

/**
 * 
 * 
 * @ClassName: MyJob2
 * 
 * @Description: 配置檔案中使用JobDetailBean,這是業務Job需要繼承QuartzJobBean
 * 
 * @author: Mr.Yang
 * 
 * @date: 2017年11月12日 上午7:54:28
 */
public class MyJob2 extends QuartzJobBean {

    @Override
    protected void executeInternal(JobExecutionContext ctx)
            throws JobExecutionException {
        System.out.println("Spring 整合 Quartz 的第二種方式");
    }

}

Spring整合Quartz的配置檔案

<?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="myJob" class="com.xgj.quartz.quartzWithSpring.xml.MyJob"></bean>

    <!-- 配置JobDetail -->
     <bean id="jobDetail" class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
        <property name="jobClass" value="com.xgj.quartz.quartzWithSpring.xml2.MyJob2"></property>
        <property name="durability" value="true"></property>
    </bean>


    <!-- 配置tirgger觸發器 -->
    <bean id="cronTriggerFactoryBean" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
        <!-- jobDetail -->
        <property name="jobDetail" ref="jobDetail"></property>

        <!-- cron表示式，執行時間  每5秒執行一次 -->
        <property name="cronExpression" value="0/5 * * * * ?"></property>
    </bean>

    <!-- 配置排程工廠 如果將lazy-init='false'那麼容器啟動就會執行排程程式 -->
    <bean id="springJobSchedulerFactoryBean" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
        <property name="triggers">
            <list>
                <ref bean="cronTriggerFactoryBean"></ref>
            </list>
        </property>

    </bean>
</beans>

測試類

package com.xgj.quartz.quartzWithSpring.xml2;

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class SpringQuartzXmlTest {

    public static void main(String[] args) {
        // 啟動Spring 容器
        ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext(
                "classpath:com/xgj/quartz/quartzWithSpring/xml2/spring-quartz.xml");
        System.out.println("initContext successfully");
    }
}

執行結果

2017-11-12 08:14:27,934  INFO [main] (AbstractApplicationContext.java:583) - Refreshing org[email protected]4af6178d: startup date [Sun Nov 12 08:14:27 BOT 2017]; root of context hierarchy
2017-11-12 08:14:28,014  INFO [main] (XmlBeanDefinitionReader.java:317) - Loading XML bean definitions from class path resource [com/xgj/quartz/quartzWithSpring/xml2/spring-quartz.xml]
INFO  StdSchedulerFactory - Using default implementation for ThreadExecutor
INFO  SchedulerSignalerImpl - Initialized Scheduler Signaller of type: class org.quartz.core.SchedulerSignalerImpl
INFO  QuartzScheduler - Quartz Scheduler v.2.2.3 created.
INFO  RAMJobStore - RAMJobStore initialized.
INFO  QuartzScheduler - Scheduler meta-data: Quartz Scheduler (v2.2.3) 'springJobSchedulerFactoryBean' with instanceId 'NON_CLUSTERED'
  Scheduler class: 'org.quartz.core.QuartzScheduler' - running locally.
  NOT STARTED.
  Currently in standby mode.
  Number of jobs executed: 0
  Using thread pool 'org.quartz.simpl.SimpleThreadPool' - with 10 threads.
  Using job-store 'org.quartz.simpl.RAMJobStore' - which does not support persistence. and is not clustered.

INFO  StdSchedulerFactory - Quartz scheduler 'springJobSchedulerFactoryBean' initialized from an externally provided properties instance.
INFO  StdSchedulerFactory - Quartz scheduler version: 2.2.3
INFO  QuartzScheduler - JobFactory set to: [email protected]404f4560
2017-11-12 08:14:28,800  INFO [main] (DefaultLifecycleProcessor.java:343) - Starting beans in phase 2147483647
2017-11-12 08:14:28,801  INFO [main] (SchedulerFactoryBean.java:645) - Starting Quartz Scheduler now
INFO  QuartzScheduler - Scheduler springJobSchedulerFactoryBean_$_NON_CLUSTERED started.
initContext successfully
Spring 整合 Quartz 的第二種方式
Spring 整合 Quartz 的第二種方式
Spring 整合 Quartz 的第二種方式
Spring 整合 Quartz 的第二種方式
Spring 整合 Quartz 的第二種方式
.......
.......
.......

示例原始碼