spring-boot-route（二十一）quartz實現動態定時任務

2020 年 10 月 21 日
筆記
spring-boot-route

Quartz是一個定時任務的調度框架，涉及到的主要概念有以下幾個：

Scheduler：調度器，所有的調度都由它控制，所有的任務都由它管理。

Job：任務，定義業務邏輯。

JobDetail：基於Job，進一步封裝。其中關聯一個Job，並為Job指定更詳細的資訊。

Trigger：觸發器，可以指定給某個任務，指定任務的觸發機制。

一創建簡單任務

1.1 Quartz依賴

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

1.2 創建任務

任務創建需要實現Job介面，重寫execute(JobExecutionContext jobExecutionContext)方法，增加定時任務的業務邏輯，這裡我只是簡單的列印一下定時任務執行。

@Slf4j
public class SimpleJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        log.info("job execute---"+new Date());
    }
}

1.3 JobDetail增加屬性

這裡增加的屬性可以在Job實現類中獲取，來處理業務。

JobDetail jobDetail = JobBuilder.newJob(SimpleJob.class)
                                // 任務標識，及任務分組
                                .withIdentity("job1", "group1")
                                // 鏈接調用，增加需要的參數
                                .usingJobData("name","Java旅途")
                                .usingJobData("age",18)
                                .build();

1.4 Trigger實現

Trigger分為兩種，SimpleTrigger和CronTrigger。SimpleTrigger是根據Quartz的一些api實現的簡單觸發行為。CronTrigger用的比較多，使用cron表達式進行觸發。這裡先用SimpleTrigger來實現。

SimpleTrigger simpleTrigger = TriggerBuilder.newTrigger()
                                            .withIdentity("trigger1", "group1")
                                            // 立即執行
                                            .startNow()
                                            // 10s後停止
                                            .endAt(new Date(System.currentTimeMillis()+10*1000))
                                            .withSchedule(
                                            SimpleScheduleBuilder.simpleSchedule()
                                            // 每秒執行一次
                                            .withIntervalInSeconds(1)
                                            // 一直執行
                                            .repeatForever()
                                            ).build();

1.5 啟動任務

@Autowired
private Scheduler scheduler;

scheduler.scheduleJob(jobDetail,simpleTrigger);

1.6 執行效果

啟動項目後，任務立即執行，每秒執行一次，10s後停止，執行效果圖如下：

二動態操作定時任務

有時候除了已經開發好的定時任務外，還需要我們手動去創建任務並且控制任務的執行。

2.1 創建任務

@GetMapping("create")
public void createJob(String jobName,String jobGroup,String cron,String triggerName,String triggerGroup) throws SchedulerException {

    JobKey jobKey = new JobKey(jobName,jobGroup);
    // 如果存在這個任務，則刪除
    if(scheduler.checkExists(jobKey)) {
        scheduler.deleteJob(jobKey);
    }

    JobDetail jobDetail = JobBuilder.newJob(SimpleJob.class)
        .withIdentity(jobKey)
        .build();

    CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule(cron);

    Trigger trigger = TriggerBuilder.newTrigger()
        .withIdentity(triggerName,triggerGroup)
        .withSchedule(cronScheduleBuilder).build();
    scheduler.scheduleJob(jobDetail,trigger);
}

2.2 暫停任務

@GetMapping("pause")
public void pauseJob(String jobName,String jobGroup) throws SchedulerException {

    JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
    JobDetail jobDetail = scheduler.getJobDetail(jobKey);
    if (jobDetail == null) {
        return;
    }
    scheduler.pauseJob(jobKey);
}

2.3 恢復暫停的任務

@GetMapping("remuse")
public void remuseJob(String jobName, String jobGroup) throws SchedulerException {
    JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
    JobDetail jobDetail = scheduler.getJobDetail(jobKey);
    if (jobDetail == null) {
        return;
    }
    scheduler.resumeJob(jobKey);
}

2.4 刪除定時任務

@GetMapping("remove")
public void removeJob(String jobName, String jobGroup,String triggerName,String triggerGroup) throws SchedulerException {

    TriggerKey triggerKey = TriggerKey.triggerKey(triggerName, triggerGroup);
    JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
    Trigger trigger =  scheduler.getTrigger(triggerKey);
    if (trigger == null) {
        return;
    }
    // 停止觸發器
    scheduler.pauseTrigger(triggerKey);
    // 移除觸發器
    scheduler.unscheduleJob(triggerKey);
    // 刪除任務
    scheduler.deleteJob(jobKey);
}

三任務持久化

Quartz默認使用RAMJobStore存儲方式將任務存儲在記憶體中，除了這種方式還支援使用JDBC將任務存儲在資料庫，為了防止任務丟失，我們一般會將任務存儲在資料庫中。

這裡使用mysql進行存儲，在quartz的源碼包中找到文件tables_mysql_innodb.sql，然後在客戶端進行運行sql文件。如果嫌源碼包不好下載的話，我已經將sql文件上傳至GitHub了，可以直接訪問github拉去表結構，數據表如下：

3.1 增加mysql和jdbc依賴

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.11</version>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

3.2 指定使用jdbc存儲

quartz默認使用memory存儲，這裡修改成jdbc進行存儲，並配置jdbc的相關資訊

spring:
  quartz:
    job-store-type: jdbc
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/simple_fast
    username: root
    password: root

3.3 創建任務

啟動項目，調用create介面創建任務，然後數據表中就會新增任務相關的數據了。

此是spring-boot-route系列的第二十一篇文章，這個系列的文章都比較簡單，主要目的就是為了幫助初次接觸Spring Boot 的同學有一個系統的認識。本文已收錄至我的github，歡迎各位小夥伴star！

github：//github.com/binzh303/spring-boot-route

點關注、不迷路

如果覺得文章不錯，歡迎關注、點贊、收藏，你們的支援是我創作的動力，感謝大家。

如果文章寫的有問題，請不要吝惜文筆，歡迎留言指出，我會及時核查修改。

如果你還想更加深入的了解我，可以微信搜索「Java旅途」進行關注。回復「1024」即可獲得學習影片及精美電子書。每天7:30準時推送技術文章，讓你的上班路不在孤獨，而且每月還有送書活動，助你提升硬實力！

Tags: spring-boot-route