Springboot中@scheduled注解解析

更新時(shí)間：2023年09月25日 10:18:03 作者：MrMoving

這篇文章主要介紹了Springboot中@scheduled注解解析,定時(shí)任務(wù)就是在指定時(shí)間執(zhí)行程序,或周期性執(zhí)行計(jì)劃任務(wù),Java中實(shí)現(xiàn)定時(shí)任務(wù)的方法有很多,本文從從JDK自帶的一些方法來(lái)實(shí)現(xiàn)定時(shí)任務(wù)的需求,需要的朋友可以參考下

Springboot中@scheduled注解解析

在這里插入圖片描述

關(guān)于該注解的詳細(xì)屬性介紹這里不做記錄。也可直接參考源碼注釋（部分詳細(xì)內(nèi)容寫(xiě)好后意外被某N吃了，這里只大致記錄一下）

使用細(xì)節(jié)

1. 需要配合@EnableScheduling注解使用

@EnableScheduling可以加在啟動(dòng)類(lèi)上或者配置類(lèi)上

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

可以看出它沒(méi)有任何屬性。所以只有一個(gè)@Import在起作用，引入了SchedulingConfiguration，它的作用在xml文件中相當(dāng)于：

<task:annotation-driven>

@Configuration(proxyBeanMethods = false)
@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也非常非常的簡(jiǎn)單。只是向容器注入了一個(gè)ScheduledAnnotationBeanPostProcessor，核心邏輯所在類(lèi)

2. @Scheduled主要有三種配置執(zhí)行時(shí)間的方式

注解的方法必須是無(wú)參的

cron 參考cron表達(dá)式

fixedRate 表示自上一次執(zhí)行開(kāi)始之后多長(zhǎng)時(shí)間執(zhí)行，以毫秒為單位

fixedDelay 表示上一次執(zhí)行完畢之后多長(zhǎng)時(shí)間執(zhí)行，單位也是毫秒。

后兩種方式可以配置初始間隔時(shí)間initialDelay

3. 該注解允許重復(fù)注解，即一個(gè)方法可以按不同的規(guī)則作為多個(gè)任務(wù)執(zhí)行。

@Repeatable(Schedules.class)
public @interface Scheduled {
}

method方法分別會(huì)在每天0點(diǎn)以及每周三12點(diǎn)執(zhí)行一次

    @Scheduled(cron = "0 0 0 * * ?")
    @Scheduled(cron = "0 0 12 ? * WED")
    public void method() {
        System.err.println("hello world");
    }

4. 控制定時(shí)任務(wù)的執(zhí)行順序

默認(rèn)是同步執(zhí)行的，因?yàn)槭褂玫哪J(rèn)線程池是單一線程的，邏輯在ScheduledTaskRegistrar類(lèi)中

如果對(duì)執(zhí)行順序有要求的定時(shí)任務(wù)（前提是任務(wù)的執(zhí)行是單線程串行的），有如下兩種情況：

在某一時(shí)刻同時(shí)執(zhí)行如任務(wù)A在零點(diǎn)初始化數(shù)據(jù)，任務(wù)B每分鐘更新數(shù)據(jù)。那么在零點(diǎn)，必須是任務(wù)A先執(zhí)行，其次才是B。但加鎖只能保證線程安全，不能保證執(zhí)行順序。在這種情況下，我們可以借助redis設(shè)置獲取鎖的順序，亦或標(biāo)志字進(jìn)行執(zhí)行順序的判斷。
總是同時(shí)執(zhí)行在任務(wù)間隔相同的情況下，一般為業(yè)務(wù)的解耦，不應(yīng)操作共享資源，應(yīng)當(dāng)放至同一個(gè)定時(shí)任務(wù)中執(zhí)行。

spring在初始化bean后，通過(guò)“postProcessAfterInitialization”攔截到所有的用到“@Scheduled”注解的方法，并解析相應(yīng)的的注解參數(shù)，按順序放入“定時(shí)任務(wù)列表”等待后續(xù)處理；之后在“定時(shí)任務(wù)列表”中統(tǒng)一按順序執(zhí)行相應(yīng)的定時(shí)任務(wù)（注冊(cè)順序取決于類(lèi)以及方法的位置前后，執(zhí)行順序還要考慮@Scheduled注解的參數(shù)配置方式，所以實(shí)際上我們并不能依賴于這種默認(rèn)順序）

5. 異步執(zhí)行任務(wù)

有兩種方式：

配合@Async注解
指定任務(wù)調(diào)度的線程池

6. 在Spring項(xiàng)目中使用@Scheduled注解，配合配置文件定義簡(jiǎn)單定時(shí)任務(wù)

在Spring的配置文件中添加定時(shí)任務(wù)相關(guān)配置：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:task="http://www.springframework.org/schema/task"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/task
       http://www.springframework.org/schema/task/spring-task.xsd">
    <!-- 指定定時(shí)任務(wù)的執(zhí)行者為下面定義的bean，這樣就不會(huì)是默認(rèn)的單線程執(zhí)行任務(wù)了 --> 
	  <task:annotation-driven scheduler="schedule"/>
    <!-- 相當(dāng)于引入了名為schedule的ThreadPoolTaskScheduler對(duì)象 -->
    <task:scheduler id="schedule" pool-size="5"/>
</beans>

不使用注解也能定義任務(wù)，DemoTask上未使用任何注解

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:task="http://www.springframework.org/schema/task"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/task
       http://www.springframework.org/schema/task/spring-task.xsd">
		<bean id="demoTask" class="tasks.DemoTask"/>
		<!-- 不指定scheduler會(huì)默認(rèn)去找名為taskScheduler的bean，那么注解形式和xml形式的定時(shí)任務(wù)使用的就不是同一個(gè)線程池 -->
		<task:annotation-driven scheduler="scheduledjob"/>
    <task:scheduler id="scheduledjob" pool-size="10"/>  
    <!-- 這里不指定schedule的話，也是會(huì)默認(rèn)去找名為taskScheduler的bean-->
    <task:scheduled-tasks scheduler="scheduledjob">
        <task:scheduled ref="demoTask" method="method2" fixed-rate="2000"/>
    </task:scheduled-tasks>
</beans>

約定大于配置，如果對(duì)配置不熟悉，建議scheduler的id使用默認(rèn)的taskScheduler，且要么都默認(rèn)不指定scheduler，要么都指定為同一個(gè)scheduler

ThreadPoolTaskScheduler

該類(lèi)為默認(rèn)的定時(shí)任務(wù)執(zhí)行管理者，內(nèi)部包裝了一個(gè)ScheduledThreadPoolExecutor線程池，默認(rèn)核心線程數(shù)為1，也解釋了為什么spring定時(shí)任務(wù)默認(rèn)是單線程的。

private volatile int poolSize = 1;
	@Nullable
	private ScheduledExecutorService scheduledExecutor;
	this.scheduledExecutor = createExecutor(this.poolSize, threadFactory, rejectedExecutionHandler);

7. 任務(wù)未完成

如果某個(gè)cron格式的定時(shí)任務(wù)執(zhí)行未完成會(huì)出現(xiàn)什么現(xiàn)象呢？

答：此任務(wù)一直無(wú)法執(zhí)行完成，無(wú)法設(shè)置下次任務(wù)執(zhí)行時(shí)間，之后會(huì)導(dǎo)致此任務(wù)后面的所有定時(shí)任務(wù)無(wú)法繼續(xù)執(zhí)行，也就會(huì)出現(xiàn)所有的定時(shí)任務(wù)“失效”現(xiàn)象。

所以應(yīng)用springBoot中定時(shí)任務(wù)的方法中，一定不要出現(xiàn)“死循環(huán)”、“http持續(xù)等待無(wú)響應(yīng)”現(xiàn)象，否則會(huì)導(dǎo)致定時(shí)任務(wù)程序無(wú)法正常。

8. 任務(wù)執(zhí)行時(shí)間過(guò)長(zhǎng)

A任務(wù)執(zhí)行時(shí)間過(guò)長(zhǎng)，可能的影響，是否會(huì)影響此任務(wù)的下一次執(zhí)行，以及影響其他任務(wù)B的準(zhǔn)時(shí)執(zhí)行

供參考標(biāo)準(zhǔn)使用方式

@Configuration
@EnableScheduling
public class ScheduledExecutorConfig implements SchedulingConfigurer {
    private final int corePoolSize = 10;
    private final String feature = "ScheduledTask";
    @Override
    public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
        // 方式一：創(chuàng)建一個(gè)ScheduledThreadPoolExecutor
        scheduledTaskRegistrar.setScheduler(taskExecutor());
        // 方式二 ：可議直接使用一個(gè)TaskScheduler  然后設(shè)置上poolSize等參數(shù)即可
//        ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
//        taskScheduler.setPoolSize(corePoolSize);
//        taskScheduler.initialize(); // 手動(dòng)初始化，同樣會(huì)創(chuàng)建一個(gè)ScheduledThreadPoolExecutor
//        scheduledTaskRegistrar.setTaskScheduler(taskScheduler);
        // 題外話，通過(guò)這我們可以捕獲到ScheduledTaskRegistrar，從而我們可以通過(guò)接口動(dòng)態(tài)的去改變或添加任務(wù)
        scheduledTaskRegistrar.addFixedRateTask(() -> System.out.println("執(zhí)行定時(shí)任務(wù)1: " + System.currentTimeMillis()), 1000);
    }
    @Bean(destroyMethod = "shutdown")
    public ScheduledExecutorService taskExecutor() {
        return new ScheduledThreadPoolExecutor(corePoolSize, new ThreadFactoryConfig(feature));
    }
}

或者在一個(gè)配置類(lèi)中直接注入TaskScheduler

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