【任务篇】Spring Boot 内置定时任务 Spring Task

写在最前

定时任务意指：指定时间执行的任务（业务代码）。

定时任务的场景非常广泛，比如：清理一些堆积的数据；推送短信、邮件；关闭已结束的活动；积分过期每年结算等等。

实现方式

JDK 自带 Timer；
Quartz 框架；
Spring Task；
XXL-Job；
…

Cron 表达式

Cron 表达式是一个具有时间含义的字符串，字符串以5个空格隔开，分为6个域，格式为 X X X X X X。其中 X 是一个域的占位符。单个域有多个取值时，使用半角逗号 , 隔开取值。每个域可以是确定的取值，也可以是具有逻辑意义的特殊字符。

Cron表达式生成器

域取值

域	是否必需	取值范围	特殊字符
秒	是	[0, 59]	* , – /
分钟	是	[0, 59]	* , – /
小时	是	[0, 23]	* , – /
日期	是	[1, 31]	* , – / ? L W
月份	是	[1, 12]或[JAN, DEC]	* , – /
星期	是	[1, 7]或[MON, SUN]。若您使用[1, 7]表达方式，`1`代表星期一，`7`代表星期日。	* , – / ? L #

特殊字符

特殊字符	含义	示例
`*`	所有可能的值。	在月域中，``表示每个月；在星期域中，``表示星期的每一天。
`,`	列出枚举值。	在分钟域中，`5,20`表示分别在5分钟和20分钟触发一次。
`-`	范围。	在分钟域中，`5-20`表示从5分钟到20分钟之间每隔一分钟触发一次。
`/`	指定数值的增量。	在分钟域中，`0/15`表示从第0分钟开始，每15分钟。在分钟域中`3/20`表示从第3分钟开始，每20分钟。
`?`	不指定值，仅日期和星期域支持该字符。	当日期或星期域其中之一被指定了值以后，为了避免冲突，需要将另一个域的值设为`?`。
`L`	单词Last的首字母，表示最后一天，仅日期和星期域支持该字符。指定`L`字符时，避免指定列表或者范围，否则，会导致逻辑问题。	在日期域中，`L`表示某个月的最后一天。在星期域中，`L`表示一个星期的最后一天，也就是星期日（`SUN`）。如果在`L`前有具体的内容，例如，在星期域中的`6L`表示这个月的最后一个星期六。
`W`	除周末以外的有效工作日，在离指定日期的最近的有效工作日触发事件。`W`字符寻找最近有效工作日时不会跨过当前月份，连用字符`LW`时表示为指定月份的最后一个工作日。	在日期域中`5W`，如果5日是星期六，则将在最近的工作日星期五，即4日触发。如果5日是星期天，则将在最近的工作日星期一，即6日触发；如果5日在星期一到星期五中的一天，则就在5日触发。
`#`	确定每个月第几个星期几，仅星期域支持该字符。	在星期域中，`4#2`表示某月的第二个星期四。

Spring Boot 整合 Spring Task

Spring Task 是 Spring 自主研发的轻量级定时任务工具，相比于 Quartz 更加简单方便，且不需要引入其他依赖即可使用。Spring Task 缺点在于不支持持久化，并且默认是所有定时任务都在一个线程中执行，不配置线程池可能会出现线程阻塞、卡死等！

Demo地址：mingyue-springboot-task

1.开启 Spring Task

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

/** @author Strive */
@EnableScheduling
@SpringBootApplication
public class MingYueSpringbootTaskApplication {

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

2.编写定时任务

import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

/**
 * @author Strive
 * @date 2022/4/18 16:19
 * @description 明月定时任务
 */
@Slf4j
@Component
public class MingYueScheduledTask {

  /** 每1分钟扫描一次，扫描发送失败的短信，再次发送 */
  @Scheduled(cron = "0 0/1 * * * ?")
  private void sendErrorMsg() {
    log.info("发送失败的短信，再次发送");
  }
}

启动项目，查看日志打印

16:37:00.009  INFO 6192 --- [   scheduling-1] c.c.m.t.scheduled.MingYueScheduledTask   : 发送失败的短信，再次发送
16:38:00.002  INFO 6192 --- [   scheduling-1] c.c.m.t.scheduled.MingYueScheduledTask   : 发送失败的短信，再次发送
16:39:00.002  INFO 6192 --- [   scheduling-1] c.c.m.t.scheduled.MingYueScheduledTask   : 发送失败的短信，再次发送
16:40:00.008  INFO 6192 --- [   scheduling-1] c.c.m.t.scheduled.MingYueScheduledTask   : 发送失败的短信，再次发送
16:41:00.002  INFO 6192 --- [   scheduling-1] c.c.m.t.scheduled.MingYueScheduledTask   : 发送失败的短信，再次发送

3.模拟阻塞任务

import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

/**
 * @author Strive
 * @date 2022/4/18 16:19
 * @description 明月定时任务
 */
@Slf4j
@Component
public class MingYueScheduledTask {

  /** 每1分钟扫描一次，扫描发送失败的短信，再次发送 */
  @Scheduled(cron = "0 0/1 * * * ?")
  private void sendErrorMsg() {
    log.info("发送失败的短信，再次发送");
  }

  /** 模拟阻塞任务 */
  @Scheduled(cron = "0 0/1 * * * ?")
  private void sendErrorMsg2() throws InterruptedException {
    // 阻塞2分钟
    Thread.sleep(60 * 1000 * 2);
    log.info("222 发送失败的短信，再次发送  222");
  }
}

启动项目，查看日志打印，从时间上看 sendErrorMsg 运行时间并非1分钟执行一次，原因就是 Spring Task 默认是所有定时任务都在一个线程中执行，sendErrorMsg 被 sendErrorMsg2 阻塞了。

16:51:00.008  INFO 2072 --- [   scheduling-1] c.c.m.t.scheduled.MingYueScheduledTask   : 发送失败的短信，再次发送
16:53:00.012  INFO 2072 --- [   scheduling-1] c.c.m.t.scheduled.MingYueScheduledTask   : 222 发送失败的短信，再次发送  222
16:53:00.012  INFO 2072 --- [   scheduling-1] c.c.m.t.scheduled.MingYueScheduledTask   : 发送失败的短信，再次发送
16:54:00.003  INFO 2072 --- [   scheduling-1] c.c.m.t.scheduled.MingYueScheduledTask   : 发送失败的短信，再次发送
16:56:00.010  INFO 2072 --- [   scheduling-1] c.c.m.t.scheduled.MingYueScheduledTask   : 222 发送失败的短信，再次发送  222
16:56:00.010  INFO 2072 --- [   scheduling-1] c.c.m.t.scheduled.MingYueScheduledTask   : 发送失败的短信，再次发送

文章由极客之音整理，本文链接：https://www.bmabk.com/index.php/post/78344.html