Spring Cloud 2.x系列之springboot集成quartz

• java设计模式之观察者模式
  
• 一大波视频分享
• Mysql代理中间件Atlas安装和配置

在做项目时有时候会有定时器任务的功能，比如某某时间应该做什么，多少秒应该怎么样之类的。定时任务常用的业务场景是进行数据统计。spring支持多种定时任务的实现，今天介绍一下spring定时器和quartz定时器的使用。

一、spring定时器

spring自带支持定时器的任务实现。其可通过简单配置来实现定时任务。主要用到如下两注解：

@EnableScheduling：标注启动定时任务

         @Scheduled：定义某个定时任务

常用说明：

@Scheduled(fixedRate=2000)：上一次开始执行时间点后2秒再次执行

        @Scheduled(fixedDelay=2000)：上一次执行完毕时间点后2秒再次执行

        @Scheduled(initialDelay=1000,fixedDelay=2000)：第一次延迟1秒执行，然后在上一次执行完毕时间点后2秒再次执行

        @Scheduled(cron="** * * * ?")：按cron规则执行

二、quartz定时任务

       quzrtz主要理解如下几个概念：

Job：是一个接口，只有一个方法void execute(JobExecutionContext context)，开发者实现该接口定义运行任务，JobExecutionContext类提供了调度上下文的各种信息。Job运行时的信息保存在JobDataMap实例中。

JobDetail：Quartz在每次执行Job时，都重新创建一个Job实例，所以它不直接接受一个Job的实例，相反它接收一个Job实现类，以便运行时通过newInstance()的反射机制实例化Job。因此需要通过一个类来描述Job的实现类及其它相关的静态信息，如Job名字、描述、关联监听器等信息，JobDetail承担了这一角色。

Trigger：是一个类，描述触发Job执行的时间触发规则。主要有SimpleTrigger和CronTrigger这两个子类。当仅需触发一次或者以固定时间间隔周期执行，SimpleTrigger是最适合的选择；而CronTrigger则可以通过Cron表达式定义出各种复杂时间规则的调度方案：如每凌晨1:00执行，周一、周三、周五下午5:00执行等；

Calendar：org.quartz.Calendar和java.util.Calendar不同，它是一些日历特定时间点的集合（可以简单地将org.quartz.Calendar看作java.util.Calendar的集合——java.util.Calendar代表一个日历时间点，无特殊说明后面的Calendar即指org.quartz.Calendar）。一个Trigger可以和多个Calendar关联，以便排除或包含某些时间点。假设，我们安排每周星期一早上10:00执行任务，但是如果碰到法定的节日，任务则不执行，这时就需要在Trigger触发机制的基础上使用Calendar进行定点排除。

Scheduler：代表一个Quartz的独立运行容器，Trigger和JobDetail可以注册到Scheduler中，两者在Scheduler中拥有各自的组及名称，组及名称是Scheduler查找定位容器中某一对象的依据，Trigger的组及名称必须唯一，JobDetail的组和名称也必须唯一（但可以和Trigger的组和名称相同，因为它们是不同类型的）。Scheduler定义了多个接口方法，允许外部通过组及名称访问和控制容器中Trigger和JobDetail。

 

1、新建项目，对应的pom.xml文件如下

<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.0http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>spring-cloud</groupId> <artifactId>sc-scheduled</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>sc-scheduled</name> <url>http://maven.apache.org</url> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.4.RELEASE</version> </parent> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Finchley.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- 集成quartz需要引入 --> <!--quartz相关依赖--> <!-- <dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz</artifactId> </dependency> <dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz-jobs</artifactId> </dependency>--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-quartz</artifactId> </dependency> </dependencies> </project>

2、新建sprinboot启动类ScheduledApplication.java

package sc.schedule; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.scheduling.annotation.EnableScheduling; @SpringBootApplication @EnableScheduling // 开启spring自带定时任务 publicclass ScheduledApplication { public static void main(String[] args) { SpringApplication.run(ScheduledApplication.class, args); } }

3、Spring定时任务类

packagesc.schedule.spring; import java.text.SimpleDateFormat; import java.util.Date; import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Component; @Component public class SpringScheduled { // 每1分钟执行一次 @Scheduled(cron = "0 */1 * ** * ") public void reportCurrentByCron() { System.out.println("Spring Scheduling Tasks: " + dateFormat().format(new Date())); } private SimpleDateFormat dateFormat() { returnnewSimpleDateFormat("HH:mm:ss"); } }

4、Quartz定时任务类

单任务模式：

package sc.schedule.quartz; import org.quartz.JobDetail; import org.quartz.Trigger; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.scheduling.quartz.CronTriggerFactoryBean; import org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean; importorg.springframework.scheduling.quartz.SchedulerFactoryBean; @Configuration publicclass QuartzScheduledOne { @Bean public ScheduledJobOne getScheduledJobOne(){ return new ScheduledJobOne(); } /** * 调度工厂 * *@param jobTrigger * 触发器 *@return */ @Bean(name = "scheduler") public SchedulerFactoryBean schedulerFactory(Trigger jobTrigger) { SchedulerFactoryBeanfactoryBean = new SchedulerFactoryBean(); // 用于quartz集群,QuartzScheduler 启动时更新己存在的Job factoryBean.setOverwriteExistingJobs(true); // 延时启动，应用启动1秒后 factoryBean.setStartupDelay(1); // 注册触发器 factoryBean.setTriggers(jobTrigger); return factoryBean; } /** * * 定时触发器 * *@param reptilianJob * 任务 * *@return * */ @Bean(name = "jobTrigger") public CronTriggerFactory BeancronJobTrigger(JobDetail jobDetail) { CronTriggerFactoryBean tigger = newCronTriggerFactoryBean(); tigger.setJobDetail(jobDetail); // cron表达式，每1分钟执行一次 tigger.setCronExpression("0/20 ** * * ?"); tigger.setName("jobTrigger"); return tigger; } /** * 配置任务 * *@param quartzTask * QuartzTask为需要执行的任务 *@return */ @Bean(name = "jobDetail") public MethodInvokingJobDetailFactory BeandetailFactoryBean(ScheduledJobOne quartzTask) { MethodInvokingJobDetailFactoryBeanjobDetail = new MethodInvokingJobDetailFactoryBean(); // 是否并发执行 jobDetail.setConcurrent(false); // 设置任务的名字 jobDetail.setName("jobDetail"); // 设置任务的分组，在多任务的时候使用 jobDetail.setGroup("jobDetailGroup"); // 需要执行的对象 jobDetail.setTargetObject(quartzTask); /* * TODO非常重要 执行QuartzTask类中的需要执行方法 */ jobDetail.setTargetMethod("execute"); return jobDetail; } } 

任务模式参考源码

5、对应的类结构说明

6、启动ScheduledApplication类，并验证定时任务是否启动

(1)  注释QuartzScheduled类的Configuration注解

启动ScheduledApplication类查看日志：

(2)  放开QuartzScheduled类的Configuration注解，然后注释QuartzScheduled类的Configuration注解

启动ScheduledApplication类查看日志：

源码：

https://gitee.com/hjj520/spring-cloud-2.x/tree/master/sc-scheduled

本文作者：java乐园

本文来自云栖社区合作伙伴“JAVA乐园”，了解相关信息可以关注“JAVA乐园”