spring Boot 发送定时任务。 springBoot中使用Quartz和task

叁歲伎倆 2023-09-29 09:38 19阅读 0赞

**目录**

Quartz

Task

**定时任务是企业级开发中必不可少的组成部分，诸如长周期业务数据的计算，例如年度报表，诸如系统脏数据的处理，再比如系统性能监控报告，还有抢购类活动的商品上架，这些都离不开定时任务** 。

## Quartz ##

Quartz技术是一个比较成熟的定时任务框架，但是使用的过程有点繁琐。springboot对其进行整合后，简化了一系列的配置，将**很多配置采用默认设置**，这样开发阶段就简化了很多。再学习springboot整合Quartz前先普及几个Quartz的概念。

*  工作（Job）：用于定义具体执行的工作（就是具体要干的事情）。
 *  工作明细（JobDetail）：用于描述定时工作相关的信息（比如创建了工作，但是并不一定要执行的事情）。
 *  触发器（Trigger）：用于描述触发工作的执行规则，通常使用cron表达式定义规则（在什么时间执行任务，每隔多久执行一次）。
 *  调度器（Scheduler）：描述了工作明细与调度器的对应关系。

**步骤①**：导入springboot整合Quartz的starter

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

**步骤②**：定义任务Bean，按照Quartz的开发规范制作，继承QuartzJobBean

注意：**这里**就是一个普通的Java对象，我们没有把它注入到容器中交给spring管理；

public class MyQuartz extends QuartzJobBean {
        @Override
        protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
            //具体要干的事情
            System.out.println("具体要干的事情...");
        }
    }

**步骤③**：创建Quartz配置类，定义工作明细（JobDetail）与触发器的（Trigger）bean

@Configuration
    public class QuartzConfig {
        @Bean
        public JobDetail printJobDetail(){
            //绑定具体的工作，就是绑定你要做的事情，把类放进来就行  storeDurably()这个表示创建的工作，假设这个工作没有被使用，那么要不要把它持久化给存起来，这个记得加上
            return JobBuilder.newJob(MyQuartz.class).storeDurably().build();
        }
        @Bean
        public Trigger printJobTrigger(){
            //cron表达式  注意，日期和星期我们是不做同一规定的，因为这个是不确定的对应
            ScheduleBuilder schedBuilder = CronScheduleBuilder.cronSchedule("0/5 * * * * ?");
            //绑定对应的工作明细 printJobDetail() 上面的方法
            return TriggerBuilder.newTrigger().forJob(printJobDetail()).withSchedule(schedBuilder).build();
        }
    }

工作明细中要设置对应的具体工作，使用newJob()操作传入对应的工作任务类型即可。

触发器需要绑定任务，使用forJob()操作传入绑定的工作明细对象。此处可以为工作明细设置名称然后使用名称绑定，也可以直接调用对应方法绑定。触发器中最核心的规则是执行时间，此处使用调度器定义执行时间，执行时间描述方式使用的是cron表达式。网络上是有具体的cron表达式生成器的，一搜索就可以找到的。

**总结**

1.  springboot整合Quartz就是将Quartz对应的核心对象交给spring容器管理，包含两个对象，JobDetail和Trigger对象
2.  JobDetail对象描述的是工作的执行信息，需要绑定一个QuartzJobBean类型的对象
3.  Trigger对象定义了一个触发器，需要为其指定绑定的JobDetail是哪个，同时要设置执行周期调度器

## Task ##

spring根据定时任务的**特征**，将定时任务的开发简化到了极致。

**步骤①**：开启定时任务功能，在引导类上开启定时任务功能的开关，使用注解@EnableScheduling

@SpringBootApplication
    //开启定时任务功能
    @EnableScheduling
    public class Springboot22TaskApplication {
        public static void main(String[] args) {
            SpringApplication.run(Springboot22TaskApplication.class, args);
        }
    }

**步骤②**：定义**Bean**，在对应要定时执行的操作上方，使用注解@Scheduled定义执行的时间，执行时间的描述方式还是cron表达式

@Component
    public class MyBean {
        @Scheduled(cron = "0/1 * * * * ?")
        public void print(){
            System.out.println(Thread.currentThread().getName()+" :spring task run...");
        }
    }

这就完成了定时任务的配置。总体感觉其实什么东西都没少，只不过没有将所有的信息都抽取成bean，而是直接使用注解绑定定时执行任务的事情而已。

如何想对定时任务进行相关配置，可以通过配置文件进行

spring:
      task:
       	scheduling:
          pool:
           	size: 1							# 任务调度线程池大小 默认 1
          thread-name-prefix: ssm_      	# 调度线程名称前缀 默认 scheduling-    方便程序的调试   
            shutdown:
              await-termination: false		# 线程池关闭时等待所有任务完成
              await-termination-period: 10s	# 调度线程关闭前最大等待时间，确保最后一定关闭

**总结**

1.  spring task需要使用注解@EnableScheduling开启定时任务功能
2.  为定时执行的的任务设置执行周期，描述方式cron表达式

【本篇笔记基于b站黑马的李老师 的spring boot2 学习视频。】