juejin.im/post/5ce5effb6fb9a07f0b039a14小伙伴們是否想起曾經(jīng)被 SSM 整合支配的恐懼？相信很多小伙伴都是有過這樣的經(jīng)歷的，一大堆配置問題，各種排除掃描，導(dǎo)入一個(gè)新的依賴又得添加新的配置。自從有了 Spring Boot 之后，咋們就起飛了！各種零配置開箱即用，而我們之所以開發(fā)起來能夠這么爽，自動(dòng)配置的功勞少不了，今天我們就一起來討論一下 Spring Boot 自動(dòng)配置原理，看完心里有個(gè)大概，不至于被面試官問的面紅耳赤。
1. SpringBoot 源碼常用注解拾遺這部分主要講一下 SpringBoot 源碼中經(jīng)常使用到的注解，以掃清后面閱讀源碼時(shí)候的障礙。組合注解當(dāng)可能大量同時(shí)使用到幾個(gè)注解到同一個(gè)類上，就可以考慮將這幾個(gè)注解到別的注解上。被注解的注解我們就稱之為組合注解。@Value @Value 就相當(dāng)于傳統(tǒng) xml 配置文件中的 value 字段。@Component public class Person {
@Value('i am name') private String name;
}
<bean class='Person'> <property name ='name' value='i am name'></property></bean>
- 通過
${key} 方式從環(huán)境變量中獲取值
所以，我們就可以通過 @Value(${key}) 的方式獲取全局配置文件中的指定配置項(xiàng)。@ConfigurationProperties 如果我們需要取 N 個(gè)配置項(xiàng)，通過 @Value 的方式去配置項(xiàng)需要一個(gè)一個(gè)去取，這就顯得有點(diǎn) low 了。我們可以使用 @ConfigurationProperties。標(biāo)有 @ConfigurationProperties 的類的所有屬性和配置文件中相關(guān)的配置項(xiàng)進(jìn)行綁定。（默認(rèn)從全局配置文件中獲取配置值），綁定之后我們就可以通過這個(gè)類去訪問全局配置文件中的屬性值了。person.name=kundy person.age=13 person.sex=male
2.創(chuàng)建配置類，由于篇幅問題這里省略了 setter、getter 方法，但是實(shí)際開發(fā)中這個(gè)是必須的，否則無法成功注入。另外，@Component 這個(gè)注解也還是需要添加的。@Component @ConfigurationProperties(prefix = 'person') public class Person {
private String name; private Integer age; private String sex;
}
這里 @ConfigurationProperties 有一個(gè) prefix 參數(shù)，主要是用來指定該配置項(xiàng)在配置文件中的前綴。3.測試，在 SpringBoot 環(huán)境中，編寫個(gè)測試方法，注入 Person 類，即可通過 Person 對象取到配置文件的值。@Import @Import 注解支持導(dǎo)入普通 java 類，并將其聲明成一個(gè)bean。主要用于將多個(gè)分散的 java config 配置類融合成一個(gè)更大的 config 類。- @Import 注解在 4.2 之前只支持導(dǎo)入配置類。
- 在4.2之后 @Import 注解支持導(dǎo)入普通的 java 類,并將其聲明成一個(gè) bean。
- 配合自定義的 ImportSelector 使用。
- 配合 ImportBeanDefinitionRegistrar 使用。
1. 直接導(dǎo)入普通的 Java 類1. 創(chuàng)建一個(gè)普通的 Java 類。public class Circle {
public void sayHi() { System.out.println('Circle sayHi()'); }
}
2. 創(chuàng)建一個(gè)配置類，里面沒有顯式聲明任何的 Bean，然后將剛才創(chuàng)建的 Circle 導(dǎo)入。@Import({Circle.class}) @Configuration public class MainConfig {
}
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class); Circle circle = context.getBean(Circle.class); circle.sayHi();
}
可以看到我們順利的從 IOC 容器中獲取到了 Circle 對象，證明我們在配置類中導(dǎo)入的 Circle 類，確實(shí)被聲明為了一個(gè) Bean。2. 配合自定義的 ImportSelector 使用ImportSelector 是一個(gè)接口，該接口中只有一個(gè) selectImports 方法，用于返回全類名數(shù)組。所以利用該特性我們可以給容器動(dòng)態(tài)導(dǎo)入 N 個(gè) Bean。1.創(chuàng)建普通 Java 類 Triangle。public class Triangle {
public void sayHi(){ System.out.println('Triangle sayHi()'); }
}2.創(chuàng)建 ImportSelector 實(shí)現(xiàn)類，selectImports 返回 Triangle 的全類名。public class MyImportSelector implements ImportSelector {
@Override public String[] selectImports(AnnotationMetadata annotationMetadata) { return new String[]{'annotation.importannotation.waytwo.Triangle'}; }
}
3. 創(chuàng)建配置類，在原來的基礎(chǔ)上還導(dǎo)入了 MyImportSelector。@Import({Circle.class,MyImportSelector.class}) @Configuration public class MainConfigTwo {
}
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MainConfigTwo.class); Circle circle = context.getBean(Circle.class); Triangle triangle = context.getBean(Triangle.class); circle.sayHi(); triangle.sayHi();
}
Circle sayHi()
Triangle sayHi() 可以看到 Triangle 對象也被 IOC 容器成功的實(shí)例化出來了。3. 配合 ImportBeanDefinitionRegistrar 使用ImportBeanDefinitionRegistrar 也是一個(gè)接口，它可以手動(dòng)注冊bean到容器中，從而我們可以對類進(jìn)行個(gè)性化的定制。(需要搭配 @Import 與 @Configuration 一起使用。）1.創(chuàng)建普通 Java 類 Rectangle。public class Rectangle {
public void sayHi() { System.out.println('Rectangle sayHi()'); }
}2.創(chuàng)建 ImportBeanDefinitionRegistrar 實(shí)現(xiàn)類，實(shí)現(xiàn)方法直接手動(dòng)注冊一個(gè)名叫 rectangle 的 Bean 到 IOC 容器中。public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
@Override public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) {
RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Rectangle.class); // 注冊一個(gè)名字叫做 rectangle 的 bean beanDefinitionRegistry.registerBeanDefinition('rectangle', rootBeanDefinition); }
}
3.創(chuàng)建配置類，導(dǎo)入 MyImportBeanDefinitionRegistrar 類。@Import({Circle.class, MyImportSelector.class, MyImportBeanDefinitionRegistrar.class}) @Configuration public class MainConfigThree {
}
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MainConfigThree.class); Circle circle = context.getBean(Circle.class); Triangle triangle = context.getBean(Triangle.class); Rectangle rectangle = context.getBean(Rectangle.class); circle.sayHi(); triangle.sayHi(); rectangle.sayHi();
}
Circle sayHi()
Triangle sayHi()
Rectangle sayHi() 嗯對，Rectangle 對象也被注冊進(jìn)來了。@Conditional @Conditional 注釋可以實(shí)現(xiàn)只有在特定條件滿足時(shí)才啟用一些配置。 1.創(chuàng)建普通 Java 類 ConditionBean，該類主要用來驗(yàn)證 Bean 是否成功加載。public class ConditionBean {
public void sayHi() { System.out.println('ConditionBean sayHi()'); }
}
2.創(chuàng)建 Condition 實(shí)現(xiàn)類，@Conditional 注解只有一個(gè) Condition 類型的參數(shù)，Condition 是一個(gè)接口，該接口只有一個(gè)返回布爾值的 matches() 方法，該方法返回 true 則條件成立，配置類生效。反之，則不生效。在該例子中我們直接返回 true。public class MyCondition implements Condition {
@Override public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { return true; }
}
3.創(chuàng)建配置類，可以看到該配置的 @Conditional 傳了我們剛才創(chuàng)建的 Condition 實(shí)現(xiàn)類進(jìn)去，用作條件判斷。@Configuration @Conditional(MyCondition.class) public class ConditionConfig {
@Bean public ConditionBean conditionBean(){ return new ConditionBean(); }
}
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(ConditionConfig.class); ConditionBean conditionBean = context.getBean(ConditionBean.class); conditionBean.sayHi();
}
因?yàn)?Condition 的 matches 方法直接返回了 true，配置類會(huì)生效，我們可以把 matches 改成返回 false，則配置類就不會(huì)生效了。除了自定義 Condition，Spring 還為我們擴(kuò)展了一些常用的 Condition。2. SpringBoot 啟動(dòng)過程在看源碼的過程中，我們會(huì)看到以下四個(gè)類的方法經(jīng)常會(huì)被調(diào)用，我們需要對一下幾個(gè)類有點(diǎn)印象：- ApplicationContextInitializer
- SpringApplicationRunListener
下面開始源碼分析，先從 SpringBoot 的啟動(dòng)類的 run() 方法開始看，以下是調(diào)用鏈：SpringApplication.run() -> run(new Class[]{primarySource}, args) -> new SpringApplication(primarySources)).run(args)。一直在run，終于到重點(diǎn)了，我們直接看 new SpringApplication(primarySources)).run(args) 這個(gè)方法。- 創(chuàng)建 SpringApplication 對象。
創(chuàng)建 SpringApplication 對象public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) {
this.sources = new LinkedHashSet(); this.bannerMode = Mode.CONSOLE; this.logStartupInfo = true; this.addCommandLineProperties = true; this.addConversionService = true; this.headless = true; this.registerShutdownHook = true; this.additionalProfiles = new HashSet(); this.isCustomEnvironment = false; this.resourceLoader = resourceLoader; Assert.notNull(primarySources, 'PrimarySources must not be null'); // 保存主配置類（這里是一個(gè)數(shù)組，說明可以有多個(gè)主配置類） this.primarySources = new LinkedHashSet(Arrays.asList(primarySources)); // 判斷當(dāng)前是否是一個(gè) Web 應(yīng)用 this.webApplicationType = WebApplicationType.deduceFromClasspath(); // 從類路徑下找到 META/INF/Spring.factories 配置的所有 ApplicationContextInitializer，然后保存起來 this.setInitializers(this.getSpringFactoriesInstances(ApplicationContextInitializer.class)); // 從類路徑下找到 META/INF/Spring.factories 配置的所有 ApplicationListener，然后保存起來 this.setListeners(this.getSpringFactoriesInstances(ApplicationListener.class)); // 從多個(gè)配置類中找到有 main 方法的主配置類（只有一個(gè)） this.mainApplicationClass = this.deduceMainApplicationClass();
}
運(yùn)行 run() 方法public ConfigurableApplicationContext run(String... args) {
// 創(chuàng)建計(jì)時(shí)器 StopWatch stopWatch = new StopWatch(); stopWatch.start(); // 聲明 IOC 容器 ConfigurableApplicationContext context = null; Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList(); this.configureHeadlessProperty(); // 從類路徑下找到 META/INF/Spring.factories 獲取 SpringApplicationRunListeners SpringApplicationRunListeners listeners = this.getRunListeners(args); // 回調(diào)所有 SpringApplicationRunListeners 的 starting() 方法 listeners.starting(); Collection exceptionReporters; try { // 封裝命令行參數(shù) ApplicationArguments applicationArguments = new DefaultApplicationArguments(args); // 準(zhǔn)備環(huán)境，包括創(chuàng)建環(huán)境，創(chuàng)建環(huán)境完成后回調(diào) SpringApplicationRunListeners#environmentPrepared()方法，表示環(huán)境準(zhǔn)備完成 ConfigurableEnvironment environment = this.prepareEnvironment(listeners, applicationArguments); this.configureIgnoreBeanInfo(environment); // 打印 Banner Banner printedBanner = this.printBanner(environment); // 創(chuàng)建 IOC 容器（決定創(chuàng)建 web 的 IOC 容器還是普通的 IOC 容器） context = this.createApplicationContext(); exceptionReporters = this.getSpringFactoriesInstances(SpringBootExceptionReporter.class, new Class[]{ConfigurableApplicationContext.class}, context); /* * 準(zhǔn)備上下文環(huán)境，將 environment 保存到 IOC 容器中，并且調(diào)用 applyInitializers() 方法 * applyInitializers() 方法回調(diào)之前保存的所有的 ApplicationContextInitializer 的 initialize() 方法 * 然后回調(diào)所有的 SpringApplicationRunListener#contextPrepared() 方法 * 最后回調(diào)所有的 SpringApplicationRunListener#contextLoaded() 方法 */this.prepareContext(context, environment, listeners, applicationArguments, printedBanner); // 刷新容器，IOC 容器初始化（如果是 Web 應(yīng)用還會(huì)創(chuàng)建嵌入式的 Tomcat），掃描、創(chuàng)建、加載所有組件的地方 this.refreshContext(context); // 從 IOC 容器中獲取所有的 ApplicationRunner 和 CommandLineRunner 進(jìn)行回調(diào) this.afterRefresh(context, applicationArguments); stopWatch.stop(); if (this.logStartupInfo) { (new StartupInfoLogger(this.mainApplicationClass)).logStarted(this.getApplicationLog(), stopWatch); } // 調(diào)用 所有 SpringApplicationRunListeners#started()方法 listeners.started(context); this.callRunners(context, applicationArguments); } catch (Throwable var10) { this.handleRunFailure(context, var10, exceptionReporters, listeners); throw new IllegalStateException(var10); } try { listeners.running(context); return context; } catch (Throwable var9) { this.handleRunFailure(context, var9, exceptionReporters, (SpringApplicationRunListeners)null); throw new IllegalStateException(var9); } }
小結(jié)：run() 階段主要就是回調(diào)本節(jié)開頭提到過的4個(gè)監(jiān)聽器中的方法與加載項(xiàng)目中組件到 IOC 容器中，而所有需要回調(diào)的監(jiān)聽器都是從類路徑下的 META-INF/Spring.factories 中獲取，從而達(dá)到啟動(dòng)前后的各種定制操作。3. SpringBoot 自動(dòng)配置原理@SpringBootApplication 注解SpringBoot 項(xiàng)目的一切都要從 @SpringBootApplication 這個(gè)注解開始說起。@SpringBootApplication 標(biāo)注在某個(gè)類上說明：- 這個(gè)類是 SpringBoot 的主配置類。
- SpringBoot 就應(yīng)該運(yùn)行這個(gè)類的 main 方法來啟動(dòng) SpringBoot 應(yīng)用。
@SpringBootConfiguration @EnableAutoConfiguration @ComponentScan( excludeFilters = {@Filter( type = FilterType.CUSTOM, classes = {TypeExcludeFilter.class} ), @Filter( type = FilterType.CUSTOM, classes = {AutoConfigurationExcludeFilter.class} )} ) public @interface SpringBootApplication {
} 可以看到 SpringBootApplication 注解是一個(gè)組合注解（關(guān)于組合注解文章的開頭有講到），其主要組合了一下三個(gè)注解：- @SpringBootConfiguration：該注解表示這是一個(gè) SpringBoot 的配置類，其實(shí)它就是一個(gè) @Configuration 注解而已。
- @EnableAutoConfiguration：從名字就可以看出來，就是這個(gè)類開啟自動(dòng)配置的。嗯，自動(dòng)配置的奧秘全都在這個(gè)注解里面。
@EnableAutoConfiguration 注解@AutoConfigurationPackage @Import({AutoConfigurationImportSelector.class}) public @interface EnableAutoConfiguration {
@AutoConfigurationPackage從字面意思理解就是自動(dòng)配置包。點(diǎn)進(jìn)去可以看到就是一個(gè) @Import 注解：@Import({Registrar.class})，導(dǎo)入了一個(gè) Registrar 的組件。關(guān)于 @Import 的用法文章上面也有介紹哦。我們在 Registrar 類中的 registerBeanDefinitions 方法上打上斷點(diǎn)，可以看到返回了一個(gè)包名，該包名其實(shí)就是主配置類所在的包。一句話：@AutoConfigurationPackage 注解就是將主配置類（@SpringBootConfiguration標(biāo)注的類）的所在包及下面所有子包里面的所有組件掃描到Spring容器中。所以說，默認(rèn)情況下主配置類包及子包以外的組件，Spring 容器是掃描不到的。@Import({AutoConfigurationImportSelector.class})該注解給當(dāng)前配置類導(dǎo)入另外的 N 個(gè)自動(dòng)配置類。（該注解詳細(xì)用法上文有提及）。那具體的導(dǎo)入規(guī)則是什么呢？我們來看一下源碼。在開始看源碼之前，先啰嗦兩句。就像小馬哥說的，我們看源碼不用全部都看，不用每一行代碼都弄明白是什么意思，我們只要抓住關(guān)鍵的地方就可以了。我們知道 AutoConfigurationImportSelector 的 selectImports 就是用來返回需要導(dǎo)入的組件的全類名數(shù)組的，那么如何得到這些數(shù)組呢？在 selectImports 方法中調(diào)用了一個(gè) getAutoConfigurationEntry() 方法。由于篇幅問題我就不一一截圖了，我直接告訴你們調(diào)用鏈：在 getAutoConfigurationEntry() -> getCandidateConfigurations() -> loadFactoryNames()。在這里 loadFactoryNames() 方法傳入了 EnableAutoConfiguration.class 這個(gè)參數(shù)。先記住這個(gè)參數(shù)，等下會(huì)用到。loadFactoryNames() 中關(guān)鍵的三步：- 從當(dāng)前項(xiàng)目的類路徑中獲取所有 META-INF/spring.factories 這個(gè)文件下的信息。
- 將上面獲取到的信息封裝成一個(gè) Map 返回。
- 從返回的 Map 中通過剛才傳入的 EnableAutoConfiguration.class 參數(shù)，獲取該 key 下的所有值。
META-INF/spring.factories 探究聽我這樣說完可能會(huì)有點(diǎn)懵，我們來看一下 META-INF/spring.factories 這類文件是什么就不懵了。當(dāng)然在很多第三方依賴中都會(huì)有這個(gè)文件，一般每導(dǎo)入一個(gè)第三方的依賴，除了本身的jar包以外，還會(huì)有一個(gè) xxx-spring-boot-autoConfigure，這個(gè)就是第三方依賴自己編寫的自動(dòng)配置類。我們現(xiàn)在就以 spring-boot-autocongigure 這個(gè)依賴來說。可以看到 EnableAutoConfiguration 下面有很多類，這些就是我們項(xiàng)目進(jìn)行自動(dòng)配置的類。 一句話：將類路徑下 META-INF/spring.factories 里面配置的所有 EnableAutoConfiguration 的值加入到 Spring 容器中。 HttpEncodingAutoConfiguration 通過上面方式，所有的自動(dòng)配置類就被導(dǎo)進(jìn)主配置類中了。但是這么多的配置類，明顯有很多自動(dòng)配置我們平常是沒有使用到的，沒理由全部都生效吧。 接下來我們以 HttpEncodingAutoConfiguration為例來看一個(gè)自動(dòng)配置類是怎么工作的。為啥選這個(gè)類呢？主要是這個(gè)類比較的簡單典型。 先看一下該類標(biāo)有的注解： @Configuration @EnableConfigurationProperties({HttpProperties.class}) @ConditionalOnWebApplication( type = Type.SERVLET ) @ConditionalOnClass({CharacterEncodingFilter.class}) @ConditionalOnProperty( prefix = 'spring.http.encoding', value = {'enabled'}, matchIfMissing = true ) public class HttpEncodingAutoConfiguration {
}
- @Configuration：標(biāo)記為配置類。
- @ConditionalOnWebApplication：web應(yīng)用下才生效。
- @ConditionalOnClass：指定的類（依賴）存在才生效。
- @ConditionalOnProperty：主配置文件中存在指定的屬性才生效。
- @EnableConfigurationProperties({HttpProperties.class})：啟動(dòng)指定類的ConfigurationProperties功能；將配置文件中對應(yīng)的值和 HttpProperties 綁定起來；并把 HttpProperties 加入到 IOC 容器中。
因?yàn)?/span> @EnableConfigurationProperties({HttpProperties.class})把配置文件中的配置項(xiàng)與當(dāng)前 HttpProperties 類綁定上了。然后在 HttpEncodingAutoConfiguration 中又引用了 HttpProperties ，所以最后就能在 HttpEncodingAutoConfiguration 中使用配置文件中的值了。最終通過 @Bean 和一些條件判斷往容器中添加組件，實(shí)現(xiàn)自動(dòng)配置。（當(dāng)然該Bean中屬性值是從 HttpProperties 中獲?。?/span>HttpProperties 通過 @ConfigurationProperties 注解將配置文件與自身屬性綁定。所有在配置文件中能配置的屬性都是在 xxxProperties 類中封裝著；配置文件能配置什么就可以參照某個(gè)功能對應(yīng)的這個(gè)屬性類。@ConfigurationProperties( prefix = 'spring.http' )// 從配置文件中獲取指定的值和bean的屬性進(jìn)行綁定 public class HttpProperties { }
小結(jié)：SpringBoot啟動(dòng)會(huì)加載大量的自動(dòng)配置類。 我們看需要的功能有沒有SpringBoot默認(rèn)寫好的自動(dòng)配置類。 我們再來看這個(gè)自動(dòng)配置類中到底配置了那些組件（只要我們要用的組件有，我們就不需要再來配置了）。 給容器中自動(dòng)配置類添加組件的時(shí)候，會(huì)從properties類中獲取某些屬性。我們就可以在配置文件中指定這些屬性的值。
xxxAutoConfiguration：自動(dòng)配置類給容器中添加組件。
xxxProperties：封裝配置文件中相關(guān)屬性。
不知道小伙伴們有沒有發(fā)現(xiàn)，很多需要待加載的類都放在類路徑下的META-INF/Spring.factories 文件下，而不是直接寫死這代碼中，這樣做就可以很方便我們自己或者是第三方去擴(kuò)展，我們也可以實(shí)現(xiàn)自己 starter，讓SpringBoot 去加載?，F(xiàn)在明白為什么 SpringBoot 可以實(shí)現(xiàn)零配置，開箱即用了吧！
|
