淘寶一面：“說一下 Spring Boot 自動裝配原理唄？”

阿新 • • 發佈：2021-01-21

本文已經收錄進 Github 95k+ Star 的Java專案JavaGuide 。JavaGuide專案地址 : https://github.com/Snailclimb/JavaGuide 。

作者：Miki-byte-1024 & Snailclimb

每次問到 Spring Boot，面試官非常喜歡問這個問題：“講述一下 SpringBoot 自動裝配原理？”。

我覺得我們可以從以下幾個方面回答：

什麼是 SpringBoot 自動裝配？
SpringBoot 是如何實現自動裝配的？如何實現按需載入？
如何實現一個 Starter？

篇幅問題，這篇文章並沒有深入，小夥伴們也可以直接使用 debug 的方式去看看 SpringBoot 自動裝配部分的原始碼。

前言

使用過 Spring 的小夥伴，一定有被 XML 配置統治的恐懼。即使 Spring 後面引入了基於註解的配置，我們在開啟某些 Spring 特性或者引入第三方依賴的時候，還是需要用 XML 或 Java 進行顯式配置。

舉個例子。沒有 Spring Boot 的時候，我們寫一個 RestFul Web 服務，還首先需要進行如下配置。

@Configuration
public class RESTConfiguration
{
    @Bean
    public View jsonTemplate() {
        MappingJackson2JsonView view = new MappingJackson2JsonView();
        view.setPrettyPrint(true);
        return view;
    }

    @Bean
    public ViewResolver viewResolver() {
        return new BeanNameViewResolver();
    }
}

spring-servlet.xml

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/context/ http://www.springframework.org/schema/context/spring-context.xsd
    http://www.springframework.org/schema/mvc/ http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <context:component-scan base-package="com.howtodoinjava.demo" />
    <mvc:annotation-driven />

    <!-- JSON Support -->
    <bean name="viewResolver" class="org.springframework.web.servlet.view.BeanNameViewResolver"/>
    <bean name="jsonTemplate" class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"/>

</beans>

但是，Spring Boot 專案，我們只需要新增相關依賴，無需配置，通過啟動下面的 main 方法即可。

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

並且，我們通過 Spring Boot 的全域性配置檔案 application.properties或application.yml即可對專案進行設定比如更換埠號，配置 JPA 屬性等等。

為什麼 Spring Boot 使用起來這麼酸爽呢？ 這得益於其自動裝配。自動裝配可以說是 Spring Boot 的核心，那究竟什麼是自動裝配呢？

什麼是 SpringBoot 自動裝配？

我們現在提到自動裝配的時候，一般會和 Spring Boot 聯絡在一起。但是，實際上 Spring Framework 早就實現了這個功能。Spring Boot 只是在其基礎上，通過 SPI 的方式，做了進一步優化。

SpringBoot 定義了一套介面規範，這套規範規定：SpringBoot 在啟動時會掃描外部引用 jar 包中的META-INF/spring.factories檔案，將檔案中配置的型別資訊載入到 Spring 容器（此處涉及到 JVM 類載入機制與 Spring 的容器知識），並執行類中定義的各種操作。對於外部 jar 來說，只需要按照 SpringBoot 定義的標準，就能將自己的功能裝置進 SpringBoot。

沒有 Spring Boot 的情況下，如果我們需要引入第三方依賴，需要手動配置，非常麻煩。但是，Spring Boot 中，我們直接引入一個 starter 即可。比如你想要在專案中使用 redis 的話，直接在專案中引入對應的 starter 即可。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

引入 starter 之後，我們通過少量註解和一些簡單的配置就能使用第三方元件提供的功能了。

在我看來，自動裝配可以簡單理解為：通過註解或者一些簡單的配置就能在 Spring Boot 的幫助下實現某塊功能。

SpringBoot 是如何實現自動裝配的？

我們先看一下 SpringBoot 的核心註解 SpringBootApplication 。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
<1.>@SpringBootConfiguration
<2.>@ComponentScan
<3.>@EnableAutoConfiguration
public @interface SpringBootApplication {

}

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration //實際上它也是一個配置類
public @interface SpringBootConfiguration {
}

大概可以把 @SpringBootApplication看作是 @Configuration、@EnableAutoConfiguration、@ComponentScan 註解的集合。根據 SpringBoot 官網，這三個註解的作用分別是：

@EnableAutoConfiguration：啟用 SpringBoot 的自動配置機制
@Configuration：允許在上下文中註冊額外的 bean 或匯入其他配置類
@ComponentScan：掃描被@Component (@Service,@Controller)註解的 bean，註解預設會掃描啟動類所在的包下所有的類，可以自定義不掃描某些 bean。如下圖所示，容器中將排除TypeExcludeFilter和AutoConfigurationExcludeFilter。

@EnableAutoConfiguration 是實現自動裝配的重要註解，我們以這個註解入手。

@EnableAutoConfiguration:實現自動裝配的核心註解

EnableAutoConfiguration 只是一個簡單地註解，自動裝配核心功能的實現實際是通過 AutoConfigurationImportSelector類。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage //作用：將main包下的所欲元件註冊到容器中
@Import({AutoConfigurationImportSelector.class}) //載入自動裝配類 xxxAutoconfiguration
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    Class<?>[] exclude() default {};

    String[] excludeName() default {};
}

我們現在重點分析下AutoConfigurationImportSelector 類到底做了什麼？

AutoConfigurationImportSelector:載入自動裝配類

AutoConfigurationImportSelector類的繼承體系如下：

public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware, ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered {

}

public interface DeferredImportSelector extends ImportSelector {

}

public interface ImportSelector {
    String[] selectImports(AnnotationMetadata var1);
}

可以看出，AutoConfigurationImportSelector 類實現了 ImportSelector介面，也就實現了這個介面中的 selectImports方法，該方法主要用於獲取所有符合條件的類的全限定類名，這些類需要被載入到 IoC 容器中。

private static final String[] NO_IMPORTS = new String[0];

public String[] selectImports(AnnotationMetadata annotationMetadata) {
        // <1>.判斷自動裝配開關是否開啟
        if (!this.isEnabled(annotationMetadata)) {
            return NO_IMPORTS;
        } else {
          //<2>.獲取所有需要裝配的bean
            AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);
            AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata);
            return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
        }
    }

這裡我們需要重點關注一下getAutoConfigurationEntry()方法，這個方法主要負責載入自動配置類的。

該方法呼叫鏈如下：

現在我們結合getAutoConfigurationEntry()的原始碼來詳細分析一下：

private static final AutoConfigurationEntry EMPTY_ENTRY = new AutoConfigurationEntry();

AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) {
        //<1>.
        if (!this.isEnabled(annotationMetadata)) {
            return EMPTY_ENTRY;
        } else {
            //<2>.
            AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
            //<3>.
            List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
            //<4>.
            configurations = this.removeDuplicates(configurations);
            Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
            this.checkExcludedClasses(configurations, exclusions);
            configurations.removeAll(exclusions);
            configurations = this.filter(configurations, autoConfigurationMetadata);
            this.fireAutoConfigurationImportEvents(configurations, exclusions);
            return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
        }
    }

第 1 步:

判斷自動裝配開關是否開啟。預設spring.boot.enableautoconfiguration=true，可在 application.properties 或 application.yml 中設定

第 2 步 ：

用於獲取EnableAutoConfiguration註解中的 exclude 和 excludeName。

第 3 步

獲取需要自動裝配的所有配置類，讀取META-INF/spring.factories

spring-boot/spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories

從下圖可以看到這個檔案的配置內容都被我們讀取到了。XXXAutoConfiguration的作用就是按需載入元件。

不光是這個依賴下的META-INF/spring.factories被讀取到，所有 Spring Boot Starter 下的META-INF/spring.factories都會被讀取到。

所以，你可以清楚滴看到， druid 資料庫連線池的 Spring Boot Starter 就建立了META-INF/spring.factories檔案。

如果，我們自己要建立一個 Spring Boot Starter，這一步是必不可少的。

第 4 步 ：

到這裡可能面試官會問你:“spring.factories中這麼多配置，每次啟動都要全部載入麼？”。

很明顯，這是不現實的。我們 debug 到後面你會發現，configurations 的值變小了。

因為，這一步有經歷了一遍篩選，@ConditionalOnXXX 中的所有條件都滿足，該類才會生效。

@Configuration
// 檢查相關的類：RabbitTemplate 和 Channel是否存在
// 存在才會載入
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
@EnableConfigurationProperties(RabbitProperties.class)
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {
}

有興趣的童鞋可以詳細瞭解下 Spring Boot 提供的條件註解

@ConditionalOnBean：當容器裡有指定 Bean 的條件下
@ConditionalOnMissingBean：當容器裡沒有指定 Bean 的情況下
@ConditionalOnSingleCandidate：當指定 Bean 在容器中只有一個，或者雖然有多個但是指定首選 Bean
@ConditionalOnClass：當類路徑下有指定類的條件下
@ConditionalOnMissingClass：當類路徑下沒有指定類的條件下
@ConditionalOnProperty：指定的屬性是否有指定的值
@ConditionalOnResource：類路徑是否有指定的值
@ConditionalOnExpression：基於 SpEL 表示式作為判斷條件
@ConditionalOnJava：基於 Java 版本作為判斷條件
@ConditionalOnJndi：在 JNDI 存在的條件下差在指定的位置
@ConditionalOnNotWebApplication：當前專案不是 Web 專案的條件下
@ConditionalOnWebApplication：當前專案是 Web 項目的條件下

如何實現一個 Starter

光說不練假把式，現在就來擼一個 starter，實現自定義執行緒池

第一步，建立threadpool-spring-boot-starter工程

第二步，引入 Spring Boot 相關依賴

第三步，建立ThreadPoolAutoConfiguration

第四步，在threadpool-spring-boot-starter工程的 resources 包下建立META-INF/spring.factories檔案

最後新建工程引入threadpool-spring-boot-starter

測試通過！！！

總結

Spring Boot 通過@EnableAutoConfiguration開啟自動裝配，通過 SpringFactoriesLoader 最終載入META-INF/spring.factories中的自動配置類實現自動裝配，自動配置類其實就是通過@Conditional按需載入的配置類，想要其生效必須引入spring-boot-starter-xxx包實現起步依賴

淘寶一面：“說一下 Spring Boot 自動裝配原理唄？”

前言

什麼是 SpringBoot 自動裝配？

SpringBoot 是如何實現自動裝配的？

@EnableAutoConfiguration:實現自動裝配的核心註解

AutoConfigurationImportSelector:載入自動裝配類

如何實現一個 Starter

總結

淘寶一面：“說一下 Spring Boot 自動裝配原理唄？”

Spring Boot 自動裝配原始碼分析

Spring Boot自動配置原理與實踐（二）

封裝一個流水號ID生成器：id-spring-boot-starter

Spring Boot自動注入的原理分析

使用@AutoConfigureBefore、After、Order調整Spring Boot自動配置順序

淘寶臺灣：10月15日起陸續關閉平臺下單等前臺功能，年底停止運營

淘寶還有這玩法？自動寫文案的AI黑科技

spring boot自動配置

頭禿了，Spring Boot 自動配置原始碼解析瞭解一波~

Spring Boot 自動配置註解原始碼解析

Spring Boot學習-Spring MVC 自動配置原理

淘寶直播：向主播開放官方貨品池，覆蓋超 1 億商品

淘寶宣佈：買東西也能搜 emoji 表情了

“未發貨僅退款”規則升級！淘寶 500 元以內訂單可自動秒退

Sring Boot 自動裝配

基於XML配置Spring的自動裝配過程解析

springboot2.x基礎教程：自動裝配原理與條件註解

Spring的自動裝配

Spring Boot--->執行原理初探

淘寶一面：“說一下 Spring Boot 自動裝配原理唄？”

前言

什麼是 SpringBoot 自動裝配？

SpringBoot 是如何實現自動裝配的？

@EnableAutoConfiguration:實現自動裝配的核心註解

AutoConfigurationImportSelector:載入自動裝配類

如何實現一個 Starter

總結

相關推薦