共计 2359 个字符,预计需要花费 6 分钟才能阅读完成。
Spring Schedule 是 Spring 提供的定时任务框架,相较于 Quartz,Schedule 更加简单易用,在中小型应用中,对于大部分需求,Schedule 都可以胜任。
一、Spring Schedule 使用演示
在 SpringBoot 使用 Spring Schedule 非常简单,因为 SpringBoot 自身的 starter 中已经集成了 Schedule,而不需要我们做更多的处理。
使用 @EnableScheduling 注解开启定时功能,该注解可以使用在启动类上,也可以注解于定时任务的类上。然后使用 @Scheduled 注解配合其参数完成定时任务。
例如我们需要每一秒执行一次的任务,写成 @Scheduled(fixedRate = 1000)即可。
@EnableScheduling
@Component
public class Task {private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
@Scheduled(fixedRate = 1000)
public void taskOne(){System.out.println("现在时间:" + dateFormat.format(new Date()));
}
}
启动程序,该定时就可以间隔一秒持续执行了。
使用 Spring Schedule 就是这么简单,如果有更多其他的需求,配合 @Scheduled 的其他参数,基本也可以实现。
一、@Scheduled 参数详解
cron
支持传入 cron 表达式:[秒] [分] [小时] [日] [月] [周] [年],[年]不是必须的域,可以省略[年],则一共 6 个域。
位置 | 说明 | 必填 | 允许填写的值 | 允许的通配符 |
---|---|---|---|---|
1 | 秒 | 是 | 0-59 | – * / |
2 | 分 | 是 | 0-59 | – * / |
3 | 时 | 是 | 0-23 | – * / |
4 | 日 | 是 | 1-31 | – * ? / L W |
5 | 月 | 是 | 1-12 or 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 ?
zone
表示时区,接收一个 java.util.TimeZone#ID。cron 表达式会基于该时区解析。默认是一个空字符串,即取服务器所在地的时区。
fixedDelay
上一次执行完毕时间点之后多长时间再执行。
fixedDelayString
与 fixedDelay 类似,传入字符串,也可支持传入 ${}占位符读取配置文件。
@Scheduled(fixedDelayString = "${task.two.fixedDelay}")
void taskTwo() {System.out.println("现在时间:" + dateFormat.format(new Date()));
}
fixedRate
上一次开始执行时间点之后多长时间再执行。
fixedRate 与 fixedDelay 的区别就是:fixedDelay 是在上一个任务结束后才开始进行间隔计时,也就是说两次任务之间的时间差等于间隔 + 任务执行耗时,而 fixedRate 是在上一个任务一开始就已经开始进行间隔计时了,可以视为固定等于设置的间隔时间。
fixedRateString
与 fixedRate 一样,传入字符串,支持占位符读取配置文件。
initialDelay
第一次任务延迟时间。
initialDelayString
同 initialDelay,支持占位符读取配置信息。