SpringBoot 中定时任务功能入门(@scheduled)

2021-05-06 0 By admin

SpringBoot 框架中内置了定时任务的功能模块,我们只需要一个注解就可以开启它,使用起来很容易。

一、概述

1.1、定时任务基本使用过程

SpringBoot 框架中 @scheduled 的基本使用过程是:

  1. 在项目的启动类上添加 @EnableScheduling 注解,开启定时任务模块。
  2. 对项目设置时区选项,避免时区不对造成定时任务混乱。
  3. 创建定时任务,使用 @Scheduled 注解定时任务方法即可。

1.2、定时任务的三种执行模式

在 SpringBoot 框架中 @Scheduled 注解支持三种属性类型,定义不同的静态定时任务执行模式。

  1. cron: 定时执行任务。
  2. fixedRate:上一个调用开始后再次调用的延时(不用等待上一次调用完成)。
  3. fixedDelay:等到方法执行完成后延迟配置的时间再次执行该方法。

二、SpringBoot 框架使用定时任务过程

2.1、项目启动类的设置

@SpringBootApplication
@EnableScheduling //开启定时任务
public class DemoApplication {
  public static void main(String[] args) {
  //设置程序的时区
    TimeZone.setDefault(TimeZone.getTimeZone("Asia/Shanghai"));
    SpringApplication.run(DemoApplication.class, args);
  }
}

2.2、定时任务方法示例

创建一个每5秒钟执行一次的定时任务;fixedDelay 模式会等待上次执行完成后,才开始计时,执行间隔会大于5秒钟。

@Component
public class TimingTask {
    /**
     *  每五秒执行一次
     */
  @Scheduled(fixedDelay = 1000 * 5)
    public void executeFileDownLoadTask() {
        System.out.println("定时任务启动");
    }
}

三、cron 模式介绍

cron 模式可以设置指定的时间执行定时任务。
设定时间是通过七个字段实现,分别为:秒 分 小时 日期 月份 星期 年份。

3.1、常用的表达式

0 0 10,14,16 * * ? 每天上午10点,下午2点,4点每天上午10点,下午2点,4点
0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时
0 0 12 ? * WED 表示每个星期三中午12点
0 0 12 * * ? 每天中午12点触发
0 15 10 ? * * 每天上午10:15触发
0 15 10 * * ? 每天上午10:15触发
0 15 10 * * ? * 每天上午10:15触发
0 15 10 * * ? 2019 2019年的每天上午10:15触发
0 * 14 * * ? 在每天下午2点到下午2:59期间的每1分钟触发
0 0/5 14 * * ? 在每天下午2点到下午2:55期间的每5分钟触发
0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发
0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44触发
0 15 10 ? * MON-FRI 周一至周五的上午10:15触发
0 15 10 15 * ? 每月15日上午10:15触发
0 15 10 L * ? 每月最后一日的上午10:15触发
0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发
0 15 10 ? * 6L 2018-2019 2018年至2019年的每月的最后一个星期五上午10:15触发
0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发

3.2、特殊字符介绍

  • * 表示所有值。 例如:在分的字段上设置 *,表示每一分钟都会触发。
  • ? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作,但不关心是周几。
  • – 表示区间。例如 在小时上设置 “10-12”,表示 10,11,12点都会触发。
  • , 表示指定多个值,例如在周字段上设置 “MON,WED,FRI” 表示周一,周三和周五触发。
  • / 用于递增触发。如在秒上面设置”5/15” 表示从5秒开始,每增15秒触发(5,20,35,50)。 在月字段上设置’1/3’所示每月1号开始,每隔三天触发一次。
  • L 表示最后的意思。在周字段上表示星期六,相当于”7”或”SAT”。如果在”L”前加上数字,则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示“本月最后一个星期五”。
  • W 表示离指定日期的最近那个工作日(周一至周五)。 例如在日字段上置”15W”,表示离每月15号最近的那个工作日触发。如果15号正好是周六,则找最近的周五(14号)触发, 如果15号是周未,则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五),则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六,则将在3号下周一触发。(注,”W”前只能设置具体的数字,不允许区间”-“)。
  • # 序号(表示每月的第几个周几),例如在周字段上设置”6#3”表示在每月的第三个周六.注意如果指定”#5”,正好第五周没有周六,则不会触发该配置(用在母亲节和父亲节再合适不过了) ;小提示:’L’和 ‘W’可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发;周字段的设置,若使用英文字母是不区分大小写的,即MON与mon相同。

四、fixedRate 模式、fixedDelay 模式与 initialDelay 属性

fixedRate 模式和 fixedDelay 模式相似,另外还需要补充说明一下 initialDelay 属性。

4.1、fixedRate 模式

fixedRate 模式是上一个调用开始后再次调用的延时(不用等待上一次调用完成),这样就会存在重复执行的问题,不推荐使用。

@Scheduled(fixedRate = 5000)
public void fixedRate() throws InterruptedException {
	//log.info(".............s"+new Date());
	//Thread.sleep(8000);
	//log.info(".............e"+new Date());
}

4.2、fixedDelay 模式

fixedDelay 模式的效果与 fixedRate 模式相似,配置了该属性后会等到方法执行完成后延迟配置的时间再次执行该方法。

@Scheduled(fixedDelay = 5000)
// 5000毫秒执行一次
public void fixedDelay() throws InterruptedException {	
	log.info("............."+new Date());
	Thread.sleep(8000);
}

4.3、initialDelay 属性

initialDelay 属性 跟上面的fixedDelay、fixedRate有着密切的关系,该属性的作用是第一次执行延迟时间,只是做延迟的设定,并不会控制其他逻辑,所以要配合fixedDelay或者fixedRate来使用。

@Scheduled(fixedDelay = 5000, initialDelay=8000)
// 5000毫秒执行一次,第一次执行延时8000毫秒
public void fixedDelayAndInitialDelay() {
	//log.info("............."+new Date());
}