Spring Boot---(16)SpringBoot的定时任务（分别有Quartz和Scheduled）
SpringBoot的定时任务（分别有Quartz和Scheduled）
Quartz定时任务框架
Quartz可以与javaee与javase应用程序结合使用，也可以单独使用。
Quartz可以用来创建简单或为运行十个，百个，甚至是好几万个Jobs这样复杂的程序。Jobs可以做成标准的Java组件或EJBs。
Quartz的使用思路：
- job任务：你需要做什么事？
- Trigger触发器：你什么时候去做？
- Scheduler任务调度：你什么时候需要去做什么事？
Cron表达式讲解：
Cron表达式是一个字符串，分为6或7个域，每一个域代表一个含义
Cron有如下两个语法格式：
1.Seconds Minutes Hours Day Month Week Year
2.Seconds Minutes Hours Day Month Week
结构：
Cron从左到右（用空格隔开）：秒 分 小时 月份中的日期 月份 星期中的日期 年份
各字段含义：
位置 时间域名 允许值 允许的特殊字符
1 秒 0-59 , - /
2 分钟 0-59 , - /
3 小时 0-23 , - /
4 日 1-31 , - ? / L W C
5 月 1-12 , - /
6 星期日期 1-7 , - ? / L C #
7 年 1970-2099 , - /
：可以使用在所有字段中，表示对应时间的每一个时刻。比如：分钟字段中，表示每分钟。
? ：表示舍弃。比如：星期字段中使用?，则表示不使用星期。
- ：表示一个范围。比如：在小时字段中使用"10-12"，则表示10点到12点，即10,11,12。
, ：表示一个列表值。比如：在星期字段中使用"MON,WED,FRI"，则表示星期一，星期三和星期五。
/ ： x/y 表达一个等步长序列， x 为起始值， y 为增量步长值。 如在分钟字段中使用 0/15，
则表示为 0,15,30 和 45 秒， 而 5/15 在分钟字段中表示 5,20,35,50， 你也可以使用 / y，它等同于 0/y。
L ：该字符只在日期和星期字段中使用，代表“Last”的意思，但它在两个字段中意思不同。L 在日期字段中，
表示这个月份的最后一天，如一月的 31号，非闰年二月的 28号。如果 L用在星期中，则表示星 期六，等同于 7。但是，
如果 L出现在星期字段里，而且在前面有一个数值 X，则表示“这个月的最后 X天”，例如， 6L表示该月的最后星期五；
W ：该字符只能出现在日期字段里，是对前导日期的修饰，表示离该日期最近的工作日。例如 15W ，
表示离该月 15号最近的工作日，如果该月 15号是星期六，则匹配 14号星期五；如果 15日是星期日，
则匹配 16号星期一；如果 15号是星期二，那结果就是 15号星期二。但必须注意关联的匹配日期不能够 跨月，
如你指定 1W，如果 1号是星期六，结果匹配的是 3号星期一，而非上个月最后的那天。W 字符串只能指定单一日期，而不能指定日期范围；
LW 组合：在日期字段可以组合使用 LW，它的意思是当月的最后一个工作日；
# ：该字符只能在星期字段中使用，表示当月某个工作日。如 6#3表示当月的第三个星期五(6表示星期五， #3表示当前的第三个)，
而 4#5表示当月的第五个星期三，假设当月没有第五个星期三，忽略不触发；
C ：该字符只在日期和星期字段中使用，代表“Calendar”的意思。它的意思是计划所关联的日期，
如果日期没有被关联，则相当于日历中所有日期。例如 5 C 在日期字段中就相当于日历 5日以后的第一天。
1C 在星期字段中相当于星期日后的第一天。Cron 表达式对特殊字符的大小写不敏感，对代表星期的缩写英文大小写也不敏感。
例子：
@Scheduled(cron = "0 0 1 1 1 ?")//每年一月的一号的 1:00:00 执行一次
@Scheduled(cron = "0 0 1 1 1,6 ?") //一月和六月的一号的 1:00:00 执行一次
@Scheduled(cron = "0 0 1 1 1,4,7,10 ?") //每个季度的第一个月的一号的 1:00:00 执行一次
@Scheduled(cron = "0 0 1 1 ?")//每月一号 1:00:00 执行一次
@Scheduled(cron = "0 0 1 ") //每天凌晨 1 点执行一次
Scheduled任务定时器的使用
pom.xml的依赖包
<!-- 添加Scheduled依赖包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
</dependency>启动类
package com.kevin;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
/**
* @author kevin
* @version 1.0
* @description SpringBoot整合Scheduled定时任务器
*
* 在pom.xml中加入Scheduled依赖包
* <!-- 添加Scheduled依赖包 -->
* <dependency>
* <groupId>org.springframework</groupId>
* <artifactId>spring-context-support</artifactId>
* </dependency>
*
* @createDate 2019/3/20
*/
@SpringBootApplication
@EnableScheduling // 启动定时器
public class ScheduledApplication {
public static void main(String[] args) {
SpringApplication.run(ScheduledApplication.class,args);
}
}
Scheduled任务定时器的使用
package com.kevin.scheduled;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.util.Date;
/**
* @author kevin
* @version 1.0
* @description Scheduled定时任务
* @createDate 2019/3/20
*/
@Component
public class ScheduledDemo {
/**
* 定时任务方法
* @Scheduled：设置定时任务
* cron属性：cron表达式，定时任务触发是时间的一个字符串表达形式
*
*/
@Scheduled(cron = "2 * * * * ?")
public void scheduledMethod(){
// 设置为两秒启动一次
System.out.println("定时器被触发"+new Date());
}
}
测试Scheduled
Quartz定时任务框架
pom.xml中的依赖包
<dependencies>
<!-- springBoot的启动器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- thymeleaf的启动器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!-- 添加Scheduled依赖包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
</dependency>
<!-- spring tx事务的依赖包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
</dependency>
<!-- Quartz依赖包 -->
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz</artifactId>
<!-- 排除该依赖包内的slf4j-api依赖项 -->
<exclusions>
<exclusion>
<artifactId>slf4j-api</artifactId>
<groupId>org.slf4j</groupId>
</exclusion>
</exclusions>
</dependency>
</dependencies>启动类
package com.kevin;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
/**
* @author kevin
* @version 1.0
* @description SptingBoot整合Quart定时任务框架
* 编写配置类
*
* Quartz可以与javaee与javase应用程序结合使用，也可以单独使用。
* Quartz可以用来创建简单或为运行十个，百个，甚至是好几万个Jobs这样复杂的程序。Jobs可以做成标准的Java组件或EJBs。
*
* Quartz的使用思路：
* job任务：你需要做什么事？
* Trigger触发器：你什么时候去做？
* Scheduler任务调度：你什么时候需要去做什么事？
*
* 在pom.xml中加入以下依赖包
* <!-- 添加Scheduled依赖包 -->
* <dependency>
* <groupId>org.springframework</groupId>
* <artifactId>spring-context-support</artifactId>
* </dependency>
* <!-- spring tx事务的依赖包 -->
* <dependency>
* <groupId>org.springframework</groupId>
* <artifactId>spring-tx</artifactId>
* </dependency>
* <!-- Quartz依赖包 -->
* <dependency>
* <groupId>org.quartz-scheduler</groupId>
* <artifactId>quartz</artifactId>
* <!-- 排除该依赖包内的slf4j-api依赖项 -->
* <exclusions>
* <exclusion>
* <artifactId>slf4j-api</artifactId>
* <groupId>org.slf4j</groupId>
* </exclusion>
* </exclusions>
* </dependency>
* @createDate 2019/3/20
*/
@SpringBootApplication
@EnableScheduling // 开启定时器
public class QuartzApplication {
public static void main(String[] args) {
SpringApplication.run(QuartzApplication.class,args);
}
}
Service层
package com.kevin.service;
import org.springframework.stereotype.Service;
import java.util.Date;
/**
* @author kevin
* @version 1.0
* @description
* @createDate 2019/3/20
*/
@Service
public class UsersService {
public void addUsers(){
System.out.println("ServiceExecute..."+new Date());
}
}
配置类
package com.kevin.config;
import com.kevin.quartz.QuartzDemo;
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;
/**
* @author kevin
* @version 1.0
* @description Quartz配置类
* @createDate 2019/3/20
*/
@Configuration
public class QuartzConfig {
//1.创建Job对象
@Bean
public JobDetailFactoryBean jobDetailFactoryBean(){
JobDetailFactoryBean factory = new JobDetailFactoryBean();
// 关联我们自己的Job类
factory.setJobClass(QuartzDemo.class);
return factory;
}
// 2.创建Trigger对象。方式一：使用Cron Trigger，使用Cron表达式设置触发时间
@Bean
public CronTriggerFactoryBean cronTriggerFactoryBean(JobDetailFactoryBean jobDetailFactoryBean){
CronTriggerFactoryBean factory = new CronTriggerFactoryBean();
factory.setJobDetail(jobDetailFactoryBean.getObject());
// 设置触发时间
factory.setCronExpression("0/2 * * * * ?"); // 触发时间，每两秒触发一次
return factory;
}
//3.创建Schrduler对象，想要调用Service，所以需要将MyAdaptableJobFactory对象实例化
@Bean
public SchedulerFactoryBean schedulerFactoryBean(CronTriggerFactoryBean cronTriggerFactoryBean,
MyAdaptableJobFactory myAdaptableJobFactory){
SchedulerFactoryBean factory = new SchedulerFactoryBean();
// 关联Trigger对象
factory.setTriggers(cronTriggerFactoryBean.getObject());
// 调用到MyAdaptableJobFactory并完成对象实例化
factory.setJobFactory(myAdaptableJobFactory);
return factory;
}
//3.创建Schrduler对象，不需要调用Service
/*@Bean
public SchedulerFactoryBean schedulerFactoryBean(CronTriggerFactoryBean cronTriggerFactoryBean){
SchedulerFactoryBean factory = new SchedulerFactoryBean();
// 关联Trigger对象
factory.setTriggers(cronTriggerFactoryBean.getObject());
return factory;
}*/
//2.创建Trigger对象。方式二：简单的Trigger，使用内置方法设置触发时间
/*@Bean
public SimpleTriggerFactoryBean simpleTriggerFactoryBean(JobDetailFactoryBean jobDetailFactoryBean){
SimpleTriggerFactoryBean factory = new SimpleTriggerFactoryBean();
// 关联JobDetail对象
factory.setJobDetail(jobDetailFactoryBean.getObject());
// 该参数表示一个执行的毫秒数
factory.setRepeatInterval(2000);
// 重复次数
factory.setRepeatCount(5);
return factory;
}
//3.创建Schrduler对象
@Bean
public SchedulerFactoryBean schedulerFactoryBean(SimpleTriggerFactoryBean simpleTriggerFactoryBean){
SchedulerFactoryBean factory = new SchedulerFactoryBean();
// 关联Trigger对象
factory.setTriggers(simpleTriggerFactoryBean.getObject());
return factory;
}*/
}
需要使用Service层时配置的类
package com.kevin.config;
import org.quartz.spi.TriggerFiredBundle;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
import org.springframework.scheduling.quartz.AdaptableJobFactory;
import org.springframework.stereotype.Component;
/**
* @author kevin
* @version 1.0
* @description 想要调用service数据持久层需要重写createJobInstance，并将实例化对象注入到SpringIOC容器中
* 如果不要要在Job任务类中调用service，则不需要重写该类
* @createDate 2019/3/20
*/
@Component("myAdaptableJobFactory") // 给注入SpringIOC的对象起个名称
public class MyAdaptableJobFactory extends AdaptableJobFactory {
// AutowireCapableBeanFactory 可以将一个对象添加到SpringIOC容器中，并完成该对象注入
@Autowired
private AutowireCapableBeanFactory autowireCapableBeanFactory;
// 该方法需要将实例化的任务对象手动的添加到SpringIOC容器中并完成对象注入
@Override
protected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {
Object obj = super.createJobInstance(bundle);
// 将obj对象添加到SpringIOC容器中，并完成注入
this.autowireCapableBeanFactory.autowireBean(obj);
return obj;
}
}
Job执行的定时任务
package com.kevin.quartz;
import com.kevin.service.UsersService;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.beans.factory.annotation.Autowired;
/**
* @author kevin
* @version 1.0
* @description Job执行的任务类
* @createDate 2019/3/20
*/
public class QuartzDemo implements Job {
@Autowired
private UsersService usersService;
@Override
public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
//System.out.println("Execute..."+new Date());
this.usersService.addUsers();
}
}
上文有写了，只是再贴进去，这个代码不用理会
package com.kevin.scheduled;
/**
* @author kevin
* @version 1.0
* @description Cron表达式讲解
* @createDate 2019/3/20
*/
public class Cron {
/**
* Cron表达式讲解：
* Cron表达式是一个字符串，分为6或7个域，每一个域代表一个含义
* Cron有如下两个语法格式：
* 1.Seconds Minutes Hours Day Month Week Year
* 2.Seconds Minutes Hours Day Month Week
* 结构：
* Cron从左到右（用空格隔开）：秒 分 小时 月份中的日期 月份 星期中的日期 年份
* 各字段含义：
* 位置 时间域名 允许值 允许的特殊字符
* 1 秒 0-59 , - * /
* 2 分钟 0-59 , - * /
* 3 小时 0-23 , - * /
* 4 日 1-31 , - * ? / L W C
* 5 月 1-12 , - * /
* 6 星期日期 1-7 , - * ? / L C #
* 7 年 1970-2099 , - * /
*
* * ：可以使用在所有字段中，表示对应时间的每一个时刻。比如：分钟字段中，表示每分钟。
* ? ：表示舍弃。比如：星期字段中使用?，则表示不使用星期。
* - ：表示一个范围。比如：在小时字段中使用"10-12"，则表示10点到12点，即10,11,12。
* , ：表示一个列表值。比如：在星期字段中使用"MON,WED,FRI"，则表示星期一，星期三和星期五。
* / ： x/y 表达一个等步长序列， x 为起始值， y 为增量步长值。 如在分钟字段中使用 0/15，
* 则表示为 0,15,30 和 45 秒， 而 5/15 在分钟字段中表示 5,20,35,50， 你也可以使用* / y，它等同于 0/y。
* L ：该字符只在日期和星期字段中使用，代表“Last”的意思，但它在两个字段中意思不同。L 在日期字段中，
* 表示这个月份的最后一天，如一月的 31号，非闰年二月的 28号。如果 L用在星期中，则表示星 期六，等同于 7。但是，
* 如果 L出现在星期字段里，而且在前面有一个数值 X，则表示“这个月的最后 X天”，例如， 6L表示该月的最后星期五；
* W ：该字符只能出现在日期字段里，是对前导日期的修饰，表示离该日期最近的工作日。例如 15W ，
* 表示离该月 15号最近的工作日，如果该月 15号是星期六，则匹配 14号星期五；如果 15日是星期日，
* 则匹配 16号星期一；如果 15号是星期二，那结果就是 15号星期二。但必须注意关联的匹配日期不能够 跨月，
* 如你指定 1W，如果 1号是星期六，结果匹配的是 3号星期一，而非上个月最后的那天。W 字符串只能指定单一日期，而不能指定日期范围；
* LW 组合：在日期字段可以组合使用 LW，它的意思是当月的最后一个工作日；
* # ：该字符只能在星期字段中使用，表示当月某个工作日。如 6#3表示当月的第三个星期五(6表示星期五， #3表示当前的第三个)，
* 而 4#5表示当月的第五个星期三，假设当月没有第五个星期三，忽略不触发；
* C ：该字符只在日期和星期字段中使用，代表“Calendar”的意思。它的意思是计划所关联的日期，
* 如果日期没有被关联，则相当于日历中所有日期。例如 5 C 在日期字段中就相当于日历 5日以后的第一天。
* 1C 在星期字段中相当于星期日后的第一天。Cron 表达式对特殊字符的大小写不敏感，对代表星期的缩写英文大小写也不敏感。
* 例子：
* @Scheduled(cron = "0 0 1 1 1 ?")//每年一月的一号的 1:00:00 执行一次
* @Scheduled(cron = "0 0 1 1 1,6 ?") //一月和六月的一号的 1:00:00 执行一次
* @Scheduled(cron = "0 0 1 1 1,4,7,10 ?") //每个季度的第一个月的一号的 1:00:00 执行一次
* @Scheduled(cron = "0 0 1 1 * ?")//每月一号 1:00:00 执行一次
* @Scheduled(cron = "0 0 1 * * *") //每天凌晨 1 点执行一次
*
*/
}
测试