Springboot中@scheduled注解解析
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ù)據,任務B每分鐘更新數(shù)據。那么在零點,必須是任務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如果在try里面執(zhí)行return還會不會執(zhí)行finally
這篇文章主要介紹了Java如果在try里面執(zhí)行return,那么還會不會執(zhí)行finally,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-01-01Springboot項目刪除項目同步target文件問題解決方案
這篇文章主要介紹了Springboot項目刪除項目同步target文件問題解決方案,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-12-12springboot全局配置文件與多環(huán)境配置的全過程
SpringBoot項目在多環(huán)境配置上表現(xiàn)的非常優(yōu)秀,只需要非常簡單的操作就可以完成配置,下面這篇文章主要給大家介紹了關于springboot全局配置文件與多環(huán)境配置的相關資料,需要的朋友可以參考下2021-12-12Mybatis使用MySQL模糊查詢時輸入中文檢索不到結果怎么辦
這篇文章主要介紹了Mybatis使用MySQL模糊查詢時輸入中文檢索不到結果的解決辦法的相關資料,非常不錯,具有參考借鑒價值,需要的朋友可以參考下2016-07-07