SpringBoot之整合Quartz调度框架-基于Spring Boot2.0.2版本

ゞ浴缸里的玫瑰 2022-05-13 17:22 220阅读 0赞

## 一、引言 ##

定时任务调度是Java开发中不可或缺的重要部分，但是Java自带的Time等任务调度类在实际项目中不好用。所以Quartz和Spring Task就成了我们项目开发技术选型最多的，在这里我们着重探讨一下Quartz在Spring Boot 2.X版本中的使用。

## 二、Quartz ##

### 1. 介绍 ###

Quartz是OpenSymphony开源组织在Job scheduling领域的开源项目,它可以与J2EE与J2SE应用程序相结合也可以单独使用。Quartz可以用来创建简单或为运行十个，百个，甚至是好几万个Jobs这样复杂的日程序表。Jobs可以做成标准的Java组件或 EJBs。  
Quartz是一个任务日程管理系统，一个在预先确定（被纳入日程）的时间到达时，负责执行（或者通知）其他软件组件的系统。  
Quartz用一个小Java库发布文件（.jar文件），这个库文件包含了所有Quartz核心功能。这些功能的主要接口(API)是Scheduler接口。它提供了简单的操作，例如：将任务纳入日程或者从日程中取消，开始/停止/暂停日程进度。

### 2.安装配置 ###

官方网站：[官网][Link 1]

### 3.设计架构 ###

1.  介绍
    
     *  Scheduler – 核心调度器
     *  Job – 任务
     *  JobDetail – 任务描述
     *  Trigger – 触发器
2.  图示  
    ![在这里插入图片描述][70]

多个定时的图示如下：  
![在这里插入图片描述][70 1]  
对比下配置xml中的配置：

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:context="http://www.springframework.org/schema/context" xmlns:p="http://www.springframework.org/schema/p" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-4.0.xsd">
    
        
        
        <bean name="hwJob" class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
            
            <property name="name" value="hw_job"/>
            
            <property name="group" value="hw_group"/>
            
            <property name="jobClass" value="com.dufy.spring.quartz.chapter01.job.HelloWorldJob"/>
            
            <property name="durability" value="true"/>
            
            <property name="applicationContextJobDataKey" value="applicationContext"/>
        </bean>
        
        
    
        
        <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
            
            <property name="name" value="hw_trigger"/>
            
            <property name="group" value="hw_trigger_group"/>
            
            <property name="jobDetail" ref="hwJob"/>
            
            <property name="cronExpression" value="0/1 * * * * ?" />
        </bean>
    
    
        
        <bean id="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
            <property name="triggers">
                <list>
                    
                    <ref bean="cronTrigger"/>
                </list>
            </property>
            
        </bean>
    
    </beans>

## 三、整合 ##

### 1.项目基础 ###

项目是基于Spring Boot2.x版本的。  
![在这里插入图片描述][70 2]

### 2.添加依赖 ###

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

### 3.yml配置 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70]  
application-quartz.yml的配置内容如下

spring:
      quartz:
        #相关属性配置
        properties:
          org:
            quartz:
              scheduler:
                instanceName: clusteredScheduler
                instanceId: AUTO
              jobStore:
                class: org.quartz.impl.jdbcjobstore.JobStoreTX
                driverDelegateClass: org.quartz.impl.jdbcjobstore.StdJDBCDelegate
                tablePrefix: QRTZ_
                isClustered: true
                clusterCheckinInterval: 10000
                useProperties: false
              threadPool:
                class: org.quartz.simpl.SimpleThreadPool
                threadCount: 10
                threadPriority: 5
                threadsInheritContextClassLoaderOfInitializingThread: true
        #数据库方式
        job-store-type: jdbc
        #初始化表结构
        #jdbc:
          #initialize-schema: never

### 4.创建任务测试类 ###

*  简单任务  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70 1]  
    代码如下：

public class MyJob extends QuartzJobBean { 
    
        @Override
        protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException { 
            System.out.println("start My Job：" + LocalDateTime.now());
            try { 
                Thread.sleep(3000);
            } catch (InterruptedException e) { 
                e.printStackTrace();
            }
            System.out.println("end My Job：" + LocalDateTime.now());
    
        }
    }

*  CRON任务  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70 2]

public class MyCronJob extends QuartzJobBean { 
    
        @Autowired
        IndexController indexController;
    
        @Override
        protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException { 
            System.out.println("任务执行了" + new Date());
            // indexController.testMail();
        }
    }

### 5.Java配置（QuartzConfiguration） ###

@Configuration
    public class QuartzConfiguration { 
    
    	// 使用jobDetail包装job
        @Bean
        public JobDetail myJobDetail() { 
            return JobBuilder.newJob(MyJob.class).withIdentity("myJob").storeDurably().build();
        }
    
    	// 把jobDetail注册到trigger上去
        @Bean
        public Trigger myJobTrigger() { 
            SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule()
                    .withIntervalInSeconds(15).repeatForever();
    
            return TriggerBuilder.newTrigger()
                    .forJob(myJobDetail())
                    .withIdentity("myJobTrigger")
                    .withSchedule(scheduleBuilder)
                    .build();
        }
    
    	// 使用jobDetail包装job
        @Bean
        public JobDetail myCronJobDetail() { 
            return JobBuilder.newJob(MyCronJob.class).withIdentity("myCronJob").storeDurably().build();
        }
    
    	// 把jobDetail注册到Cron表达式的trigger上去
        @Bean
        public Trigger CronJobTrigger() { 
            CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule("0/10 * * * * ?");
    
            return TriggerBuilder.newTrigger()
                    .forJob(myCronJobDetail())
                    .withIdentity("myCronJobTrigger")
                    .withSchedule(cronScheduleBuilder)
                    .build();
        }
    }

其实上面的配置就等价于在传统的xml中配置bean是一样的。

### 6.启动测试 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70 3]  
至此，SpringBoot集成Quartz的完毕。

## 四、总结 ##

*  Spring Boot集成quartz还是比较简单的。
 *  其实还有更高级的用法，就是前台动态创建和控制定时任务，后面有时间再完善。大家先把这种最简单的基本用法熟练掌握。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70 4]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70 5]

Github地址：[源码][Link 2]

[Link 1]: http://quartz-scheduler.org/
[70]: /images/20220504/83f2c16c41644de982804ae4c56e41c9.png
[70 1]: /images/20220504/d3e51106c4bc4c56b783eb6a235f8d20.png
[70 2]: /images/20220504/ef1b92549eea4c258fa764d47256aaac.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70]: /images/20220504/f53e44c192c944539addcf2a0a533fc2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70 1]: /images/20220504/a39c167609304c95b1a5e9609dbbd1e5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70 2]: /images/20220504/1dccc499ac1a44faa9afa889570549ef.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70 3]: /images/20220504/2fae5fc15c9842d7bac576eacf060e6b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70 4]: /images/20220504/31212d0271ce49dbbbc9826118b317fa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTcyMzU0NA_size_27_color_FFFFFF_t_70 5]: /images/20220504/edfe8d7bbf11421f9660d253274ad902.png
[Link 2]: https://github.com/gyoomi/framework