## Spring Boot自動配置原理

Spring Boot是由Pivotal團隊提供的全新框架，其設計目的是用來簡化新Spring應用的初始搭建以及開發過程。它使用“習慣優于配置”的理念可以讓你的項目快速運行部署。使用Spring Boot可以不用或者只需要很少的Spring配置。

Spring Boot核心的功能就是自動配置。它會根據在類路徑中的jar、類自動配置Bean,當我們需要配置的Bean沒有被Spring Boot提供支持時,也可以自定義自動配置。

### 自動配置原理

spring-boot-starter-==web==：

spring-boot-starter：spring-boot場景啟動器；幫我們導入了web模塊正常運行所依賴的組件；

1.Spring Boot將所有的功能場景都抽取出來，做成一個個的starters（啟動器），只需要在項目里面引入這些starter相關場景的所有依賴都會導入進來。要用什么功能就導入什么場景的啟動器

### 主程序類，主入口類

/**

* @SpringBootApplication 來標注一個主程序類，說明這是一個Spring Boot應用

*/

@SpringBootApplication

public class HelloWorldMainApplication {

? ? public static void main(String[] args) {

? ? ? ? // Spring應用啟動起來

? ? ? ? SpringApplication.run(HelloWorldMainApplication.class,args);

? ? }

}

@SpringBootApplication: Spring Boot應用標注在某個類上說明這個類是SpringBoot的主配置類，SpringBoot就應該運行這個類的main方法來啟動SpringBoot應用；

@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 {

@SpringBootConfiguration:Spring Boot的配置類；

?標注在某個類上，表示這是一個Spring Boot的配置類；

@Configuration:配置類上來標注這個注解；

配置類 -----? 配置文件；配置類也是容器中的一個組件；@Component

@EnableAutoConfiguration：開啟自動配置功能；

以前我們需要配置的東西，Spring Boot幫我們自動配置；@EnableAutoConfiguration告訴SpringBoot開啟自動配置功能；這樣自動配置才能生效；

@AutoConfigurationPackage

@Import(EnableAutoConfigurationImportSelector.class)

public @interface EnableAutoConfiguration {

@AutoConfigurationPackage：自動配置包

@Import(AutoConfigurationPackages.Registrar.class)：

Spring的底層注解@Import，給容器中導入一個組件；導入的組件由AutoConfigurationPackages.Registrar.class；

將主配置類（@SpringBootApplication標注的類）的所在包及下面所有子包里面的所有組件掃描到Spring容器；==

?@Import(EnableAutoConfigurationImportSelector.class)；

給容器中導入組件

EnableAutoConfigurationImportSelector：導入哪些組件的選擇器；

將所有需要導入的組件以全類名的方式返回；這些組件就會被添加到容器中；

會給容器中導入非常多的自動配置類（xxxAutoConfiguration）；就是給容器中導入這個場景需要的所有組件，并配置好這些組件；

有了自動配置類，免去了我們手動編寫配置注入功能組件等的工作；

SpringFactoriesLoader.loadFactoryNames(EnableAutoConfiguration.class,classLoader)；

Spring Boot在啟動的時候從類路徑下的META-INF/spring.factories中獲取EnableAutoConfiguration指定的值，將這些值作為自動配置類導入到容器中，自動配置類就生效，幫我們進行自動配置工作；==以前我們需要自己配置的東西，自動配置類都幫我們；

J2EE的整體整合解決方案和自動配置都在spring-boot-autoconfigure-1.5.11.RELEASE.jar；

Spring Boot自動配置其實是基于Spring 4.x提供的條件配置(Conditional)實現的。

pring Boot啟動的時候加載主配置類，開啟了自動配置功能 ==@EnableAutoConfiguration==

@EnableAutoConfiguration 作用

?利用EnableAutoConfigurationImportSelector給容器中導入一些組件

可以查看selectImports()方法的內容；

List configurations = getCandidateConfigurations(annotationMetadata, attributes);獲取候選的配置

SpringFactoriesLoader.loadFactoryNames()

? ? ? ?掃描所有jar包類路徑下 META-INF/spring.factories

? ? ? ?把掃描到的這些文件的內容包裝成properties對象

? ? ? ?從properties中獲取到EnableAutoConfiguration.class類（類名）對應的值，然后把他們添加在容器中；

? ? ? 將 類路徑下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中；

每一個這樣的 xxxAutoConfiguration類都是容器中的一個組件，都加入到容器中；用他們來做自動配置；

### 以HttpEncodingAutoConfiguration(Http編碼自動配置)為例解釋自動配置原理

@Configuration? //表示這是一個配置類,以前編寫的配置文件一樣，也可以給容器中添加組件

@EnableConfigurationProperties(HttpEncodingProperties.class)? //啟動指定類的ConfigurationProperties功能；將配置文件中對應的值和HttpEncodingProperties綁定起來；并把HttpEncodingProperties加入到ioc容器中

@ConditionalOnWebApplication //Spring底層@Conditional注解（Spring注解版），根據不同的條件，如果滿足指定的條件，整個配置類里面的配置就會生效；判斷當前應用是否是web應用，如果是，當前配置類生效

@ConditionalOnClass(CharacterEncodingFilter.class)? //判斷當前項目有沒有這個類CharacterEncodingFilter；SpringMVC中進行亂碼解決的過濾器；

@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)? //判斷配置文件中是否存在某個配置? spring.http.encoding.enabled；如果不存在，判斷也是成立的

即使我們配置文件中不配置pring.http.encoding.enabled=true，也是默認生效的；

public class HttpEncodingAutoConfiguration {

//他已經和SpringBoot的配置文件映射了

private final HttpEncodingProperties properties;

? //只有一個有參構造器的情況下，參數的值就會從容器中拿

? ? public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {

? ? ? ? this.properties = properties;

? ? }

? ? @Bean? //給容器中添加一個組件，這個組件的某些值需要從properties中獲取

? ? @ConditionalOnMissingBean(CharacterEncodingFilter.class) //判斷容器沒有這個組件？

? ? public CharacterEncodingFilter characterEncodingFilter() {

? ? ? ? CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();

? ? ? ? filter.setEncoding(this.properties.getCharset().name());

? ? ? ? filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));

? ? ? ? filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));

? ? ? ? return filter;

? ? }

根據當前不同的條件判斷，決定這個配置類是否生效？

但這個配置類生效；這個配置類就會給容器中添加各種組件；這些組件的屬性是從對應的properties類中獲取的，這些類里面的每一個屬性又是和配置文件綁定的；

所有在配置文件中能配置的屬性都是在xxxxProperties類中封裝者‘；配置文件能配置什么就可以參照某個功能對應的這個屬性類

@ConfigurationProperties(prefix = "spring.http.encoding")? //從配置文件中獲取指定的值和bean的屬性進行綁定

public class HttpEncodingProperties {

public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");

### 精髓

-SpringBoot啟動會加載大量的自動配置類

-我們再來看這個自動配置類中到底配置了哪些組件；（只要我們要用的組件有，我們就不需要再來配置了）

-給容器中自動配置類添加組件的時候，會從properties類中獲取某些屬性。我們就可以在配置文件中指定這些屬性的值；

- xxxxAutoConfigurartion：自動配置類；

-給容器中添加組件；

- xxxxProperties:封裝配置文件中相關屬性；

### 細節

1、@Conditional派生注解（Spring注解版原生的@Conditional作用）**

作用：必須是@Conditional指定的條件成立，才給容器中添加組件，配置配里面的所有內容才生效；

@Conditional擴展注解 |? 作用（判斷是否滿足當前指定條件）

@ConditionalOnJava |系統的java版本是否符合要求

@ConditionalOnBean | 容器中存在指定Bean；

@ConditionalOnMissingBean | 容器中不存在指定Bean；

@ConditionalOnExpression | 滿足SpEL表達式指定

@ConditionalOnClass | 系統中有指定的類

@ConditionalOnMissingClass| 系統中沒有指定的類

@ConditionalOnSingleCandidate| 容器中只有一個指定的Bean，或者這個Bean是首選Bean

@ConditionalOnProperty| 系統中指定的屬性是否有指定的值

@ConditionalOnResource| 類路徑下是否存在指定資源文件

@ConditionalOnWebApplication| 當前是web環境

@ConditionalOnNotWebApplication| 當前不是web環境

@ConditionalOnJndi| JNDI存在指定項

## 自定義配置

? ? ?SpringBoot中免除了大部分手動配置，但是對于一些特定的情況，還是需要我們進行手動配置的，SpringBoot為我們提供了application.properties配置等文件，讓我們可以進行自定義配置，來對默認的配置進行修改，以適應具體的生產情況，當然還包括一些第三方的配置。幾乎所有配置都可以寫到application.peroperties文件中，這個文件會被SpringBoot自動加載，免去了我們手動加載的煩惱。Spring Boot 支持使用YAML語言的配置文件，YAML是以數據位中心的語言，所以使用application.yml作為全局配置也是同樣的效果，如果使用YAML替代properties注意寫法，冒號后面要加個空格，否則會解析不出來。

### 引用XML文件配置

? ? ?在實際項目中有的情況需要使用到XML配置文件，或者是你還不習慣用Java 配置的方式，那么你可以通過在入口啟動類上加上@ImportResource(value = { "路徑" })或者使用@ImportResource(locations= { "路徑" })，一樣的效果，多個XML文件的話你可以用逗號“,”分隔，就這樣輕而易舉的引用XML配置。

### 引入多個@Configuration 配置類

? ? ?在實際項目中可能不會把所有的配置都放在一個配置類（用@Configuration注解的類）中，可能會分開配置。這時可以用@Import注解引用。

### 引用自定義properties

? ? ? Spring Boot使用全局配置（application.properties）提供了很多的默認的配置屬性。在開發的時候，大多數會用到自定義的一些配置屬性，例如：指定上傳文件保存的路徑，定義：file.upload.stor-path=E:/test/，Spring Boot 提供了@Value注解獲取properties中的屬性，還提供了基于類型安全的配置方式，通過@ConfigurationProperties將properties屬性注入到一個Bean中，在1.4以上版本官方不建議使用@ConfigurationProperties來指定properties文件位置。接下來請看實例：

? ? ? 在pom.xml中加入以下依賴：

?<dependency>

? ? <groupId> org.springframework.boot</groupId>? ?

? ? <artifactId>spring-boot-configuration-processor</artifactId>? ?

? ? ? ? ? <optional>true</optional>? ?

</dependency>?

第一種：

（1 在src/main/resources下新建application.properties文件并加入以下代碼：

? file.upload.stor-path=E:/test/?

（2）直接使用@Value注解方式，具體代碼如下：

package com.chengli.springboot.helloworld;?

import org.springframework.beans.factory.annotation.Value;?

import org.springframework.boot.SpringApplication;?

import org.springframework.boot.autoconfigure.SpringBootApplication;?

import org.springframework.web.bind.annotation.RequestMapping;?

import org.springframework.web.bind.annotation.RestController;?

@RestController?

@SpringBootApplication?

public class SampleController {?

? ? @Value(value = "${file.upload.stor-path}")?

? ? private String storPath;?

? ? @RequestMapping("/")?

? ? String home() {?

? ? ? ? return "Hello World! file.upload.stor-path為：" + storPath;?

? ? }?

? ? public static void main(String[] args) throws Exception {?

? ? ? ? SpringApplication springApplication = new SpringApplication(SampleController.class);?

? ? ? ? springApplication.run(args);?

? ? }?

}?

第二種：

? ? ? 屬性配置放在application.properties文件中，使用@ConfigurationProperties將配置屬性注入到Bean中，代碼如下：

? ? ? （1）定義FileUploadProperties類

package com.chengli.springboot.helloworld;?

import org.springframework.boot.context.properties.ConfigurationProperties;?

import org.springframework.stereotype.Component;?

@Component?

@ConfigurationProperties(prefix = "file.upload")?

public class FileUploadProperties {?

? ? private String storPath;?

? ? public String getStorPath() {?

? ? ? ? return storPath;?

? ? }?

public void setStorPath(String storPath) {?

? ? ? ? this.storPath = storPath;?

? ? }?

}

（2）入口啟動類代碼如下：

package com.chengli.springboot.helloworld;?

import org.springframework.beans.factory.annotation.Autowired;?

import org.springframework.boot.SpringApplication;?

import org.springframework.boot.autoconfigure.SpringBootApplication;?

import org.springframework.web.bind.annotation.RequestMapping;?

import org.springframework.web.bind.annotation.RestController;?

@RestController?

@SpringBootApplication?

public class SampleController {?

? ? @Autowired?

? ? private FileUploadProperties fileUploadProperties;?

? ? @RequestMapping("/")?

? ? String home() {?

? ? ? ? return "Hello World! file.upload.stor-path為：" + fileUploadProperties.getStorPath();?

? ? }?

? ? public static void main(String[] args) throws Exception {?

? ? ? ? SpringApplication springApplication = new SpringApplication(SampleController.class);?

? ? ? ? springApplication.run(args);?

? ? }?

}?

?? ? ?注意：這里我對FileUploadProperties使用了@Component注解，如果沒有使用@Component注解，則需要在入口啟動類上加上@EnableConfigurationProperties注解。Spring Boot 在properties文件中支持使用SpEL表達式，可以進行校驗（校驗注解使用的是javax.validation）等操作。

例如以下：

-? 隨機數

? ? ? ? ? test.int.random=${random.int}

- 數組校驗

? ? ? ? ? test.int.random[0]=${random.int}

? ? ? ? ? test.int.random[1]=${random.int}

- 校驗

? ? ? ? ?@NotNull

? ?private String storPath;

4.外部化配置（配置方式與優先級）

? ? ? Spring Boot 允許外化配置，Spring Boot使用了一個特別的PropertySource次序來允許對值進行覆蓋，覆蓋的優先級順序如下：

? （1）Devtools全局設置主目錄（~ /.spring-boot-devtools.properties 為活躍的）。

? （2）@TestPropertySource注解在Test。

? （3）@SpringBootTest#properties 注解在Test。

? （4）命令行參數。

? （5）從SPRING_APPLICATION_JSON屬性(內聯JSON嵌入在一個環境變量或系統屬性)。

? （6）ServletConfig init參數。

? （7）ServletContext init參數。

? （8）JNDI屬性java:comp/env。

? （9）Java系統屬性(System.getProperties())。

? （10）操作系統環境變量。

? （11）RandomValuePropertySource配置的random.*屬性值

? （12）打包在jar以外的application-{profile}.properties或application.yml配置文件

? （13）打包在jar以內的application-{profile}.properties或application.yml配置文件

? （14）打包在jar以外的application.properties或application.yml配置文件

? （15）打包在jar以內的application.properties或application.yml配置文件

? （16）@configuration注解類上的@PropertySource。

? （17）默認的屬性(使用SpringApplication.setDefaultProperties指定)。

a) 通過命令行來修改默認參數，例如：

? ? 啟動命令：java -jar *.jar --name="chengli"

? ? 以上的意思是，將name值修改為：chengli

b) 通過命令行來設置加載properties 例如：

? ? java -jar *.jar --spring.profiles.active=dev

? ? 5.application.properties文件按優先級，優先級高的會覆蓋優先級低的

? 優先級順序如下：

? （1）當前目錄下的一個/config子目錄

? （2）當前目錄

? （3）一個classpath下的/config包

? （4）classpath根目錄