SpringBoot Schedule

1、依赖在 pom 包中的配置

pom包里面只需要引入Spring Boot Starter包即可！

  1. <dependencies>
  2.     <!--spring boot核心-->
  3.     <dependency>
  4.         <groupId>org.springframework.boot</groupId>
  5.         <artifactId>spring-boot-starter</artifactId>
  6.     </dependency>
  7.     <!--spring boot 测试-->
  8.     <dependency>
  9.         <groupId>org.springframework.boot</groupId>
  10.         <artifactId>spring-boot-starter-test</artifactId>
  11.         <scope>test</scope>
  12.     </dependency>
  13. </dependencies>

2、启动类配置启用定时调度

在启动类上面加上@EnableScheduling即可开启定时

  1. @SpringBootApplication
  2. @EnableScheduling
  3. public class ScheduleApplication {
  4.     public static void main(String[] args) {
  5.         SpringApplication.run(ScheduleApplication.class, args);
  6.     }
  7. }

3、创建定时任务—@Scheduled参数详解

Spring Scheduler支持四种形式的任务调度！

  • fixedRate：固定速率执行，例如每5秒执行一次
  • fixedDelay：固定延迟执行，例如距离上一次调用成功后2秒执行
  • initialDelay：初始延迟任务，例如任务开启过5秒后再执行，之后以固定频率或者间隔执行
  • cron：使用 Cron 表达式执行定时任务

    3.1 zone

    时区，接收一个java.util.TimeZone#ID。cron表达式会基于该时区解析。默认是一个空字符串，即取服务器所在地的时区。比如一般使用的时区Asia/Shanghai。该字段一般留空。

    3.2 fixedRate—固定速率执行

    可以通过使用fixedRate参数以固定时间间隔来执行任务，示例如下：
    1. @Component
    2. public class SchedulerTask {
    3.   private static final Logger log = LoggerFactory.getLogger(SchedulerTask.class);
    4.   private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    5.   /**
    6.    * fixedRate：固定速率执行。每5秒执行一次。
    7.    */
    8.   @Scheduled(fixedRate = 5000)
    9.   public void runWithFixedRate() {
    10.       log.info("Fixed Rate Task，Current Thread : {}，The time is now : {}", Thread.currentThread().getName(), dateFormat.format(new Date()));
    11.   }
    12. }
    运行ScheduleApplication主程序，即可看到控制台输出效果：
    1. Fixed Rate Task，Current Thread : scheduled-thread-1，The time is now : 2020-12-15 11:46:00
    2. Fixed Rate Task，Current Thread : scheduled-thread-1，The time is now : 2020-12-15 11:46:10
    3. ...

    fixedRateString

    与 fixedRate 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

    3.3 fixedDelay—固定延迟执行

    可以通过使用fixedDelay参数来设置上一次任务调用完成与下一次任务调用开始之间的延迟时间，示例如下：
    1. @Component
    2. public class SchedulerTask {
    3.   private static final Logger log = LoggerFactory.getLogger(SchedulerTask.class);
    4.   private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    5.   /**
    6.    * fixedDelay：固定延迟执行。距离上一次调用成功后2秒后再执行。
    7.    */
    8.   @Scheduled(fixedDelay = 2000)
    9.   public void runWithFixedDelay() {
    10.       log.info("Fixed Delay Task，Current Thread : {}，The time is now : {}", Thread.currentThread().getName(), dateFormat.format(new Date()));
    11.   }
    12. }
    控制台输出效果：
    1. Fixed Delay Task，Current Thread : scheduled-thread-1，The time is now : 2020-12-15 11:46:00
    2. Fixed Delay Task，Current Thread : scheduled-thread-1，The time is now : 2020-12-15 11:46:02
    3. ...

    fixedDelayString

    与 fixedDelay 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。如：
    1. @Scheduled(fixedDelayString = "5000") //上一次执行完毕时间点之后5秒再执行
    占位符的使用(配置文件中有配置：time.fixedDelay=5000)：
    1. @Scheduled(fixedDelayString = "${time.fixedDelay}")
    2. void testFixedDelayString() {
    3.   System.out.println("Execute at " + System.currentTimeMillis());
    4. }

    3.4 初始延迟任务

    可以通过使用initialDelay参数与fixedRate或者fixedDelay搭配使用来实现初始延迟任务调度。
    1. @Component
    2. public class SchedulerTask {
    3.   private static final Logger log = LoggerFactory.getLogger(SchedulerTask.class);
    4.   private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    5.   /**
    6.    * initialDelay:初始延迟。任务的第一次执行将延迟5秒，然后将以5秒的固定间隔执行。
    7.    */
    8.   @Scheduled(initialDelay = 5000, fixedRate = 5000)
    9.   public void reportCurrentTimeWithInitialDelay() {
    10.       log.info("Fixed Rate Task with Initial Delay，Current Thread : {}，The time is now : {}", Thread.currentThread().getName(), dateFormat.format(new Date()));
    11.   }
    12. }
    控制台输出效果：
    1. Fixed Rate Task with Initial Delay，Current Thread : scheduled-thread-1，The time is now : 2020-12-15 11:46:05
    2. Fixed Rate Task with Initial Delay，Current Thread : scheduled-thread-1，The time is now : 2020-12-15 11:46:10
    3. ...

    initialDelayString

    与 initialDelay 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

    3.5 使用 Cron 表达式

    Spring Scheduler同样支持Cron表达式，如果以上简单参数都不能满足现有的需求，可以使用 cron 表达式来定时执行任务。
    该参数接收一个cron表达式，cron表达式是一个字符串，字符串以5或6个空格隔开，分开共6或7个域，每一个域代表一个含义。

    cron表达式语法

    1. [秒] [分] [小时] [日] [月] [周] [年]

    注：[年]不是必须的域，可以省略[年]，则一共6个域

序号 说明 必填 允许填写的值 允许的通配符
1 秒 是 0-59 , - * /
2 分 是 0-59 , - * /
3 时 是 0-23 , - * /
4 日 是 1-31 , - * ? / L W
5 月 是 1-12 / JAN-DEC , - * /
6 周 是 1-7 or SUN-SAT , - * ? / L #
7 年 否 1970-2099 , - * /

通配符说明:
  • * 表示所有值。例如:在分的字段上设置 *,表示每一分钟都会触发。
  • ? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为”?” 具体设置为 0 0 0 10 * ?
  • - 表示区间。例如 在小时上设置 “10-12”,表示 10,11,12点都会触发。
  • , 表示指定多个值，例如在周字段上设置 “MON,WED,FRI” 表示周一，周三和周五触发
  • / 用于递增触发。如在秒上面设置”5/15” 表示从5秒开始，每增15秒触发(5,20,35,50)。在月字段上设置’1/3’所示每月1号开始，每隔三天触发一次。
  • L 表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六，相当于”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相同。

    示例

  • 每隔5秒执行一次：/5 * ?

  • 每隔1分钟执行一次：0 /1 ?
  • 每天23点执行一次：0 0 23 ?
  • 每天凌晨1点执行一次：0 0 1 ?
  • 每月1号凌晨1点执行一次：0 0 1 1 * ?
  • 每月最后一天23点执行一次：0 0 23 L * ?
  • 每周星期天凌晨1点实行一次：0 0 1 ? * L
  • 在26分、29分、33分执行一次：0 26,29,33 * ?
  • 每天的0点、13点、18点、21点都执行一次：0 0 0,13,18,21 ?
    cron表达式使用占位符
    另外，cron属性接收的cron表达式支持占位符。eg：
    配置文件：
    1. time:
    2. cron: */5 * * * * *
    3. interval: 5
    每5秒执行一次：
    1. @Scheduled(cron="${time.cron}")
    2. void testPlaceholder1() {
    3.   System.out.println("Execute at " + System.currentTimeMillis());
    4. }
    5. @Scheduled(cron="*/${time.interval} * * * * *")
    6. void testPlaceholder2() {
    7.   System.out.println("Execute at " + System.currentTimeMillis());
    8. }
    更多关于cron表达式的具体用法，可以点击参考这里：https://cron.qqe2.com/
    1. @Component
    2. public class SchedulerTask {
    3.   private static final Logger log = LoggerFactory.getLogger(SchedulerTask.class);
    4.   private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    5.   /**
    6.    * cron：使用Cron表达式。每6秒中执行一次
    7.    */
    8.   @Scheduled(cron = "*/6 * * * * ?")
    9.   public void reportCurrentTimeWithCronExpression() {
    10.       log.info("Cron Expression，Current Thread : {}，The time is now : {}", Thread.currentThread().getName(), dateFormat.format(new Date()));
    11.   }
    12. }
    控制台输出效果：
    1. Cron Expression，Current Thread : scheduled-thread-1，The time is now : 2020-12-15 11:46:06
    2. Cron Expression，Current Thread : scheduled-thread-1，The time is now : 2020-12-15 11:46:12
    3. ...

    3.5 异步执行定时任务

    在下面的示例中，创建了一个每隔2秒执行一次的定时任务，在任务里面大概需要花费 3 秒钟，猜猜执行结果如何？
    1. @Component
    2. public class AsyncScheduledTask {
    3.   private static final Logger log = LoggerFactory.getLogger(AsyncScheduledTask.class);
    4.   private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    5.   @Scheduled(fixedRate = 2000)
    6.   public void runWithFixedDelay() {
    7.       try {
    8.           TimeUnit.SECONDS.sleep(3);
    9.           log.info("Fixed Delay Task, Current Thread : {} : The time is now {}", Thread.currentThread().getName(), dateFormat.format(new Date()));
    10.       } catch (InterruptedException e) {
    11.           log.error("错误信息",e);
    12.       }
    13.   }
    14. }
    控制台输入结果：
    1. Fixed Delay Task, Current Thread : scheduling-1 : The time is now 2020-12-15 17:55:26
    2. Fixed Delay Task, Current Thread : scheduling-1 : The time is now 2020-12-15 17:55:31
    3. Fixed Delay Task, Current Thread : scheduling-1 : The time is now 2020-12-15 17:55:36
    4. Fixed Delay Task, Current Thread : scheduling-1 : The time is now 2020-12-15 17:55:41
    5. ...
    很清晰的看到，任务调度频率变成了每隔5秒调度一次！
    这是为啥呢？
    从Current Thread : scheduling-1输出结果可以很看到，任务执行都是同一个线程！默认的情况下，@Scheduled任务都在 Spring 创建的大小为 1 的默认线程池中执行！
    更直观的结果是，任务都是串行执行！
    下面，将其改成异步线程来执行，看看效果如何？
    1. @Component
    2. @EnableAsync
    3. public class AsyncScheduledTask {
    4.   private static final Logger log = LoggerFactory.getLogger(AsyncScheduledTask.class);
    5.   private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    6.   @Async
    7.   @Scheduled(fixedDelay = 2000)
    8.   public void runWithFixedDelay() {
    9.       try {
    10.           TimeUnit.SECONDS.sleep(3);
    11.           log.info("Fixed Delay Task, Current Thread : {} : The time is now {}", Thread.currentThread().getName(), dateFormat.format(new Date()));
    12.       } catch (InterruptedException e) {
    13.           log.error("错误信息",e);
    14.       }
    15.   }
    16. }
    控制台输出结果：
    1. Fixed Delay Task, Current Thread : SimpleAsyncTaskExecutor-1 : The time is now 2020-12-15 18:55:26
    2. Fixed Delay Task, Current Thread : SimpleAsyncTaskExecutor-2 : The time is now 2020-12-15 18:55:28
    3. Fixed Delay Task, Current Thread : SimpleAsyncTaskExecutor-3 : The time is now 2020-12-15 18:55:30
    4. ...
    任务的执行频率不受方法内的时间影响，以并行方式执行！

    3.6 自定义任务线程池

    虽然默认的情况下，@Scheduled任务都在 Spring 创建的大小为 1 的默认线程池中执行，但是也可以自定义线程池，只需要实现SchedulingConfigurer类即可！
    自定义线程池示例如下：
    1. @Configuration
    2. public class SchedulerConfig implements SchedulingConfigurer {
    3.   @Override
    4.   public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
    5.       ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
    6.       //线程池大小为10
    7.       threadPoolTaskScheduler.setPoolSize(10);
    8.       //设置线程名称前缀
    9.       threadPoolTaskScheduler.setThreadNamePrefix("scheduled-thread-");
    10.       //设置线程池关闭的时候等待所有任务都完成再继续销毁其他的Bean
    11.       threadPoolTaskScheduler.setWaitForTasksToCompleteOnShutdown(true);
    12.       //设置线程池中任务的等待时间，如果超过这个时候还没有销毁就强制销毁，以确保应用最后能够被关闭，而不是阻塞住
    13.       threadPoolTaskScheduler.setAwaitTerminationSeconds(60);
    14.       //这里采用了CallerRunsPolicy策略，当线程池没有处理能力的时候，该策略会直接在 execute 方法的调用线程中运行被拒绝的任务；如果执行程序已关闭，则会丢弃该任务
    15.       threadPoolTaskScheduler.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
    16.       threadPoolTaskScheduler.initialize();
    17.       scheduledTaskRegistrar.setTaskScheduler(threadPoolTaskScheduler);
    18.   }
    19. }
    启动服务，看看cron任务示例调度效果：
    1. Cron Expression，Current Thread : scheduled-thread-1，The time is now : 2020-12-15 20:46:00
    2. Cron Expression，Current Thread : scheduled-thread-2，The time is now : 2020-12-15 20:46:06
    3. Cron Expression，Current Thread : scheduled-thread-3，The time is now : 2020-12-15 20:46:12
    4. Cron Expression，Current Thread : scheduled-thread-4，The time is now : 2020-12-15 20:46:18
    5. ....
    当前线程名称已经被改成自定义scheduled-thread的前缀！