@Scheduled注解各参数详解
cron表达式语法
[秒] [分] [小时] [日] [月] [周] [年]
注：[年]不是必须的域，可以省略[年]
| 域 | 必填 | 值 | 通配符 |
|---|---|---|---|
| 秒 | 是 | 0-59 | , - * / |
| 分 | 是 | 0-59 | , - * / |
| 时 | 是 | 0-23 | , - * / |
| 日 | 是 | 1-31 | , - * ? / L W |
| 月 | 是 | 1-12 / JAN-DEC | , - * / |
| 周 | 是 | 1-7 or SUN-SAT | , - * ? / L # |
| 年 | 否 | 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 * * ?
参数详解引用至 @Scheduled注解各参数详解
根据环境开启关闭定时任务
有时候我们需要根据环境来开关定时任务。
使用@ConditionalOnProperty
开启定时器需要@Configuration定义配置类，@ConditionalOnProperty可以用来控制@Configuration是否生效，即当前bean是否交由spring管理。
@Configuration
@EnableScheduling
@ConditionalOnProperty(prefix="scheduled",name = "enable", havingValue = "true")
public class ScheduledConfiguration {
}
配置文件application.properties
scheduled.enable=true
@ConditionalOnProperty可以多条件组合
条件与 @ConditionalOnProperty(name={"scheduled.true","scheduled.false"}, havingValue="true")
条件或 @ConditionalOnProperty("${scheduled.ture:ture} || ${scheduled.false:false}")
在配置文件中设置@Scheduled参数
@Scheduled可以在配置文件中设置参数，在不用的环境中配置不同的参数来定制定时任务，甚至关闭它。
定时器类
@Scheduled(cron = "${scheduled.cron}")
public void scheduled(){
System.out.println("STOP-THE-WORLD");
}
配置文件
// 每5秒执行一次
scheduled.cron:0/5 * * * * ?
// 关闭定时任务
scheduled.cron:-
使用@Conditional
@Conditional根据返回值来决定是否将bean加载进Spring容器中。目前已知较灵活的方法，既可以全局设置又可以用在单个定时器上。
public class ScheduledCondition implements Condition {
@Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
// 获取环境名称
String environmentName = conditionContext.getEnvironment().getProperty("spring.profiles.active");
return "test-local".equals(environmentName);
}
}
控制全局定时器
@Configuration
@EnableScheduling
@Conditional(ScheduledCondition.class)
public class ScheduledConfiguration {
}
控制单个定时器
@Component
@Conditional(ScheduledCondition.class)
public class Schedule {
@Scheduled(cron = "0/5 * * * * ?")
public void schedule() {
System.out.println("STOP-THE-WORLD");
}
}
关于@Condition的详细使用可以参考这篇博客
Spring Boot @Condition 注解，组合条件你知道吗
@Scheduled的异步执行
定时任务默认单线程的，它会等待上一个任务执行完成后再去执行下一个任务。
fixedDelay
等待上一个任务执行完后N秒执行下一个任务。是上个任务结束与下个任务开始的时间间隔。
fixedRate
上一个任务执行开始，N秒后执行下一个任务，如果N秒后上一个任务没有执行完成，会在它执行完后立即执行下一个任务。是上个任务开始与下个任务开始的时间间隔
cron
它与fixedRate一样，关心的是上一个任务的开始时间，但不同的是当下一个任务开始时，上一个任务还没有结束，那它会跳过这次任务不执行。
最佳实践
如果是强调任务间隔的定时任务，建议使用fixedRate和fixedDelay，如果是强调任务在某时某分某刻执行的定时任务，建议使用cron表达式。
@Scheduled如何异步执行
只需要在方法上加上@Async
@Async
@Scheduled(cron = "${scheduled.cron}")
public void scheduled(){
System.out.println("STOP-THE-WORLD");
}
参考
