Java中Quartz高可用定時(shí)任務(wù)快速入門

更新時(shí)間：2022年04月03日 10:27:25 作者：Java知識(shí)圖譜

如果你想做定時(shí)任務(wù)，有高可用方面的需求，或者僅僅想入門快，上手簡(jiǎn)單，那么選用它準(zhǔn)沒錯(cuò)，感興趣的小伙伴們可以參考一下

定時(shí)任務(wù)使用指南

如果你想做定時(shí)任務(wù)，有高可用方面的需求，或者僅僅想入門快，上手簡(jiǎn)單，那么選用它準(zhǔn)沒錯(cuò)。

定時(shí)任務(wù)模塊是對(duì)Quartz框架進(jìn)一步封裝，使用更加簡(jiǎn)潔。

1、引入依賴

<dependency>
    <groupId>xin.altitude.cms</groupId>
    <artifactId>ucode-cms-quartz</artifactId>
    <version>1.5.4.1</version>
</dependency>

2、快速上手

實(shí)現(xiàn)org.quartz.Job接口；使用注解CronExp添加任務(wù)的調(diào)度策略；使用注解Component將任務(wù)注入容器中。

啟動(dòng)項(xiàng)目，定時(shí)任務(wù)便處于監(jiān)聽與運(yùn)行中。

@Component
@DisallowConcurrentExecution
@CronExp(cron = "0/5 * * * * ?")
public class DemoJob implements Job {
    @Override
    public void execute(JobExecutionContext context) {
        System.out.println("任務(wù)1：" + LocalDateTime.now());
    }
}

3、手動(dòng)觸發(fā)定時(shí)任務(wù)

定時(shí)任務(wù)除了以既有頻率周期性運(yùn)行外，還有通過接口手動(dòng)被觸發(fā)的能力。

調(diào)用如下接口，可手動(dòng)觸發(fā)任務(wù)ID編號(hào)為jobId的任務(wù)。

http://localhost:8080/cms-api/quartz/job/{jobId}

如果有手動(dòng)觸發(fā)定時(shí)任務(wù)的需求，則需要任務(wù)ID唯一并且已知，因此需要在編寫定時(shí)任務(wù)時(shí)手動(dòng)指定。

@CronExp(id = 1, cron = "0/5 * * * * ?")

通過注解CronExp的id屬性可指定任務(wù)ID，不顯示指定則使用隨機(jī)ID，不滿足已知的條件，因此無法手動(dòng)觸發(fā)。

4、帶參數(shù)任務(wù)

盡管大多數(shù)任務(wù)不需要注入?yún)?shù)，但仍有少量的場(chǎng)景需要向定時(shí)任務(wù)注入?yún)?shù)。

public void execute(JobExecutionContext context) {
    /* 如果在調(diào)用任務(wù)時(shí)傳入了參數(shù)，則能夠從Map中獲取 */
    Map<String, Object> dataMap = context.getMergedJobDataMap();
    /* 比如從Map中獲取一個(gè)鍵值對(duì)，一般來說參數(shù)均為基本數(shù)據(jù)類型 */
    Object key = dataMap.get("key");
    System.out.println("任務(wù)2：" + LocalDateTime.now() + ": " + key);
}

在編寫定時(shí)任務(wù)時(shí)，可從JobExecutionContext對(duì)象中解析一個(gè)Map，從而完成參數(shù)的注入。

http://localhost:8080/cms-api/quartz/job/1?key=a

上述http調(diào)用的含義是手動(dòng)觸發(fā)任務(wù)ID為【1】的任務(wù)，并且向其傳遞參數(shù)為【key】值為【a】的參數(shù)。

5、任務(wù)并發(fā)

本框架不支持任務(wù)并發(fā)，換句話說并發(fā)對(duì)定時(shí)任務(wù)不利，因此需要手動(dòng)禁止。

需要注意的是Quartz的并發(fā)是指當(dāng)任務(wù)執(zhí)行耗時(shí)超過任務(wù)調(diào)度周期時(shí)，上一個(gè)任務(wù)未執(zhí)行完，新任務(wù)是否執(zhí)行。

一般來說需要顯示禁止并發(fā)，在任務(wù)類上添加注解DisallowConcurrentExecution即可禁止任務(wù)并發(fā)。

6、持久化

如果定時(shí)任務(wù)有高可用的需求，那么需要對(duì)任務(wù)進(jìn)行持久化。定時(shí)任務(wù)數(shù)據(jù)持久化到數(shù)據(jù)庫中后，支持應(yīng)用程序多開。定時(shí)任務(wù)持久化多節(jié)點(diǎn)部署后，集群中單節(jié)點(diǎn)故障不影響定時(shí)任務(wù)的執(zhí)行。

定時(shí)任務(wù)持久化，僅需修改yml文件配置即可達(dá)到目標(biāo)，無需修改代碼。一般而言使用Mysql做持久化的容器。

spring:
  quartz:
    properties:
      org.quartz.jobStore.isClustered: true
      org.quartz.jobStore.class: org.quartz.impl.jdbcjobstore.JobStoreTX
      org.quartz.jobStore.driverDelegateClass: org.quartz.impl.jdbcjobstore.StdJDBCDelegate
      org.quartz.jobStore.dataSource: qzDS
      org.quartz.dataSource.qzDS.driver: com.mysql.cj.jdbc.Driver
      org.quartz.dataSource.qzDS.URL: jdbc:mysql://localhost:3306/quartz-demo
      org.quartz.dataSource.qzDS.user: root
      org.quartz.dataSource.qzDS.password: 123456

除了修改主機(jī)、端口、數(shù)據(jù)庫名、用戶名、密碼五個(gè)參數(shù)外，其余參數(shù)使用默認(rèn)值即可。