Springboot中@scheduled注解解析

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

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

Springboot中@scheduled注解解析

在這里插入圖片描述

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

使用細節(jié)

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

@EnableScheduling可以加在啟動類上或者配置類上

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

可以看出它沒有任何屬性。所以只有一個@Import在起作用，引入了SchedulingConfiguration，它的作用在xml文件中相當于：

<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也非常非常的簡單。只是向容器注入了一個ScheduledAnnotationBeanPostProcessor，核心邏輯所在類

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

注解的方法必須是無參的

cron 參考cron表達式

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

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

后兩種方式可以配置初始間隔時間initialDelay

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

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

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

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

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

默認是同步執(zhí)行的，因為使用的默認線程池是單一線程的，邏輯在ScheduledTaskRegistrar類中

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

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

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

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

有兩種方式：

配合@Async注解
指定任務調度的線程池

6. 在Spring項目中使用@Scheduled注解，配合配置文件定義簡單定時任務

在Spring的配置文件中添加定時任務相關配置：

<?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">
    <!-- 指定定時任務的執(zhí)行者為下面定義的bean，這樣就不會是默認的單線程執(zhí)行任務了 --> 
	  <task:annotation-driven scheduler="schedule"/>
    <!-- 相當于引入了名為schedule的ThreadPoolTaskScheduler對象 -->
    <task:scheduler id="schedule" pool-size="5"/>
</beans>

不使用注解也能定義任務，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會默認去找名為taskScheduler的bean，那么注解形式和xml形式的定時任務使用的就不是同一個線程池 -->
		<task:annotation-driven scheduler="scheduledjob"/>
    <task:scheduler id="scheduledjob" pool-size="10"/>  
    <!-- 這里不指定schedule的話，也是會默認去找名為taskScheduler的bean-->
    <task:scheduled-tasks scheduler="scheduledjob">
        <task:scheduled ref="demoTask" method="method2" fixed-rate="2000"/>
    </task:scheduled-tasks>
</beans>

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

ThreadPoolTaskScheduler

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

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

7. 任務未完成

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

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

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

8. 任務執(zhí)行時間過長

A任務執(zhí)行時間過長，可能的影響，是否會影響此任務的下一次執(zhí)行，以及影響其他任務B的準時執(zhí)行

供參考標準使用方式

@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)建一個ScheduledThreadPoolExecutor
        scheduledTaskRegistrar.setScheduler(taskExecutor());
        // 方式二 ：可議直接使用一個TaskScheduler  然后設置上poolSize等參數(shù)即可
//        ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
//        taskScheduler.setPoolSize(corePoolSize);
//        taskScheduler.initialize(); // 手動初始化，同樣會創(chuàng)建一個ScheduledThreadPoolExecutor
//        scheduledTaskRegistrar.setTaskScheduler(taskScheduler);
        // 題外話，通過這我們可以捕獲到ScheduledTaskRegistrar，從而我們可以通過接口動態(tài)的去改變或添加任務
        scheduledTaskRegistrar.addFixedRateTask(() -> System.out.println("執(zhí)行定時任務1: " + System.currentTimeMillis()), 1000);
    }
    @Bean(destroyMethod = "shutdown")
    public ScheduledExecutorService taskExecutor() {
        return new ScheduledThreadPoolExecutor(corePoolSize, new ThreadFactoryConfig(feature));
    }
}

或者在一個配置類中直接注入TaskScheduler

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

其他

Task在平時業(yè)務開發(fā)中確實使用非常的廣泛，但在分布式環(huán)境下，其實已經很少使用Spring自帶的定時器了，而使用分布式任務調度框架：Elastic-job、xxl-job等

到此這篇關于Springboot中@scheduled注解解析的文章就介紹到這了,更多相關@scheduled注解內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

java使用觀察者模式異步短信/郵箱提醒用戶群
這篇文章主要為大家詳細介紹了java使用觀察者模式異步短信和郵箱提醒用戶群，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2018-11-11
SpringBoot自定義啟動界面的實現(xiàn)代碼
實現(xiàn)自定義啟動動畫是一項有趣的任務,雖然Spring Boot本身不提供內置的動畫功能,但可以通過一些技巧來實現(xiàn),本文主要以Demo的形式展示,再者下面的Demo都可以聯(lián)合使用,需要的朋友可以參考下
2024-07-07
分析mybatis運行原理
Mybatis是一個優(yōu)秀的持久層框架，它對JDBC操作數(shù)據(jù)庫的過程進行封裝，使開發(fā)者只需要關注sql本身。我們原來使用JDBC操作數(shù)據(jù)庫，需要手動的寫代碼去注冊驅動、獲取connection、獲取statement等等，現(xiàn)在Mybaits幫助我們把這些事情做了，我們只需要關注我們的業(yè)務sql即可
2021-06-06
java分布式面試接口如何保證冪等及概念理解
這篇文章主要為大家介紹了java分布式面試中接口如何保證冪等的問題解答以及概念描述，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步
2022-03-03
SpringBoot的@RestControllerAdvice作用詳解
這篇文章主要介紹了SpringBoot的@RestControllerAdvice作用詳解,@RestContrllerAdvice是一種組合注解,由@ControllerAdvice,@ResponseBody組成,本質上就是@Component,需要的朋友可以參考下
2024-01-01
String類型傳遞是值傳遞,char[]類型傳遞是引用傳遞的實現(xiàn)
下面小編就為大家?guī)硪黄猄tring類型傳遞是值傳遞,char[]類型傳遞是引用傳遞的實現(xiàn)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看不
2016-09-09
一文帶你學會Java中ScheduledThreadPoolExecutor使用
ScheduledThreadPoolExecutor是Java并發(fā)包中的一個類,同時也是?ThreadPoolExecutor的一個子類,本文主要為大家介紹一下ScheduledThreadPoolExecutor使用,需要的可以參考下
2024-12-12
Java線程中的Timer和TimerTask原理詳解
這篇文章主要介紹了Java線程中的Timer和TimerTask原理詳解,Timer和TimerTask成對出現(xiàn)，Timer是定時器，TimerTask是定時任務,換句話說，定時任務TimerTask是給定時器Timer執(zhí)行的具體任務,需要的朋友可以參考下
2023-10-10
SpringBoot中的@ConditionalOnMissingBean注解使用詳解
這篇文章主要介紹了SpringBoot中的@ConditionalOnMissingBean注解使用詳解,@ConditionalOnMissingBean作用在@Bean定義上,也就是說在容器加載它作用的Bean時,檢查容器中是否存在目標類型,需要的朋友可以參考下
2024-01-01
Springboot上傳文件與物理刪除功能
文章介紹了在Springboot中實現(xiàn)文件上傳和刪除的功能,實現(xiàn)了圖片的上傳與刪除,刪除數(shù)據(jù)庫記錄時,同步刪除了文件,結合實例代碼給大家講解的非常詳細,感興趣的朋友跟隨小編一起看看吧
2026-01-01