SpringBoot原理深入及源碼剖析(一) 依賴管理及自動配置


前言

傳統的Spring框架實現一個Web服務需要導入各種依賴jar包,然后編寫對應的XML配置文件等,相較而言,SpringBoot顯得更加方便、快捷和高效。那么,SpringBoot究竟是如何做到這些的呢?

下面分別針對SpringBoot框架的依賴管理、自動配置和執行流程進行深入分析。

依賴管理

問題1:為什么導入依賴時不需要指定版本?

在前面SpringBoot項目簡單案例中,項目pom.xml文件有兩個核心依賴,分別是spring-boot-starter-parent和spring-boot-starter-web,關於這兩個依賴的相關介紹具體如下:

1、spring-boot-starter-parent依賴

pom.xml中spring-boot-starter-parent依賴的示例代碼如下:

<!-- SpringBoot 父項目依賴管理 -->
<parent>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-parent</artifactId>
       <version>2.5.0</version>
       <relativePath/> <!-- lookup parent from repository -->
</parent>

上述代碼中,將spring-boot-starter-parent依賴作為SpringBoot項目的統一父項目依賴管理,並將項目版本號統一為2.5.0(該版本號可根據實際開發需求進行修改)。

使用“Ctrl+鼠標左鍵”進入查看spring-boot-starter-parent底層源碼文件,可以看到spring-boot-starter-parent的底層有一個父依賴spring-boot-dependencies,核心代碼如下:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-dependencies</artifactId>
    <version>2.5.0</version>
</parent>

繼續查看spring-boot-dependencies底層源碼文件,核心代碼具體如下:

<properties>
    <activemq.version>5.16.2</activemq.version>
    <antlr2.version>2.7.7</antlr2.version>
    <appengine-sdk.version>1.9.88</appengine-sdk.version>
    <artemis.version>2.17.0</artemis.version>
    <aspectj.version>1.9.6</aspectj.version>
    <assertj.version>3.19.0</assertj.version>
    <atomikos.version>4.0.6</atomikos.version>
    <awaitility.version>4.0.3</awaitility.version>
    <build-helper-maven-plugin.version>3.2.0</build-helper-maven-plugin.version>
    <byte-buddy.version>1.10.22</byte-buddy.version>
    <caffeine.version>2.9.1</caffeine.version>
    <cassandra-driver.version>4.11.1</cassandra-driver.version>
    <classmate.version>1.5.1</classmate.version>
    <commons-codec.version>1.15</commons-codec.version>
    <commons-dbcp2.version>2.8.0</commons-dbcp2.version>
    <commons-lang3.version>3.12.0</commons-lang3.version>
    <commons-pool.version>1.6</commons-pool.version>
    <commons-pool2.version>2.9.0</commons-pool2.version>
    <couchbase-client.version>3.1.5</couchbase-client.version>
    <db2-jdbc.version>11.5.5.0</db2-jdbc.version>
    <dependency-management-plugin.version>1.0.11.RELEASE</dependency-management-plugin.version>
    <derby.version>10.14.2.0</derby.version>
    <dropwizard-metrics.version>4.1.21</dropwizard-metrics.version>
    <ehcache.version>2.10.9.2</ehcache.version>
    <ehcache3.version>3.9.3</ehcache3.version>
    <elasticsearch.version>7.12.1</elasticsearch.version>
    <embedded-mongo.version>3.0.0</embedded-mongo.version>
    <flyway.version>7.7.3</flyway.version>
    <freemarker.version>2.3.31</freemarker.version>
    <git-commit-id-plugin.version>4.0.4</git-commit-id-plugin.version>
    <glassfish-el.version>3.0.3</glassfish-el.version>
    <glassfish-jaxb.version>2.3.4</glassfish-jaxb.version>
    <groovy.version>3.0.8</groovy.version>
    <gson.version>2.8.6</gson.version>
    <h2.version>1.4.200</h2.version>
    <hamcrest.version>2.2</hamcrest.version>
    <hazelcast.version>4.1.3</hazelcast.version>
    <hazelcast-hibernate5.version>2.2.0</hazelcast-hibernate5.version>
    <hibernate.version>5.4.31.Final</hibernate.version>
    <hibernate-validator.version>6.2.0.Final</hibernate-validator.version>
    <hikaricp.version>4.0.3</hikaricp.version>
    <hsqldb.version>2.5.2</hsqldb.version>
    <htmlunit.version>2.49.1</htmlunit.version>
    <httpasyncclient.version>4.1.4</httpasyncclient.version>
    <httpclient.version>4.5.13</httpclient.version>
    <httpclient5.version>5.0.4</httpclient5.version>
    <httpcore.version>4.4.14</httpcore.version>
    <httpcore5.version>5.1.1</httpcore5.version>
    <infinispan.version>12.1.3.Final</infinispan.version>
    <influxdb-java.version>2.21</influxdb-java.version>
    <jackson-bom.version>2.12.3</jackson-bom.version>
    <jakarta-activation.version>1.2.2</jakarta-activation.version>
    <jakarta-annotation.version>1.3.5</jakarta-annotation.version>
    <jakarta-jms.version>2.0.3</jakarta-jms.version>
    <jakarta-json.version>1.1.6</jakarta-json.version>
    <jakarta-json-bind.version>1.0.2</jakarta-json-bind.version>
    <jakarta-mail.version>1.6.7</jakarta-mail.version>
    <jakarta-persistence.version>2.2.3</jakarta-persistence.version>
    <jakarta-servlet.version>4.0.4</jakarta-servlet.version>
    <jakarta-servlet-jsp-jstl.version>1.2.7</jakarta-servlet-jsp-jstl.version>
    <jakarta-transaction.version>1.3.3</jakarta-transaction.version>
    <jakarta-validation.version>2.0.2</jakarta-validation.version>
    <jakarta-websocket.version>1.1.2</jakarta-websocket.version>
    <jakarta-ws-rs.version>2.1.6</jakarta-ws-rs.version>
    <jakarta-xml-bind.version>2.3.3</jakarta-xml-bind.version>
    <jakarta-xml-soap.version>1.4.2</jakarta-xml-soap.version>
    <jakarta-xml-ws.version>2.3.3</jakarta-xml-ws.version>
    <janino.version>3.1.4</janino.version>
    <javax-activation.version>1.2.0</javax-activation.version>
    <javax-annotation.version>1.3.2</javax-annotation.version>
    <javax-cache.version>1.1.1</javax-cache.version>
    <javax-jaxb.version>2.3.1</javax-jaxb.version>
    <javax-jaxws.version>2.3.1</javax-jaxws.version>
    <javax-jms.version>2.0.1</javax-jms.version>
    <javax-json.version>1.1.4</javax-json.version>
    <javax-jsonb.version>1.0</javax-jsonb.version>
    <javax-mail.version>1.6.2</javax-mail.version>
    <javax-money.version>1.1</javax-money.version>
    <javax-persistence.version>2.2</javax-persistence.version>
    <javax-transaction.version>1.3</javax-transaction.version>
    <javax-validation.version>2.0.1.Final</javax-validation.version>
    <javax-websocket.version>1.1</javax-websocket.version>
    <jaxen.version>1.2.0</jaxen.version>
    <jaybird.version>4.0.3.java8</jaybird.version>
    <jboss-logging.version>3.4.1.Final</jboss-logging.version>
    <jboss-transaction-spi.version>7.6.1.Final</jboss-transaction-spi.version>
    <jdom2.version>2.0.6</jdom2.version>
    <jedis.version>3.6.0</jedis.version>
    <jersey.version>2.33</jersey.version>
    <jetty-el.version>9.0.29</jetty-el.version>
    <jetty-jsp.version>2.2.0.v201112011158</jetty-jsp.version>
    <jetty-reactive-httpclient.version>1.1.8</jetty-reactive-httpclient.version>
    <jetty.version>9.4.41.v20210516</jetty.version>
    <jmustache.version>1.15</jmustache.version>
    <johnzon.version>1.2.11</johnzon.version>
    <jolokia.version>1.6.2</jolokia.version>
    <jooq.version>3.14.9</jooq.version>
    <json-path.version>2.5.0</json-path.version>
    <json-smart.version>2.4.7</json-smart.version>
    <jsonassert.version>1.5.0</jsonassert.version>
    <jstl.version>1.2</jstl.version>
    <jtds.version>1.3.1</jtds.version>
    <junit.version>4.13.2</junit.version>
    <junit-jupiter.version>5.7.2</junit-jupiter.version>
    <kafka.version>2.7.1</kafka.version>
    <kotlin.version>1.5.0</kotlin.version>
    <kotlin-coroutines.version>1.5.0</kotlin-coroutines.version>
    <lettuce.version>6.1.2.RELEASE</lettuce.version>
    <liquibase.version>4.3.5</liquibase.version>
    <log4j2.version>2.14.1</log4j2.version>
    <logback.version>1.2.3</logback.version>
    <lombok.version>1.18.20</lombok.version>
    <mariadb.version>2.7.3</mariadb.version>
    <maven-antrun-plugin.version>1.8</maven-antrun-plugin.version>
    <maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version>
    <maven-clean-plugin.version>3.1.0</maven-clean-plugin.version>
    <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
    <maven-dependency-plugin.version>3.1.2</maven-dependency-plugin.version>
    <maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
    <maven-enforcer-plugin.version>3.0.0-M3</maven-enforcer-plugin.version>
    <maven-failsafe-plugin.version>2.22.2</maven-failsafe-plugin.version>
    <maven-help-plugin.version>3.2.0</maven-help-plugin.version>
    <maven-install-plugin.version>2.5.2</maven-install-plugin.version>
    <maven-invoker-plugin.version>3.2.2</maven-invoker-plugin.version>
    <maven-jar-plugin.version>3.2.0</maven-jar-plugin.version>
    <maven-javadoc-plugin.version>3.2.0</maven-javadoc-plugin.version>
    <maven-resources-plugin.version>3.2.0</maven-resources-plugin.version>
    <maven-shade-plugin.version>3.2.4</maven-shade-plugin.version>
    <maven-source-plugin.version>3.2.1</maven-source-plugin.version>
    <maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
    <maven-war-plugin.version>3.3.1</maven-war-plugin.version>
    <micrometer.version>1.7.0</micrometer.version>
    <mimepull.version>1.9.14</mimepull.version>
    <mockito.version>3.9.0</mockito.version>
    <mongodb.version>4.2.3</mongodb.version>
    <mssql-jdbc.version>9.2.1.jre8</mssql-jdbc.version>
    <mysql.version>8.0.25</mysql.version>
    <nekohtml.version>1.9.22</nekohtml.version>
    <neo4j-java-driver.version>4.2.5</neo4j-java-driver.version>
    <netty.version>4.1.65.Final</netty.version>
    <netty-tcnative.version>2.0.39.Final</netty-tcnative.version>
    <oauth2-oidc-sdk.version>9.3.3</oauth2-oidc-sdk.version>
    <nimbus-jose-jwt.version>9.8.1</nimbus-jose-jwt.version>
    <ojdbc.version>19.3.0.0</ojdbc.version>
    <okhttp3.version>3.14.9</okhttp3.version>
    <oracle-database.version>21.1.0.0</oracle-database.version>
    <pooled-jms.version>1.2.2</pooled-jms.version>
    <postgresql.version>42.2.20</postgresql.version>
    <prometheus-pushgateway.version>0.10.0</prometheus-pushgateway.version>
    <quartz.version>2.3.2</quartz.version>
    <querydsl.version>4.4.0</querydsl.version>
    <r2dbc-bom.version>Arabba-SR10</r2dbc-bom.version>
    <rabbit-amqp-client.version>5.12.0</rabbit-amqp-client.version>
    <reactive-streams.version>1.0.3</reactive-streams.version>
    <reactor-bom.version>2020.0.7</reactor-bom.version>
    <rest-assured.version>4.3.3</rest-assured.version>
    <rsocket.version>1.1.0</rsocket.version>
    <rxjava.version>1.3.8</rxjava.version>
    <rxjava-adapter.version>1.2.1</rxjava-adapter.version>
    <rxjava2.version>2.2.21</rxjava2.version>
    <saaj-impl.version>1.5.3</saaj-impl.version>
    <selenium.version>3.141.59</selenium.version>
    <selenium-htmlunit.version>2.49.1</selenium-htmlunit.version>
    <sendgrid.version>4.7.2</sendgrid.version>
    <servlet-api.version>4.0.1</servlet-api.version>
    <slf4j.version>1.7.30</slf4j.version>
    <snakeyaml.version>1.28</snakeyaml.version>
    <solr.version>8.8.2</solr.version>
    <spring-amqp.version>2.3.7</spring-amqp.version>
    <spring-batch.version>4.3.3</spring-batch.version>
    <spring-data-bom.version>2021.0.1</spring-data-bom.version>
    <spring-framework.version>5.3.7</spring-framework.version>
    <spring-hateoas.version>1.3.1</spring-hateoas.version>
    <spring-integration.version>5.5.0</spring-integration.version>
    <spring-kafka.version>2.7.1</spring-kafka.version>
    <spring-ldap.version>2.3.4.RELEASE</spring-ldap.version>
    <spring-restdocs.version>2.0.5.RELEASE</spring-restdocs.version>
    <spring-retry.version>1.3.1</spring-retry.version>
    <spring-security.version>5.5.0</spring-security.version>
    <spring-session-bom.version>2021.0.0</spring-session-bom.version>
    <spring-ws.version>3.1.1</spring-ws.version>
    <sqlite-jdbc.version>3.34.0</sqlite-jdbc.version>
    <sun-mail.version>1.6.7</sun-mail.version>
    <thymeleaf.version>3.0.12.RELEASE</thymeleaf.version>
    <thymeleaf-extras-data-attribute.version>2.0.1</thymeleaf-extras-data-attribute.version>
    <thymeleaf-extras-java8time.version>3.0.4.RELEASE</thymeleaf-extras-java8time.version>
    <thymeleaf-extras-springsecurity.version>3.0.4.RELEASE</thymeleaf-extras-springsecurity.version>
    <thymeleaf-layout-dialect.version>2.5.3</thymeleaf-layout-dialect.version>
    <tomcat.version>9.0.46</tomcat.version>
    <unboundid-ldapsdk.version>4.0.14</unboundid-ldapsdk.version>
    <undertow.version>2.2.7.Final</undertow.version>
    <versions-maven-plugin.version>2.8.1</versions-maven-plugin.version>
    <webjars-hal-browser.version>3325375</webjars-hal-browser.version>
    <webjars-locator-core.version>0.46</webjars-locator-core.version>
    <wsdl4j.version>1.6.3</wsdl4j.version>
    <xml-maven-plugin.version>1.0.2</xml-maven-plugin.version>
    <xmlunit2.version>2.8.2</xmlunit2.version>
  </properties>
......

從spring-boot-dependencies底層源碼文件可以看出,該文件通過標簽對一些常用技術框架的依賴文件進行了統一版本號管理,例如activemq、mysql、spring、tomcat等,都有與SpringBoot2.5.0版本相匹配的版本,這也是SpringBoot項目的pom.xml引入依賴文件不需要標注依賴文件版本號的原因。

需要說明的是,如果pom.xml引入的依賴文件不是由spring-boot-starter-parent管理的,那么在pom.xml引入依賴文件時,還是需要使用標簽指定依賴文件的版本號

 

問題2:spring-boot-starter-parent父依賴啟動器的主要作用是進行版本統一管理,那么項目運行依賴的JAR包是從何而來的?

2、spring-boot-starter-web依賴

查看spring-boot-starter-web依賴文件源碼,其核心代碼如下:

<dependencies>
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter</artifactId>
     <version>2.5.0</version>
     <scope>compile</scope>
   </dependency>
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-json</artifactId>
     <version>2.5.0</version>
     <scope>compile</scope>
   </dependency>
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-tomcat</artifactId>
     <version>2.5.0</version>
     <scope>compile</scope>
   </dependency>
   <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-web</artifactId>
     <version>5.3.7</version>
     <scope>compile</scope>
   </dependency>
   <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-webmvc</artifactId>
     <version>5.3.7</version>
     <scope>compile</scope>
   </dependency>
</dependencies>

從上述代碼可以發現,spring-boot-starter-web依賴啟動器的主要作用是提供Web開發場景所需要的底層所有依賴。

正因如此,在pom.xml中引入spring-boot-starter-web依賴啟動器時,就可以實現Web場景開發,而不需要額外導入Tomcat服務器以及其他Web依賴文件等。當然,這些依賴文件的版本號還是由spring-boot-starter-parent父依賴進行統一管理。

SpringBoot除了提供上述上述介紹的Web依賴器之外,還提供了其他許多開發場景的相關依賴,打開SpringBoot的官方文檔,搜索“Starters”關鍵字查詢場景依賴啟動器:

這里列出了SpringBoot官方提供的提供的部分場景依賴啟動器,這些依賴啟動器適用於不同的場景開發,使用時只需要在pom.xml文件中導入對應的依賴啟動器即可。

需要說明的是,SpringBoot並不是對所有場景開發的技術框架都提供了場景啟動器,例如數據庫操作框架Mybatis、阿里巴巴的Druid數據源等,SpringBoot官方就沒有提供對應的依賴啟動器。為了充分利用SpringBoot框架的優勢,在SpringBoot官方沒有整合這些技術框架的情況下,Mybatis和Druid等技術框架的開發團隊主動與SpringBoot框架進行了整合,實現了各自的依賴啟動器,例如mybatis-spring-boot-starter和druid-spring-boot-starter等。我們在pom.xml文件中引入這些第三方的依賴啟動器時,一定要配置對應的版本號

自動配置

自動配置概念:能夠在我們添加JAR包依賴的時候,自動為我們配置一些組件的相關配置,我們無需配置或只需少量配置就能運行項目。

問題:SpringBoot到底是如何進行自動配置的?都把哪些組件進行了自動配置?

SpringBoot項目的啟動入口是@SpringBootApplication注解標注類的main()方法,如下所示:

@SpringBootApplication
public class SpringbootDemoApplication {

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

@SpringBootApplication能夠掃描Spring組件並自動配置SpringBoot。

下面,我們來查看@SpringBootApplication內部源碼進行分析,核心代碼具體如下:

@Target({ElementType.TYPE})    // 注解的適用范圍,Type表示注解可以描述在類、接口、注解或枚舉中
@Retention(RetentionPolicy.RUNTIME)    // 表示注解的生命周期,Runtime表示運行時有效
@Documented    // 表示注解可以記錄在javadoc中
@Inherited    // 表示注解可以被子類繼承
@SpringBootConfiguration    // 表示該類為配置類
@EnableAutoConfiguration    // 啟動自動掃描功能
@ComponentScan(    // 包掃描器
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
...
}

從上述源碼可以看出,@҅SpringBootApplication注解是一個組合注解,前面四個注解是注解元數據信息,我們主要來看后面三個注解:@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan三個核心注解,關於這三個核心注解的相關說明具體如下:

1、@SpringBootConfiguration注解

@SpringBootConfiguration注解用於將被標注的類設置為SpringBoot配置類。

查看@SpringBootConfiguration注解源碼,其核心代碼如下:

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration    // 配置IOC容器
@Indexed
public @interface SpringBootConfiguration {
    @AliasFor(
        annotation = Configuration.class
    )
    boolean proxyBeanMethods() default true;
}

從上述源碼可以看出,@҅SpringBootConfiguration注解內部有一個核心注解@Configuration,該注解是由Spring框架提供的,表示當前類為一個配置類(XML配置文件的表現形式),並且可以被組件掃描器掃描。由此可見,@҅SpringBootConfiguration注解的作用與@Configuration相同,都是標識一個可以被組件掃描器掃描的配置類,只不過@SpringBootConfiguration是被SpringBoot進行了封裝重命名而已

2、@EnableAutoConfiguration注解

@EnableAutoConfiguration注解表示開啟自動配置功能,該注解是SpringBoot框架中最重要的注解,也是實現自動化配置的注解。查看該注解內部的源碼信息,其核心代碼具體如下:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage    // 自動配置包
@Import(AutoConfigurationImportSelector.class)    // 自動配置類掃描導入
public @interface EnableAutoConfiguration {

    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

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

    String[] excludeName() default {};

}

可以發現它是一個組合注解,Spring中有很多以Enable開頭的注解,其作用就是借助@Import來收集並注冊特定場景的bean,並加載到IOC容器

@EnableAutoConfiguration注解就是借助@Import來收集所有符合自動配置條件的bean定義,並加載到IOC容器。

下面,對@AutoConfigurationPackage和@Import這兩個核心注解分別進行講解:

(1)@AutoConfigurationPackage注解

查看@AutoConfigurationPackage注解內部源碼信息,其核心代碼如下:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)    // 導入Registrar中注冊的組件
public @interface AutoConfigurationPackage {

    String[] basePackages() default {};

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

}

從上述源碼可以看出,@҅AutoConfigurationPackage注解的功能是由@Import注解實現的,它是Spring框架的底層注解,它的作用就是給容器導入某個組件類。

例如,@Import(AutoConfigurationPackages.Registrar.class),它的作用就是將Registrar這個組件類導入到容器中,可查看Registrar類中的registerBeanDefinitions方法,它就是導入組件類的具體實現方法:

從上述源碼可以看出,在Registrar類中有一個@registerBeanDefinitions()方法,使用Debug模式啟動項目,在調用register()方法處打斷點:

追蹤到getPackageNames()方法,可以看到掃描的包名為com.hardy.springboot_demo:

也就是說,@AutoConfigurationPackage注解的主要作用就是將主程序類所在包及其所有子包下的組件掃描到Spring容器中

因此,在定義項目包結構時,要求定義的包結構非常規范,項目主程序啟動類要定義在最外層的根目錄位置,然后在根目錄位置內部建立子包和類進行業務開發,這樣才能夠保證定義的類能夠被組件掃描器掃描到。

(2)@Import(AutoConfigurationImportSelector.class)

將AutoConfigurationImportSelector這個類導入到Spring容器中,AutoConfigurationImportSelector可以幫助SpringBoot應用將所有符合條件的@Configuration配置都加載到當前SpringBoot創建並使用的IOC容器(ApplicationContext)中。

繼續研究AutoConfigurationImportSelector這個類,通過源碼分析發現,這個類是通過selectImports這個方法告訴SpringBoot需要導入哪些組件:

@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
  // 檢查是否開啟了自動配置類
    if (!isEnabled(annotationMetadata)) {
        return NO_IMPORTS;
    }
    // 若開啟了自動配置類,則加載注解數據、獲取配置信息
    AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
    return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}

深入研究getAutoConfigurationEntry()方法:

protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
    if (!isEnabled(annotationMetadata)) {
        return EMPTY_ENTRY;
    }
    AnnotationAttributes attributes = getAttributes(annotationMetadata);
   // 查詢配置文件
    List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
    configurations = removeDuplicates(configurations);
    Set<String> exclusions = getExclusions(annotationMetadata, attributes);
    checkExcludedClasses(configurations, exclusions);
    configurations.removeAll(exclusions);
    configurations = getConfigurationClassFilter().filter(configurations);
    fireAutoConfigurationImportEvents(configurations, exclusions);
    return new AutoConfigurationEntry(configurations, exclusions);
}

查看其中的getCandidateConfigurations()方法:

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    // 加載META-INF/spring.factories文件
    List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
    Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
    return configurations;
}

這里的loadFactoryNames()方法需要傳入兩個參數:getSpringFactoriesLoaderFactoryClass() 和 getBeanClassLoader()。

getSpringFactoriesLoaderFactoryClass()方法返回的是EnableAutoConfiguration.class,具體代碼如下所示:

protected Class<?> getSpringFactoriesLoaderFactoryClass() {
    return EnableAutoConfiguration.class;
}

getBeanClassLoader()返回的是beanClassLoader(類加載器),具體代碼如下所示:

protected ClassLoader getBeanClassLoader() {
    return this.beanClassLoader;
}

繼續查看loadFactoryNames()方法:

public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
    ClassLoader classLoaderToUse = classLoader;
    if (classLoaderToUse == null) {
        classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();
    }
    // 獲取出入的鍵
    String factoryTypeName = factoryType.getName();
    return loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());
}

查看loadSpringFactories()方法的代碼:

private static Map<String, List<String>> loadSpringFactories(ClassLoader classLoader) {
    Map<String, List<String>> result = cache.get(classLoader);
    if (result != null) {
        return result;
    }

    result = new HashMap<>();
    try {
        // 加載類路徑下的spring.factories文件,將其中設置的配置類的全部路徑信息封裝為Enumeration類對象
        Enumeration<URL> urls = classLoader.getResources(FACTORIES_RESOURCE_LOCATION);
        // 循環遍歷Enumeration類對象,根據相應的節點信息生成Properties對象,通過傳入的鍵獲取值,再將值切割為一個個小的字符串轉化為ArrayList,添加到result集合中
        while (urls.hasMoreElements()) {
            URL url = urls.nextElement();
            UrlResource resource = new UrlResource(url);
            Properties properties = PropertiesLoaderUtils.loadProperties(resource);
            for (Map.Entry<?, ?> entry : properties.entrySet()) {
                String factoryTypeName = ((String) entry.getKey()).trim();
                String[] factoryImplementationNames = StringUtils.commaDelimitedListToStringArray((String) entry.getValue());
                for (String factoryImplementationName : factoryImplementationNames) {
                    result.computeIfAbsent(factoryTypeName, key -> new ArrayList<>()).add(factoryImplementationName.trim());
                }
            }
        }

        // Replace all lists with unmodifiable lists containing unique elements
        result.replaceAll((factoryType, implementations) -> implementations.stream().distinct().collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList)));
        cache.put(classLoader, result);
    }
    catch (IOException ex) {
        throw new IllegalArgumentException("Unable to load factories from location [" +FACTORIES_RESOURCE_LOCATION + "]", ex);
    }
    return result;
}

上述的loadFactoryNames()方法和loadSpringFactories()方法是內部工具類SpringFactoriesLoader的兩個方法。

由以上分析可知,這里主要是會使用Spring提供的內部工具類SpringFactoriesLoader去讀取spring.factories這個配置文件,如果讀取不到會報這個錯:"No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct."。

我們可以看到spring.factories是在如下圖所示的位置:

它的主要內容如下所示:

也就是說,@EnableAutoConfiguration其實就是從classpath中搜索META-INF/spring.factories配置文件,並將其中的org.springframework.boot.autoconfigure.EnableutoConfiguration對應的配置項通過反射(Java Refletion)實例化為對應的標注了@Configuration的JavaConfig形式的配置類,並加載到IOC容器中

以剛剛的項目為例,在項目中加入了Web環境依賴啟動器,對應的WebMvcAutoConfiguration自動配置類就會生效,打開該自動配置類會發現,在該配置類中通過全注解配置類的方式對Spring MVC運行所需環境進行了默認設置,包括默認前綴、默認后綴、視圖解析器MVC校驗器等。而這些自動配置類的本質是傳統Spring MVC框架中對應的XML配置文件,只不過在SpringBoot中以自動配置類的形式進行了預先配置。因此,在SpringBoot項目中加入相關依賴啟動器后,基本上不需要任何配置就可以運行程序,當然,我們也可以對這些自動配置類中默認的配置進行修改。

總結

SpringBoot底層實現自動配置的步驟是:

  1. SpringBoot應用啟動;
  2. @SpringBootApplication注解起作用;
  3. @EnableAutoConfiguration注解實現自動化配置;
  4. @AutoConfigurationPackage注解通過@Import(AutoConfigurationPackages.Registrar.class),將Registrar類導入到IOC容器中,Registrar類的作用是掃描主配置類同級目錄以及子包,並將相應的組件導入到SpringBoot創建管理的容器中;
  5. @Import(AutoConfigurationImportSelector.class):它會將AutoConfigurationImportSelector類導入到容器中,AutoConfigurationImportSelector的作用是通過執行selectImports方法,使用內部工具類SpringFactoriesLoader,查找classpath上所有JAR包中的META-INF/spring.factories進行加載,實現將配置信息交給SpringFactory加載器進行一系列的容器創建過程的功能。

3、@ComponentScan注解

@ComponentScan注解具體掃描的包的根路徑由SpringBoot項目主程序啟動類所在的包位置決定,在掃描過程中由前面介紹過的@AutoConfigurationPackage注解進行解析,從而得到SpringBoot項目主程序啟動類所在包的具體位置。

總結

關於@SpringBootApplication注解的功能分析到這里就差不多結束了,簡單來說就是3個注解的組合注解,3個注解對應的功能大致如下所示:

- @SpringBootConfiguration
 |- @Configuration // 通過javaConfig的方式將組件添加到IOC容器中
|- @EnableAutoConfiguration
 |- @AutoConfigurationPackage // 自動配置包,與@ComponentScan配合使用,將掃描到的組件添加到IOC容器中
 |- @Import(AutoConfigurationImportSelector.class) // 將METAINF/spring.factories中定義的bean添加到IOC容器中
|- @ComponentScan // 包掃描


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM