文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

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

2023-09-10 17:25

关注

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

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

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

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

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

根据Scheduler来启动JobDetail与Trigger

二、进入正题,引入依赖

     org.springframework.boot   spring-boot-starter-quartz  

三、创建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;@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:

@Autowiredprivate Scheduler scheduler;

五、创建任务明细(JobDetail)

        JobDetail jobDetail = JobBuilder.newJob(TestJob.class)                                .usingJobData("name","zy")                                .usingJobData("age",23)                                .withIdentity(orderNo)                .build();//执行       

六、创建触发器(Trigger)

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

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

Trigger trigger = TriggerBuilder.newTrigger()                .usingJobData("orderNo", "123456")                .withIdentity("我是name","我是group")        //      .startNow()                .startAt(start)                .endAt(start)                .withSchedule(                SimpleScheduleBuilder.simpleSchedule()                                .withIntervalInSeconds(3)                                .repeatForever()        )        .build();//执行

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

CronTrigger  trigger = TriggerBuilder.newTrigger()                .usingJobData("orderNo", "123456")                .withIdentity("我是name","我是group")        //      .startNow()                .startAt(start)                .endAt(start)                .withSchedule(CronScheduleBuilder.cronSchedule("0 0/2 * * * ?"))        .build();//执行

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

    public TriggerBuilder startAt(Date triggerStartTime) {        this.startTime = triggerStartTime;        return this;    }    public TriggerBuilder 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;@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秒之后                JobDetail jobDetail = JobBuilder.newJob(TestJob.class)                                .usingJobData("name","zy")                                .usingJobData("age",23)                                .withIdentity(orderNo)                .build();//执行        Trigger trigger = TriggerBuilder.newTrigger()                                .usingJobData("orderNo", orderNo)                                .withIdentity(orderNo)                //      .startNow()                                .startAt(start)                //        .endAt(start)                                .withSchedule(                        SimpleScheduleBuilder.simpleSchedule()        .withIntervalInSeconds(3)        .repeatForever()                )                .build();//执行//CronTrigger  trigger = TriggerBuilder.newTrigger()//        //        .usingJobData("orderNo", orderNo)//        //        .withIdentity(orderNo)//        //        .startAt(start)//        //        .endAt(start)//        //        .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";    }}

运行启动:

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

源码地址 https://gitee.com/javawsj/quartzdemo

来源地址:https://blog.csdn.net/onceing/article/details/129045733

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯