SpringBoot整合任务系统quartz和SpringTask的方法

2022-11-13 18:11:01 整合 系统 方法

springBoot整合任务系统

​ 这里说的任务系统指的是定时任务。定时任务是企业级开发中必不可少的组成部分,诸如长周期业务数据的计算,例如年度报表,诸如系统脏数据的处理,再比如系统性能监控报告,还有抢购类活动的商品上架,这些都离不开定时任务。下面将介绍两种不同的定时任务技术。

1:Quartz

​ Quartz是一个比较成熟了的定时任务框架,但是捏,它稍微的有些许繁琐,因此,SpringBoot大哥说:我来给它整合整合。” 于是呢,SpringBoot大哥出手了,对其进行整合,简化了一系列配置,将很多配置都简化为了默认配置(包含常用的注解式开发?),这样对Quartz的的整合就舒服了许多。

​ 接下来,咱们先了解下Quartz的一些基本概念。

  • 工作(Job):用于定义具体执行的工作(工作的逻辑和流程)
  • 工作明细(JobDetail):用于描述定时工作相关的信息()
  • 触发器(Trigger):描述了工作明细与调度器的对应关系
  • 调度器(Scheduler):用于描述触发工作的执行规则,通常使用cron表达式定义规则

​ 这简单来说就是咱们要提前定好什么时候干什么事情,这个就是工作;儿工作不可能只有一个工作名称吧,肯定要有具体的工作内容,这个就是工作明细(JobDetail)。这个时候工作内容都明确了,现在需要明确的就是什么时候去执行了,以及按照什么规则去执行,这个时候需要调度器。那么这个时候,就有宝贝儿问了,触发器呢?它当然在啦,因为调度器和工作是两个独立的个体,所以需要一个东西去把他们联系起来,这个东西就是触发器。

​ OK,现在开始,咱们来看SpringBoot来整合Quartz。

1.导入Quartz的Maven坐标。

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

2,遵守Quartz的规范编写相应的工作内容的bean,让它交给第三步的JobDetail去绑定

//定义开发任务的bean,注意,这里要继承QuartzJobBean,
//而不是将定义的开发任务的bean交给Spring去管理
public class MyQuartz extends QuartzJobBean {

    //这个方法里写的逻辑是你需要执行的操作,也就是任务内容
    @Override
    protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("踏风彡");
    }
}

3.编写Quartz的具体配置类,这个配置类要交给Spring去管理

类名称和方法名称可以自定义

//创建Quartz的具体配置类,包含任务绑定和触发器
@Configuration
public class QuartzConfig {

    //.storeDurably():生命当任务未执行会被框架给持久化,不会直接结束
    //.newJob():绑定具体的任务类
    @Bean
    public JobDetail Print(){
           return JobBuilder.newJob(MyQuartz.class).storeDurably().build();
    }


    //定义触发器
//    forjob():绑定跟要执行任务绑定的返回值为JObDetail的方法(即工作明细对象)
//    TriggerBuilder.newTrigger():创建触发器对象
//    withSchedule(scheduleBuilder):使用调度器,规定任务的执行策略
    @Bean
    public Trigger PrintJobTrigger(){
        //这里使用cron表达式:
        //"0/5 * * * * ?"
        //意思是:每五秒 任意分 任意小时 任意日 任意月 任意周几
        ScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0/5 * * * * ?");
        return TriggerBuilder.newTrigger().forJob(Print()).withSchedule(scheduleBuilder).build();
    }
}

4.配置类里主要实现两个方法,方法名可以自定义,方法返回值要限定

工作明细方法

//.storeDurably():生命当任务未执行会被框架给持久化,不会直接结束
//.newJob():绑定具体的任务类
@Bean
public JobDetail Print(){
       return JobBuilder.newJob(MyQuartz.class).storeDurably().build();
}

触发器方法

    //定义触发器
//    forjob():绑定跟要执行任务绑定的返回值为JObDetail的方法(即工作明细对象)
//    TriggerBuilder.newTrigger():创建触发器对象
//    withSchedule(scheduleBuilder):使用调度器,规定任务的执行策略
    @Bean
    public Trigger PrintJobTrigger(){
        //这里使用cron表达式:
        //"0/5 * * * * ?"
        //意思是:每五秒 任意分 任意小时 任意日 任意月 任意周几
        ScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0/5 * * * * ?");
        return TriggerBuilder.newTrigger().forJob(Print()).withSchedule(scheduleBuilder).build();
    }

接下来,宝贝们,咱们来看一下执行结果。

在这里插入图片描述

​ 工作明细中利用newJob()传入具体的工作对象。

​ 触发器也需要绑定具体的任务,通过forJob()绑定具体的工作明细对象,这里可以对工作明细对象设置具体名称进行绑定,或者直接对相应的bean方法进行绑定。触发器中最核心的是执行规则,其中最核心的是执行时间,这里我用的是cron表达式,关于表达式我只对在这篇文章中所需的在代码里进行了介绍,如果朋友们想学习更详细的cron表达式规则,可以自行找相应的资料进行学习呦~~。

总结:

  • SpringBoot整合Quartz的核心说到底还是把相应的bean容器对象交给Spring容器管理,包含两个对象:JobDetail和Trigger对象。
  • JobDetail对象是工作信息,需要绑定一个继承了QuartzJobBean类的子类对象。
  • JobDetail和Trigger由触发器进行关联,触发器需要绑定相关的JobDetail,还要设置执行周期调度器。

2:Task

​ 接下来咱们来看Spring对定时任务进行整合后的简化开发的操作。

​ 简单来说就是,注解式开发,你只需要把你要执行的任务加上Spring要求的注解,并根据注解的格式去设置定时任务的执行规则即可。

1.开启定时任务的开关,在启动类上加入@EnableScheduling注解。

@SpringBootApplication
@EnableScheduling
public class YsjApplication {

    public static void main(String[] args) {
        SpringApplication.run(YsjApplication.class, args);
    }

}

2.创建相应的定时任务类,并将其交给Spring管理

@Component
public class TestBean {

}

3.在定时任务类中的相应的定时任务方法加上@Scheduled注解,相应的执行时间规则用cron表达式表示

@Component
public class TestBean {

    @Scheduled(cron = "0/20 * * * * ?")
    public void print(){
        System.out.println("踏风彡");
    }
}

4.若需要对定时任务的相关配置进行配置,可以在配置文件里进行配置

spring:
  task:
    scheduling:
      pool:
        max-size: 2  #task线程池最大大小
        keep-alive: 100s
        allow-core-thread-timeout: true
      thread-name-prefix: Spring_task_  #调度线程名前缀,默认为:scheduling_
     # shutdown:
       # await-termination: false  #线程池关闭时是否等待所有任务完成
       # await-termination-period: 20s #调度线程前关闭前的最大等待时间
      shutdown:
        await-termination-period: 100s
        await-termination: false

总结:

一定要先开启定时任务的开关,在启动类上加上@EnableScheduling注解这里的定时任务方法的容器所在的类要交给Spring去管理若需要调试,可以在相应配置类中加上相应的配置

rmination-period: 100s
await-termination: false

**总结:** 1. 一定要先开启定时任务的开关,在启动类上加上@EnableScheduling注解 2. 这里的定时任务方法的容器所在的类要交给Spring去管理 3. 若需要调试,可以在相应配置类中加上相应的配置

到此这篇关于SpringBoot整合任务系统(quartz和SpringTask)的文章就介绍到这了,更多相关SpringBoot整合任务系统内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持!

相关文章