SpringBoot啟動機制（starter機制）核心原理詳解

阿新 • • 發佈：2019-12-31

作者：MyBug

一、前言

使用過springboot的同學應該已經知道，springboot通過預設配置了很多框架的使用方式幫我們大大簡化了專案初始搭建以及開發過程。本文的目的就是一步步分析springboot的啟動過程，這次主要是分析springboot特性自動裝配。那麼首先帶領大家回顧一下以往我們的web專案是如何搭建的，通常我們要搭建一個基於Spring的Web應用，我們需要做以下一些工作：

pom檔案中引入相關jar包，包括spring、springmvc、redis、mybaits、log4j、mysql-connector-java 等等相關jar …
配置web.xml，Listener配置、Filter配置、Servlet配置、log4j配置、error配置 …

配置資料庫連線、配置spring事務
配置檢視解析器
開啟註解、自動掃描功能
配置完成後部署tomcat、啟動除錯 ……

花在搭建一個初始專案，可能一個小時就過去了或者半天救過了，但是用了SpringBoot之後一切都會變得非常便捷，下面我們首先來分析一下SpringBoot的起步依賴以及自動配置。

二、起步依賴

1.在我們的pom檔案裡面引入以下jar：

   <modelVersion>4.0.0</modelVersion>
   <parent>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-parent</artifactId>
       <version>2.0.4.RELEASE</version>
       <relativePath /> <!-- lookup parent from repository -->
   </parent>
   <groupId>com.example</groupId>
   <artifactId>demo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>demo</name>
   <description>Demo project for 
 Spring Boot</description>

   <properties>
       <java.version>1.8</java.version>
   </properties>

   <dependencies>
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
       </dependency>

       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-test</artifactId>
           <scope>test 
</scope>
       </dependency>

       <!--mybatis 開發包 -->
       <dependency>
           <groupId>org.mybatis.spring.boot</groupId>
           <artifactId>mybatis-spring-boot-starter</artifactId>
           <version>1.3.2</version>
       </dependency>
       <!--springboot web模組支援 -->
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
       </dependency>
       <dependency>
           <groupId>mysql</groupId>
           <artifactId>mysql-connector-java</artifactId>
           <scope>runtime</scope>
       </dependency>
   </dependencies>

   <build>
       <plugins>
           <plugin>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-maven-plugin</artifactId>
           </plugin>
       </plugins>
   </build>

複製程式碼

spring-boot-starter-web包自動幫我們引入了web模組開發需要的相關jar包。
mybatis-spring-boot-starter幫我們引入了dao開發相關的jar包。
spring-boot-starter-xxx是官方提供的starter，xxx-spring-boot-starter是第三方提供的starter。

截圖看一下我們的mybatis-spring-boot-starter

可以看出mybatis-spring-boot-starter並沒有任何原始碼，只有一個pom檔案，它的作用就是幫我們引入其它jar。

2.配置資料來源

spring:
 datasource:
    type: com.zaxxer.hikari.HikariDataSource
    url: jdbc:mysql://127.0.0.1:3306/mybatis_test
    username: root
    password: root
    driver-class-name: com.mysql.jdbc.Driver
    hikari:
     # 最小空閒連線數量
     minimum-idle: 5
     # 連線池最大連線數，預設是10
     maximum-pool-size: 60
     # 此屬性控制從池返回的連線的預設自動提交行為,預設值：true
     auto-commit: true
     # 一個連線idle狀態的最大時長（毫秒），超時則被釋放（retired），預設:10分鐘
     idle-timeout: 600000
     # 此屬性控制池中連線的最長生命週期，值0表示無限生命週期，預設1800000即30分鐘
     max-lifetime: 1800000
     # 資料庫連線超時時間,預設30秒，即30000
     connection-timeout: 60000

複製程式碼

stater機制幫我們完成了專案起步所需要的的相關jar包。那問題又來了，傳統的spring應用中不是要在application.xml中配置很多bean的嗎，比如dataSource的配置，transactionManager的配置 … springboot是如何幫我們完成這些bean的配置的？下面我們來分析這個過程

三、自動配置

1.基於java程式碼的bean配置

以mybatis為例，在上面的截圖中，我們發現mybatis-spring-boot-starter這個包幫我們引入了mybatis-spring-boot-autoconfigure這個包，如下圖：

裡面有MybatisAutoConfiguration這個類，開啟這個類看看有些什麼東西。

熟悉@Configuration&、@Bean這兩個bean的同學或許已經知道了。這兩個註解一起使用就可以建立一個基於java程式碼的配置類，可以用來替代相應的xml配置檔案。 @Configuration註解的類可以看作是能生產讓Spring IoC容器管理的Bean例項的工廠。 @Bean註解告訴Spring，一個帶有@Bean的註解方法將返回一個物件，該物件應該被註冊到spring容器中。所以上面的MybatisAutoConfiguration這個類，自動幫我們生成了SqlSessionFactory這些Mybatis的重要例項並交給spring容器管理，從而完成bean的自動註冊。

2.自動配置條件依賴

從MybatisAutoConfiguration這個類中使用的註解可以看出，要完成自動配置是有依賴條件的。

@org.springframework.context.annotation.Configuration
@ConditionalOnClass({ SqlSessionFactory.class,SqlSessionFactoryBean.class })
@ConditionalOnBean(DataSource.class)
@EnableConfigurationProperties(MybatisProperties.class)
@AutoConfigureAfter(DataSourceAutoConfiguration.class)
public class MybatisAutoConfiguration {

 private static final Logger logger = LoggerFactory.getLogger(MybatisAutoConfiguration.class);

 private final MybatisProperties properties;

 private final Interceptor[] interceptors;

 private final ResourceLoader resourceLoader;

 private final DatabaseIdProvider databaseIdProvider;

 private final List<ConfigurationCustomizer> configurationCustomizers;
 ......

複製程式碼

首先預習一下Springboot是常用的條件依賴註解有：

@ConditionalOnBean，僅在當前上下文中存在某個bean時，才會例項化這個Bean。
@ConditionalOnClass，某個class位於類路徑上，才會例項化這個Bean。
@ConditionalOnExpression，當表示式為true的時候，才會例項化這個Bean。
@ConditionalOnMissingBean，僅在當前上下文中不存在某個bean時，才會例項化這個Bean。
@ConditionalOnMissingClass，某個class在類路徑上不存在的時候，才會例項化這個Bean。
@ConditionalOnNotWebApplication，不是web應用時才會例項化這個Bean。
@AutoConfigureAfter，在某個bean完成自動配置後例項化這個bean。
@AutoConfigureBefore，在某個bean完成自動配置前例項化這個bean。

所以要完成Mybatis的自動配置，需要在類路徑中存在SqlSessionFactory.class、SqlSessionFactoryBean.class這兩個類，需要存在DataSource這個bean且這個bean完成自動註冊。進入DataSourceAutoConfiguration這個類，可以看到這個類屬於這個包：

org.springframework.boot.autoconfigure.jdbc

這個包又屬於spring-boot-autoconfigure-2.0.4.RELEASE.jar這個包，自動配置這個包幫們引入了jdbc、kafka、logging、mail、mongo等包。很多包需要我們引入相應jar後自動配置才生效。

3.Bean引數的獲取

到此我們已經知道了bean的配置過程，但是還沒有看到springboot是如何讀取yml或者properites配置檔案的的屬性來建立資料來源的？在DataSourceAutoConfiguration類裡面，我們注意到使用了EnableConfigurationProperties這個註解。

@Configuration
@ConditionalOnClass({ DataSource.class,EmbeddedDatabaseType.class })
@EnableConfigurationProperties(DataSourceProperties.class)
@Import({ DataSourcePoolMetadataProvidersConfiguration.class,DataSourceInitializationConfiguration.class })
public class DataSourceAutoConfiguration {

    @Configuration
    @Conditional(EmbeddedDatabaseCondition.class)
    @ConditionalOnMissingBean({ DataSource.class,XADataSource.class })
    @Import(EmbeddedDataSourceConfiguration.class)
    protected static class EmbeddedDatabaseConfiguration {

    }
......

複製程式碼

DataSourceProperties中封裝了資料來源的各個屬性，且使用了註解ConfigurationProperties指定了配置檔案的字首。

@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceProperties implements BeanClassLoaderAware,InitializingBean {

    private ClassLoader classLoader;

    /**
     * Name of the datasource. Default to "testdb" when using an embedded database.
     */
    private String name;

    /**
     * Whether to generate a random datasource name.
     */
    private boolean generateUniqueName;

    /**
     * Fully qualified name of the connection pool implementation to use. By default,it
     * is auto-detected from the classpath.
     */
    private Class<? extends DataSource> type;

    /**
     * Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.
     */
    private String driverClassName;

    /**
     * JDBC URL of the database.
     */
    private String url;

    /**
     * Login username of the database.
     */
    private String username;

    /**
     * Login password of the database.
     */
    private String password;

    /**
     * JNDI location of the datasource. Class,url,username & password are ignored when
     * set.
     */
    private String jndiName;

    /**
     * Initialize the datasource with available DDL and DML scripts.
     */
    private DataSourceInitializationMode initializationMode = DataSourceInitializationMode.EMBEDDED;

    /**
     * Platform to use in the DDL or DML scripts (such as schema-${platform}.sql or
     * data-${platform}.sql).
     */
    private String platform = "all";

    /**
     * Schema (DDL) script resource references.
     */
    private List<String> schema;

    /**
     * Username of the database to execute DDL scripts (if different).
     */
    private String schemaUsername;

    /**
     * Password of the database to execute DDL scripts (if different).
     */
    private String schemaPassword;

    /**
     * Data (DML) script resource references.
     */
    private List<String> data;

    ......

複製程式碼

通過以上分析，我們可以得知： @ConfigurationProperties註解的作用是把yml或者properties配置檔案轉化為bean。 @EnableConfigurationProperties註解的作用是使@ConfigurationProperties註解生效。如果只配置@ConfigurationProperties註解，在spring容器中是獲取不到yml或者properties配置檔案轉化的bean的。通過這種方式，把yml或者properties配置引數轉化為bean，這些bean又是如何被發現與載入的？

4.Bean的發現

springboot預設掃描啟動類所在的包下的主類與子類的所有元件，但並沒有包括依賴包的中的類，那麼依賴包中的bean是如何被發現和載入的？我們通常在啟動類中加@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 {

    /**
     * Exclude specific auto-configuration classes such that they will never be applied.
     * @return the classes to exclude
     */
    @AliasFor(annotation = EnableAutoConfiguration.class)
    Class<?>[] exclude() default {};

    /**
     * Exclude specific auto-configuration class names such that they will never be
     * applied.
     * @return the class names to exclude
     * @since 1.3.0
     */
     ......

複製程式碼

實際上重要的只有三個Annotation：

@Configuration（@SpringBootConfiguration裡面還是應用了@Configuration）
@EnableAutoConfiguration
@ComponentScan

@Configuration的作用上面我們已經知道了，被註解的類將成為一個bean配置類。 @ComponentScan的作用就是自動掃描並載入符合條件的元件，比如@Component和@Repository等，最終將這些bean定義載入到spring容器中。 @EnableAutoConfiguration 這個註解的功能很重要，藉助@Import的支援，收集和註冊依賴包中相關的bean定義。

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

    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    /**
     * Exclude specific auto-configuration classes such that they will never be applied.
     * @return the classes to exclude
     */
    Class<?>[] exclude() default {};

    /**
     * Exclude specific auto-configuration class names such that they will never be
     * applied.
     * @return the class names to exclude
     * @since 1.3.0
     */
    String[] excludeName() default {};

}

複製程式碼

如上原始碼，@EnableAutoConfiguration註解引入了@AutoConfigurationPackage和@Import這兩個註解。@AutoConfigurationPackage的作用就是自動配置的包，@Import匯入需要自動配置的元件。

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

}

複製程式碼

/**
 * {@link ImportBeanDefinitionRegistrar} to store the base package from the importing
 * configuration.
 */
static class Registrar implements ImportBeanDefinitionRegistrar,DeterminableImports {

    @Override
    public void registerBeanDefinitions(AnnotationMetadata metadata,BeanDefinitionRegistry registry) {
        register(registry,new PackageImport(metadata).getPackageName());
    }

    @Override
    public Set<Object> determineImports(AnnotationMetadata metadata) {
        return Collections.singleton(new PackageImport(metadata));
    }

}

複製程式碼

new AutoConfigurationPackages.PackageImport(metadata)).getPackageName() new AutoConfigurationPackages.PackageImport(metadata)

這兩句程式碼的作用就是載入啟動類所在的包下的主類與子類的所有元件註冊到spring容器，這就是前文所說的springboot預設掃描啟動類所在的包下的主類與子類的所有元件。那問題又來了，要蒐集並註冊到spring容器的那些beans來自哪裡？進入 AutoConfigurationImportSelector類，我們可以發現SpringFactoriesLoader.loadFactoryNames方法呼叫loadSpringFactories方法從所有的jar包中讀取META-INF/spring.factories檔案資訊。下面是spring-boot-autoconfigure這個jar中spring.factories檔案部分內容，其中有一個key為org.springframework.boot.autoconfigure.EnableAutoConfiguration的值定義了需要自動配置的bean，通過讀取這個配置獲取一組@Configuration類。

org.springframework.boot.autoconfigure.AutoConfigurationImportListener=\
org.springframework.boot.autoconfigure.condition.ConditionEvaluationReportAutoConfigurationImportListener

# Auto Configuration Import Filters
org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=\
org.springframework.boot.autoconfigure.condition.OnClassCondition

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\

複製程式碼

每個xxxAutoConfiguration都是一個基於java的bean配置類。實際上，這些xxxAutoConfiguratio不是所有都會被載入，會根據xxxAutoConfiguration上的@ConditionalOnClass等條件判斷是否載入;通過反射機制將spring.factories中@Configuration類例項化為對應的java實列。到此我們已經知道怎麼發現要自動配置的bean了，最後一步就是怎麼樣將這些bean載入到spring容器。

5.Bean 載入

如果要讓一個普通類交給Spring容器管理，通常有以下方法：

使用 @Configuration與@Bean 註解
使用@Controller @Service @Repository @Component 註解標註該類，然後啟用@ComponentScan自動掃描
使用@Import 方法

springboot中使用了@Import 方法 @EnableAutoConfiguration註解中使用了@Import({AutoConfigurationImportSelector.class})註解，AutoConfigurationImportSelector實現了DeferredImportSelector介面， DeferredImportSelector介面繼承了ImportSelector介面，ImportSelector介面只有一個selectImports方法。 selectImports方法返回一組bean，@EnableAutoConfiguration註解藉助@Import註解將這組bean注入到spring容器中，springboot正式通過這種機制來完成bean的注入的。

四、總結

我們可以將自動配置的關鍵幾步以及相應的註解總結如下：

@Configuration&與@Bean------>>>基於java程式碼的bean配置
@Conditional-------->>>>>>設定自動配置條件依賴
@EnableConfigurationProperties與@ConfigurationProperties->讀取配置檔案轉換為bean。
@EnableAutoConfiguration、@AutoConfigurationPackage 與@Import->實現bean發現與載入。

歡迎大家一起交流，喜歡文章記得點個贊喲，感謝支援！

SpringBoot啟動機制（starter機制）核心原理詳解

一、前言

二、起步依賴

1.在我們的pom檔案裡面引入以下jar：

2.配置資料來源

三、自動配置

1.基於java程式碼的bean配置

2.自動配置條件依賴

3.Bean引數的獲取

4.Bean的發現

5.Bean 載入

四、總結

SpringBoot啟動機制（starter機制）核心原理詳解

Python引數傳遞機制傳值和傳引用原理詳解

零拷貝（Zero-copy）及其應用詳解

.NET RulesEngine（規則引擎）的使用詳解

.NET RulesEngine（規則引擎）的使用 .NET RulesEngine（規則引擎）的使用詳解

深度解析Python垃圾回收機制（超級詳細）

Python 字串駐留機制（intern 機制）

轉載-python垃圾回收機制（Garbage collection）

mysql的表鎖機制（讀寫）

快速失敗機制（fail-fast）

linux訊號機制（初識版）

Storm 系列（二）—— Storm 核心概念詳解

SpringBoot學習記錄（十四）-------- Spring Boot整合Redis開發：模擬高併發秒殺活動

es(elasticsearch)整合SpringCloud（SpringBoot）搭建教程詳解

Maven 專題（五）：Maven核心概念詳解（一）

springboot 整合mybatis（ssm框架）

小白的springboot之路（十七）、阿里雲OSS 的使用

小白的springboot之路（十八）、i18n多語言支援（後端篇）

小白的springboot之路（十九）、整合swagger（com.spring4all篇）

Springboot：springboot整合Shiro（JdbcRealm 方式）

SpringBoot啟動機制（starter機制）核心原理詳解

一、前言

二、起步依賴

1.在我們的pom檔案裡面引入以下jar：

2.配置資料來源

三、自動配置

1.基於java程式碼的bean配置

2.自動配置條件依賴

3.Bean引數的獲取

4.Bean的發現

5.Bean 載入

四、總結

相關推薦