Springboot 系列（三）Spring Boot 自動配置
注意：本 Spring Boot 系列文章基於 Spring Boot 版本 v2.1.1.RELEASE 進行學習分析，版本不同可能會有細微差別。
前言
關於配置檔案可以配置的內容，在 Spring Boot 官方網站 已經提供了完整了配置示例和解釋。
可以這麼說，Spring Boot 的一大精髓就是自動配置，為開發省去了大量的配置時間，可以更快的融入業務邏輯的開發，那麼自動配置是怎麼實現的呢？
1. @SpringBootApplication
跟著 Spring Boot 的啟動類的註解 @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 {
@EnableAutoConfiguration 開啟自動配置。
@ComponentScan 開啟註解掃描
從 SpringBootApplication 我們可以發現，這是一個簡便的註解配置，它包含了自動配置，配置類，包掃描等一系列功能。
2. @EnableAutoConfiguration
繼續跟蹤，檢視 @EnableAutoConfiguration 原始碼，裡面比較重要的是 @Import ，匯入了一個翻譯名為自動配置的選擇器的類。這個類其實就是自動配置的載入選擇器。
@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 {};
}
繼續跟蹤 AutoConfigurationImportSelector.class .在這個類有一個重要的方法 getCandidateConfigurations .用於載入 Spring Boot 配置的自動配置類。
getAutoConfigurationEntry 會篩選出有效的自動配置類。
protected AutoConfigurationEntry getAutoConfigurationEntry(
AutoConfigurationMetadata autoConfigurationMetadata,
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 = filter(configurations, autoConfigurationMetadata);
fireAutoConfigurationImportEvents(configurations, exclusions);
return new AutoConfigurationEntry(configurations, exclusions);
}
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
AnnotationAttributes attributes) {
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;
}
下圖是 DEBUG 模式下篩選之後的結果，因為我只添加了 web 模組，所以只有 web 相關的自動配置。
3. xxxAutoConfiguration 與 xxxProperties
在上面的 debug 裡，我們看到了成功載入的自動配置，目前只看到了配置類，卻還沒有發現自動配置值，隨便選擇一個 AutoConfiguration 檢視原始碼。
這裡選擇了 ServletWebServerFactoryAutoConfiguration .
@Configuration
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
//判斷當前專案有沒有這個類
//CharacterEncodingFilter；SpringMVC中進行亂碼解決的過濾器；
@ConditionalOnClass(ServletRequest.class)
//Spring底層@Conditional註解（Spring註解版），根據不同的條件，如果
//滿足指定的條件，整個配置類裡面的配置就會生效； 判斷當前應用是否是web應用，如果是，當前配置類生效
@ConditionalOnWebApplication(type = Type.SERVLET)
@EnableConfigurationProperties(ServerProperties.class)
@Import({ ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class,
ServletWebServerFactoryConfiguration.EmbeddedTomcat.class,
ServletWebServerFactoryConfiguration.EmbeddedJetty.class,
ServletWebServerFactoryConfiguration.EmbeddedUndertow.class })
public class ServletWebServerFactoryAutoConfiguration {
需要注意的是 @EnableConfigurationProperties(ServerProperties.class) .他的意思是啟動指定類的
ConfigurationProperties 功能；將配置檔案中對應的值和 ServerProperties 繫結起來；並把
ServerProperties 加入到 IOC 容器中。
再來看一下 ServerProperties .
@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {
/**
* Server HTTP port.
*/
private Integer port;
顯而易見了，這裡使用 ConfigurationProperties 繫結屬性對映檔案中的 server 開頭的屬性。結合預設配置
# 路徑spring-boot-autoconfigure-2.1.1.RELEASE.jar
# /META-INF/spring-configuration-metadata.json
{
"name": "server.port",
"type": "java.lang.Integer",
"description": "Server HTTP port.",
"sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties",
"defaultValue": 8080
}
達到了自動配置的目的。
4. 自動配置總結
- SpringBoot 啟動的時候載入主配置類，開啟了自動配置功能 @EnableAutoConfiguration 。
- @EnableAutoConfiguration 給容器匯入META-INF/spring.factories 裡定義的自動配置類。
- 篩選有效的自動配置類。
- 每一個自動配置類結合對應的 xxxProperties.java 讀取配置檔案進行自動配置功能 。
5. 配置類
通過自動配置，我們發現已經幫我們省去了大量的配置檔案的編寫，那麼在自定義配置的時候，我們是不是需要編寫XML呢？Spring boot 儘管可以使用 SpringApplication XML 檔案進行配置，但是我們通常會使用 @Configuration 類進行代替，這也是官方推薦的方式。
5.1 XML配置
定義 helloService Bean.
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"> <bean id="helloService" class="net.codingme.boot.service.HelloService"></bean> </beans>
引入配置。
@ImportResource(value = "classpath:spring-service.xml")
@SpringBootApplication
public class BootApplication {
public static void main(String[] args) {
SpringApplication.run(BootApplication.class, args);
}
}
5.2 註解配置
此種方式和上面的XML配置是等效的，也是官方推薦的方式。 @Configuration 註解的類（要在掃描的包路徑中）會被掃描到。
/**
* <p>
* 配置類，相當於傳統Spring 開發中的 xml-> bean的配置
*
* @Author niujinpeng
* @Date 2018/12/7 0:04
*/
@Configuration
public class ServiceConfig {
/**
* 預設新增到容器中的 ID 為方法名（helloService）
*
* @return
*/
@Bean
public HelloService helloService() {
return new HelloService();
}
}
6. 附錄
| @Conditional擴充套件註解 | 作用（判斷是否滿足當前指定條件） |
|---|---|
| @ConditionalOnJava | 系統的java版本是否符合要求 |
| @ConditionalOnBean | 容器中存在指定Bean； |
| @ConditionalOnMissingBean | 容器中不存在指定Bean； |
| @ConditionalOnExpression | 滿足SpEL表示式指定 |
| @ConditionalOnClass | 系統中有指定的類 |
| @ConditionalOnMissingClass | 系統中沒有指定的類 |
| @ConditionalOnSingleCandidate | 容器中只有一個指定的Bean，或者這個Bean是首選Bean |
| @ConditionalOnProperty | 系統中指定的屬性是否有指定的值 |
| @ConditionalOnResource | 類路徑下是否存在指定資原始檔 |
| @ConditionalOnWebApplication | 當前是web環境 |
| @ConditionalOnNotWebApplication | 當前不是web環境 |
| @ConditionalOnJndi | JNDI存在指定項 |
文章程式碼已經上傳到 GitHub Spring Boot 自動配置 。
