概述

本文介紹如何把Quartz定時任務做成接口，實作以下功能的動态配置：

添加任務
修改任務
暫停任務
恢複任務
删除任務
任務清單
任務詳情

注：添加任務接口仍然需要開發者提前準備好任務類，接口的目的是實作定時任務的動态調整，按需進行開關和修改，請注意這點。

Spring Boot整合Quartz

簡單說下Quartz的整合，做一下準備工作。

導入Quartz依賴

xml複制代碼<!--Quartz定時任務-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

配置檔案中增加Quartz的支援

yml複制代碼spring:
 datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: xxx
    username: xxx
    password: xxx
  quartz:
    job-store-type: jdbc # 定時任務的資料儲存到jdbc即資料庫中
    jdbc:
      # embedded：預設
      # always：啟動的時候初始化表，我們隻在第一次啟動的時候用它來自動建立表，然後改回embedded即可，不然資料每次都會被清空
      # never：啟動的時候不初始化表，也不知道和embedded有什麼不同
      initialize-schema: embedded

第一次啟動的時候請把上面的initialize-schema設定為always，這會在資料庫裡面自動建表，然後第二次啟動時改回embedded即可。

如果不需要定時任務的持久化就可以不管。

寫一個測試用的任務類

java複制代碼import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;
import org.springframework.stereotype.Component;

@Component
public class QuartzTestJob extends QuartzJobBean {
    @Override
    protected void executeInternal(org.quartz.JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("Quartz Test Job");
    }
}

為這個任務類寫一個配置類

java複制代碼
import org.quartz.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class QuartzTestJobConfig {
    @Bean
    public JobDetail quartzTestJobDetail() {
        return JobBuilder.newJob(QuartzTestJob.class)
                .withIdentity(QuartzTestJob.class.getSimpleName())
                .storeDurably()
                .usingJobData("data", "test")
                .build();
    }

    @Bean
    public Trigger quartzTestJobTrigger() {
        // 0/1 * * * * ?
        return TriggerBuilder.newTrigger()
                .forJob(QuartzTestJob.class.getSimpleName())
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(1).repeatForever())
                .build();
    }
}

結論

以上是使用Quartz寫一個定時任務的步驟，很簡單，問題是配置寫死了，沒有辦法動态調整，是以我們開始寫接口，把上面這個任務配置類去掉。

定時任務動态配置實作

我們還是用上面的任務類QuartzTestJob做測試，這裡再說明一次，我們需要有一個任務類作為基礎，本文的目的隻是去掉上面的QuartzTestJobConfig。

剩下的内容沒有什麼需要多說明的，我直接貼代碼了。

業務層

java複制代碼public interface QuartzService {
    /**
     * 添加定時任務
     */
    void addJob(QuartzCreateParam param) throws SchedulerException;

    /**
     * 修改定時任務
     */
    void updateJob(QuartzUpdateParam param) throws SchedulerException;

    /**
     * 暫停定時任務
     */
    void pauseJob(QuartzDetailParam param) throws SchedulerException;

    /**
     * 恢複定時任務
     */
    void resumeJob(QuartzDetailParam param) throws SchedulerException;

    /**
     * 删除定時任務
     */
    void deleteJob(QuartzDetailParam param) throws SchedulerException;

    /**
     * 定時任務清單
     * @return
     */
    List<QuartzJobDetailDto> jobList() throws SchedulerException;

    /**
     * 定時任務詳情
     */
    QuartzJobDetailDto jobDetail(QuartzDetailParam param) throws SchedulerException;
}

業務層實作

java複制代碼@Service
public class QuartzServiceImpl implements QuartzService {
    @Autowired
    private Scheduler scheduler;
    @Autowired
    private SchedulerFactoryBean schedulerFactoryBean;

    @Override
    public void addJob(QuartzCreateParam param) throws SchedulerException {
        String clazzName = param.getJobClazz();
        String jobName = param.getJobName();
        String jobGroup = param.getJobGroup();
        String cron = param.getCron();
        String description = param.getDescription();

        JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
        checkJobExist(jobKey);

        Class<? extends Job> jobClass = null;
        try {
            jobClass = (Class<? extends Job>) Class.forName(clazzName);
        } catch (ClassNotFoundException e) {
            throw new BaseException("找不到任務類：" + clazzName);
        }
        JobDataMap jobDataMap = new JobDataMap();
        if (param.getJobDataMap() != null) {
            param.getJobDataMap().forEach(jobDataMap::put);
        }

        Scheduler scheduler = schedulerFactoryBean.getScheduler();
        JobDetail jobDetail = JobBuilder.newJob(jobClass)
                .withIdentity(jobName, jobGroup)
                .usingJobData(jobDataMap)
                .build();

        CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cron);
        String triggerId = jobKey.getGroup() + jobKey.getName();
        Trigger trigger = TriggerBuilder.newTrigger()
                .withSchedule(scheduleBuilder)
                .withIdentity(triggerId)
                .withDescription(description)
                .build();
        scheduler.scheduleJob(jobDetail, trigger);

        if (!scheduler.isShutdown()) {
            scheduler.start();
        }
    }

    @Override
    public void updateJob(QuartzUpdateParam param) throws SchedulerException {
        String jobName = param.getJobName();
        String jobGroup = param.getJobGroup();
        String cron = param.getCron();

        JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
        String triggerId = jobKey.getGroup() + jobKey.getName();

        checkJobExist(jobKey);

        TriggerKey triggerKey = TriggerKey.triggerKey(triggerId);
        CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cron);
        TriggerBuilder<?> triggerBuilder = TriggerBuilder.newTrigger()
                .withSchedule(scheduleBuilder)
                .withIdentity(triggerId);

        Trigger trigger = triggerBuilder.build();
        scheduler.rescheduleJob(triggerKey, trigger);
    }

    @Override
    public void pauseJob(QuartzDetailParam param) throws SchedulerException {
        String jobName = param.getJobName();
        String jobGroup = param.getJobGroup();

        JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
        checkJobExist(jobKey);

        scheduler.pauseJob(jobKey);
    }

    @Override
    public void resumeJob(QuartzDetailParam param) throws SchedulerException {
        String jobName = param.getJobName();
        String jobGroup = param.getJobGroup();

        JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
        checkJobExist(jobKey);

        scheduler.resumeJob(jobKey);
    }

    @Override
    public void deleteJob(QuartzDetailParam param) throws SchedulerException {
        String jobName = param.getJobName();
        String jobGroup = param.getJobGroup();

        JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
        checkJobExist(jobKey);
        
        // 先暫停再删除
        scheduler.pauseJob(jobKey);
        scheduler.deleteJob(jobKey);
    }

    @Override
    public List<QuartzJobDetailDto> jobList() throws SchedulerException {
        GroupMatcher<JobKey> matcher = GroupMatcher.anyJobGroup();
        List<QuartzJobDetailDto> jobDtoList = new ArrayList<>();
        for (JobKey jobKey : scheduler.getJobKeys(matcher)) {
            QuartzJobDetailDto jobDto = getJobDtoByJobKey(jobKey);
            jobDtoList.add(jobDto);
        }
        return jobDtoList;
    }

    @Override
    public QuartzJobDetailDto jobDetail(QuartzDetailParam param) throws SchedulerException {
        String jobName = param.getJobName();
        String jobGroup = param.getJobGroup();
        JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
        return getJobDtoByJobKey(jobKey);
    }

    /*************** 私有方法 ***************/
    private void checkJobExist(JobKey jobKey) throws SchedulerException {
        if (!scheduler.checkExists(jobKey)) {
            throw new BaseException("該定時任務不存在：" + jobKey.getName());
        }
    }
    
    public QuartzJobDetailDto getJobDtoByJobKey(JobKey jobKey) throws SchedulerException {
        JobDetail jobDetail = scheduler.getJobDetail(jobKey);
        List<Trigger> triggerList = (List<Trigger>) scheduler.getTriggersOfJob(jobKey);

        QuartzJobDetailDto jobDto = new QuartzJobDetailDto();
        jobDto.setJobClazz(jobDetail.getJobClass().toString());
        jobDto.setJobName(jobKey.getName());
        jobDto.setJobGroup(jobKey.getGroup());
        jobDto.setJobDataMap(jobDetail.getJobDataMap());

        List<QuartzTriggerDetailDto> triggerDtoList = new ArrayList<>();
        for (Trigger trigger : triggerList) {
            QuartzTriggerDetailDto triggerDto = new QuartzTriggerDetailDto();
            triggerDto.setTriggerName(trigger.getKey().getName());
            triggerDto.setTriggerGroup(trigger.getKey().getGroup());
            triggerDto.setDescription(trigger.getDescription());

            if (trigger instanceof CronTriggerImpl) {
                CronTriggerImpl cronTriggerImpl = (CronTriggerImpl) trigger;
                String cronExpression = cronTriggerImpl.getCronExpression();
                triggerDto.setCron(cronExpression);

                // 最近10次的觸發時間
                List<Date> dates = TriggerUtils.computeFireTimes(cronTriggerImpl, null, 10);
                triggerDto.setRecentFireTimeList(dates);
            }

            Trigger.TriggerState triggerState = scheduler.getTriggerState(trigger.getKey());
            triggerDto.setTriggerState(triggerState.toString());

            triggerDtoList.add(triggerDto);
        }
        jobDto.setTriggerDetailDtoList(triggerDtoList);
        return jobDto;
    }
}

接口層

java複制代碼@RestController
public class QuartzController {
    @Autowired
    private QuartzServiceImpl quartzService;

    @PostMapping("/quartz/addJob")
    public void addJob(@RequestBody QuartzCreateParam param) throws SchedulerException {
        quartzService.addJob(param);
    }

    @PostMapping("/quartz/updateJob")
    public void updateJob(@RequestBody QuartzUpdateParam param) throws SchedulerException {
        quartzService.updateJob(param);
    }

    @PostMapping("/quartz/pauseJob")
    public void pauseJob(@RequestBody QuartzDetailParam param) throws SchedulerException {
        quartzService.pauseJob(param);
    }

    @PostMapping("/quartz/resumeJob")
    public void resumeJob(@RequestBody QuartzDetailParam param) throws SchedulerException {
        quartzService.resumeJob(param);
    }

    @PostMapping("/quartz/deleteJob")
    public void deleteJob(@RequestBody QuartzDetailParam param) throws SchedulerException {
        quartzService.deleteJob(param);
    }

    @PostMapping("/quartz/jobList")
    public List<QuartzJobDetailDto> jobList() throws SchedulerException {
        return quartzService.jobList();
    }

    @PostMapping("/quartz/jobDetail")
    public QuartzJobDetailDto jobDetail(@RequestBody QuartzDetailParam param) throws SchedulerException {
        return quartzService.jobDetail(param);
    }
}

接口請求參數

java複制代碼@ApiModel(value = "Quartz任務添加請求參數")
public class QuartzCreateParam extends BaseParam {
    @NotBlank(message = "任務類不能為空")
    @ApiModelProperty(value = "任務類路徑", required = true)
    private String jobClazz;

    @NotBlank(message = "任務類名不能為空")
    @ApiModelProperty(value = "任務類名", required = true)
    private String jobName;

    /**
     * 組名+任務類key組成唯一辨別，是以如果這個參數為空，那麼預設以任務類key作為組名
     */
    @ApiModelProperty(value = "任務組名，命名空間")
    private String jobGroup;

    @ApiModelProperty(value = "任務資料")
    private Map<String, Object> jobDataMap;

    @ApiModelProperty(value = "cron表達式")
    private String cron;

    @ApiModelProperty(value = "描述")
    private String description;
}

java複制代碼@ApiModel(value = "Quartz任務更新請求參數")
public class QuartzUpdateParam extends BaseParam {
    @NotBlank(message = "任務類名不能為空")
    @ApiModelProperty(value = "任務類名", required = true)
    private String jobName;

    @ApiModelProperty(value = "任務組名，命名空間")
    private String jobGroup;

    @ApiModelProperty(value = "cron表達式")
    private String cron;
}

java複制代碼@ApiModel(value = "Quartz任務詳情請求參數")
public class QuartzDetailParam extends BaseParam {
    @NotBlank(message = "任務類名不能為空")
    @ApiModelProperty(value = "任務類名", required = true)
    private String jobName;

    @ApiModelProperty(value = "任務組名，命名空間")
    private String jobGroup;
}

接口傳回結果類

java複制代碼@ApiModel(value = "Quartz定時任務詳情類")
public class QuartzJobDetailDto {
    @ApiModelProperty(value = "任務類路徑")
    private String jobClazz;

    @ApiModelProperty(value = "任務類名")
    private String jobName;

    @ApiModelProperty(value = "任務組名，命名空間")
    private String jobGroup;

    @ApiModelProperty(value = "任務資料")
    private Map<String, Object> jobDataMap;

    @ApiModelProperty(value = "觸發器清單")
    private List<QuartzTriggerDetailDto> triggerDetailDtoList;
}

java複制代碼@ApiModel(value = "Quartz定時任務觸發器詳情類")
public class QuartzTriggerDetailDto {
    private String triggerName;
    private String triggerGroup;
    private String cron;
    private String description;

    private String triggerState;

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private List<Date> recentFireTimeList;
}

調用接口進行測試

寫完接口代碼後，我們來測試一下

添加任務接口：/quartz/addJob

json複制代碼{
    "jobClazz": "com.cc.job.QuartzTestJob",
    "jobName": "QuartzTestJob",
    "cron": "1/2 * * * * ? ",
    "description": "測試定時任務",
    "jobDataMap": {
        "key": "value"
    }
}

修改任務接口：/quartz/updateJob

json複制代碼{
    "jobName": "QuartzTestJob",
    "cron": "0/2 * * * * ?"
}

修改任務隻能修改cron時間，如果想要修改其他内容，隻能删除任務後重新添加。

删除任務接口：/quartz/updateJob

json複制代碼{
    "jobName": "QuartzTestJob"
}

暫停、恢複、詳情接口同删除任務接口的請求參數，就不贅述了。

任務清單：/quartz/jobList

json複制代碼{}

傳回結果：

json複制代碼{
    "code": 10000,
    "msg": "請求成功",
    "data": [
        {
            "jobClazz": "class com.cc.job.QuartzTestJob",
            "jobName": "QuartzTestJob",
            "jobGroup": "DEFAULT",
            "jobDataMap": {
                "key": "value"
            },
            "triggerDetailDtoList": [
                {
                    "triggerName": "DEFAULTQuartzTestJob",
                    "triggerGroup": "DEFAULT",
                    "cron": "0/2 * * * * ?",
                    "description": null,
                    "triggerState": "NORMAL",
                    "recentFireTimeList": [
                        "2023-07-19 09:23:16",
                        "2023-07-19 09:23:18",
                        "2023-07-19 09:23:20",
                        "2023-07-19 09:23:22",
                        "2023-07-19 09:23:24",
                        "2023-07-19 09:23:26",
                        "2023-07-19 09:23:28",
                        "2023-07-19 09:23:30",
                        "2023-07-19 09:23:32",
                        "2023-07-19 09:23:34"
                    ]
                }
            ]
        }
    ],
    "traceId": null,
    "success": true
}

原文連結：https://juejin.cn/post/7257440759569498170

Spring Boot整合Quartz實作動态配置

概述

Spring Boot整合Quartz

導入Quartz依賴

配置檔案中增加Quartz的支援

寫一個測試用的任務類

為這個任務類寫一個配置類

結論

定時任務動态配置實作

業務層

業務層實作

接口層

接口請求參數

接口傳回結果類

調用接口進行測試

添加任務接口：/quartz/addJob

修改任務接口：/quartz/updateJob

删除任務接口：/quartz/updateJob

任務清單：/quartz/jobList

繼續閱讀

Using MessageConverter

馴服爛代碼_C＃中的馴服配置

springboot使用 swagger-ui 2.10.5 有關版本更新帶來的問題

Spring Cloud整合Sleuth，當請求完成後，Zipkin沒有鍊路資訊

JAVA自學之路——馬士兵

Rabbitmq指令行手動建立隊列

整合 Spring 開發架構及服務端技術

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

Spring資料和Redis

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

spring boot @SpringBootApplication @EnableAutoConfiguration 的工作原理

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法

Apache2.4.x 配置檔案詳解Apache配置需要了解如下：開始講解：