SpringBoot | 2.1 SpringBoot自動(dòng)裝配原理

前言

前面第一章的內(nèi)容基本上都是基于注解的Spring內(nèi)容,想要學(xué)好SpringBoot這些Spring基礎(chǔ)必不可少。從這章開始就是SpringBoot了,首先學(xué)習(xí)一下SpringBoot最重要的自動(dòng)裝配原理。

一句話概括SpringBoot的自動(dòng)配置原理就是:啟動(dòng)時(shí)加載所有,最終按照條件進(jìn)行裝配。

本小節(jié)重點(diǎn)注解結(jié)構(gòu)列圖如下:

@SpringBootApplication:主程序注解;

  • @SpringBootConfiguration:表名核心配置類;
    • @Configuration:表名配置類;
  • @ComponentScan:開啟包掃描;
  • @EnableAutoConfiguration:啟用自動(dòng)配置;
    • @AutoConfigurationPackage:自動(dòng)配置包,指定了自動(dòng)配置包的默認(rèn)規(guī)則;
      • @Import(AutoConfigurationPackages.Registrar.class):容器中導(dǎo)入Registrar組件;
    • @Import(AutoConfigurationImportSelector.class):【重要】按照條件配裝規(guī)則@Conditional,按需配置;

注:在說明注解時(shí),第一點(diǎn)加粗為注解中文含義,第二點(diǎn)為一般加在哪身上,縮進(jìn)或代碼塊為示例,如:

@注解

  • 中文含義
  • 加在哪
  • 其他……
    • 語句示例
    //代碼示例
    

1. 引入配置文件與配置綁定

在理解自動(dòng)裝配原理之前,還需要知道配置綁定相關(guān)注解。

引入配置文件常用@ImportResource注解:

@ImportResource

  • 配置引入;
  • 用于類上;
  • 用于引入配置文件,常用于老項(xiàng)目(需要保留大量xml文件的項(xiàng)目);
    • @ImportResource("classpath:beans.xml") 引入beans.xml配置文件。


配置綁定的核心注解為@ConfigurationProperties,指讀取properties文件中的內(nèi)容,封裝進(jìn)JavaBean中,以供隨時(shí)使用。

@ConfigurationProperties

  • 屬性配置
  • 用于POJO類上;

配置綁定有兩種形式:

1.1 @ConfigurationProperties + @EnableConfigurationProperties

  • EnableConfigurationProperties:啟用配置屬性;
  • POJO類上寫@ConfigurationProperties,在配置類上寫@EnableConfigurationProperties
  • @EnableConfigurationProperties的兩個(gè)核心功能:將按照制定規(guī)則與配置文件綁定、將組件導(dǎo)入容器中;
    • 例:將Car組件自動(dòng)注冊進(jìn)容器中:
//配置類
@EnableConfigurationProperties(Car.class)
public class MyConfig {
}

//POJO類
@ConfigurationProperties(prefix = "mycar")
public class Car {
  private String brand;
  private Integer price;
}
#配置文件
mycar: 
  brand: 小鵬
  price: 100000

1.2 @ConfigurationProperties + @Component

  • Component:組件注入;

  • POJO類上同時(shí)標(biāo)注這兩個(gè)注解;

  • @Component表示將POJO類作為組件注冊進(jìn)容器中,只有在容器中的組件, 才會(huì)擁有SpringBoot提供的強(qiáng)大功能;

    • 例:將Car組件自動(dòng)注冊進(jìn)容器中:
    @Component
    @ConfigurationProperties(prefix = "mycar") //prefix表示前綴
    public class Car {
        private String brand;
        private Integer price;
    }
    
    #配置文件
    mycar: 
      brand: 小鵬
      price: 100000
    


2. 自動(dòng)配置原理【總述】

SpringBoot自動(dòng)配置的核心注解是@SpringBootApplication,這是個(gè)十分【重要】的注解。

@SpringBootApplication

  • SpringBoot應(yīng)用
  • 用在主啟動(dòng)類上;
  • 表名該應(yīng)用是個(gè)SpringBoot應(yīng)用,并且指定主啟動(dòng)類入口;
  • 是SpringBoot的核心注解,也是個(gè)合成注解,由3個(gè)注解組合而成@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan);
    • SpringBoot源碼:
    @SpringBootConfiguration
    @EnableAutoConfiguration
    @ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
          @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
    public @interface SpringBootApplication{
        ……
    }
    

主程序注解結(jié)構(gòu)列圖【精髓】

建議在下面學(xué)習(xí)底層注解時(shí)對(duì)照結(jié)構(gòu)圖。

@SpringBootApplication:主程序注解;

  • @SpringBootConfiguration:表名核心配置類;
    • @Configuration:表名配置類;
  • @ComponentScan:開啟包掃描;
  • @EnableAutoConfiguration:啟用自動(dòng)配置;
    • @AutoConfigurationPackage:自動(dòng)配置包,指定了自動(dòng)配置包的默認(rèn)規(guī)則;
      • @Import(AutoConfigurationPackages.Registrar.class):容器中導(dǎo)入Registrar組件;
    • @Import(AutoConfigurationImportSelector.class):【重要】按照條件配裝規(guī)則@Conditional,按需配置;

下面將對(duì)@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan三個(gè)注解逐一分析。


3. 引導(dǎo)加載自動(dòng)配置類【三注解源碼分析】

這三個(gè)注解中,@EnableAutoConfiguration為核心。

@SpringBootConfiguration

  • 配置注解
  • 標(biāo)注類上;
  • 底層是一個(gè)@Configuration,代表當(dāng)前類是一個(gè)配置類。在這里指核心配置類。


@ComponentScan

  • 開啟包掃描

  • 標(biāo)注類上;

  • 可以指定掃描路徑,掃描到的包里的注解才能生效。在這里自定義了兩個(gè)掃描器。

    • 例:@ComponentScan(basePackages = {"com.dlhjw"})


@EnableAutoConfiguration

  • 啟用自動(dòng)配置
  • 標(biāo)注在配置類上;
  • 需要在配置類里寫,表示開啟屬性配置功能,將指定的組件自動(dòng)注冊到容器中;
  • 重要注解,實(shí)現(xiàn)注解@SpringBootApplication的核心功能,其本身也是一個(gè)合成注解。
    • 注解源碼,由@AutoConfigurationPackage@Import合成:
    @AutoConfigurationPackage
    @Import(AutoConfigurationImportSelector.class)
    public @interface EnableAutoConfiguration {
       ……
    }
    

第一個(gè)注解:

@AutoConfigurationPackage
  • 自動(dòng)配置包
  • 用在類上;
  • 指定了自動(dòng)配置包的默認(rèn)規(guī)則:將主程序類MainApplication所在包下的所有組件用Registrar方法批量注冊進(jìn)容器里。
    • 注解源碼:
    @Import(AutoConfigurationPackages.Registrar.class)  //給容器中導(dǎo)入一個(gè)組件
    public @interface AutoConfigurationPackage {
       ……
    }
    

源碼級(jí)分析:

解釋SpringBoot默認(rèn)的掃描路徑為主程序類MainApplication所在包及以下:

Registrar方法源碼如下:

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
   Registrar() {
   }
   
   //Registrar方法傳遞兩個(gè)參數(shù),第一個(gè)是注解的源信息AnnotationMetadata,這個(gè)注解標(biāo)在主程序類MainApplication上(合成注解層層傳遞)
   public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
       //Registrar方法利用注解源信息獲取到主程序MainApplication所在包名com.dlhjw.boot,封裝成數(shù)組,注冊進(jìn)容器里。
       AutoConfigurationPackages.register(registry, (String[])(new AutoConfigurationPackages.PackageImports(metadata)).getPackageNames().toArray(new String[0]));
   }

   public Set<Object> determineImports(AnnotationMetadata metadata) {
       return Collections.singleton(new AutoConfigurationPackages.PackageImports(metadata));
   }
}
  • 即:@AutoConfigurationPackage注解的含義是:將指定的一個(gè)包下的所有組件導(dǎo)入進(jìn)容器。


第二個(gè)注解

@Import(AutoConfigurationImportSelector.class)【重要】
  • 引入自動(dòng)配置類;
  • 用在類上;
  • 在SpringBoot初始啟動(dòng)時(shí)導(dǎo)入127個(gè)自動(dòng)配置類,按照條件配裝規(guī)則@Conditional,按需配置;


源碼級(jí)分析:

總體上:利用Selector機(jī)制給容器批量導(dǎo)入自動(dòng)配置類;(底層 -> 實(shí)現(xiàn))

  1. 首先從META-INF/spring.factories位置加載一個(gè)文件。即默認(rèn)掃描當(dāng)前系統(tǒng)里面所有META-INF/spring.factories位置的文件。其中最重要的是spring-boot-autoconfigure-2.3.4.RELEASE.jar包里的META-INF/spring.factories(SpringBoot兼容全場景的127個(gè)自動(dòng)配置類就在這里,即xxxxAutoConfiguration);
  2. 接著使用Spring的工廠加載類loadSpringFactories得到所有的組件;
  3. 然后調(diào)用getCandidateConfigurations()獲取到所有需要導(dǎo)入到容器中的配置類(默認(rèn)導(dǎo)入導(dǎo)容器中的127個(gè)全類名組件)
  4. 接著利用getAutoConfigurationEntry(annotationMetadata)方法獲取自動(dòng)配置集合
  5. 【核心】最后對(duì)getAutoConfigurationEntry(annotationMetadata)獲取到的配置進(jìn)行封裝,封裝成selectImports(AnnotationMetadata am)方法,返回String數(shù)組,數(shù)組里說明了需要導(dǎo)入的自動(dòng)配置類(組件)。


4. 按需開啟自動(dòng)配置項(xiàng)【核心】

雖然127個(gè)場景的所有自動(dòng)配置啟動(dòng)的時(shí)候默認(rèn)全部加載。xxxxAutoConfiguration
但我們不一定全部都會(huì)用到,需要按照條件裝配規(guī)則@Conditional,按需配置。

例:給容器中加入文件上傳解析器;

@Bean
@ConditionalOnBean(MultipartResolver.class)  //容器中有這個(gè)類型組件
@ConditionalOnMissingBean(name = DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME) //容器中沒有這個(gè)名字 multipartResolver 的組件
public MultipartResolver multipartResolver(MultipartResolver resolver) {
    //給@Bean標(biāo)注的方法傳入了對(duì)象參數(shù),這個(gè)參數(shù)的值會(huì)從容器中找。
    //SpringMVC multipartResolver。防止有些用戶配置的文件上傳解析器不符合規(guī)范
    return resolver;
}


5. 修改默認(rèn)配置【定制化配置】

約定大于配置思想: SpringBoot默認(rèn)會(huì)在底層配好所有的組件。但是如果用戶自己配置了以用戶的優(yōu)先

@ConditionalOnMissingBean

  • 條件裝配
  • 用在方法上;
  • SpringBoot源碼里經(jīng)常會(huì)有@ConditionalOnMissingBean注解,表示當(dāng)容器中沒有該組件時(shí),才會(huì)注冊SpringBoot默認(rèn)的。
    //源碼里
    @Bean
    @ConditionalOnMissingBean
    public CharacterEncodingFilter characterEncodingFilter() {
    }
    


用戶配置方式(定制化配置):

定制化配置基于屬性綁定注解@EnableConfigurationProperties與修改默認(rèn)配置方法

  1. 在config包下的配置文件類上標(biāo)注引入配置文件注解@ImportResource

    @ImportResource("classpath:beans.xml")
    public class MyConfig(){
        //(*)
    }
    
  2. 在config包下的配置文件類里(*)處配置用戶方式

    @Bean
    public CharacterEncodingFilter myFilter() {
        ……
    }
    
  3. application.properties 配置文件里配置(推薦)


*6. 改變掃描路徑

SpringBoot默認(rèn)掃描主程序所在包及其下面的所有子包里面的組件,但可以改變掃描路徑。

改變掃描路徑:

@SpringBootApplication(scanBasePackages="com.dlhjw")

  • 掃描com.dlhjw包下的注解;

@ComponentScan("com.dlhjw")

  • 掃描com.dlhjw包下的注解;

排除自動(dòng)掃描:

@SpringBootApplication(exclude={XX.class,YY.class})

  • 例:@SpringBootApplication(exclude=DataSourceAutoConfiguration.class)取消數(shù)據(jù)庫配置。


7. 自動(dòng)配置總結(jié)

一句話概括SpringBoot的自動(dòng)配置原理就是:啟動(dòng)時(shí)加載所有,最終按照條件進(jìn)行裝配。

即:

  • SpringBoot先加載所有的自動(dòng)配置類 xxxxxAutoConfiguration
  • 每個(gè)自動(dòng)配置類按照條件進(jìn)行生效,默認(rèn)都會(huì)綁定配置文件指定的值。從xxxxProperties里面取,xxxProperties和配置文件進(jìn)行了綁定;
  • 生效的配置類就會(huì)給容器中裝配很多組件,只要容器中有這些組件,相當(dāng)于這些功能就有了;
  • 由此可得:定制化配置基于屬性綁定注解@EnableConfigurationProperties修改默認(rèn)配置方法
    • 用戶直接自己@Bean替換底層的組件(基于SpringBoot的@ConditionalOnMissingBean);
    • 用戶去看這個(gè)組件是獲取的配置文件什么值就去修改(基于SpringBoot的屬性綁定注解@EnableConfigurationProperties);
  • 即:xxxxxAutoConfiguration ---> 組件 ---> xxxxProperties里面拿值 ---> application.properties


主程序注解結(jié)構(gòu)列圖

這里再列一下結(jié)構(gòu)圖,因?yàn)楸拘」?jié)的精髓都在這了。

@SpringBootApplication:主程序注解;

  • @SpringBootConfiguration:表名核心配置類;
    • @Configuration:表名配置類;
  • @ComponentScan:開啟包掃描;
  • @EnableAutoConfiguration:啟用自動(dòng)配置;
    • @AutoConfigurationPackage:自動(dòng)配置包,指定了自動(dòng)配置包的默認(rèn)規(guī)則;
      • @Import(AutoConfigurationPackages.Registrar.class):容器中導(dǎo)入Registrar組件;
    • @Import(AutoConfigurationImportSelector.class):【重要】按照條件配裝規(guī)則@Conditional,按需配置;

其他說明:

  • 若在配置類里只有一個(gè)有參構(gòu)造器,說明有參構(gòu)造器里的所有屬性都會(huì)從屬性里確定;(4.2.x 設(shè)置靜態(tài)頁面)



最后

\color{blue}{\rm\small{新人制作,如有錯(cuò)誤,歡迎指出,感激不盡!}}

\color{blue}{\rm\small{歡迎關(guān)注我,并與我交流!}}

\color{blue}{\rm\small{如需轉(zhuǎn)載,請標(biāo)注出處!}}

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容