如何正确控制springboot中bean的加載順序總結

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的加載順序呢，我們先看看官方的解釋：     

{@code @Order} defines the sort order for an annotated component. 
Since Spring 4.0, annotation-based ordering is supported for many kinds of components in Spring, even for collection injection where the order values of the target components are taken into account (either from their target class or from their {@code @Bean} method). 

While such order values may influence priorities at injection points, please be aware that they do not influence singleton startup order which is an orthogonal concern determined by dependency relationships and {@code @DependsOn} declarations (influencing a runtime-determined dependency graph).
           

最開始

@Order

注解用于切面的優先級指定；在 4.0 之後對它的功能進行了增強，支援集合的注入時，指定集合中 bean 的順序，并且特别指出了，它對于但執行個體的 bean 之間的順序，沒有任何影響。

目前用的比較多的有以下3點：

• 控制AOP的類的加載順序，也就是被

  @Aspect

  标注的類
• 控制

  ApplicationListener

  實作類的加載順序
• 控制

  CommandLineRunner

  實作類的加載順序

3.如何控制

[email protected]

@DependsOn

注解可以用來控制bean的建立順序，該注解用于聲明目前bean依賴于另外一個bean。所依賴的bean會被容器確定在目前bean執行個體化之前被執行個體化。

示例：

@Configuration
public class BeanOrderConfiguration {
 
 
    @Bean
    @DependsOn("beanB")
    public BeanA beanA(){
        System.out.println("bean A init");
        return new BeanA();
    }
 
 
    @Bean
    public BeanB beanB(){
        System.out.println("bean B init");
        return new BeanB();
    }
 
 
    @Bean
    @DependsOn({"beanD","beanE"})
    public BeanC beanC(){
        System.out.println("bean C init");
        return new BeanC();
    }
 
 
    @Bean
    @DependsOn("beanE")
    public BeanD beanD(){
        System.out.println("bean D init");
        return new BeanD();
    }
 
 
    @Bean
    public BeanE beanE(){
        System.out.println("bean E init");
        return new BeanE();
    }
}

           

以上代碼bean的加載順序為：

bean B init
bean A init
bean E init
bean D init
bean C init
           

@DependsOn

的使用：

• 直接或者間接标注在帶有

  @Component

  注解的類上面;
• 直接或者間接标注在帶有

  @Bean

  注解的方法上面;
• 使用

  @DependsOn

  注解到類層面僅僅在使用 component-scanning 方式時才有效，如果帶有

  @DependsOn

  注解的類通過XML方式使用，該注解會被忽略，

  <bean depends-on="..."/>

  這種方式會生效。

3.2 參數注入

在

@Bean

标注的方法上，如果你傳入了參數，springboot會自動會為這個參數在spring上下文裡尋找這個類型的引用。并先初始化這個類的執行個體。

利用此特性，我們也可以控制bean的加載順序。

示例：

@Bean
public BeanA beanA(BeanB demoB){
  System.out.println("bean A init");
  return new BeanA();
}
 
 
@Bean
public BeanB beanB(){
  System.out.println("bean B init");
  return new BeanB();
}
           

以上結果，beanB先于beanA被初始化加載。

需要注意的是，springboot會按類型去尋找。如果這個類型有多個執行個體被注冊到spring上下文，那你就需要加上

@Qualifier("Bean的名稱")

來指定

3.3 利用bean的生命周期中的擴充點

在spring體系中，從容器到Bean執行個體化&初始化都是有生命周期的，并且提供了很多的擴充點，允許你在這些步驟時進行邏輯的擴充。

這些可擴充點的加載順序由spring自己控制，大多數是無法進行幹預的。我們可以利用這一點，擴充spring的擴充點。在相應的擴充點加入自己的業務初始化代碼。從來達到順序的控制。

具體關于spring容器中大部分的可擴充點的分析，之前已經寫了一篇文章詳細介紹了：《Springboot啟動擴充點超詳細總結，再也不怕面試官問了》。

3.4 @AutoConfigureOrder

這個注解用來指定配置檔案的加載順序。但是在實際測試中發現，以下這樣使用是不生效的：

@Configuration
@AutoConfigureOrder(2)
public class BeanOrderConfiguration1 {
    @Bean
    public BeanA beanA(){
        System.out.println("bean A init");
        return new BeanA();
    }
}
 
 
@Configuration
@AutoConfigureOrder(1)
public class BeanOrderConfiguration2 {
    @Bean
    public BeanB beanB(){
        System.out.println("bean B init");
        return new BeanB();
    }
}

           

無論你2個數字填多少，都不會改變其加載順序結果。

那這個

@AutoConfigureOrder

到底是如何使用的呢。

經過測試發現，

@AutoConfigureOrder

隻能改變外部依賴的

@Configuration

的順序。如何了解是外部依賴呢。

能被你工程内部scan到的包，都是内部的Configuration，而spring引入外部的Configuration，都是通過spring特有的spi檔案：

spring.factories

換句話說，

@AutoConfigureOrder

能改變

spring.factories

中的

@Configuration

的順序。

具體使用方式：

@Configuration
@AutoConfigureOrder(10)
public class BeanOrderConfiguration1 {
    @Bean
    public BeanA beanA(){
        System.out.println("bean A init");
        return new BeanA();
    }
}
 
 
@Configuration
@AutoConfigureOrder(1)
public class BeanOrderConfiguration2 {
    @Bean
    public BeanB beanB(){
        System.out.println("bean B init");
        return new BeanB();
    }
}

           

spring.factories

：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.example.demo.BeanOrderConfiguration1,\
  com.example.demo.BeanOrderConfiguration2
           

4.總結

其實在工作中，我相信很多人碰到過複雜的依賴關系的bean加載，把這種不确定性交給spring去做，還不如我們自己去控制，這樣在閱讀代碼的時候 ，也能輕易看出bean之間的依賴先後順序。