spring的@Scheduled定时任务介绍

介绍

在项目中我们很多时候需要跑定时任务。而常用的定时任务就有@Scheduled()。我也一直在用,但很多时候都记不住, 没次需要用的时候再去查找。一直没哟时间来总结一下。所以现在总结一下希望自己能更好的记住。

使用

在项目主类中加入@EnableScheduling注解,启用定时任务的配置

首先,看一下 @Scheduled的注解,然后一个一个解释。

public @interface Scheduled {

	/**
	 * A cron-like expression, extending the usual UN*X definition to include triggers
	 * on the second as well as minute, hour, day of month, month and day of week.
	 * 

E.g. {@code "0 * * * * MON-FRI"} means once per minute on weekdays * (at the top of the minute - the 0th second). * @return an expression that can be parsed to a cron schedule * @see org.springframework.scheduling.support.CronSequenceGenerator */ String cron() default ""; /** * A time zone for which the cron expression will be resolved. By default, this * attribute is the empty String (i.e. the server's local time zone will be used). * @return a zone id accepted by {@link java.util.TimeZone#getTimeZone(String)}, * or an empty String to indicate the server's default time zone * @since 4.0 * @see org.springframework.scheduling.support.CronTrigger#CronTrigger(String, java.util.TimeZone) * @see java.util.TimeZone */ String zone() default ""; /** * Execute the annotated method with a fixed period in milliseconds between the * end of the last invocation and the start of the next. * @return the delay in milliseconds */ long fixedDelay() default -1; /** * Execute the annotated method with a fixed period in milliseconds between the * end of the last invocation and the start of the next. * @return the delay in milliseconds as a String value, e.g. a placeholder * @since 3.2.2 */ String fixedDelayString() default ""; /** * Execute the annotated method with a fixed period in milliseconds between * invocations. * @return the period in milliseconds */ long fixedRate() default -1; /** * Execute the annotated method with a fixed period in milliseconds between * invocations. * @return the period in milliseconds as a String value, e.g. a placeholder * @since 3.2.2 */ String fixedRateString() default ""; /** * Number of milliseconds to delay before the first execution of a * {@link #fixedRate()} or {@link #fixedDelay()} task. * @return the initial delay in milliseconds * @since 3.2 */ long initialDelay() default -1; /** * Number of milliseconds to delay before the first execution of a * {@link #fixedRate()} or {@link #fixedDelay()} task. * @return the initial delay in milliseconds as a String value, e.g. a placeholder * @since 3.2.2 */ String initialDelayString() default ""; }

corn

corn 的功能很全,几乎涵盖了我们平时需要的所有类型。

1. 表达式构成

Cron表达式是一个字符串,分为6或7个域,每一个域代表一个含义, 每个域之间以空格相互隔开,Cron有如下两种语法格式:

  • Seconds Minutes Hours DayofMonth Month DayofWeek Year
  • Seconds Minutes Hours DayofMonth Month DayofWeek

对应的含义分别为: 秒 分 小时 月份中的日期 月份 星期中的日期 年份

2. 含义

字段 允许值 允许的特殊字符
秒(Seconds) 0~59的整数 , - * /
分(Minutes) 0~59的整数 , - * /
小时(Hours) 0~23的整数 , - * /
日期(DayofMonth) 1~31的整数(需要符合月的天数) ,- * ? / L W C
月份(Month) 1~12的整数或者 JAN-DEC , - * /
星期(DayofWeek) 1~7的整数或者 SUN,MON,TUE,WED,THU,FRI,SAT (1=SUN) , - * ? / L C #
年(可选,留空) (Year) 1970~2099 , - * /

其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于"月份中的日期"和"星期中的日期"这两个元素互斥的,必须要对其中一个设置?.

特殊字符含义解析

(1) * :表示匹配该域的任意值。假如在Minutes域使用*, 即表示每分钟都会触发事件,在子表达式(月)里表示每个月的含义,在子表达式(天(星期))表示星期的每一天

(2) ?:只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值,但实际不会。因为DayofMonth和DayofWeek会相互影响。例如想在每月的20日触发调度,不管20日到底是星期几,则只能使用如下写法: 13 13 15 20 * ?, 其中最后一位只能用?,而不能使用*,如果使用*表示不管星期几都会触发,实际上并不是这样。

(3) -:表示范围。例如在Minutes域使用5-20,表示从5分到20分钟每分钟触发一次

(4) /:用来指定数值的增量,表示起始时间开始触发,然后每隔固定时间触发一次。例如在Minutes域使用5/20,则意味着5分钟触发一次,而25,45等分别触发一次. 在子表达式(分钟)里的“0/15”表示从第0分钟开始,每15分钟 在子表达式(分钟)里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义。

(5) ,:表示列出枚举值。例如:在Minutes域使用5,20,则意味着在5和20分每分钟触发一次。

(6) L:表示最后,只能出现在DayofWeek和DayofMonth域。如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。 在使用“L”参数时,不要指定列表或范围。

(7) W:表示有效工作日(周一到周五),只能出现在DayofMonth域,系统将在离指定日期的最近的有效工作日触发事件。例如:在 DayofMonth使用5W,如果5日是星期六,则将在最近的工作日:星期五,即4日触发。如果5日是星期天,则在6日(周一)触发;如果5日在星期一到星期五中的一天,则就在5日触发。另外一点,W的最近寻找不会跨过月份 。

(8) LW:这两个字符可以连用,表示在某个月最后一个工作日,即最后一个星期五。

(9) #:用于确定每个月第几个星期几,只能出现在DayofMonth域。例如在4#2,表示某月的第二个星期三。

3. 示例

0 0 2 1 * ? * : 表示在每月的1日的凌晨2点调整任务

0 15 10 ? * MON-FRI : 表示周一到周五每天上午10:15执行作业

0 15 10 ? 6L 2002-2006 : 表示2002-2006年的每个月的最后一个星期五上午10:15执行作

0 0 10,14,16 * * ? : 每天上午10点,下午2点,4点

0 0/30 9-17 * * ? : 朝九晚五工作时间内每半小时

0 0 12 ? * WED : 表示每个星期三中午12点

0 0 12 * * ? : 每天中午12点触发

0 15 10 ? * * : 每天上午10:15触发

0 15 10 * * ? : 每天上午10:15触发

0 15 10 * * ? * : 每天上午10:15触发

0 15 10 * * ? 2005 : 2005年的每天上午10:15触发

0 * 14 * * ? : 在每天下午2点到下午2:59期间的每1分钟触发

0 0/5 14 * * ? : 在每天下午2点到下午2:55期间的每5分钟触发

0 0/5 14,18 * * ? : 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发

0 0-5 14 * * ? : 在每天下午2点到下午2:05期间的每1分钟触发

0 10,44 14 ? 3 WED : 每年三月的星期三的下午2:10和2:44触发

0 15 10 ? * MON-FRI 周一至周五的上午10:15触发

0 15 10 15 * ? : 每月15日上午10:15触发

0 15 10 L * ? : 每月最后一日的上午10:15触发

0 15 10 ? * 6L : 每月的最后一个星期五上午10:15触发

0 15 10 ? * 6L 2002-2005 : 2002年至2005年的每月的最后一个星期五上午10:15触发

0 15 10 ? * 6#3 : 每月的第三个星期五上午10:15触发

注意:
“?” 字符仅被用于天(月)和天(星期)两个子表达式,表示不指定值
  当2个子表达式其中之一被指定了值以后,为了避免冲突,需要将另一个子表达式的值设为“?”

“L” 字符仅被用于天(月)和天(星期)两个子表达式,它是单词“last”的缩写
  但是它在两个子表达式里的含义是不同的。
  在天(月)子表达式中,“L”表示一个月的最后一天
  在天(星期)自表达式中,“L”表示一个星期的最后一天,也就是SAT

zone

zone:表示将解析cron表达式的时区。接收一个java.util.TimeZone#ID。cron表达式会基于该时区解析。默认是一个空字符串,即取服务器所在地的时区。

fixedDelay

fixedDelay 定义的是执行间隔,是指上一次任务执行完成之后,间隔多长时间在开始再一次执行。
例如:
@Scheduled(fixedDelay=10000) 这个方法每隔 10 秒就会被调用,5 秒钟的间隔是指从上一次调用的完成之时开始算起

fixedRate

fixedRate 定义的是执行频率,间隔多长时间在开始再一次执行。不管上一次是否任务执行完成。
例如:
@Scheduled(fixedRate=10000) 这个方法每隔 5 秒就会被调用,此时的 10 秒就是从上一次调用之始开始算起了

initialDelay

initialDelay 延迟执行
例如:
@Scheduled(initialDelay=1000, fixedRate=10000) 先等待 1 秒,再以10秒的频率执行。

其中 fixedRate、fixedDelay 、corn、三者是不能同时存在的。

概念区分

cron 表达式0 0/10 * * * 与 0 */10 * * *的区别
0 0/10 * * * 与 0 */10 * * * 的差别在于什么地方。
在说这两者的差别之前,先说下各个字符代表的含义。0代表从0分开始,*代表任意字符,/代表递增。
0 0/10 * * *代表从0分钟开始,每10分钟执行任务一次。
0 */10 * * *代表从任务启动开始每10分钟执行任务一次。
例如:从5:07执行,该任务第一种写法会在5:10的时候进行执行,写法二会在5:17进行执行。

你可能感兴趣的:(#,spring,java)