参考文献

@Scheduled

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {

	String CRON_DISABLED = ScheduledTaskRegistrar.CRON_DISABLED;
	// 该参数接收一个cron表达式,cron表达式是一个字符串,字符串以5或6个空格隔开,分开共6或7个域,每一个域代表一个含义.
	/**
	 * A cron-like expression, extending the usual UN*X definition to include triggers
	 * on the second, minute, hour, day of month, month, and day of week.
	 * <p>For example, {@code "0 * * * * MON-FRI"} means once per minute on weekdays
	 * (at the top of the minute - the 0th second).
	 * <p>The fields read from left to right are interpreted as follows.
	 * <ul>
	 * <li>second</li>
	 * <li>minute</li>
	 * <li>hour</li>
	 * <li>day of month</li>
	 * <li>month</li>
	 * <li>day of week</li>
	 * </ul>
	 * <p>The special value {@link #CRON_DISABLED "-"} indicates a disabled cron
	 * trigger, primarily meant for externally specified values resolved by a
	 * <code>${...}</code> placeholder.
	 * @return an expression that can be parsed to a cron schedule
	 * @see org.springframework.scheduling.support.CronExpression#parse(String)
	 */  
	String cron() default "";

  // 时区，接收一个java.util.TimeZone#ID。cron表达式会基于该时区解析。默认是一个空字符串，即取服务器所在地的时区
	String zone() default "";

  // 上次执行完毕时间点之后多长时间再执行,时间单位默认毫秒 milliseconds
	long fixedDelay() default -1;

  // 与fixedDelay意思相同，只是使用字符串的形式。唯一不同的是支持占位符 时间单位默认毫秒 milliseconds
	String fixedDelayString() default "";

  // 上一次开始执行时间点之后多长时间再执行
	long fixedRate() default -1;

	String fixedRateString() default "";

  // 第一次延迟多长时间后再执行
	long initialDelay() default -1;

	String initialDelayString() default "";

	TimeUnit timeUnit() default TimeUnit.MILLISECONDS;

}

使用步骤

  • 需要定时执行的方法上加上@Scheduled注解
  • Spring容器中使用@EnableScheduling开启定时任务的执行,此时Spring容器才可以识别@Scheduled标注的方法,然后自动定时执行.

@Scheduled配置定时规则

cron表达式语法

1
2
3
4
[秒] [分] [小时] [日] [月] [周] [年]

# 示例
 0    *    *     *   *   MON-FRI
  • 注：[年]不是必须的域,可以省略[年],则一共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相同

示例

1
2
3
4
5
6
7
8
9
每隔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 * * ?

为定时器定义线程池

  • 定时器默认情况下使用下面的线程池来执行定时任务的

    1
    new ScheduledThreadPoolExecutor(1)
    1
    2
    3
    4
    5
    6
    @Bean
    public ScheduledExecutorService taskScheduler() { 
       //设置需要并行执行的任务数量
       int corePoolSize = 20;
       return new ScheduledThreadPoolExecutor(corePoolSize); 
    }

  • 原因

    1
    2
    3
    4
    5
    6
    org.springframework.scheduling.annotation.EnableScheduling ->
    org.springframework.scheduling.annotation.SchedulingConfiguration ->
    org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor

    public static final String DEFAULT_TASK_SCHEDULER_BEAN_NAME = "taskScheduler";