Spring整合Quartz分佈式調度

前言

爲了保證應用的高可用和高併發性，通常都會部署多個節點；對於定時任務，若是每一個節點都執行本身的定時任務，一方面耗費了系統資源，另外一方面有些任務屢次執行，可能引起應用邏輯問題，因此須要一個分佈式的調度系統，來協調每一個節點執行定時任務。

Spring整合Quartz

Quartz是一個成熟的任務調度系統，Spring對Quartz作了兼容，方便開發，下面看看具體如何整合：

1.Maven依賴文件

<dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>4.3.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>4.3.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>4.3.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>4.3.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz</artifactId>
            <version>2.2.3</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.29</version>
        </dependency>
    </dependencies>

主要就是Spring相關庫、quartz庫以及mysql驅動庫，注：分佈式調度須要用到數據庫，這裏選用mysql；

2.配置job

提供了兩種方式來配置job，分別是：MethodInvokingJobDetailFactoryBean和JobDetailFactoryBean

2.1MethodInvokingJobDetailFactoryBean

要調用特定bean的一個方法的時候使用，具體配置以下：

<bean id="firstTask" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">  
    <property name="targetObject" ref="firstService" />  
    <property name="targetMethod" value="service" />  
</bea>

2.2JobDetailFactoryBean

這種方式更加靈活，能夠設置傳遞參數，具體以下：

<bean id="firstTask"
        class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
        <property name="jobClass" value="zh.maven.SQuartz.task.FirstTask" />
        <property name="jobDataMap">
            <map>
                <entry key="firstService" value-ref="firstService" />
            </map>
        </property>
</bean>

jobClass定義的任務類，繼承QuartzJobBean，實現executeInternal方法；jobDataMap用來給job傳遞數據;

3.配置調度使用的觸發器

一樣提供了兩種觸發器類型：SimpleTriggerFactoryBean和CronTriggerFactoryBean
重點看CronTriggerFactoryBean，這種類型更加靈活，具體以下：

<bean id="firstCronTrigger"
    class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
    <property name="jobDetail" ref="firstTask" />
    <property name="cronExpression" value="0/5 * * ? * *" />
</bean>

jobDetail指定的就是在步驟2中配置的job，cronExpression配置了每5秒執行一次job；

4.配置Quartz調度器的SchedulerFactoryBean

一樣提供了兩種方式：內存RAMJobStore和數據庫方式

4.1內存RAMJobStore

job的相關信息存儲在內存裏，每一個節點存儲各自的，互相隔離，配置以下：

<bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
    <property name="triggers">
        <list>
            <ref bean="firstCronTrigger" />
        </list>
    </property>
</bean>

4.2數據庫方式

job的相關信息存儲在數據庫中，全部節點共用數據庫，每一個節點經過數據庫來通訊，保證一個job同一時間只會在一個節點上執行，而且
若是某個節點掛掉，job會被分配到其餘節點執行，具體配置以下：

<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"
        destroy-method="close">
        <property name="driverClass" value="com.mysql.jdbc.Driver" />
        <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/quartz" />
        <property name="user" value="root" />
        <property name="password" value="root" />
    </bean>
    <bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <property name="configLocation" value="classpath:quartz.properties" />
        <property name="triggers">
            <list>
                <ref bean="firstCronTrigger" />
            </list>
        </property>
    </bean>

dataSource用來配置數據源，數據表相關信息，能夠到官網下載gz包，sql文件在路徑：docsdbTables下，裏面提供了主流數據庫的sql文件，總共11張表；
configLocation配置的quartz.properties文件在quartz.jar的org.quartz包下，裏面提供了一些默認的數據，好比org.quartz.jobStore.class

org.quartz.jobStore.class: org.quartz.simpl.RAMJobStore

這裏須要將quartz.properties拷貝出來作一些修改，具體修改以下：

org.quartz.scheduler.instanceId: AUTO
org.quartz.jobStore.class: org.quartz.impl.jdbcjobstore.JobStoreTX
org.quartz.jobStore.isClustered: true
org.quartz.jobStore.clusterCheckinInterval: 1000

5.相關類

public class FirstTask extends QuartzJobBean {
 
    private FirstService firstService;
 
    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        firstService.service();
    }
 
    public void setFirstService(FirstService firstService) {
        this.firstService = firstService;
    }
}

FirstTask繼承QuartzJobBean，實現executeInternal方法，調用FirstService;

public class FirstService implements Serializable {
 
    private static final long serialVersionUID = 1L;
 
    public void service() {
        System.out.println(new SimpleDateFormat("YYYYMMdd HH:mm:ss").format(new Date()) + "---start FirstService");
        try {
            Thread.sleep(2000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println(new SimpleDateFormat("YYYYMMdd HH:mm:ss").format(new Date()) + "---end FirstService");
    }
}

FirstService須要提供序列化接口，由於須要保存在數據庫中；

public class App {
    public static void main(String[] args) {
        AbstractApplicationContext context = new ClassPathXmlApplicationContext("quartz.xml");
    }
}

主類用來加載quartz配置文件；

測試分佈式調度

1.同時啓動App兩次，觀察日誌：

20180405 14:48:10---start FirstService
20180405 14:48:12---end FirstService
20180405 14:48:15---start FirstService
20180405 14:48:17---end FirstService

其中A1有日誌輸出，A2沒有；當停掉A1之後，A2有日誌輸出；

2.添加新的job分別新建：SecondTask和SecondService，同時添加相關配置文件，啓動App觀察日誌：
A1日誌以下：

20180405 15:03:15---start FirstService
20180405 15:03:15---start SecondService
20180405 15:03:17---end FirstService
20180405 15:03:17---end SecondService
20180405 15:03:20---start FirstService
20180405 15:03:22---end FirstService
20180405 15:03:25---start FirstService
20180405 15:03:27---end FirstService

A2日誌以下：

20180405 15:03:20---start SecondService
20180405 15:03:22---end SecondService
20180405 15:03:25---start SecondService
20180405 15:03:27---end SecondService

能夠發現A1和A2都有執行任務，可是同一任務同一時間只會在一個節點執行，而且只有在執行結束後纔有可能分配到其餘節點；

3.若是間隔時間小於任務執行時間，好比這裏改爲sleep(6000)
A1日誌以下：

20180405 15:14:40---start FirstService
20180405 15:14:45---start FirstService
20180405 15:14:46---end FirstService
20180405 15:14:50---start FirstService
20180405 15:14:50---start SecondService
20180405 15:14:51---end FirstService

A2日誌以下：

20180405 15:14:40---start SecondService
20180405 15:14:45---start SecondService
20180405 15:14:46---end SecondService
20180405 15:14:51---end SecondService

間隔時間是5秒，而任務執行須要6秒，觀察日誌能夠發現，任務尚未結束，新的任務已經開始，這種狀況可能引起應用的邏輯問題，其實就是任務能不能支持串行的問題；

4.@DisallowConcurrentExecution註解保證任務的串行
在FirstTask和SecondTask上分別添加@DisallowConcurrentExecution註解，日誌結果以下：
A1日誌以下：

20180405 15:32:45---start FirstService
20180405 15:32:51---end FirstService
20180405 15:32:51---start FirstService
20180405 15:32:51---start SecondService
20180405 15:32:57---end FirstService
20180405 15:32:57---end SecondService
20180405 15:32:57---start FirstService
20180405 15:32:57---start SecondService

A2日誌以下：

20180405 15:32:45---start SecondService
20180405 15:32:51---end SecondService

觀察日誌能夠發現，任務只有在end之後，纔會開始新的任務，實現了任務的串行化；

總結

本文旨在對Spring+Quartz分佈式調度有一個直觀的瞭解，經過實際的使用來解決問題，固然可能還有不少疑問好比它是如何調度的，數據庫若是掛了會怎麼樣等等，還須要作更加深刻的瞭解。

系列文章

Quartz數據庫表分析
Quartz調度源碼分析