快捷導(dǎo)航

Springboot @Configuration與自動配置詳解

更新時間：2022年07月18日 11:07:28 作者：bijian-bijian

這篇文章主要介紹了SpringBoot中的@Configuration自動配置，在進(jìn)行項目編寫前，我們還需要知道一個東西，就是SpringBoot對我們的SpringMVC還做了哪些配置，包括如何擴(kuò)展，如何定制，只有把這些都搞清楚了，我們在之后使用才會更加得心應(yīng)手

不知道大家第一次搭SpringBoot環(huán)境的時候，有沒有覺得非常簡單。無須各種的配置文件，無須各種繁雜的pom坐標(biāo)，一個main方法，就能run起來了。與其他框架整合也賊方便，使用EnableXXXXX注解就可以搞起來了！

所以今天來講講SpringBoot是如何實現(xiàn)自動配置的~

@SpringBootApplication: Spring Boot應(yīng)用標(biāo)注在某個類上說明這個類是SpringBoot的主配置類，SpringBoot需要運行這個類的main方法來啟動SpringBoot應(yīng)用；

先看一下@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的配置類；標(biāo)注在某個類上，表示這是一個Spring Boot的配置類（對@Con?guration做了繼承，目的只是標(biāo)識是springboot的配置類）；

@EnableAutoCon?guration：

開啟自動配置功能的關(guān)鍵注解，就是通過這個注解把所需的bean自動裝配到spring容器中。

再看一下這個注解：

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

其中有一個通過@Import注解導(dǎo)入了一個重要的對象AutoConfigurationImportSelector，它實現(xiàn)了DeferredImportSelector接口，

關(guān)于這個接口的的作用是延遲導(dǎo)入所有自動裝配的BeanDefinition，把這些BeanDefinition和生成的bean對比其它的bean是放在最后導(dǎo)入，這樣后面使用springboot封裝的@ConditionalOnBean、@ConditionalOnMissingBean 、@ConditionalOnClass、@ConditionalOnMissingClass、@ConditionalOnProperty判斷這個類需不需要裝配具有前提條件。

例如：如果我們自己在項目中配置類mybatis的SqlSessionFactory對象，則springboot中則不會再進(jìn)行自動裝配，

自定義

@Bean

Public SqlSessionFactory getSqlSessionFactory (){

…

Return sqlSessionFactory ;

}

再看一下AutoConfigurationImportSelector對象：

其實現(xiàn)了延遲導(dǎo)入bean的接口DeferredImportSelector

這個可以往spring容器中注入對象。

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

主要看實現(xiàn)的方法：

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

在spring中會執(zhí)行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()));
//在此方法中找到候選自動轉(zhuǎn)入的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，調(diào)用下面的方法：

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

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

1、是獲取項目中（pom.xml導(dǎo)入jar包）META-INF/spring.factories文件中配置的的所有key-value

2、所以找到Map<String, List>類型的數(shù)據(jù);

3、根據(jù)可以org.springframework.boot.autoconfigure.EnableAutoConfiguration作為key找到其中的List數(shù)據(jù)；

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