文章目錄

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 入門案例

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

任務類,需要實現(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;

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

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

定時器類

package com.sugar.quartz.utils;

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

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

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

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

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

1.3 Job 與 JobDetail

Job：基于反射的任務調(diào)度接口，所有任務類都要實現(xiàn)該接口，在接口的 execute 編寫自己的業(yè)務邏輯。

Job 生命周期：每次執(zhí)行 Job，在 execute 方法前會創(chuàng)建新的 Job實例，調(diào)用后實例被釋放，再被GC回收。

JobDetail：封裝 Job，給 Job 實例提供許多屬性。

JobDetail 屬性：name、group、jobClass、jobDataMap。

1.4 JobExecutionContext

下文將 JobExecutionContext 簡稱為 JEC

JEC ：當調(diào)度器調(diào)用 Job 時，會將 JEC 傳遞給 Job 的 execute 方法。

JEC 作用：Job 通過 JEC 獲取運行環(huán)境的信息，以及 Job 信息。

1.5 JobDataMap

下文將 JobDataMap 簡稱為 JDM

JDM：任務調(diào)度時，JDM 存儲在 JEC 中，方便獲取。

JDM 優(yōu)點：實現(xiàn) Map 接口，可以存取任何可序列化對象，Job 執(zhí)行時會將參數(shù)傳給 JDM。

1、手動獲取 JDM 參數(shù)案例

HelloSchedulerDemo：

package com.sugar.quartz.utils;

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

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

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

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

        // 調(diào)度器關(guān)聯(lián)觸發(fā)器,并啟動
        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;

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

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
 
        // 獲取當前時間,并格式化
        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è)務功能模擬
        System.out.println("開始備份數(shù)據(jù)庫,時間：" + dateSrting);

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

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

HelloJob：

// 實例化時自動綁定 JDM key對應的值
private String msg;

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

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

問題：上文中 JobDetail 和 Trigger 中的 JDM 的 key 均為 "msg" ，那此 msg 是哪一個？

E.g：遇到同名key，Trigger 會覆蓋 JobDetail 的值，所以 msg 為 Trigger JDM 的值。

1.6 Job 狀態(tài)

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

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

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

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

HelloSchedulerDemo：

// JobDeatil 添加一個 JDM，用做計數(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;

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

    // 實例化時自動綁定 JDM key對應的值
    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 {
        // 獲取當前時間,并格式化
        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è)務功能模擬
        System.out.println("開始備份數(shù)據(jù)庫,時間：" + dateSrting);

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

有狀態(tài) HelloJob：

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

1.7 Trigger

Trigger 常用：SimpleTrigger、CronTrigger。

JobKey：Job 實例標識，觸發(fā)器觸發(fā)時，執(zhí)行 JobKey 對應任務。

StartTime：第一次觸發(fā)時間。

EndTime：終止觸發(fā)時間。

1、Trigger 獲取參數(shù)案例

HelloSchedulerTriggerDemo：

package com.sugar.quartz.utils;

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

import java.util.Date;

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

        // 任務開始時間推遲 3 s,結(jié)束時間推遲 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)度實例
        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();

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

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

        // 調(diào)度器關(guān)聯(lián)觸發(fā)器,并啟動
        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;

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

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

        // 業(yè)務功能模擬
        System.out.println("---------------------------------------------------");
        System.out.println("開始備份數(shù)據(jù)庫,時間：" + 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("---------------------------------------------------");
    }
}

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