Springboot @Configuration與自動設定詳解

2022-07-18 14:02:59

不知道大家第一次搭SpringBoot環境的時候，有沒有覺得非常簡單。無須各種的組態檔，無須各種繁雜的pom座標，一個main方法，就能run起來了。與其他框架整合也賊方便，使用EnableXXXXX註解就可以搞起來了！

所以今天來講講SpringBoot是如何實現自動設定的~

@SpringBootApplication: Spring Boot應用標註在某個類上說明這個類是SpringBoot的主設定類，SpringBoot需要執行這個類的main方法來啟動SpringBoot應用；

先看一下@SpringBootApplication註解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
      @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {

註解說明：

@SpringBootConﬁguration:

Spring Boot的設定類；標註在某個類上，表示這是一個Spring Boot的設定類（對@Conﬁguration做了繼承，目的只是標識是springboot的設定類）；

@EnableAutoConﬁguration：

開啟自動設定功能的關鍵註解，就是通過這個註解把所需的bean自動裝配到spring容器中。

再看一下這個註解：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

其中有一個通過@Import註解匯入了一個重要的物件AutoConfigurationImportSelector，它實現了DeferredImportSelector介面，

關於這個介面的的作用是延遲匯入所有自動裝配的BeanDefinition，把這些BeanDefinition和生成的bean對比其它的bean是放在最後匯入，這樣後面使用springboot封裝的@ConditionalOnBean、@ConditionalOnMissingBean 、@ConditionalOnClass、@ConditionalOnMissingClass、@ConditionalOnProperty判斷這個類需不需要裝配具有前提條件。

例如：如果我們自己在專案中設定類mybatis的SqlSessionFactory物件，則springboot中則不會再進行自動裝配，

自定義

@Bean

Public SqlSessionFactory getSqlSessionFactory (){

…

Return sqlSessionFactory ;

}

再看一下AutoConfigurationImportSelector物件：

其實現了延遲匯入bean的介面DeferredImportSelector

這個可以往spring容器中注入物件。

String[] selectImports(AnnotationMetadata annotationMetadata) 此方法是在public Class<? extends Group> getImportGroup() 方法返回null的情況下，才執行生效的。否則不生效，所以此方法不做特別講解。

主要看實現的方法：

@Override
public Class<? extends Group> getImportGroup() {
   return AutoConfigurationGroup.class;
}

在spring中會執行AutoConfigurationGroup類的process方法，先分析此方法的作用：

@Override
public void process(AnnotationMetadata annotationMetadata, DeferredImportSelector deferredImportSelector) {
   Assert.state(deferredImportSelector instanceof AutoConfigurationImportSelector,
         () -> String.format("Only %s implementations are supported, got %s",
               AutoConfigurationImportSelector.class.getSimpleName(),
               deferredImportSelector.getClass().getName()));
//在此方法中找到候選自動轉入的bean的class的name。
   AutoConfigurationEntry autoConfigurationEntry = ((AutoConfigurationImportSelector) deferredImportSelector)
         .getAutoConfigurationEntry(annotationMetadata);
   this.autoConfigurationEntries.add(autoConfigurationEntry);
   for (String importClassName : autoConfigurationEntry.getConfigurations()) {
      this.entries.putIfAbsent(importClassName, annotationMetadata);
   }
}

此方法的作用是找出所有候選的需要自動裝配bean的class物件名字；都封裝在AutoConfigurationEntry物件中，然後裝入全域性變數中待後面方法的使用。

看一下如何找到候選待裝配的bean，呼叫下面的方法：

protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
   if (!isEnabled(annotationMetadata)) {
      return EMPTY_ENTRY;
   }
//此方法就是獲取註解中設定的排除裝配的bean
   AnnotationAttributes attributes = getAttributes(annotationMetadata);
//此方法就是獲取所有的候選的bean
   List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
//根據名稱去重
   configurations = removeDuplicates(configurations);
//獲取排除的Bean
   Set<String> exclusions = getExclusions(annotationMetadata, attributes);
   checkExcludedClasses(configurations, exclusions);
//進行排除
   configurations.removeAll(exclusions);
//這一步也是比較重要的，就是根據那些@Condition註解從候選的class中選擇符合條件的
   configurations = getConfigurationClassFilter().filter(configurations);
//執行自動匯入的監聽事件AutoConfigurationImportListener
   fireAutoConfigurationImportEvents(configurations, exclusions);
   return new AutoConfigurationEntry(configurations, exclusions);
}

那如何獲取到合適的class的呢？

1、是獲取專案中（pom.xml匯入jar包）META-INF/spring.factories檔案中設定的的所有key-value

2、所以找到Map<String, List>型別的資料;

3、根據可以org.springframework.boot.autoconfigure.EnableAutoConfiguration作為key找到其中的List資料；

4、這些就是所有候選的class的名字