一.何為自動(dòng)裝配

自動(dòng)裝配是 SpringBoot 的核心功能，主要是讓開(kāi)發(fā)者盡可能少的關(guān)注一些基礎(chǔ)化的 Bean 的配置，實(shí)際上完成的工作是如何自動(dòng)將 Bean 裝載到 Ioc 容器中。

在 SpringBoot 中如果想要引入一個(gè)新的模塊，例如項(xiàng)目中想使用 Redis 緩存，只需要做以下幾步即可。

1、在 pom.xml 文件中引入 spring-boot-starter-data-redis 相關(guān)的 jar 包

  org.springframework.boot
  spring-boot-starter-data-redis

2、在 application.properties 文件中加入 Redis 相關(guān)的配置

spring.redis.host=127.0.0.1
spring.redis.port=6379

3、在代碼中引用 Redis 緩存的操作類(lèi)

@Autowired
private RedisTemplateredisTemplate;

為什么 RedisTemplate 可以被直接注入，它是什么時(shí)候加入到 Ioc 容器中的，這都是自動(dòng)裝配的功勞，我們一起來(lái)看一下。

二.自動(dòng)裝配過(guò)程

1、@EnableAutoConfiguration分析

SpringBoot 項(xiàng)目啟動(dòng)類(lèi)上有 @SpringBootApplication 這樣一個(gè)注解，它繼承了 @EnableAutoConfiguration，主要作用是幫助 Springboot 應(yīng)用把所有符合條件的配置類(lèi)都加載到當(dāng)前 SpringBoot 創(chuàng)建并使用的 Ioc 容器中。

這個(gè)注解主要由兩部分組成

• @AutoConfigurationPackage，指定 SpringBoot 掃描的包范圍，這個(gè)范圍下使用 @Service 、 @Component 等注解的 Bean 加入 Ioc 容器，默認(rèn)值是啟動(dòng)類(lèi)所在的包路徑，默認(rèn)指定啟動(dòng)類(lèi)路徑下的類(lèi)加載到 Ioc 容器。
• **@Import(AutoConfigurationImportSelector.class)**，將導(dǎo)入第三方提供的 Bean 配置類(lèi)加載加載到 Ioc 容器。

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

1.1 @AutoConfigurationPackage

@AutoConfigurationPackage 指定 SpringBoot 掃描的包范圍,主要邏輯在 AutoConfigurationPackages#register 方法中。

該方法有兩個(gè)參數(shù) registry 和 packageNames，在斷點(diǎn)中發(fā)現(xiàn) registry 實(shí)際上就是 DefaultListableBeanFactory 實(shí)例，packageNames 的值默認(rèn)是啟動(dòng)類(lèi)包所在的路徑，在這里將 @AutoConfigurationPackage 指定的包路徑添加到 DefaultListableBeanFactory，在后續(xù)Ioc容器掃描時(shí)將其加載進(jìn)去。

圖片

1.2 AutoConfigurationImportSelector.class

AutoConfigurationImportSelector 主要是實(shí)現(xiàn) importSelector 方法來(lái)實(shí)現(xiàn)基于動(dòng)態(tài) Bean 的加載功能，我們定位到 importSelector 方法看一下里面的邏輯。

@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
  if (!isEnabled(annotationMetadata)) {
    return NO_IMPORTS;
  }
  //1、從配置文件spring-autoconfigure-metadata.properties中加載自動(dòng)裝配候選規(guī)則
  AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
    .loadMetadata(this.beanClassLoader);
  //2、獲取@SpringBootApplication上配置的屬性值
 AnnotationAttributes attributes = getAttributes(annotationMetadata);
  //3、使用SpringFactoriesLoader 加載classpath路徑下META-INF\spring.factories中
  //通過(guò)key=org.springframework.boot.autoconfigure.EnableAutoConfiguration獲取候選類(lèi)
 List configurations = getCandidateConfigurations(annotationMetadata,attributes);
  //4、去除重復(fù)值
  configurations = removeDuplicates(configurations);
  //5、獲取exclude屬性值，將exclude中的值排除掉
  Set exclusions = getExclusions(annotationMetadata, attributes);
  checkExcludedClasses(configurations, exclusions);
  configurations.removeAll(exclusions);
  //6、檢查候選配置類(lèi)上的注解@ConditionalOnClass，如果要求的類(lèi)不存在，則這個(gè)候選類(lèi)會(huì)被過(guò)濾不被加載
  configurations = filter(configurations, autoConfigurationMetadata);
  fireAutoConfigurationImportEvents(configurations, exclusions);
  return StringUtils.toStringArray(configurations);
}

第一步和第三步邏輯中涉及到兩個(gè)非常重要的文件 spring-autoconfigure-metadata.properties、spring.factories

• spring.factories 主要記錄了待自動(dòng)裝配的候選類(lèi)，從下圖斷點(diǎn)中可以看到有 109 個(gè)。

圖片

• spring-autoconfigure-metadata.properties 中配置了系列 ConditionalOnClass 類(lèi)和配置類(lèi)之間的依賴，通過(guò)這個(gè)文件中配置的規(guī)則，來(lái)判斷 spring.factories 哪些類(lèi)真的需要加載。為什么會(huì)這樣做，是因?yàn)楹芏嗟?@Configuration 其實(shí)是依托于其他的框架來(lái)加載的，如果當(dāng)前的 classpath 環(huán)境下沒(méi)有相關(guān)聯(lián)的依賴，則意味著這些類(lèi)沒(méi)必要進(jìn)行加載，斷點(diǎn)的最后發(fā)現(xiàn)真正需要加載的只有 31 個(gè)。

• 加載 spring.factories 文件，借助了 Spring 框架提供的一個(gè)工具類(lèi) SpringFactoriesLoader，它的實(shí)現(xiàn)和 java 中的 SPI 機(jī)制原理是一樣的，它相對(duì)于 SPI 的改進(jìn)點(diǎn)在于不會(huì)一次性加載所有的類(lèi)，而是根據(jù) key 進(jìn)行加載。

SPI ，全稱為 Service Provider Interface，是一種服務(wù)發(fā)現(xiàn)機(jī)制。它通過(guò)在 ClassPath 路徑下的 META-INF/services 文件夾查找文件，自動(dòng)加載文件里所定義的類(lèi)。這一機(jī)制為很多框架擴(kuò)展提供了可能，比如在 Dubbo、JDBC 中都使用到了 SPI 機(jī)制。

圖片

2、@Import分析

在 @EnableAutoConfiguration 分析中，兩種加載 Bean 到 Ioc 容器的方式，他們都是通過(guò) @import 引入，這里我們來(lái)分析一下 @import 是在哪里進(jìn)行加載的。

2.1 @import3種使用方式

• 引入普通類(lèi),直接在 @Import 中引入即可。

@Import(PersonConfig.class)
@Configuration
public class PersonConfiguration { 
}

• 引入 ImportSelector 實(shí)現(xiàn)類(lèi)（AutoConfigurationImportSelector 就是實(shí)現(xiàn)了這個(gè)接口），這個(gè)接口需要實(shí)現(xiàn)的方法是 selectImports()，它返回的是一個(gè)字符串?dāng)?shù)組，代表的是類(lèi)名集合，這些類(lèi)將會(huì)被加載到Ioc容器中。

@Import(TestImportSelector.class)
@Configuration
public class ImportTestConfig {
}

public class TestImportSelector implements ImportSelector {
  @Override
  public String[] selectImports(AnnotationMetadata importingClassMetadata) {
    return new String[]{"com.example.service.TestService"};
  }
}

• 引用 ImportBeanDefinitionRegistrar 實(shí)現(xiàn)類(lèi)(AutoConfigurationPackages.Registrar 就是實(shí)現(xiàn)類(lèi)這個(gè)接口)，這個(gè)接口需要實(shí)現(xiàn)的方法是 registerBeanDefinitions()，它有兩個(gè)入?yún)ⅲ谝粋€(gè)參數(shù) AnnotationMetadata代表當(dāng)前類(lèi)的注解信息；第二個(gè)參數(shù) registry 代表的是 DefaultListableBeanFactory 實(shí)例，因?yàn)閰?shù) DefaultListableBeanFactory 代表的是 Ioc 容器，如果想注入 Bean，可以直接對(duì)該類(lèi)進(jìn)行操作。

@Import(TestImportBeanDefinitorSelector.class)
@Configuration
public class ImportBeanDefinitionTestConfig {
}

public class TestImportBeanDefinitorSelector implements ImportBeanDefinitionRegistrar {
  @Override
  public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
                                      BeanDefinitionRegistry registry) {
    AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder
     .rootBeanDefinition(Person.class)
     .getBeanDefinition();
    registry.registerBeanDefinition("person", beanDefinition);
  }
}

2.2 @Import實(shí)現(xiàn)原理

• @Import 主要由 ConfigurationClassPostProcessor 后置處理器加載實(shí)現(xiàn)，ConfigurationClassPostProcessor 則實(shí)現(xiàn)了 BeanDefinitionRegistryPostProcessor 接口，在 invokeBeanFactoryPostProcessors() 方法中進(jìn)行處理，該方法實(shí)例化并調(diào)用所有的 BeanFactory 后置處理器。

@Override
public void refresh() throws BeansException, IllegalStateException {
  //....省略n行代碼
  //1.beanFactory后置處理邏輯，在這個(gè)方法里加載ConfigurationClassPostProcessor
  invokeBeanFactoryPostProcessors(beanFactory);
  //2.注冊(cè)bean后置處理邏輯
  registerBeanPostProcessors(beanFactory);
  //...省略n行代碼
  //3.實(shí)例化非懶加載的bean，并加入到Ioc容器中
  finishBeanFactoryInitialization(beanFactory);
  //....省略n行代碼
}

• ConfigurationClassPostProcessor 實(shí)現(xiàn)了方法 postProcessBeanDefinitionRegistry()，在這個(gè)方法中跟蹤代碼到 ConfigurationClassParser.parse()，所有配置類(lèi)的解析邏輯都在 parse() 方法中進(jìn)行處理。
• 在 ConfigurationClassParser.parseparse() 繼續(xù)往下跟蹤會(huì)到 doProcessConfigurationClass() 方法，在該方法中會(huì)有一些常用配置注解的解析，例如 @Component、@ComponentScan、@Bean、@Configuration、@Import 等。

@Nullable
protected final SourceClass doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass)
   throws IOException {
  //...省略n行代碼
  //加載@Import注解，遞歸解析，獲取導(dǎo)入的配置類(lèi)
  processImports(configClass, sourceClass, getImports(sourceClass), true);
  //...省略n行代碼
}

• processImports() 中主要實(shí)現(xiàn)類(lèi)了 @Import 接口的 3 種不同的加載方式

private void processImports(ConfigurationClass configClass, 
                            SourceClass currentSourceClass,
                            Collection importCandidates, 
                            boolean checkForCircularImports) {
  //...省略n行代碼
  if (candidate.isAssignable(ImportSelector.class)) {
   //1.實(shí)現(xiàn)了ImportSelector接口的類(lèi)在@Import中引用邏輯
   Class candidateClass = candidate.loadClass();
   ImportSelector selector = BeanUtils.instantiateClass(
      candidateClass,ImportSelector.class);
   ParserStrategyUtils.invokeAwareMethods(
     selector, this.environment, this.resourceLoader, this.registry);
   if (this.deferredImportSelectors != null && 
      selector instanceof DeferredImportSelector) {
     this.deferredImportSelectors.add(
      new DeferredImportSelectorHolder(configClass, (DeferredImportSelector) selector));
   } else {
     String[] importClassNames = selector.selectImports(currentSourceClass.getMetadata());
    Collection importSourceClasses = asSourceClasses(importClassNames);
    processImports(configClass, currentSourceClass, importSourceClasses, false);
   }
  } else if (candidate.isAssignable(ImportBeanDefinitionRegistrar.class)) {
   //2.實(shí)現(xiàn)了ImportBeanDefinitionRegistrar接口的類(lèi)在@Import中引用邏輯
   Class candidateClass = candidate.loadClass();
   ImportBeanDefinitionRegistrar registrar =BeanUtils.instantiateClass(
      candidateClass, ImportBeanDefinitionRegistrar.class);
  ParserStrategyUtils.invokeAwareMethods(
    registrar, this.environment, this.resourceLoader, this.registry);
  configClass.addImportBeanDefinitionRegistrar(
      registrar, currentSourceClass.getMetadata());
 } else {
    //3.普通類(lèi)直接在@Import中引用邏輯
   this.importStack.registerImport(
      currentSourceClass.getMetadata(), candidate.getMetadata().getClassName());
  processConfigurationClass(candidate.asConfigClass(configClass));
 }
  //...省略n行代碼
}

總結(jié)一下就是如下的方法鏈調(diào)用

refresh()=>invokeBeanFactoryPostProcessors()=>postProcessBeanDefinitionRegistry()=>parse()=>
doProcessConfigurationClass()=>processImports()

3、啟動(dòng)類(lèi)何時(shí)加入到 Ioc 容器

前面我們分析了自動(dòng)裝配的主要邏輯，那么 SpringBoot 啟動(dòng)類(lèi)又是如何加入到Ioc容器中的呢？

3.1 prepareContext() 中的 load() 方法

• 從 SpringBoot 啟動(dòng)類(lèi)的 run() 方法開(kāi)始，跟蹤代碼到 SpringApplication.run() 方法，這里是 SpringBoot 啟動(dòng)的核心邏輯。
• 在 SpringApplication.run() 方法中有一個(gè) prepareContext() 方法，進(jìn)入這個(gè)方法里面，會(huì)發(fā)現(xiàn)有一個(gè) load() 方法，這里就是加載啟動(dòng)類(lèi)的地方，它會(huì)將啟動(dòng)類(lèi)注入到 Ioc 容器中。

private void prepareContext(ConfigurableApplicationContext context,
   ConfigurableEnvironment environment, SpringApplicationRunListeners listeners,
   ApplicationArguments applicationArguments, Banner printedBanner) {
  //...省略n行代碼
  //加載啟動(dòng)類(lèi)，將啟動(dòng)類(lèi)注入到Ioc容器中
  load(context, sources.toArray(new Object[0]));
  //...省略n行代碼
}

• 在斷點(diǎn)中可以看到，SpringBoot 啟動(dòng)類(lèi)注入到了 annotatedReader 中（AnnotatedBeanDefinitionReader 基于注解的 beanDefinition 解析器），在這里將啟動(dòng)類(lèi)加入到了 Ioc 容器。

圖片

總結(jié)一下就是如下的方法鏈調(diào)用

run()=>prepareContext()()=>load()=>parse()=>register()

4、自動(dòng)裝配整體流程

基于以上3塊的分析我們可以得到如下一個(gè)關(guān)于自動(dòng)裝配的流程圖

圖片

三.總結(jié)

學(xué)習(xí)源碼的過(guò)程中如果不了解源碼的整體思路，直接看代碼會(huì)迷失在源碼的海洋中。要了解代碼的整體脈絡(luò)，以總-分-總的方式去學(xué)習(xí)，學(xué)會(huì)舍棄部分無(wú)關(guān)的代碼，才能高效的閱讀和學(xué)習(xí)源碼，從中汲取到代碼的精華所在，提升自己的編程能力。

參考資料：

• 知乎：@Import使用及原理詳解

新聞標(biāo)題：一篇學(xué)會(huì)SpringBoot自動(dòng)裝配
轉(zhuǎn)載來(lái)源：http://uogjgqi.cn/article/ccegcog.html