SpringBoot 整合 Quartz 定时任务框架

在选择技术栈之前，一定要先明确一件事情，你真的需要用它吗？还有其他方式可以使用吗？

相比其他技术技术，优点在哪里呢？使用了之后的利与弊等等。

写这个主要是因为一直想写一下定时任务这个主题，这个算是写那篇文前期的铺垫和基础吧~

本文没有聊到 Java 其他的实现定时任务的方法啥的~，只是对使用 Quartz 做了一个小实践

一、简单聊一聊 Quartz

Quartz 是一个完全由 Java 编写的开源作业调度框架，为在 Java 应用程序中进行作业调度提供了简单却强大的机制。

Quartz 其实就是通过一个调度线程不断的扫描数据库中的数据来获取到那些已经到点要触发的任务，然后调度执行它的。这个线程就是 QuartzSchedulerThread类。其run方法中就是quartz的调度逻辑。

另外，这是一个Demo，木有考虑并发、多任务执行等等状态的发生及处理情况，见谅。

1.1、Quartz 概念

Quartz 的几个核心概念

1. Job

   表示一个工作，要执行的具体内容。此接口中只有一个方法

    void execute(JobExecutionContext context) 
   复制代码

2. JobDetail表示一个具体的可执行的调度程序，Job 是这个可执行程调度程序所要执行的内容，另外 JobDetail 还包含了这个任务调度的方案和策略。

3. Trigger代表一个调度参数的配置，什么时候去调。

4. Scheduler代表一个调度容器，一个调度容器中可以注册多个 JobDetail 和 Trigger。当 Trigger 与 JobDetail 组合，就可以被 Scheduler 容器调度了。

二、SpringBoot 使用 Quartz

2.1、基本步骤

基本步骤就那些，这篇也不是高大上讲原理和流程之类的，就是偏向实操，可能一些地方在代码中含有注释，就不再贴说明了~

基本：JDK 8、SpringBoot、MybatisPlus、Quartz

创建一个 SpringBoot 项目

导入相关依赖~

 
     org.springframework.boot
     spring-boot-starter-parent
     2.5.2
     
 
 ​
 
     1.8
     8
     8
 
 ​
 
     
         org.springframework.boot
         spring-boot-starter-web
     
     
         org.springframework.boot
         spring-boot-starter-quartz
     
     
         org.projectlombok
         lombok
     
     
         mysql
         mysql-connector-java
     
     
         com.baomidou
         mybatis-plus-boot-starter
         3.4.1
     
 ​
     
         cn.hutool
         hutool-all
         5.1.4
     
     
         com.alibaba
         fastjson
         1.2.76
     
 
复制代码

项目结构：

2.2、执行 Quartz 需要的SQL文件

找到 quartz 需要的 sql 文件，在数据库中执行，这也是Quartz持久化的基础~

往下滑，找到你需要的sql文件即可。

执行完的结果：

在此基础上，我们再额外增加一张表，与我们可能有业务关联的信息整合，这啥啥允许为空，是方便我写测试~，并非正例

 DROP TABLE IF EXISTS `sys_quartz_job`;
 CREATE TABLE `sys_quartz_job`  (
   `id` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL,
   `create_by` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '创建人',
   `create_time` datetime NULL DEFAULT NULL COMMENT '创建时间',
   `del_flag` int(1) NULL DEFAULT NULL COMMENT '删除状态',
   `update_by` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '修改人',
   `update_time` datetime NULL DEFAULT NULL COMMENT '修改时间',
   `job_class_name` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '任务类名',
   `cron_expression` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT 'cron表达式',
   `parameter` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '参数',
   `description` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '描述',
   `status` int(1) NULL DEFAULT NULL COMMENT '状态 0正常 -1停止',
   PRIMARY KEY (`id`) USING BTREE
 ) ENGINE = MyISAM CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = DYNAMIC;
 ​
复制代码

2.3、Controller

我们直接从controller说起吧，从上往下开发。

其实一旦牵扯到表的操作，我们无疑就是crud四件事。

 /**
  * @Description: 定时任务在线管理
  * @author nzc
  */
 @RestController
 @RequestMapping("/quartzJob")
 @Slf4j
 public class QuartzJobController {
 ​
     @Autowired
     private IQuartzJobService quartzJobService;
     @Autowired
     private Scheduler scheduler;
 ​
 ​
     @RequestMapping(value = "/list", method = RequestMethod.GET)
     public Result queryPageList(QuartzJob quartzJob, @RequestParam(name = "pageNo", defaultValue = "1") Integer pageNo,
                                    @RequestParam(name = "pageSize", defaultValue = "10") Integer pageSize, HttpServletRequest req) {
         Page page = new Page(pageNo, pageSize);
         IPage pageList = quartzJobService.page(page);
         return Result.ok(pageList);
 ​
     }
 ​
     @RequestMapping(value = "/add", method = RequestMethod.POST)
     public Result add(@RequestBody QuartzJob quartzJob) {
         List list = quartzJobService.findByJobClassName(quartzJob.getJobClassName());
         if (list != null && list.size() > 0) {
             return Result.error("该定时任务类名已存在");
         }
         quartzJobService.saveAndScheduleJob(quartzJob);
         return Result.ok("创建定时任务成功");
     }
 ​
     @RequestMapping(value = "/edit", method = RequestMethod.PUT)
     public Result eidt(@RequestBody QuartzJob quartzJob) {
         try {
             quartzJobService.editAndScheduleJob(quartzJob);
         } catch (SchedulerException e) {
             log.error(e.getMessage(),e);
             return Result.error("更新定时任务失败!");
         }
         return Result.ok("更新定时任务成功!");
     }
 ​
     @RequestMapping(value = "/delete", method = RequestMethod.DELETE)
     public Result delete(@RequestParam(name = "id", required = true) String id) {
         QuartzJob quartzJob = quartzJobService.getById(id);
         if (quartzJob == null) {
             return Result.error("未找到对应实体");
         }
         quartzJobService.deleteAndStopJob(quartzJob);
         return Result.ok("删除成功!");
 ​
     }
 ​
     @RequestMapping(value = "/deleteBatch", method = RequestMethod.DELETE)
     public Result deleteBatch(@RequestParam(name = "ids", required = true) String ids) {
         if (ids == null || "".equals(ids.trim())) {
             return Result.error("参数不识别！");
         }
         for (String id : Arrays.asList(ids.split(","))) {
             QuartzJob job = quartzJobService.getById(id);
             quartzJobService.deleteAndStopJob(job);
         }
         return Result.ok("删除定时任务成功!");
     }
 ​
     /**
      * 暂停定时任务
      * @param jobClassName
      */
     @GetMapping(value = "/pause")
     public Result