Java任務(wù)調(diào)度框架Quartz怎么使用

發(fā)布時(shí)間：2021-12-14 14:07:09 來源：億速云閱讀：126 作者：iii 欄目：開發(fā)技術(shù)

本篇內(nèi)容介紹了“Java任務(wù)調(diào)度框架Quartz怎么使用”的有關(guān)知識(shí)，在實(shí)際案例的操作過程中，不少人都會(huì)遇到這樣的困境，接下來就讓小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧！希望大家仔細(xì)閱讀，能夠?qū)W有所成！

Quartz相較于Timer， Quartz增加了很多功能：

持久性作業(yè) - 就是保持調(diào)度定時(shí)的狀態(tài);
作業(yè)管理 - 對(duì)調(diào)度作業(yè)進(jìn)行有效的管理;

1、Quartz

1.1 引入依賴

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

1.2 入門案例

任務(wù)：將任務(wù)類執(zhí)行 10 次，每次間隔 3 秒。

任務(wù)類,需要實(shí)現(xiàn) Job 接口

package com.sugar.quartz.utils;

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

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * 功能描述: 任務(wù)
 *
 * @author XiaoNianXin
 * @date 2021/12/13 20:52
 */
public class HelloJob implements Job {

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        // 獲取當(dāng)前時(shí)間,并格式化
        Date date = new Date();
        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String dateSrting = format.format(date);
        // 業(yè)務(wù)功能模擬
        System.out.println("開始備份數(shù)據(jù)庫,時(shí)間：" + dateSrting);
    }
}

定時(shí)器類

package com.sugar.quartz.utils;

import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

/**
 * 功能描述: 定時(shí)器配置
 *
 * @author XiaoNianXin
 * @date 2021/12/13 21:08
 */
public class HelloSchedulerDemo {
    public static void main(String[] args) throws SchedulerException {
        // 1、調(diào)度器 - 從工廠獲取調(diào)度實(shí)例
        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();

        // 2、任務(wù)實(shí)例 - 執(zhí)行的任務(wù)對(duì)象
        JobDetail job = JobBuilder.newJob(HelloJob.class)
                .withIdentity("job1", "group1") // 任務(wù)名稱,組名稱
                .build();

        // 3、觸發(fā)器 - 控制執(zhí)行次數(shù)和執(zhí)行時(shí)間
        Trigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("trigger1", "group1") // 同上
                .startNow() // 立刻啟動(dòng)
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().
                        withIntervalInSeconds(3).
                        withRepeatCount(10))   // 循環(huán)10次,每次間隔3s
                .build();

        // 調(diào)度器關(guān)聯(lián)觸發(fā)器,并啟動(dòng)
        scheduler.scheduleJob(job,trigger);
        scheduler.start();
    }
}

1.3 Job 與 JobDetail

Job：基于反射的任務(wù)調(diào)度接口，所有任務(wù)類都要實(shí)現(xiàn)該接口，在接口的 execute 里編寫自己的業(yè)務(wù)邏輯。
Job 生命周期：每次執(zhí)行 Job，在 execute 方法前會(huì)創(chuàng)建新的 Job實(shí)例，調(diào)用后實(shí)例被釋放，再被GC回收。
JobDetail：封裝 Job，給 Job 實(shí)例提供許多屬性。
JobDetail 屬性：name、group、jobClass、jobDataMap。

1.4 JobExecutionContext

下文將 JobExecutionContext 簡(jiǎn)稱為 JEC

JEC ：當(dāng)調(diào)度器調(diào)用 Job 時(shí)，會(huì)將 JEC 傳遞給 Job 的 execute 方法。
JEC 作用：Job 通過 JEC 獲取運(yùn)行環(huán)境信息，以及 Job 信息。

1.5 JobDataMap

下文將 JobDataMap 簡(jiǎn)稱為 JDM

JDM：任務(wù)調(diào)度時(shí)，JDM 存儲(chǔ)在 JEC 中，方便獲取。
JDM 優(yōu)點(diǎn)：實(shí)現(xiàn) Map 接口，可以存取任何可序列化對(duì)象，Job 執(zhí)行時(shí)會(huì)將參數(shù)傳給 JDM。

手動(dòng)獲取 JDM 參數(shù)案例

HelloSchedulerDemo：

package com.sugar.quartz.utils;

import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

/**
 * 功能描述: 定時(shí)器配置
 *
 * @author XiaoNianXin
 * @date 2021/12/13 21:08
 */
public class HelloSchedulerDemo {
    public static void main(String[] args) throws SchedulerException {
        // 1、調(diào)度器 - 從工廠獲取調(diào)度實(shí)例
        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();

        // 2、任務(wù)實(shí)例 - 執(zhí)行的任務(wù)對(duì)象
        JobDetail job = JobBuilder.newJob(HelloJob.class)
                .withIdentity("job1", "group1") // 任務(wù)名稱,組名稱
                .usingJobData("msg","JDM使用 - Detail")    // JDM 傳遞參數(shù)
                .build();

        // 3、觸發(fā)器 - 控制執(zhí)行次數(shù)和執(zhí)行時(shí)間
        Trigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("trigger1", "group1") // 同上
                .startNow() // 立刻啟動(dòng)
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().
                        withIntervalInSeconds(3).
                        withRepeatCount(10))   // 循環(huán)10次,每次間隔3s
                .usingJobData("msg","JDM使用 - Trigger")
                .build();

        // 調(diào)度器關(guān)聯(lián)觸發(fā)器,并啟動(dòng)
        scheduler.scheduleJob(job,trigger);
        scheduler.start();
    }
}

HelloJob：

package com.sugar.quartz.utils;

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

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * 功能描述: 定時(shí)業(yè)務(wù)功能
 *
 * @author XiaoNianXin
 * @date 2021/12/13 20:52
 */
public class HelloJob implements Job {

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        // 獲取當(dāng)前時(shí)間,并格式化
        Date date = new Date();
        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String dateSrting = format.format(date);

        // 獲取 JDM
        JobDataMap Detail_JDM = context.getJobDetail().getJobDataMap();
        JobDataMap Trigger_JDM = context.getTrigger().getJobDataMap();
        String detail_jdmString = Detail_JDM.getString("msg");
        String trigger_jdmString = Trigger_JDM.getString("msg");
        System.out.println("---------------------------------------------------");
        System.out.println("detail_jdmString = " + detail_jdmString);
        System.out.println("trigger_jdmString = " + trigger_jdmString);

        // 業(yè)務(wù)功能模擬
        System.out.println("開始備份數(shù)據(jù)庫,時(shí)間：" + dateSrting);

        // 其他內(nèi)容
        System.out.println("Job 運(yùn)行時(shí)間：" + context.getJobRunTime());
        System.out.println("Job 當(dāng)前運(yùn)行時(shí)間：" + context.getFireTime());
        System.out.println("Job 下次運(yùn)行時(shí)間：" + context.getNextFireTime());
        System.out.println("---------------------------------------------------");
    }
}

2、Job 類實(shí)現(xiàn) JDM 參數(shù)的 Setter 方法，實(shí)例化時(shí)自動(dòng)綁定參數(shù)

HelloJob：

// 實(shí)例化時(shí)自動(dòng)綁定 JDM key對(duì)應(yīng)的值
private String msg;

public void setMsg(String msg) {
    this.msg = msg;
}

// 獲取 JDM
System.out.println(Trigger JDM ： " + msg);

問題：上文中 JobDetail 和 Trigger 中的 JDM 的 key 均為 "msg"，那此 msg 是哪一個(gè)？
E.g：遇到同名key，Trigger 會(huì)覆蓋 JobDetail 的值，所以 msg 為 Trigger JDM 的值。

1.6 Job 狀態(tài)

有狀態(tài) Job：多次調(diào)用 Job 期間，公用同一個(gè) JDM。
有狀態(tài) Job：多次調(diào)用 Job 期間，每次新建一個(gè)新的 JDM。

有無狀態(tài) Job 區(qū)別案例

預(yù)期：無狀態(tài) count 輸出永遠(yuǎn)為 1，有狀態(tài) count 輸出累加。

HelloSchedulerDemo：

// JobDeatil 添加一個(gè) JDM，用做計(jì)數(shù)器
.usingJobData("count",0)

無狀態(tài) HelloJob：

package com.sugar.quartz.utils;

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

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * 功能描述: 任務(wù)類
 *
 * @author XiaoNianXin
 * @date 2021/12/13 20:52
 */
public class HelloJob implements Job {

    // 實(shí)例化時(shí)自動(dòng)綁定 JDM key對(duì)應(yīng)的值
    private String msg;
    private Integer count;

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public void setCount(Integer count) {
        this.count = count;
    }

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        // 獲取當(dāng)前時(shí)間,并格式化
        Date date = new Date();
        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String dateSrting = format.format(date);

        // 獲取 JDM
        System.out.println("---------------------------------------------------");
        System.out.println("Trigger JDM ： " + msg); 
        System.out.println("Count ： " + count);
        
        // 更新 JobDetail JDM 的 count
        count++;
        context.getJobDetail().getJobDataMap().put("count",count);

        // 業(yè)務(wù)功能模擬
        System.out.println("開始備份數(shù)據(jù)庫,時(shí)間：" + dateSrting);

        // 其他內(nèi)容
        System.out.println("Job 運(yùn)行時(shí)間：" + context.getJobRunTime());
        System.out.println("Job 當(dāng)前運(yùn)行時(shí)間：" + context.getFireTime());
        System.out.println("Job 下次運(yùn)行時(shí)間：" + context.getNextFireTime());
        System.out.println("---------------------------------------------------");
    }
}

有狀態(tài) HelloJob：

// 任務(wù)類加上下面注解，多次調(diào)用 Job，會(huì)持久化 Job，JDM 的數(shù)據(jù)會(huì)被保存，供下次使用
@PersistJobDataAfterExecution

1.7 Trigger

Trigger 常用：SimpleTrigger、CronTrigger。
JobKey：Job 實(shí)例標(biāo)識(shí)，觸發(fā)器觸發(fā)時(shí)，執(zhí)行 JobKey 對(duì)應(yīng)任務(wù)。
StartTime：第一次觸發(fā)時(shí)間。
EndTime：終止觸發(fā)時(shí)間。

Trigger 獲取參數(shù)案例

HelloSchedulerTriggerDemo：

package com.sugar.quartz.utils;

import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

import java.util.Date;

/**
 * 功能描述: 定時(shí)器配置2
 *
 * @author XiaoNianXin
 * @date 2021/12/13 21:08
 */
public class HelloSchedulerTriggerDemo {
    public static void main(String[] args) throws SchedulerException {

        // 任務(wù)開始時(shí)間推遲 3 s,結(jié)束時(shí)間推遲 10 s
        Date startData = new Date();
        startData.setTime(startData.getTime() + 3000);
        Date endData = new Date();
        endData.setTime(endData.getTime() + 10000);

        // 1、調(diào)度器 - 從工廠獲取調(diào)度實(shí)例
        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();

        // 2、任務(wù)實(shí)例 - 執(zhí)行的任務(wù)對(duì)象
        JobDetail job = JobBuilder.newJob(helloJobTrigger.class)
                .withIdentity("job1", "group1") // 任務(wù)名稱,組名稱
                .usingJobData("msg","JDM使用 - Detail")    // JDM 傳遞參數(shù)
                .build();

        // 3、觸發(fā)器 - 控制執(zhí)行次數(shù)和執(zhí)行時(shí)間
        Trigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("trigger1", "group1") // 同上
                .startNow() // 立刻啟動(dòng)
                .startAt(startData)
                .endAt(endData)
                .build();

        // 調(diào)度器關(guān)聯(lián)觸發(fā)器,并啟動(dòng)
        scheduler.scheduleJob(job,trigger);
        scheduler.start();
    }
}

helloJobTrigger：

package com.sugar.quartz.utils;

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

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * 功能描述: 任務(wù)類2
 *
 * @author XiaoNianXin
 * @date 2021/12/13 20:52
 */
@PersistJobDataAfterExecution
public class helloJobTrigger implements Job {

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        // 獲取當(dāng)前時(shí)間,并格式化
        Date date = new Date();
        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String dateSrting = format.format(date);

        // 業(yè)務(wù)功能模擬
        System.out.println("---------------------------------------------------");
        System.out.println("開始備份數(shù)據(jù)庫,時(shí)間：" + dateSrting);

        // 獲取 JobKey,StartTime,EndTime
        System.out.println("JobKey ： " + context.getTrigger().getJobKey());
        System.out.println("StartTime ： " + format.format(context.getTrigger().getStartTime()));
        System.out.println("EndTime ： " + format.format(context.getTrigger().getEndTime()));
        System.out.println("---------------------------------------------------");
    }
}

// 運(yùn)行結(jié)果
---------------------------------------------------
開始備份數(shù)據(jù)庫,時(shí)間：2021-12-13 23:25:06
JobKey ： group1.job1
StartTime ： 2021-12-13 23:25:06
EndTime ： 2021-12-13 23:25:13
---------------------------------------------------

1.8 SimpleTripper

下文將 SimpleTripper 簡(jiǎn)稱為 ST

ST：特定時(shí)間范圍啟動(dòng)/結(jié)束，且以一個(gè)時(shí)間間隔重復(fù) n 次 Job 所設(shè)計(jì)。
ST 屬性：開始時(shí)間、結(jié)束時(shí)間、重復(fù)次數(shù)和時(shí)間間隔。
ST 提示：指定了結(jié)束時(shí)間，那么結(jié)束時(shí)間優(yōu)先級(jí) > 重復(fù)次數(shù)。

“Java任務(wù)調(diào)度框架Quartz怎么使用”的內(nèi)容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識(shí)可以關(guān)注億速云網(wǎng)站，小編將為大家輸出更多高質(zhì)量的實(shí)用文章！

向AI問一下細(xì)節(jié)