定时任务 @Scheduled注解的学习
Spring中提供了@Scheduled 注解,目的是为了方便进行定时任务的开发。
要使用@Scheduled注解,首先需要在启动类添加@EnableScheduling ,启用Spring的计划任务执行功能,这样可以在容器中的任何Spring管理的bean上检测Scheduled 注解,执行计划任务。
@EnableScheduling 在配置类上使用,开启计划任务的支持(类上)
@Scheduled 来声明这是一个任务,包括cron,fixDelay,fixRate等类型(方法上,需先开启计划任务的支持)
注解源码:
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {
String CRON_DISABLED = "-";
String cron() default "";
String zone() default "";
long fixedDelay() default -1L;
String fixedDelayString() default "";
long fixedRate() default -1L;
String fixedRateString() default "";
long initialDelay() default -1L;
String initialDelayString() default "";
}
参数说明:
参数 | 参数说明 | 示例 |
---|
cron | 任务执行的cron表达式 | 0/1 * * * * ? | zone | cron表达式解析使用的时区,默认为服务器的本地时区,使用java.util.TimeZone#getTimeZone(String)方法解析 | GMT-8:00 | fixedDelay | 上一次任务执行结束到下一次执行开始的间隔时间,单位为ms | 1000 | fixedDelayString | 上一次任务执行结束到下一次执行开始的间隔时间,使用java.time.Duration#parse解析 | PT15M | fixedRate | 以固定间隔执行任务,即上一次任务执行开始到下一次执行开始的间隔时间,单位为ms,若在调度任务执行时,上一次任务还未执行完毕,会加入worker队列,等待上一次执行完成后立即执行下一次任务 | 2000 | fixedRateString | 与fixedRate逻辑一致,只是使用java.time.Duration#parse解析 | PT15M | initialDelay | 首先任务执行的延迟时间 | 1000 | initialDelayString | 首次任务执行的延迟时间,使用java.time.Duration#parse解析 | PT15M |
fixedRate 是配置上一次任务执行开始到下一次执行开始的时间间隔,不会等待上一次任务执行完成就会调度下一次任务,将其放入等待队列中。
fixedDelay是配置的上一次任务执行结束到下一次执行开始的间隔时间,也就是说会等待上一次任务执行结束后,延迟间隔时间,再执行下一次任务。
一些定时例子
cron 表达式格式:
{秒数} {分钟} {小时} {日期} {月份} {星期} {年份(可为空)}
# 每隔5秒执行一次
@Scheduled(cron = "*/5 * * * * ?")
# 每隔1分钟执行一次
@Scheduled(cron = "0 */1 * * * ?")
# 每天23点执行一次
@Scheduled(cron = "0 0 23 * * ?")
# 每天凌晨1点执行一次
@Scheduled(cron = "0 0 1 * * ?")
# 每月1号凌晨1点执行一次
@Scheduled(cron = "0 0 1 1 * ?")
# 每月最后一天23点执行一次;
@Scheduled(cron = "0 0 23 L * ?")
# 每周星期天凌晨1点执行一次
@Scheduled(cron = "0 0 1 ? * L")
# 在26分、29分、33分执行一次
@Scheduled(cron = "0 26,29,33 * * * ?")
# 每天的0点、13点、18点、21点都执行一次
@Scheduled(crom = "0 0 0,13,18,21 * * ?")
cron 表达式
cron 表达式由7个部分组成,各部分用空格隔开,cron 表达式的7个部分从左到右代表的含义如下:
秒 分 时 日 月 周 (年)
其中,年是可选的。
字段名 | 允许的值 | 允许的特殊字符 |
---|
秒 | 0-59 | , - * / | 分 | 0-59 | , - * / | 时 | 0-23 | , - * / | 日 | 1-31 | , - * ? / L W C | 月 | 1-12 or JAN-DEC | , - * / | 周 | 1-7 or SUN-SAT | , - * ? / L C # | 年(可选字段) | empty,1970-2099 | , - * / |
特殊字符说明
- , :表示列出枚举值,例如在 分 使用5,20,则意味着在5和20分 每分钟触发一次。
- - :表示范围。例如在 分 使用5-20,表示从5分到20分钟每分钟触发一次。
- ***** :表示匹配该域的任意值。假如在分域使用*,即表示每分钟都会触发事件。
- / :表示起始时间开始触发,然后每隔固定时间触发一次,例如在分域使用5/20,则意味着5分钟触发一次,而25,45等分别触发一次。
- ? :只能用在周和日。它也匹配域的任意值,但是实际不会,因为周和日会相互影响。例如想在每月的20日触发调度,不管20日到底是星期几,则只能使用如下写法:13 13 15 20 * ?,其中最后一位只能用?,而不能使用*,如果使用 *表示不管星期几都会触发,实际上并不是这样。
- L :表示最后,只能出现日和周,如果在 日 使用 5L,意味着在最后的一个星期四触发。
- W :表示有效工作日(周一到周五),只能出现在周域,系统将在离指定日期的最近的有效工作日除法事件。例如:在 日 使用 5W,如果5日是星期六,则将在最近的工作日:星期五,即4日触发。如果5日是星期天,则在6日触发;如果5日在星期一到星期五中的一天,则就在5日触发。另外一点,W的最近寻找不会跨过月份。
- # :用于确定每个月第几个星期几,只能出现在周。例如在4#2,表示某月的第二个星期三。
- LW :这两个字符可以连用,表示在某个月最后一个工作日,即最后一个星期五。
|