SpringBoot整合quartz定時任務

[奋斗]發表於2024-10-30
Spring Bootquartz

Quartz基本概念

Quartz是一個任務排程框架，主要用於在特定時間觸發任務執行。‌

Quartz的核心概念
‌排程器（Scheduler）‌：負責任務的排程和管理，包括任務的啟動、暫停、恢復等操作。
‌任務（Job）‌：需要實現org.quartz.Job介面的execute方法，定義了任務的具體執行邏輯。
‌觸發器（Trigger）‌：定義任務執行的觸發條件，包括簡單觸發器（SimpleTrigger）和cron觸發器（CronTrigger）。
‌任務詳情（JobDetail）‌：用於定義任務的詳細資訊，如任務名、組名等。
‌任務構建器（JobBuilder）和觸發器構建器（TriggerBuilder）‌：用於定義和構建任務和觸發器的例項。
‌執行緒池（ThreadPool）‌：用於並行排程執行每個作業，提高效率。
‌監聽器（Listener）‌：包括任務監聽器、觸發器監聽器和排程器監聽器，用於監聽任務和觸發器的狀態變化。
Quartz的基本使用步驟
‌建立任務類‌：實現Job介面的execute方法，定義任務的執行邏輯。
‌生成任務詳情（JobDetail）‌：透過JobBuilder定義任務的詳細資訊。
‌生成觸發器（Trigger）‌：透過TriggerBuilder定義任務的觸發條件，可以選擇使用簡單觸發器或cron觸發器。
‌獲取排程器（Scheduler）‌：透過SchedulerFactory建立排程器物件，並將任務和觸發器繫結在一起，啟動排程器。
Quartz的優點和缺點
‌優點‌：支援複雜的排程需求，包括定時、重複執行、併發執行等；提供了豐富的API和工具類，易於使用和維護；支援Spring整合，方便在Spring專案中應用。
‌缺點‌：配置複雜，需要一定的學習成本；對於簡單的定時任務，使用Quartz可能會顯得過於複雜。

整合SpringBoot

第一步：新增依賴

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

第二步：建立scheduler

package com.xy.quartz;

import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SchedulerFactory;
import org.quartz.impl.StdSchedulerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class QuartzConfig {
    @Bean
    public Scheduler scheduler() throws SchedulerException {
        SchedulerFactory schedulerFactoryBean = new StdSchedulerFactory();
        return schedulerFactoryBean.getScheduler();
    }
}

第三步：建立Job

import com.songwp.utils.DateUtil;
import lombok.extern.slf4j.Slf4j;
import org.quartz.Job;
import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.stereotype.Component;

import java.util.Date;

@Slf4j
@Component
public class MyJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        JobDataMap jobDataMap = jobExecutionContext.getJobDetail().getJobDataMap();
        log.info("入參:{}", jobDataMap.toString());
        log.info("執行定時任務的時間:{}", DateUtil.dateToStr(new Date()));
    }
}

第四步：建立任務資訊類

import lombok.Data;

@Data
public class JobInfo {
    private Long jobId;
    private String cronExpression;
    private String businessId;
}

第五步：建立JobDetail和trigger建立包裝類

import com.songwp.domain.quartz.JobInfo;
import com.songwp.test.MyJob;
import org.quartz.*;
import java.util.Date;

public class QuartzBuilder {
    public static final String RUN_CRON ="定時執行";
    public static final String RUN_ONE ="執行一次";
    private static final String JOB_NAME_PREFIX ="flow";
    public static final String TRIGGER_NAME_PREFIX ="trigger.";

    public static JobDetail createJobDetail(JobInfo jobInfo, String type){
        String jobKey =JOB_NAME_PREFIX + jobInfo.getJobId();
        if (RUN_ONE.equals(type)){
            jobKey = JOB_NAME_PREFIX + new Date().getTime();
        }

        return JobBuilder.newJob(MyJob.class)
                .withIdentity(jobKey,"my_group")
                .usingJobData("businessId",jobInfo.getBusinessId())
                .usingJobData("businessType","其他引數")
                .storeDurably().build();
    }


    public static Trigger createTrigger(JobDetail jobDetail, JobInfo jobInfo){
        return TriggerBuilder.newTrigger()
                .forJob(jobDetail)
                .withIdentity(TRIGGER_NAME_PREFIX + jobInfo.getJobId(),RUN_CRON)
                .withSchedule(CronScheduleBuilder.cronSchedule(jobInfo.getCronExpression()))
                .build();
        }
}

第六步：控制層介面實現介面（執行一次、啟動定時、暫停任務）

import com.songwp.config.quartz.QuartzBuilder;
import com.songwp.domain.quartz.JobInfo;
import lombok.extern.slf4j.Slf4j;
import org.quartz.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.PostConstruct;

@RestController
@Slf4j
public class QuartzController {

    @Autowired
    private Scheduler scheduler;

    /**
     * 定時任務執行（只執行一次）
     * @return
     */
    @GetMapping("runOne")
    public  String runOne(){
        JobInfo jobInfo = new JobInfo();
        jobInfo.setJobId(1L);
        jobInfo.setBusinessId("123");
        jobInfo.setCronExpression("0/5 * * * * ?");
        JobDetail jobDetail = QuartzBuilder.createJobDetail(jobInfo, QuartzBuilder.RUN_ONE);
        Trigger trigger = TriggerBuilder.newTrigger()
                .forJob(jobDetail)
                .startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().withRepeatCount(0))
                .build();

        try {
            scheduler.scheduleJob(jobDetail, trigger);
            if (!scheduler.isStarted()) {
                scheduler.start();
            }
        } catch (SchedulerException e) {
            log.error(e.getMessage());
            return "執行失敗";
        }
        return "執行成功";
    }

    /**
     * 開始定時執行
     * @return 執行結果
     */
    @GetMapping("start")
    public String start() {
        try {
            JobInfo jobInfo = new JobInfo();
            jobInfo.setJobId(1L);
            jobInfo.setBusinessId("123");
            jobInfo.setCronExpression("0/5 * * * * ?");
            TriggerKey triggerKey = new TriggerKey(QuartzBuilder.TRIGGER_NAME_PREFIX + jobInfo.getJobId(),QuartzBuilder.RUN_CRON);
            if (scheduler.checkExists(triggerKey)) {
                scheduler.resumeTrigger(triggerKey);
            } else {
                JobDetail jobDetail = QuartzBuilder.createJobDetail(jobInfo, QuartzBuilder.RUN_CRON);
                Trigger trigger = QuartzBuilder.createTrigger(jobDetail, jobInfo);
                scheduler.scheduleJob(jobDetail, trigger);
                if (!scheduler.isStarted()) {
                    scheduler.start();
                }
            }
        } catch (SchedulerException e) {
            log.error(e.getMessage());
            return "執行失敗";

        }
        return "執行成功";
    }

    /**
     * 停止任務執行
     * @return 執行結果
     */
    @GetMapping("pause")
    public String pause() {
        try {
            JobInfo jobInfo = new JobInfo();
            jobInfo.setJobId(1L);
            jobInfo.setBusinessId("123");
            jobInfo.setCronExpression("0/5 * * * * ?");
            TriggerKey triggerKey = new TriggerKey(QuartzBuilder.TRIGGER_NAME_PREFIX + jobInfo.getJobId(), QuartzBuilder.RUN_CRON);
            if (scheduler.checkExists(triggerKey)) {
                scheduler.pauseTrigger(triggerKey);
            }
        } catch (SchedulerException e) {
            log.error(e.getMessage());
            return "執行失敗";
        }
        return "執行成功";
    }

    /**
     * 查詢已啟動狀態的任務，然後重新執行
     */
    @PostConstruct
    public void init(){
       log.info("查詢已啟動狀態的任務，然後重新執行");
        start();
    }

}

最後訪問介面：

http://localhost:8080/runOne
http://localhost:8080/start
http://localhost:8080/pause

正常情況下的步驟應該是這樣:

1、建立任務時記錄到任務表job_info，此時初始狀態為0

2、啟動任務時更新任務表狀態，更新為1

3、如果應用關閉了，那麼在下次應用啟動的時候，需要把狀態為1的任務也給啟動了，就不需要認為再去調介面啟動。

相關文章