1.為什么需要控制加載順序
springboot遵從約定大于配置的原則,極大程度的解決了配置繁瑣的問題。在此基礎上,又提供了spi機制,用spring.factories可以完成一個小組件的自動裝配功能。
在一般業務場景,可能你不大關心一個bean是如何被注冊進spring容器的。只需要把需要注冊進容器的bean聲明為@Component即可,spring會自動掃描到這個Bean完成初始化并加載到spring上下文容器。
而當你在項目啟動時需要提前做一個業務的初始化工作時,或者你正在開發某個中間件需要完成自動裝配時。你會聲明自己的Configuration類,但是可能你面對的是好幾個有互相依賴的Bean。如果不加以控制,這時候可能會報找不到依賴的錯誤。
但是你明明已經把相關的Bean都注冊進spring上下文了呀。這時候你需要通過一些手段來控制springboot中的bean加載順序。
2.幾個誤區
在正式說如何控制加載順序之前,先說2個誤區。
在標注了@Configuration的類中,寫在前面的@Bean一定會被先注冊
這個不存在的,spring在以前xml的時代,也不存在寫在前面一定會被先加載的邏輯。因為xml不是漸進的加載,而是全部parse好,再進行依賴分析和注冊。到了springboot中,只是省去了xml被parse成spring內部對象的這一過程,但是加載方式并沒有大的改變。
利用@Order這個標注能進行加載順序的控制
嚴格的說,不是所有的Bean都可以通過@Order這個標注進行順序的控制。你把@Order這個標注加在普通的方法上或者類上一點鳥用都沒有。
那@Order能控制哪些bean的加載順序呢,我們先看看官方的解釋:
最開始@Order注解用于切面的優先級指定;在 4.0 之后對它的功能進行了增強,支持集合的注入時,指定集合中 bean 的順序,并且特別指出了,它對于當 實例的 bean 之間的順序,沒有任何影響。
目前用的比較多的有以下3點:
- 控制AOP的類的加載順序,也就是被@Aspect標注的類
- 控制ApplicationListener實現類的加載順序
- 控制CommandLineRunner實現類的加載順序
3.如何控制
3.1@DependsOn
@DependsOn注解可以用來控制bean的創建順序,該注解用于聲明當前bean依賴于另外一個bean。所依賴的bean會被容器確保在當前bean實例化之前被實例化。
示例:
以上代碼bean的加載順序為:
@DependsOn的使用:
直接或者間接標注在帶有@Component注解的類上面;
直接或者間接標注在帶有@Bean注解的方法上面;
使用@DependsOn注解到類層面僅僅在使用 component-scanning 方式時才有效,如果帶有@DependsOn注解的類通過XML方式使用,該注解會被忽略,<bean depends-on="..."/>這種方式會生效。
3.2 參數注入
在@Bean標注的方法上,如果你傳入了參數,springboot會自動會為這個參數在spring上下文里尋找這個類型的引用。并先初始化這個類的實例。
利用此特性,我們也可以控制bean的加載順序。
示例:
以上結果,beanB先于beanA被初始化加載。
需要注意的是,springboot會按類型去尋找。如果這個類型有多個實例被注冊到spring上下文,那你就需要加上@Qualifier("Bean的名稱")來指定
3.3 利用bean的生命周期中的擴展點
在spring體系中,從容器到Bean實例化&初始化都是有生命周期的,并且提供了很多的擴展點,允許你在這些步驟時進行邏輯的擴展。
這些可擴展點的加載順序由spring自己控制,大多數是無法進行干預的。我們可以利用這一點,擴展spring的擴展點。在相應的擴展點加入自己的業務初始化代碼。從來達到順序的控制。
3.4 @AutoConfigureOrder
這個注解用來指定配置文件的加載順序。但是在實際測試中發現,以下這樣使用是不生效的:
無論你2個數字填多少,都不會改變其加載順序結果。
那這個@AutoConfigureOrder到底是如何使用的呢。
經過測試發現,@AutoConfigureOrder只能改變外部依賴的@Configuration的順序。如何理解是外部依賴呢。
能被你工程內部scan到的包,都是內部的Configuration,而spring引入外部的Configuration,都是通過spring特有的spi文件:spring.factories
換句話說,@AutoConfigureOrder能改變spring.factories中的@Configuration的順序。
具體使用方式:
spring.factories:
4.總結
其實在工作中,我相信很多人碰到過復雜的依賴關系的bean加載,把這種不確定性交給spring去做,還不如我們自己去控制,這樣在閱讀代碼的時候 ,也能輕易看出bean之間的依賴先后順序。