從源碼中了解Spring Boot自動裝配原理

一、什麼是自動裝配

SpringBoot 定義了一套接口規範，這套規範規定：SpringBoot在啟動時會掃描外部引用jar包中的META-INF/spring.factories檔案，将檔案中配置的類型資訊加載到Spring容器，并執行類中定義的各種操作。對于外部jar包來說，隻需要按照SpringBoot定義的标準，就能将自己的功能裝配到SpringBoot中。

二、自動裝配的實作原理

自動裝配的實作，離不開SpringBootApplication這個核心注解。檢視這個注解的源碼，我們會發現在SpringBootApplication注解上，存在着幾個注解，其中SpringBootConfiguration、EnableAutoConfiguration、ComponentScan這三個注解是需要我們注意的。

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
    @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
    @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
  ...
}      

(1) ComponentScan

掃描被@Component 、@Service注解的bean，該注解預設會掃描啟動類所在的包下所有的類 ，可以自定義不掃描某些 bean。如SpringBootApplication注解源碼所示，容器中将排除TypeExcludeFilterh和AutoConfigurationExcludeFilter。

(2) EnableAutoConfiguration

啟用 SpringBoot 的自動配置機制

(3) Configuration

允許在上下文中注冊額外的 bean 或導入其他配置類

2.1 EnableAutoConfiguration詳解

@EnableAutoConfiguration是實作自動裝配的重要注解，在這個注解上存在以下兩個注解：AutoConfigurationPackage、Import。

@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
  ...
}      

2.1.1 AutoConfigurationPackage

表示對于标注該注解的類的包，應當使用AutoConfigurationPackages注冊。實質上，它負責儲存标注相關注解的類的所在包路徑。使用一個BasePackage類，儲存這個路徑。然後使用@Import注解将其注入到ioc容器中。這樣，可以在容器中拿到該路徑。

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
  @Override
  public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
    register(registry, new PackageImport(metadata).getPackageName());
  }
}      

檢視AutoConfigurationPackages中的Registrar這個類的源碼，在Registrar#registerBeanDefinitions方法中有這樣一句代碼new PackageImport(metadata).getPackageName()，檢視PackageImport的構造器後不難發現，這裡擷取的是StandardAnnotationMetadata這個執行個體所在的包名。

/**
 * metadata: 實際上是 StandardAnnotationMetadata 執行個體。
 * metadata#getClassName(): 擷取标注 @AutoConfigurationPackage 注解的類的全限定名。
 * ClassUtils.getPackageName(…): 擷取其所在包。
 */
PackageImport(AnnotationMetadata metadata) {
  this.packageName = ClassUtils.getPackageName(metadata.getClassName());
}      

public static void register(BeanDefinitionRegistry registry, String... packageNames) {
  // BEAN：AutoConfigurationPackages類的全限定名
  // 此時判斷BeanDefinitionRegistry中是否存在以BEAN作為beanName的BeanDefinition對象
  // 如果不存在，走else方法，構造了一個BackPackages執行個體，進行注冊
  if (registry.containsBeanDefinition(BEAN)) {
    BeanDefinition beanDefinition = registry.getBeanDefinition(BEAN);
    ConstructorArgumentValues constructorArguments = beanDefinition
        .getConstructorArgumentValues();
    constructorArguments.addIndexedArgumentValue(0,
        addBasePackages(constructorArguments, packageNames));
  } else {
    GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
    beanDefinition.setBeanClass(BasePackages.class);
    beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0, packageNames);
    beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
    registry.registerBeanDefinition(BEAN, beanDefinition);
  }
}      

/**
 * AutoConfigurationImportSelector類中存在一個叫selectImports的方法，就是我們到底要向容器中導入哪些
 * 内容，都會在這裡進行掃描并導入。
 */
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
    // 判斷EnableAutoConfiguration是否開啟預設開啟true
    if (!isEnabled(annotationMetadata)) {
        return NO_IMPORTS;
    }
    // 1.加載META-INF/spring-autoconfigure-metadata.properties 檔案
    // 2.從中擷取所有符合條件的支援自動裝配的類
    // 自動配置類全名.條件=條件的值
    AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
        .loadMetadata(this.beanClassLoader);
    // 擷取AutoConfigurationEntry
    AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata,annotationMetadata);
    return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}      

protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
    // 判斷EnableAutoConfiguration是否開啟預設開啟true
    if (!isEnabled(annotationMetadata)) {
        return EMPTY_ENTRY;
    }
    // 擷取注解屬性
    AnnotationAttributes attributes = getAttributes(annotationMetadata);
    // 調用getCandidateConfigurations(annotationMetadata, attributes)，利用loadSpringFactories(ClassLoader classLoader)加載目前系統所有的META-INF/spring.factories檔案，得到預設支援的自動配置的類的清單
    List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
    // 去除重複的 configuration
    configurations = removeDuplicates(configurations);
    // 擷取到SpringBootApplication上exclude和excludeName配置的需要排除的類
    Set<String> exclusions = getExclusions(annotationMetadata, attributes);
    // 檢查configurations是否含有exclusions中的類
    checkExcludedClasses(configurations, exclusions);
    // 将exclusions中的類從configurations中排除
    configurations.removeAll(exclusions);
    // 對所有候選的自動配置類進行篩選，
    // 比如ConditionalOnProperty  當屬性存在時
    // ConditionalOnClass  當class存在
    // ConditionalOnMissingClass  當這個clas不存在時才去配置
    // 過濾器
    configurations = getConfigurationClassFilter().filter(configurations);
    // 将自動配置的類，導入事件監聽器，并觸發fireAutoConfigurationImportEvents事件
    // 加載META-INF\spring.factories中的AutoConfigurationImportListener 
    fireAutoConfigurationImportEvents(configurations, exclusions);
    // 建立AutoConfigurationEntry對象
    return new AutoConfigurationEntry(configurations, exclusions);
}