Spring中定时任务@Schedule注解

1.概述

@Scheduled注解是spring boot提供的用于定时任务控制的注解,主要用于控制任务在某个指定时间执行,或者每隔一段时间执行.注意需要配合@EnableScheduling使用,配置@Scheduled主要有三种配置执行时间的方式,cron,fixedRate,fixedDelay。

在被spring初始化之后，这个定时任务就开始执行了，下面几种cron、fixedDelay、fixedRate等注解都是这样。）

博客：https://tool.lu/crontab/

手写实现 cron 解析：https://segmentfault.com/a/1190000041216521

2.1 cron表达式

该参数接收一个cron表达式，cron表达式是一个字符串，字符串以5或6个空格隔开，分开共6或7个域，每一个域代表一个含义。

cron表达式语法

[秒] [分] [小时] [日] [月] [周] [年]

注：[年]不是必须的域，可以省略[年]，则一共6个域

序号	说明	必填	允许填写的值	允许的通配符
1	秒	是	0-59	, - * /
2	分	是	0-59	, - * /
3	时	是	0-23	, - * /
4	日	是	1-31	, - * ? / L W
5	月	是	1-12 / 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 ?

cron表达式使用占位符

另外，cron属性接收的cron表达式支持占位符。eg：

配置文件：

time:
  cron: */5 * * * * *
  interval: 5

每5秒执行一次：

    @Scheduled(cron="${time.cron}")
    void testPlaceholder1() {
        System.out.println("Execute at " + System.currentTimeMillis());
    }

    @Scheduled(cron="*/${time.interval} * * * * *")
    void testPlaceholder2() {
        System.out.println("Execute at " + System.currentTimeMillis());
    }

2.2. zone

时区，接收一个java.util.TimeZone#ID。cron表达式会基于该时区解析。默认是一个空字符串，即取服务器所在地的时区。比如我们一般使用的时区Asia/Shanghai。该字段我们一般留空。

2.3. fixedDelay

上一次执行完毕时间点之后多长时间再执行。如：

@Scheduled(fixedDelay = 5000) //上一次执行完毕时间点之后5秒再执行

2.4. fixedDelayString

与 3. fixedDelay 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。如：

@Scheduled(fixedDelayString = "5000") //上一次执行完毕时间点之后5秒再执行

占位符的使用(配置文件中有配置：time.fixedDelay=5000)：

    @Scheduled(fixedDelayString = "${time.fixedDelay}")
    void testFixedDelayString() {
        System.out.println("Execute at " + System.currentTimeMillis());
    }

运行结果

2.5. fixedRate

上一次开始执行时间点之后多长时间再执行。如：

@Scheduled(fixedRate = 5000) //上一次开始执行时间点之后5秒再执行

2.6. fixedRateString

与 5. fixedRate 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

2.7. initialDelay

第一次延迟多长时间后再执行。如：

@Scheduled(initialDelay=1000, fixedRate=5000) //第一次延迟1秒后执行，之后按fixedRate的规则每5秒执行一次

2.8. initialDelayString

与 7. initialDelay 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

2.9 三种执行机制小测试结果（参考文章）

1、fixedRate配置了上一次任务的开始时间到下一次任务的开始时间的间隔，每次任务都会执行； 2、fixedDelay配置了上一次任务的结束时间到下一次任务的开始时间的间隔，每次任务都会执行； 3、cron表达式配置了在哪一刻执行任务，会在配置的任务开始时间判断任务是否可以执行，如果能则执行，不能则会跳过本次执行； 4、如果是强调任务间隔的定时任务，建议使用fixedRate和fixedDelay，如果是强调任务在某时某分某刻执行的定时任务，建议使用cron表达式。

源码分析部分

https://www.cnblogs.com/throwable/p/12616945.html#scheduling%E6%A8%A1%E5%9D%97

#

Scheduling模块支持TaskScheduler或者ScheduledExecutorService类型的任务调度器，而ScheduledExecutorService其实是JDK并发包java.util.concurrent的接口，一般实现类就是调度线程池ScheduledThreadPoolExecutor。实际上，ScheduledExecutorService类型的实例最终会通过适配器模式转变为ConcurrentTaskScheduler，所以这里只需要分析TaskScheduler类型的执行器。

• ThreadPoolTaskScheduler：基于线程池实现的任务执行器，这个是最常用的实现，底层依赖于ScheduledThreadPoolExecutor实现。
• ConcurrentTaskScheduler：TaskScheduler接口和ScheduledExecutorService接口的适配器，如果自定义一个ScheduledThreadPoolExecutor类型的Bean，那么任务执行器就会适配为ConcurrentTaskScheduler。
• DefaultManagedTaskScheduler：JDK7引入的JSR-236的支持，可以通过JNDI配置此调度执行器，一般很少用到，底层也是依赖于ScheduledThreadPoolExecutor实现。

#

Scheduling模块中支持不同类型的任务，主要包括下面的3种（解析的优先顺序也是如下）：

1. Cron表达式任务，支持通过Cron表达式配置执行的周期，对应的任务类型为org.springframework.scheduling.config.CronTask。
2. 固定延迟间隔任务，也就是上一轮执行完毕后间隔固定周期再执行本轮，依次类推，对应的的任务类型为org.springframework.scheduling.config.FixedDelayTask。
3. 固定频率任务，基于固定的间隔时间执行，不会理会上一轮是否执行完毕本轮会照样执行，对应的的任务类型为org.springframework.scheduling.config.FixedRateTask。

#

在SpringBoot注解体系下，Scheduling模块的所有逻辑基本在ScheduledAnnotationBeanPostProcessor和ScheduledTaskRegistrar中。一般来说，一个类实现的接口代表了它能提供的功能，先看ScheduledAnnotationBeanPostProcessor实现的接口：

• ScheduledTaskHolder接口：返回Set<ScheduledTask>，表示持有的所有任务实例。
• MergedBeanDefinitionPostProcessor接口：Bean定义合并时回调，预留空实现，暂时不做任何处理。
• BeanPostProcessor接口：也就是MergedBeanDefinitionPostProcessor的父接口，Bean实例初始化前后分别回调，其中，后回调的postProcessAfterInitialization()方法就是用于解析@Scheduled和装载ScheduledTask，需要重点关注此方法的逻辑。
• DestructionAwareBeanPostProcessor接口：具体的Bean实例销毁的时候回调，用于Bean实例销毁的时候移除和取消对应的任务实例。
• Ordered接口：用于Bean加载时候的排序，主要是改变ScheduledAnnotationBeanPostProcessor在BeanPostProcessor执行链中的顺序。
• EmbeddedValueResolverAware接口：回调StringValueResolver实例，用于解析带占位符的环境变量属性值。
• BeanNameAware接口：回调BeanName。
• BeanFactoryAware接口：回调BeanFactory实例，具体是DefaultListableBeanFactory，也就是熟知的IOC容器。
• ApplicationContextAware接口：回调ApplicationContext实例，也就是熟知的Spring上下文，它是IOC容器的门面，同时是事件广播器、资源加载器的实现等等。
• SmartInitializingSingleton接口：所有单例实例化完毕之后回调，作用是在持有的applicationContext为NULL的时候开始调度所有加载完成的任务，这个钩子接口十分有用，笔者常用它做一些资源初始化工作。
• ApplicationListener接口：监听Spring应用的事件，具体是ApplicationListener<ContextRefreshedEvent>，监听上下文刷新的事件，如果事件中携带的ApplicationContext实例和ApplicationContextAware回调的ApplicationContext实例一致，那么在此监听回调方法中开始调度所有加载完成的任务，也就是在ScheduledAnnotationBeanPostProcessor这个类中，SmartInitializingSingleton接口的实现和ApplicationListener接口的实现逻辑是互斥的。
• DisposableBean接口：当前Bean实例销毁时候回调，也就是ScheduledAnnotationBeanPostProcessor自身被销毁的时候回调，用于取消和清理所有的ScheduledTask。