示例源码下载:https://github.com/AlgerFan/springBootExample ,欢迎 star。

一、前言

  使用 SpringBoot 也很长时间了,也做过几个小项目,最近有时间总结一下,话不多说,本篇介绍一下 Spring Boot 的两种定时任务技术,下面直接代码演示

二、代码演示

1. Scheduled 定时任务器(Spring3.0 以后自带的一个定时任务器)

1.1 pom 文件添加 Scheduled 的坐标
<!-- 添加Scheduled坐标 -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context-support</artifactId>
</dependency>
1.2 编写定时任务类
/**
 * @author AlgerFan
 * @date Created in 2019/2/16 09
 * @Description Scheduled定时任务
 */
@Component
public class ScheduledDemo {

	/**
	 * 定时任务方法
	 * @Scheduled: 设置定时任务,使用了cron表达式
	 */
	@Scheduled(cron="0/3 * * * * ?")
	public void scheduledMethod(){
		System.out.println("定时器被触发"+new Date());
	}
}
1.3 修改启动类开启定时任务
@SpringBootApplication
@EnableScheduling
public class SpringBoot31ScheduledApplication {

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

}
1.4 cron 表达式讲解

Cron 表达式是一个字符串,分为 6 或 7 个域,每一个域代表一个含义
Cron 有如下两种语法格式:
Seconds Minutes Hours Day Month Week Year
Seconds Minutes Hours Day Month Week

  1. 结构
    corn 从左到右(用空格隔开):秒 分 小时 月份中的日期 月份 星期中的日期 年份
  2. 各字段的含义
位置 时间域名 允许值 允许的特殊字符
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 , - * /

Cron 表达式的时间字段除允许设置数值外,还可使用一些特殊的字符,提供列表、范围、通配符等功能,细说如下:

  • 星号(*):可用在所有字段中,表示对应时间域的每一个时刻,例如,*在分钟字段时,表示“每分钟”;
  • 问号(?):该字符只在日期和星期字段中使用,它通常指定为“无意义的值”,相当于占位符;
  • 减号(-):表达一个范围,如在小时字段中使用“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”的意思。它的意思是计划所关联的日期,如果日期没有被关联,则相当于日历中所有日期。例如 5C 在日期字段中就相当于日历 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(cron="0 0/5 14,18 * * ?") //每天 14 点整,和 18 点整,每隔 5 分钟执行一次
@Scheduled(cron="0 15 10 ? * 1-6") //每个月的周一至周六 10:15 分执行一次
@Scheduled(cron="0 0 2 ? * 6L") //每个月的最后一个周六凌晨 2 点执行一次
@Scheduled(cron="0 0 2 LW * ?") //每个月的最后一个工作日凌晨 2 点执行一次
@Scheduled(cron="0 0 2-4 ? * 1#1") //每个月的第一个周一凌晨 2 点到 4 点期间,每个整点都执行一次;

2. Spring Boot 整合 Quartz 定时任务框架

2.1 Quartz 的基本使用方式

1)修改 pom 文件添加 Quartz 的坐标

<!-- Quartz坐标 -->
<dependency>
    <groupId>org.quartz-scheduler</groupId>
    <artifactId>quartz</artifactId>
    <version>2.2.1</version>
</dependency>

2)创建 Job 类

**
 * @author AlgerFan
 * @date Created in 2019/2/16 09
 * @Description 定义任务类
 */
public class QuartzDemo implements Job {

	/**
	 * 任务被触发时所执行的方法
	 */
	public void execute(JobExecutionContext arg0) {
		System.out.println("Execute...."+new Date());
	}

}

3)测试代码

/**
 * @author AlgerFan
 * @date Created in 2019/2/16 09
 * @Description 启动类
 */
public class QuartzMain {

	public static void main(String[] args) throws Exception {

		// 1.创建Job对象:你要做什么事?
		JobDetail job = JobBuilder.newJob(QuartzDemo.class).build();

		/**
		 * 简单的trigger触发时间:通过Quartz提供一个方法来完成简单的重复调用 cron
		 * Trigger:按照Cron的表达式来给定触发的时间
		 */
		// 2.创建Trigger对象:在什么时间做?
		/*Trigger trigger = TriggerBuilder.newTrigger().withSchedule(SimpleScheduleBuilder.repeatSecondlyForever())
				.build();*/
		
		
		Trigger trigger = TriggerBuilder.newTrigger().withSchedule(CronScheduleBuilder.cronSchedule("0/3 * * * * ?"))
				.build();

		// 3.创建Scheduler对象:在什么时间做什么事?
		Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
		scheduler.scheduleJob(job, trigger);
		
		//启动
		scheduler.start();
	}

}
2.2 Spring Boot 整合 Quartz 定时框架

1)pom 文件添加坐标

<!-- Quartz坐标 -->
		<dependency>
			<groupId>org.quartz-scheduler</groupId>
			<artifactId>quartz</artifactId>
			<version>2.2.1</version>
			<exclusions>
				<exclusion>
					<artifactId>slf4j-api</artifactId>
					<groupId>org.slf4j</groupId>
				</exclusion>
			</exclusions>
		</dependency>

		<!-- 添加Scheduled坐标 -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context-support</artifactId>
		</dependency>

		<!-- Sprng tx 坐标 -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-tx</artifactId>
		</dependency>

2)编写定时任务类

/**
 * @author AlgerFan
 * @date Created in 2019/2/16 09
 * @Description Job类
 */
public class QuartzDemo implements Job {

	@Override
	public void execute(JobExecutionContext arg0) {
		System.out.println("定时器被触发"+new Date());
	}
}

3)编写 Quartz 的启动类

/**
 * @author AlgerFan
 * @date Created in 2019/2/16 09
 * @Description Quartz配置类
 */
@Configuration
public class QuartzConfig {

	/**
	 * 1.创建Job对象
	 */
	@Bean
	public JobDetailFactoryBean jobDetailFactoryBean(){
		JobDetailFactoryBean factory = new JobDetailFactoryBean();
		//关联我们自己的Job类
		factory.setJobClass(QuartzDemo.class);
		return factory;
	}
	
	/**
	 * 2.创建Trigger对象
	 * 简单的Trigger
	 */
	/*@Bean
	public SimpleTriggerFactoryBean simpleTriggerFactoryBean(JobDetailFactoryBean jobDetailFactoryBean){
		SimpleTriggerFactoryBean factory = new SimpleTriggerFactoryBean();
		//关联JobDetail对象
		factory.setJobDetail(jobDetailFactoryBean.getObject());
		//该参数表示一个执行的毫秒数
		factory.setRepeatInterval(3000);
		//重复次数
		factory.setRepeatCount(5);
		return factory;
	}*/
	
	/**
	 * Cron Trigger
	 */
	@Bean
	public CronTriggerFactoryBean cronTriggerFactoryBean(JobDetailFactoryBean jobDetailFactoryBean){
		CronTriggerFactoryBean factory = new CronTriggerFactoryBean();
		factory.setJobDetail(jobDetailFactoryBean.getObject());
		//设置触发时间
		factory.setCronExpression("0/3 * * * * ?");
		return factory;
	}
	
	/**
	 * 3.创建Scheduler对象
	 */
	@Bean
	public SchedulerFactoryBean schedulerFactoryBean(CronTriggerFactoryBean cronTriggerFactoryBean){
		SchedulerFactoryBean factory = new SchedulerFactoryBean();
		//关联trigger
		factory.setTriggers(cronTriggerFactoryBean.getObject());
		return factory;
	}
}

3)修改启动类开启定时任务

@SpringBootApplication
@EnableScheduling
public class SpringBoot32QuartzApplication {

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

}
2.3 Job 类中注入对象

1)注入对象

/**
 * @author AlgerFan
 * @date Created in 2019/2/16 09
 */
@Service
public class UsersService {

	public void addUsers(){
		System.out.println("Add Users......");
	}
}

/**
 * @author AlgerFan
 * @date Created in 2019/2/16 09
 * @Description Job类
 */
public class QuartzDemo implements Job {
	
	@Autowired
	private UsersService usersService;
	
	@Override
	public void execute(JobExecutionContext arg0) {
		System.out.println("定时器被触发"+new Date());
		this.usersService.addUsers();
	}
}

2)直接注入会报异常
5c677101470c1.png
说明:JobDetailFactoryBean 在实例化 QuartzDemo 对象时,所用的是 AdaptableJobFactory 的 createJobInstance 的方法,实例化的方法是采用反射的机制来实例化的,那就意味着 QuartzDemo 对象实例化没有经过 Spring 的处理,在 Spring 的 IoC 中就没有这个对象,因此无法完成注入。

3)解决方案,将对象手动添加到 Spring 的 IoC 容器中,并且完成注入

/**
 * @author AlgerFan
 * @date Created in 2019/2/16 09
 */
@Component("myAdaptableJobFactory")
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对象添加Spring IOC容器中,并完成注入
		this.autowireCapableBeanFactory.autowireBean(obj);
		return obj;
	}

}

4)修改 QuartzConfig 类

	/**
	 * 3.创建Scheduler对象
	 */
	@Bean
	public SchedulerFactoryBean schedulerFactoryBean(CronTriggerFactoryBean cronTriggerFactoryBean,MyAdaptableJobFactory myAdaptableJobFactory){
		SchedulerFactoryBean factory = new SchedulerFactoryBean();
		//关联trigger
		factory.setTriggers(cronTriggerFactoryBean.getObject());
		factory.setJobFactory(myAdaptableJobFactory);
		return factory;
	}

标题:(11)Spring Boot2.0 两种定时任务技术
作者:AlgerFan
地址:https://www.algerfan.cn/articles/2018/09/13/1536804314012.html
版权声明:本文为博主原创文章,转载请附上博文链接!