SpringBoot进阶（九）SpringBoot整合Quartz定时任务

前言

      本章讲解SpringBoot整合Quartz定时任务的相关知识

方法

1.概念

之前我们使用了Spring自带的简化版的Quartz做定时任务，可谓是十分的方便。

但是，简化版还是简化版，其只能应对较为简单的定时任务，复杂的定时任务还是要靠定时任务框架——Quartz来完成。

2.Quartz的基本要素

1. Scheduler：调度器。所有的调度都是由它控制。
2. Trigger： 触发器。决定什么时候来执行任务。
3. JobDetail & Job： JobDetail定义的是任务数据，而真正的执行逻辑是在Job中。使用JobDetail + Job而不是Job，这是因为任务是有可能并发执行，如果Scheduler直接使用Job，就会存在对同一个Job实例并发访问的问题。而JobDetail & Job 方式，sheduler每次执行，都会根据JobDetail创建一个新的Job实例，这样就可以规避并发访问的问题。

3.整合步骤

1）创建项目

2）修改pom文件，添加相关的依赖坐标

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.7.RELEASE</version>
	</parent>
	<groupId>cn.edu.ccut</groupId>
	<artifactId>springboot-quartz</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	
	<properties>
		<!-- 设定Java的版本 -->
		<java.version>1.8</java.version>
		<!-- 解决pom.xml首行报错 -->
		<maven-jar-plugin.version>3.1.0</maven-jar-plugin.version>
	</properties>
	
	<dependencies>
		<!-- 配置springBoot的web启动器 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<!-- 配置Quartz启动器  -->
		<dependency>
		    <groupId>org.springframework.boot</groupId>
		    <artifactId>spring-boot-starter-quartz</artifactId>
		</dependency>
		<!-- 配置devtools  -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-devtools</artifactId>
		</dependency>
	</dependencies>
	
	 <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <mainClass>cn.edu.ccut.App</mainClass>
                </configuration>
            </plugin>
        </plugins>
    </build>
    
</project>

3）创建定时任务类

package cn.edu.ccut.quartz;


import java.util.Date;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;

public class QuartzTest extends QuartzJobBean{

	@Override
	protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
		System.out.println("定时任务执行："+new Date());
	}

}

4）创建Quartz的配置类

package cn.edu.ccut.conf;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.quartz.CronTriggerFactoryBean;
import org.springframework.scheduling.quartz.JobDetailFactoryBean;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;

import cn.edu.ccut.quartz.QuartzTest;

@Configuration
public class QuartzConfig {

	@Bean
	public JobDetailFactoryBean getDetailFactoryBean(){
		JobDetailFactoryBean jobDetailFactoryBean = new JobDetailFactoryBean();
		jobDetailFactoryBean.setJobClass(QuartzTest.class);
		return jobDetailFactoryBean;
	}
	
	@Bean
	public CronTriggerFactoryBean getCronTriggerFactoryBean(JobDetailFactoryBean jobDetailFactoryBean){
		CronTriggerFactoryBean cronTriggerFactoryBean = new CronTriggerFactoryBean();
		cronTriggerFactoryBean.setJobDetail(jobDetailFactoryBean.getObject());
		cronTriggerFactoryBean.setCronExpression("0/2 * * * * ?");
		return cronTriggerFactoryBean;
	}
	
	@Bean
	public SchedulerFactoryBean getSchedulerFactoryBean(CronTriggerFactoryBean cronTriggerFactoryBean){
		SchedulerFactoryBean  factory = new SchedulerFactoryBean();
		factory.setTriggers(cronTriggerFactoryBean.getObject());
		return factory;
	}
}

5）修改启动器类,添加允许使用定时任务的注解

package cn.edu.ccut;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling
public class App {

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

}

6）启动SpringBoot，观察控制台效果

 

附录：多任务配置

若是要配置多任务，我的思路是这样的：

修改配置文件：

package cn.edu.ccut.conf;

import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import cn.edu.ccut.quartz.QuartzTest1;
import cn.edu.ccut.quartz.QuartzTest2;

@Configuration
public class QuartzConfig {

	    @Bean
	    public JobDetail testQuartz1() {
	        return JobBuilder.newJob(QuartzTest1.class).withIdentity("testTask1").storeDurably().build();
	    }

	    @Bean
	    public Trigger testQuartzTrigger1() {
	        //5秒执行一次
	        SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule()
	                .withIntervalInSeconds(5)
	                .repeatForever();
	        return TriggerBuilder.newTrigger().forJob(testQuartz1())
	                .withIdentity("testTask1")
	                .withSchedule(scheduleBuilder)
	                .build();
	    }

	    @Bean
	    public JobDetail testQuartz2() {
	        return JobBuilder.newJob(QuartzTest2.class).withIdentity("testTask2").storeDurably().build();
	    }

	    @Bean
	    public Trigger testQuartzTrigger2() {
	        //cron方式，每隔5秒执行一次
	        return TriggerBuilder.newTrigger().forJob(testQuartz2())
	                .withIdentity("testTask2")
	                .withSchedule(CronScheduleBuilder.cronSchedule("*/5 * * * * ?"))
	                .build();
	    }

}