Spring Boot集成Quartz实现定时任务的动态创建、启动、暂停、恢复、删除

你的名字 2024-03-27 17:33 88阅读 0赞

一、整个 Quartz 的代码流程基本基本如下：

首先需要创建我们的任务(Job)，比如取消订单、定时发送短信邮件之类的，这是我们的任务主体，也是写业务逻辑的地方。

创建任务调度器(Scheduler)，这是用来调度任务的,主要用于启动、停止、暂停、恢复等操作，也就是那几个api的用法。

创建任务明细(JobDetail)，最开始我们编写好任务(Job)后，只是写好业务代码，并没有触发，这里需要用JobDetail来和之前创建的任务(Job)关联起来，便于执行。

创建触发器(Trigger)，触发器是来定义任务的规则的，比如几点执行，几点结束，几分钟执行一次等等。这里触发器主要有两大类(SimpleTrigger和CronTrigger)。

根据Scheduler来启动JobDetail与Trigger

二、进入正题，引入依赖

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

#### **三、创建Job** ####

需实现Job接口，这个接口就一个execute()方法需要重写，方法内容就是具体的业务逻辑。如果是动态任务呢，比如取消订单，每次执行都是不同的订单号。

这个时候就需要在创建任务(JobDetail)或者创建触发器(Trigger)的那里传入参数，然后在这里通过JobExecutionContext来获取参数进行处理，

package com.example.demo.mquartz;
    
    import org.quartz.DisallowConcurrentExecution;
    import org.quartz.Job;
    import org.quartz.JobExecutionContext;
    import org.quartz.JobExecutionException;
    
    import java.text.SimpleDateFormat;
    import java.util.Date;
    
    /**
     * @Auther: wsj
     * @Date: 2023/2/15 14:38
     * @Description: TestJob
     * @Version 1.0.0
     */
    @DisallowConcurrentExecution//Job中的任务有可能并发执行，例如任务的执行时间过长，而每次触发的时间间隔太短，则会导致任务会被并发执行。如果是并发执行，就需要一个数据库锁去避免一个数据被多次处理。
    public class TestJob implements Job {
        @Override
        public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
            System.out.println(jobExecutionContext.getJobDetail().getJobDataMap().get("name"));
            System.out.println(jobExecutionContext.getJobDetail().getJobDataMap().get("age"));
            System.out.println(jobExecutionContext.getTrigger().getJobDataMap().get("orderNo"));
            System.out.println("定时任务执行，当前时间："+ new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
        }
    }

#### **四、创建任务调度器(Scheduler)** ####

这里采用Spring IOC，所以直接注入完事。如果是普通的，则需通过工厂创建。

工厂：

SchedulerFactory schedulerFactory = new StdSchedulerFactory();
    Scheduler scheduler = schedulerFactory.getScheduler();

--------------------

IOC：

@Autowired
    private Scheduler scheduler;

#### **五、创建任务明细(JobDetail)** ####

/**通过JobBuilder.newJob()方法获取到当前Job的具体实现(以下均为链式调用)
             * 这里是固定Job创建，所以代码写死XXX.class
             * 如果是动态的，根据不同的类来创建Job，则 ((Job)Class.forName("ccom.example.demo.mquartzJob").newInstance()).getClass()
             * 即是 JobBuilder.newJob(((Job)Class.forName("com.example.demo.mquartz.TestJob").newInstance()).getClass())
             * */
            JobDetail jobDetail = JobBuilder.newJob(TestJob.class)
                    /**给当前JobDetail添加参数，K V形式*/
                    .usingJobData("name","zy")
                    /**给当前JobDetail添加参数，K V形式，链式调用，可以传入多个参数，在Job实现类中，可以通过jobExecutionContext.getJobDetail().getJobDataMap().get("age")获取值*/
                    .usingJobData("age",23)
                    /**添加认证信息，有3种重写的方法，我这里是其中一种，可以查看源码看其余2种*/
                    .withIdentity(orderNo)
                    .build();//执行

#### **六、创建触发器(Trigger)** ####

这里主要分为两大类SimpleTrigger、CronTrigger。

SimpleTrigger：是根据它自带的api方法设置规则，比如每隔5秒执行一次、每隔1小时执行一次。

Trigger trigger = TriggerBuilder.newTrigger()
            /**给当前JobDetail添加参数，K V形式，链式调用，可以传入多个参数，在Job实现类中，可以通过jobExecutionContext.getTrigger().getJobDataMap().get("orderNo")获取值*/
            .usingJobData("orderNo", "123456")
            /**添加认证信息，有3种重写的方法，我这里是其中一种，可以查看源码看其余2种*/
            .withIdentity("我是name","我是group")
            /**立即生效*/
    //      .startNow()
            /**开始执行时间*/
            .startAt(start)
            /**结束执行时间,不写永久执行*/
            .endAt(start)
            /**添加执行规则，SimpleTrigger、CronTrigger的区别主要就在这里*/
            .withSchedule(
                    SimpleScheduleBuilder.simpleSchedule()
                    /**每隔3s执行一次,api方法有好多规则自行查看*/
                    .withIntervalInSeconds(3)
                    /**一直执行,如果不写,定时任务就执行一次*/
                    .repeatForever()
            )
            .build();//执行

CronTrigger：这就比较常用了，是基于Cron表达式来实现的。

CronTrigger  trigger = TriggerBuilder.newTrigger()
            /**给当前JobDetail添加参数，K V形式，链式调用，可以传入多个参数，在Job实现类中，可以通过jobExecutionContext.getTrigger().getJobDataMap().get("orderNo")获取值*/
            .usingJobData("orderNo", "123456")
            /**添加认证信息，有3种重写的方法，我这里是其中一种，可以查看源码看其余2种*/
            .withIdentity("我是name","我是group")
            /**立即生效*/
    //      .startNow()
            /**开始执行时间*/
            .startAt(start)
            /**结束执行时间,不写永久执行*/
            .endAt(start)
            /**添加执行规则，SimpleTrigger、CronTrigger的区别主要就在这里,我这里是demo，写了个每2分钟执行一次*/
            .withSchedule(CronScheduleBuilder.cronSchedule("0 0/2 * * * ?"))
            .build();//执行

注意：.startNow( )和.startAt( )这里有个坑，这两个方法是对同一个成员变量进行修改的 也就是说startAt和startNow同时调用的时候任务开始的时间是按后面调用的方法为主的，谁写在后面用谁

public TriggerBuilder<T> startAt(Date triggerStartTime) {
            this.startTime = triggerStartTime;
            return this;
        }
    
        public TriggerBuilder<T> startNow() {
            this.startTime = new Date();
            return this;
        }

#### **七、启动任务** ####

/**添加定时任务*/
    scheduler.scheduleJob(jobDetail, trigger);
    if (!scheduler.isShutdown()) {
        /**启动*/
        scheduler.start();
    }

以上，任务的创建启动都完事了，后面就是任务的暂停、恢复、删除。比较简单，大致原理就是我们在创建任务明细(JobDetail)和创建触发器(Trigger)时，会调用.withIdentity(key,group)来传入认证信息，后续就是根据这些认证信息来管理任务(通过api方法)

--------------------

#### **八、任务的暂停** ####

scheduler.pauseTrigger(TriggerKey.triggerKey("我是刚才写的name","我是刚才写的group"));

#### **九、任务的恢复** ####

scheduler.resumeTrigger(TriggerKey.triggerKey("我是刚才写的name","我是刚才写的group"));

根据你写的方式来获取。

#### **十、任务的删除** ####

scheduler.pauseTrigger(TriggerKey.triggerKey("我是刚才写的name","我是刚才写的group"));//暂停触发器
    scheduler.unscheduleJob(TriggerKey.triggerKey("我是刚才写的name","我是刚才写的group"));//移除触发器
    scheduler.deleteJob(JobKey.jobKey("我是刚才写的name","我是刚才写的group"));//删除Job

最后附上基本代码，Job实现在上面：

package com.example.demo.mquartz;
    
    import io.swagger.annotations.ApiOperation;
    import lombok.AllArgsConstructor;
    import org.quartz.*;
    import org.springframework.web.bind.annotation.*;
    
    import java.io.IOException;
    import java.text.SimpleDateFormat;
    import java.util.Date;
    /**
     * @Auther: wsj
     * @Date: 2023/2/15 14:38
     * @Description: jobControler
     * @Version 1.0.0
     */
    @RestController
    @AllArgsConstructor
    @RequestMapping("/job" )
    public class jobControler {
    
        private Scheduler scheduler;
    
        @PostMapping("/Quartz")
        @ApiOperation(value = "定时任务_创建", notes = "创建")
        @ResponseBody
        public Object quartz(@RequestParam("orderNo")  String orderNo) throws Exception {
            Date start=new Date(System.currentTimeMillis() + 7 * 1000);//当前时间7秒之后
    
            /**通过JobBuilder.newJob()方法获取到当前Job的具体实现(以下均为链式调用)
             * 这里是固定Job创建，所以代码写死XXX.class
             * 如果是动态的，根据不同的类来创建Job，则 ((Job)Class.forName("ccom.example.demo.mquartzJob").newInstance()).getClass()
             * 即是 JobBuilder.newJob(((Job)Class.forName("com.example.demo.mquartz.TestJob").newInstance()).getClass())
             * */
            JobDetail jobDetail = JobBuilder.newJob(TestJob.class)
                    /**给当前JobDetail添加参数，K V形式*/
                    .usingJobData("name","zy")
                    /**给当前JobDetail添加参数，K V形式，链式调用，可以传入多个参数，在Job实现类中，可以通过jobExecutionContext.getJobDetail().getJobDataMap().get("age")获取值*/
                    .usingJobData("age",23)
                    /**添加认证信息，有3种重写的方法，我这里是其中一种，可以查看源码看其余2种*/
                    .withIdentity(orderNo)
                    .build();//执行
    
    
            Trigger trigger = TriggerBuilder.newTrigger()
                    /**给当前JobDetail添加参数，K V形式，链式调用，可以传入多个参数，在Job实现类中，可以通过jobExecutionContext.getTrigger().getJobDataMap().get("orderNo")获取值*/
                    .usingJobData("orderNo", orderNo)
                    /**添加认证信息，有3种重写的方法，我这里是其中一种，可以查看源码看其余2种*/
                    .withIdentity(orderNo)
                    /**立即生效*/
    //      .startNow()
                    /**开始执行时间*/
                    .startAt(start)
                    /**结束执行时间*/
    //        .endAt(start)
                    /**添加执行规则，SimpleTrigger、CronTrigger的区别主要就在这里*/
                    .withSchedule(
                            SimpleScheduleBuilder.simpleSchedule()
                                    /**每隔1s执行一次*/
                                    .withIntervalInSeconds(3)
                                    /**一直执行，*/
                                    .repeatForever()
                    )
                    .build();//执行
    
    //CronTrigger  trigger = TriggerBuilder.newTrigger()
    //        /**给当前JobDetail添加参数，K V形式，链式调用，可以传入多个参数，在Job实现类中，可以通过jobExecutionContext.getTrigger().getJobDataMap().get("orderNo")获取值*/
    //        .usingJobData("orderNo", orderNo)
    //        /**添加认证信息，有3种重写的方法，我这里是其中一种，可以查看源码看其余2种*/
    //        .withIdentity(orderNo)
    //        /**开始执行时间*/
    //        .startAt(start)
    //        /**结束执行时间*/
    //        .endAt(start)
    //        /**添加执行规则，SimpleTrigger、CronTrigger的区别主要就在这里*/
    //        .withSchedule(CronScheduleBuilder.cronSchedule("* 30 10 ? * 1/5 2018"))
    //        .build();//执行
    
    
            /**添加定时任务*/
            scheduler.scheduleJob(jobDetail, trigger);
            if (!scheduler.isShutdown()) {
                /**启动*/
                scheduler.start();
            }
            System.err.println("--------定时任务启动成功 "+new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())+" ------------");
            return "ok";
        }
    
        @PostMapping("/shutdown")
        @ApiOperation(value = "定时任务_停止", notes = "停止")
        @ResponseBody
        public Object shutdown(@RequestParam("orderNo")  String orderNo) throws IOException, SchedulerException {
            scheduler.pauseTrigger(TriggerKey.triggerKey(orderNo));//暂停Trigger
            return "";
        }
    
        @PostMapping("/resume")
        @ApiOperation(value = "定时任务_恢复", notes = "恢复")
        @ResponseBody
        public Object resume(@RequestParam("orderNo")  String orderNo) throws IOException, SchedulerException {
            scheduler.resumeTrigger(TriggerKey.triggerKey(orderNo));//恢复Trigger
            return "ok";
        }
    
        @PostMapping("/del")
        @ApiOperation(value = "定时任务_删除", notes = "删除")
        @ResponseBody
        public Object del(@RequestParam("orderNo")  String orderNo) throws IOException, SchedulerException {
            scheduler.pauseTrigger(TriggerKey.triggerKey(orderNo));//暂停触发器
            scheduler.unscheduleJob(TriggerKey.triggerKey(orderNo));//移除触发器
            scheduler.deleteJob(JobKey.jobKey(orderNo));//删除Job
            return "ok";
        }
    }

运行启动：

![9389a4293d87ea0174a77e943d5080f2.png][]

![7989a4f018d68f726e7b5015521884e6.png][]

完事。。。。。。，如果想让定时任务在启动项目后自动启动，则需要持久化任务，可以把基本信息保存在数据库，项目启动时启动完，或者做分布式任务

源码地址 [https://gitee.com/javawsj/quartzdemo][https_gitee.com_javawsj_quartzdemo]

[9389a4293d87ea0174a77e943d5080f2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/82036e48f31e4d1d8336fd52bb2a7c06.png
[7989a4f018d68f726e7b5015521884e6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/c9525f1951fa4d7f871af134542a1a78.png
[https_gitee.com_javawsj_quartzdemo]: https://gitee.com/javawsj/quartzdemo