简介

之前使用@Schedule一直没有遇到什么问题，那种拿来就用的感觉还挺好，最近使用@Schedule遇到一点问题，才仔细的研究了一下@Schedule的一些细节和原理问题。

这篇文章就将分享一下，使用@Schedule一些可能被忽略的问题。

注意事项

@Schedule默认线程池大小

我相信@Schedule默认线程池大小的问题肯定是被很多拿来就用的朋友忽略的问题，默认情况下@Schedule使用线程池的大小为1。

一般情况下没有什么问题，但是如果有多个定时任务，每个定时任务执行时间可能不短的情况下，那么有的定时任务可能一直没有机会执行。

有兴趣的朋友，可以试一下：

@Component
public class BrigeTask {

    private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");

    @Scheduled(cron = "*/5 * * * * ?")
    private void cron() throws InterruptedException {
        System.out.println(Thread.currentThread().getName() + "-cron:" + LocalDateTime.now().format(FORMATTER));
        TimeUnit.SECONDS.sleep(6);
    }

    @Scheduled(fixedDelay = 5000)
    private void fixedDelay() throws InterruptedException {
        System.out.println(Thread.currentThread().getName() + "-fixedDelay:" + LocalDateTime.now().format(FORMATTER));
        TimeUnit.SECONDS.sleep(6);
    }

    @Scheduled(fixedRate = 5000)
    private void fixedRate() throws InterruptedException {
        System.out.println(Thread.currentThread().getName() + "-fixedRate:" + LocalDateTime.now().format(FORMATTER));
        TimeUnit.SECONDS.sleep(6);
    }
}

上面的任务中，fixedDelay与cron，可能很久都不会被执行。

要解决上面的问题，可以把执行任务的线程池设置大一点，怎样设置通过实现SchedulingConfigurer接口，在configureTasks方法中配置，这种方式参见后面的代码，这里可以直接注入一个TaskScheduler来解决问题。

@Bean
public TaskScheduler taskScheduler() {
    ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
    taskScheduler.setPoolSize(5);
    return taskScheduler;
}

当然也可以使用ScheduledExecutorService：

@Bean
public ScheduledExecutorService scheduledExecutorService() {
    return Executors.newScheduledThreadPool(10);
}

为啥这样有效，请参考后面@Schedule原理。

固定延迟与固定速率

@Schedule的三种方式cron、fixedDelay、fixedRate不管线程够不够都会阻塞到上一次执行完成，才会执行下一次。

如果任务方法执行时间非常短，上面三种方式其实基本没有太多的区别。

如果，任务方法执行时间比较长，大于了设置的执行周期，那么就有很大的区别。例如，假设执行任务的线程足够，执行周期是5s，任务方法会执行6s。

cron的执行方式是，任务方法执行完，遇到下一次匹配的时间再次执行，基本就会10s执行一次，因为执行任务方法的时间区间会错过一次匹配。

fixedDelay的执行方式是，方法执行了6s，然后会再等5s再执行下一次，在上面的条件下，基本就是每11s执行一次。

fixedRate的执行方式就变成了每隔6s执行一次，因为按固定区间执行它没5s就应该执行一次，但是任务方法执行了6s，没办法，只好6s执行一次。

上面的结论都可以通过，最上面的示例验证，有兴趣的朋友可以调整一下休眠时间测试一下。

SpringBoot @Schedule原理

在SpringBoot中，我们使用@EnableScheduling来启用@Schedule。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(SchedulingConfiguration.class)
@Documented
public @interface EnableScheduling {

}

EnableScheduling注解没什么特殊，需要注意import了SchedulingConfiguration。

SchedulingConfiguration一看名字就知道是一个配置类，肯定是为了添加相应的依赖类。

@Configuration
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
public class SchedulingConfiguration {

	@Bean(name = TaskManagementConfigUtils.SCHEDULED_ANNOTATION_PROCESSOR_BEAN_NAME)
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	public ScheduledAnnotationBeanPostProcessor scheduledAnnotationProcessor() {
		return new ScheduledAnnotationBeanPostProcessor();
	}
}

我们可以看到在SchedulingConfiguration创建了一个ScheduledAnnotationBeanPostProcessor。

看样子SpringBoot定时任务的核心就是ScheduledAnnotationBeanPostProcessor类了，下面我们来看一看ScheduledAnnotationBeanPostProcessor类。

ScheduledAnnotationBeanPostProcessor

public class ScheduledAnnotationBeanPostProcessor
		implements ScheduledTaskHolder, MergedBeanDefinitionPostProcessor, DestructionAwareBeanPostProcessor,
		Ordered, EmbeddedValueResolverAware, BeanNameAware, BeanFactoryAware, ApplicationContextAware,
		SmartInitializingSingleton, ApplicationListener<ContextRefreshedEvent>, DisposableBean {
}

ScheduledAnnotationBeanPostProcessor实现了很多接口，这里重点关注2个，ApplicationListener和DestructionAwareBeanPostProcessor。

DestructionAwareBeanPostProcessor封装任务

DestructionAwareBeanPostProcessor继承了BeanPostProcessor。

BeanPostProcessor相信大家已经非常熟悉了，就是在Bean创建执行setter之后，在自定义的afterPropertiesSet和init-method前后提供拦截点，大致执行的先后顺序是：

Bean实例化 -> setter -> BeanPostProcessor#postProcessBeforeInitialization ->
-> InitializingBean#afterPropertiesSet -> init-method -> BeanPostProcessor#postProcessAfterInitialization

我们看一下ScheduledAnnotationBeanPostProcessor的postProcessAfterInitialization方法：

@Override
public Object postProcessAfterInitialization(Object bean, String beanName) {
    if (bean instanceof AopInfrastructureBean || bean instanceof TaskScheduler ||
            bean instanceof ScheduledExecutorService) {
        // Ignore AOP infrastructure such as scoped proxies.
        return bean;
    }

    Class<?> targetClass = AopProxyUtils.ultimateTargetClass(bean);
    if (!this.nonAnnotatedClasses.contains(targetClass) &&
            AnnotationUtils.isCandidateClass(targetClass, Arrays.asList(Scheduled.class, Schedules.class))) {
        Map<Method, Set<Scheduled>> annotatedMethods = MethodIntrospector.selectMethods(targetClass,
                (MethodIntrospector.MetadataLookup<Set<Scheduled>>) method -> {
                    Set<Scheduled> scheduledMethods = AnnotatedElementUtils.getMergedRepeatableAnnotations(
                            method, Scheduled.class, Schedules.class);
                    return (!scheduledMethods.isEmpty() ? scheduledMethods : null);
                });
        if (annotatedMethods.isEmpty()) {
            this.nonAnnotatedClasses.add(targetClass);
            if (logger.isTraceEnabled()) {
                logger.trace("No @Scheduled annotations found on bean class: " + targetClass);
            }
        }
        else {
            // Non-empty set of methods
            annotatedMethods.forEach((method, scheduledMethods) ->
                    scheduledMethods.forEach(scheduled -> processScheduled(scheduled, method, bean)));
            if (logger.isTraceEnabled()) {
                logger.trace(annotatedMethods.size() + " @Scheduled methods processed on bean '" + beanName +
                        "': " + annotatedMethods);
            }
        }
    }
    return bean;
}

简单说一下流程：

找到所有的Schedule方法，把它封装为ScheduledMethodRunnable类(ScheduledMethodRunnable类实现了Runnable接口)，并把其做为一个任务注册到ScheduledTaskRegistrar中。

如果对具体的逻辑感兴趣，可以从postProcessAfterInitialization方法顺着processScheduled方法一次debug。

ApplicationListener执行任务

前面我们介绍通过BeanPostProcessor解析出了所有的任务，接下来要做的事情就是提交任务了。

@Override
public void onApplicationEvent(ContextRefreshedEvent event) {
    if (event.getApplicationContext() == this.applicationContext) {
        // Running in an ApplicationContext -> register tasks this late...
        // giving other ContextRefreshedEvent listeners a chance to perform
        // their work at the same time (e.g. Spring Batch's job registration).
        finishRegistration();
    }
}

ScheduledAnnotationBeanPostProcessor监听的事件是ContextRefreshedEvent，就是在容器初始化，或者刷新的时候被调用。

监听到ContextRefreshedEvent事件之后，值调用了finishRegistration方法，这个方法的基本流程如下：

1. 找到容器中的SchedulingConfigurer，并调用它的configureTasks，SchedulingConfigurer的作用主要就是配置ScheduledTaskRegistrar类，例如线程池等参数，例如：

import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;

import java.util.concurrent.Executors;

@Configuration
public class MyScheduleConfig implements SchedulingConfigurer {

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.setScheduler(Executors.newScheduledThreadPool(10));
    }
}

2. 调用ScheduledTaskRegistrar的afterPropertiesSet方法执行任务，如果对具体的逻辑感兴趣，可以阅读ScheduledTaskRegistrar的scheduleTasks方法。

关于为啥直接在容器中注入一个TaskScheduler、ScheduledExecutorService也可以有效，也可以在finishRegistration方法中找到答案。

@Schedule的使用很简单，只需要引入spring-context包，在配置文件里加上task命名空间

1.@schedule的结构

2.使用方法：在方法上注释@schedule即可 

其他属性有兴趣自己研究下，重点讲一下cron（任务执行周期），在spring集成的quartz也支持cron表达式。 

3.扩展

一个cron表达式有至少6个（也可能7个）有空格分隔的时间元素。 

按顺序依次为 

秒（0~59） 

分钟（0~59） 

小时（0~23） 

天（月）（0~31，但是你需要考虑你月的天数） 

月（0~11） 

天（星期）（1~7 1=SUN 或 SUN，MON，TUE，WED，THU，FRI，SAT） 

年份（1970－2099）

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

有些子表达式能包含一些范围或列表

例如：子表达式（天（星期） ）可以为 “MON-FRI”，“MON，WED，FRI”，“MON-WED,SAT”

“*”字符代表所有可能的值

因此，“”在子表达式（月 ）里表示每个月的含义，“”在子表达式（天（星期） ）表示星期的每一天 

“/”字符用来指定数值的增量

例如：在子表达式（分钟）里的“0/15”表示从第0分钟开始，每15分钟 

在子表达式（分钟）里的“3/20”表示从第3分钟开始，每20分钟（它和“3，23，43”）的含义一样 

“？”字符仅被用于天（月）和天（星期）两个子表达式，表示不指定值

当2个子表达式其中之一被指定了值以后，为了避免冲突，需要将另一个子表达式的值设为“？” 

“L” 字符仅被用于天（月）和天（星期）两个子表达式，它是单词“last”的缩写 

但是它在两个子表达式里的含义是不同的。 

在天（月）子表达式中，“L”表示一个月的最后一天 

在天（星期）自表达式中，“L”表示一个星期的最后一天，也就是SAT 

如果在“L”前有具体的内容，它就具有其他的含义了 

例如：“6L”表示这个月的倒数第６天，“ＦＲＩＬ”表示这个月的最一个星期五 

注意：在使用“L”参数时，不要指定列表或范围，因为这会导致问题

定时任务@SChedule详解

一、Cron详解：
Cron表达式是一个字符串，字符串以5或6个空格隔开，分为6或7个域，每一个域代表一个含义，Cron有如下两种语法格式：

1.Seconds Minutes Hours DayofMonth Month DayofWeek Year
2.Seconds Minutes Hours DayofMonth Month DayofWeek

每一个域可出现的字符如下：
Seconds: 可出现", - * /“四个字符，有效范围为0-59的整数
Minutes: 可出现”, - * /“四个字符，有效范围为0-59的整数
Hours: 可出现”, - * /“四个字符，有效范围为0-23的整数
DayofMonth :可出现”, - * / ? L W C"八个字符，有效范围为0-31的整数
Month: 可出现", - * /“四个字符，有效范围为1-12的整数或JAN-DEc
DayofWeek: 可出现”, - * / ? L C #“四个字符，有效范围为1-7的整数或SUN-SAT两个范围。1表示星期天，2表示星期一， 依次类推
Year: 可出现”, - * /"四个字符，有效范围为1970-2099年

每一个域都使用数字，但还可以出现如下特殊字符，它们的含义是：
(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等分别触发一次.

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

(6) L：表示最后，只能出现在DayofWeek和DayofMonth域，如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。

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

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

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

举几个例子:

@Scheduled(cron = “0 0/5 * * * ?”) 表示每5分钟执行一次，从第0分钟开始。0分钟会执行一次，5，10,15，20以此例推，就算是8点17分启动的，也会在8点20开始执行

每隔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日的凌晨2点调度任务：“0 0 2 1 * ? *”

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

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

注意：由于"月份中的日期"和"星期中的日期"这两个元素互斥的,必须要对其中一个设置?