五分鐘說(shuō)清楚 Spring Boot的自動(dòng)配置原理
前言
Spring Boot沒(méi)有火起來(lái)之前,使用SSM架構(gòu)的項(xiàng)目那是相當(dāng)?shù)亩啵F(xiàn)在也有不少項(xiàng)目還是使用這種架構(gòu)。在使用SSM架構(gòu)的時(shí)候,大家是否還記得大量配置的煩惱郁悶,各種配置,搞得人都不是很爽。各種配置掃描,如果想添加一個(gè)新的依賴(lài),還得添加各種配置。這種大量配置的工作不進(jìn)浪費(fèi)時(shí)間,最主要的是會(huì)產(chǎn)生各種坑。
自從有了 Spring Boot 之后,咱們就爽爽的!各種零配置開(kāi)箱即用,而我們之所以開(kāi)發(fā)起來(lái)能夠這么爽,自動(dòng)配置的功勞少不了,今天我們就一起來(lái)討論一下 SpringBoot 自動(dòng)配置原理。
快速了解 SpringBoot 源碼常用注解
我們先對(duì)相關(guān)基本的注解進(jìn)行說(shuō)明,熟悉了這些注解,有利于我們后面更好的閱讀源碼。只要搞清楚了這些注解,遠(yuǎn)嗎也就變得沒(méi)那么難了。加油!少年~
組合注解
當(dāng)可能大量同時(shí)使用到幾個(gè)注解到同一個(gè)類(lèi)上,就可以考慮將這幾個(gè)注解到別的注解上。被注解的注解我們就稱(chēng)之為組合注解。
- 元注解:可以注解到別的注解上的注解。
- 組合注解:被注解的注解我們就稱(chēng)之為組合注解。
@Value
@Value注解有Spring提供,并非是Spring Boot中的,該注解存在于spring-beans.jar中。
- @Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
- @Retention(RetentionPolicy.RUNTIME)
- @Documented
- public @interface Value {
- /**
- * The actual value expression: for example {@code #{systemProperties.myProp}}.
- * 比如我們配置項(xiàng)address=ZhongguoGuizhou,這里的value=address
- */
- String value();
- }
@Value也相當(dāng)于傳統(tǒng) xml 配置文件中的 value 字段。
假設(shè)存在代碼:
- @Component
- public class Person {
- @Value("i am name")
- private String name;
- }
上面代碼等價(jià)于的配置文件:
- <bean class="Person">
- <property name ="name" value="i am name"></property>
- </bean>
我們知道配置文件中的 value 的取值可以是:
- 字面量
- 通過(guò) ${key} 方式從環(huán)境變量中獲取值
- 通過(guò) ${key} 方式全局配置文件中獲取值
- #{SpEL}
所以,我們就可以通過(guò) @Value(${key}) 的方式獲取全局配置文件中的指定配置項(xiàng)。
使用@Value有三個(gè)缺點(diǎn):
- 配置屬性不統(tǒng)一,沒(méi)有結(jié)構(gòu)。
- 注入麻煩每個(gè)屬性都要寫(xiě)配置名,和屬性名。(只要有重復(fù)的工作,就應(yīng)該重構(gòu))
- 配置零散在項(xiàng)目中各處
@ConfigurationProperties 注解
該注解有Spring Boot提供,在spring-boot.jar包中
org.springframework.boot.context.properties;目錄下:
- @Target({ElementType.TYPE, ElementType.METHOD})
- @Retention(RetentionPolicy.RUNTIME)
- @Documented
- public @interface ConfigurationProperties {
- //前綴
- @AliasFor("prefix")
- String value() default "";
- @AliasFor("value")
- String prefix() default "";
- //...
- }
如果我們要去獲取很多配置項(xiàng),比如:賬號(hào)、密碼、地址等一堆配置項(xiàng)時(shí),如果我們還是用@Value得一個(gè)一個(gè)去獲取配置項(xiàng),是不是覺(jué)得很low呀,所以這時(shí)候我們就可以考慮使用@ConfigurationProperties。
標(biāo)有 @ConfigurationProperties 的類(lèi)的所有屬性和配置文件中相關(guān)的配置項(xiàng)進(jìn)行綁定。(默認(rèn)從全局配置文件中獲取配置值),綁定之后我們就可以通過(guò)這個(gè)類(lèi)去訪問(wèn)全局配置文件中的屬性值了。
下面看一個(gè)實(shí)例:
第1步:在主配置文件中添加如下配置
- pay.account=java后端技術(shù)全棧
- pay.password=tj20120622
- pay.url=http://woaijava.cc
第2步:創(chuàng)建配置類(lèi),由于篇幅問(wèn)題這里省略了 setter、getter 方法,但是實(shí)際開(kāi)發(fā)中這個(gè)是必須的,否則無(wú)法成功注入。另外,@Component 這個(gè)注解也還是需要添加的。
- @Component
- @ConfigurationProperties(prefix = "pay")
- public class PayInfo {
- private String account;
- private Integer password;
- private String url;
- }
這里 @ConfigurationProperties 有一個(gè) prefix 參數(shù),主要是用來(lái)指定該配置項(xiàng)在配置文件中的前綴。
第3步:測(cè)試,在 Spring Boot 環(huán)境中,編寫(xiě)個(gè)測(cè)試方法,注入PayInfo類(lèi),即可通過(guò) PayInfo對(duì)象取到配置文件的值。
@Import 【Spring 提供】
@Import 是由Spring提供的注解,支持導(dǎo)入普通 java 類(lèi),并將其聲明成一個(gè)bean。主要用于將多個(gè)分散的 java config 配置類(lèi)融合成一個(gè)更大的 config 類(lèi)。
- @Import 注解在 4.2 之前只支持導(dǎo)入配置類(lèi)。
- 在4.2之后 @Import 注解支持導(dǎo)入普通的 java 類(lèi),并將其聲明成一個(gè) bean。
@Import 三種使用方式
- 直接導(dǎo)入普通的 Java 類(lèi)。
- 配合自定義的 ImportSelector 使用。
- 配合 ImportBeanDefinitionRegistrar 使用。
第一種方式:直接導(dǎo)入普通的 Java 類(lèi)
第1步:創(chuàng)建一個(gè)普通的 Java 類(lèi)。
- public class Circle {
- public void sayHi() {
- System.out.println("Circle sayHi()");
- }
- }
第2步:創(chuàng)建一個(gè)配置類(lèi),里面沒(méi)有顯式聲明任何的 Bean,然后將剛才創(chuàng)建的 Circle 導(dǎo)入。
- @Import({Circle.class})
- @Configuration
- public class MainConfig {
- }
第3步:創(chuàng)建測(cè)試類(lèi)。
- public static void main(String[] args) {
- ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class);
- Circle circle = context.getBean(Circle.class);
- circle.sayHi();
- }
第4步:運(yùn)行結(jié)果:
- Circle sayHi()
可以看到我們順利的從 IOC 容器中獲取到了 Circle 對(duì)象,證明我們?cè)谂渲妙?lèi)中導(dǎo)入的 Circle 類(lèi),確實(shí)被聲明為了一個(gè) Bean。
第二種方式:配合自定義的 ImportSelector 使用
ImportSelector 是一個(gè)接口,該接口中只有一個(gè) selectImports 方法,用于返回全類(lèi)名數(shù)組。所以利用該特性我們可以給容器動(dòng)態(tài)導(dǎo)入 N 個(gè) Bean。
第1步:創(chuàng)建普通 Java 類(lèi) Triangle。
- public class Triangle {
- public void sayHi(){
- System.out.println("Triangle sayHi()");
- }
- }
第2步:創(chuàng)建 ImportSelector 實(shí)現(xiàn)類(lèi),selectImports 返回 Triangle 的全類(lèi)名。
- public class MyImportSelector implements ImportSelector {
- @Override
- public String[] selectImports(AnnotationMetadata annotationMetadata) {
- return new String[]{"annotation.importannotation.waytwo.Triangle"};
- }
- }
第3步:創(chuàng)建配置類(lèi),在原來(lái)的基礎(chǔ)上還導(dǎo)入了 MyImportSelector。
- @Import({Circle.class,MyImportSelector.class})
- @Configuration
- public class MainConfigTwo {
- }
第4步:創(chuàng)建測(cè)試類(lèi)
- 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();
- }
第5步:運(yùn)行結(jié)果:
Circle sayHi()
Triangle sayHi()
可以看到 Triangle 對(duì)象也被 IOC 容器成功的實(shí)例化出來(lái)了。
第三種方式:配合 ImportBeanDefinitionRegistrar 使用
ImportBeanDefinitionRegistrar 也是一個(gè)接口,它可以手動(dòng)注冊(cè)bean到容器中,從而我們可以對(duì)類(lèi)進(jìn)行個(gè)性化的定制。(需要搭配 @Import 與 @Configuration 一起使用。)
第1步:創(chuàng)建普通 Java 類(lèi) Rectangle。
- public class Rectangle {
- public void sayHi() {
- System.out.println("Rectangle sayHi()");
- }
- }
第2步:創(chuàng)建 ImportBeanDefinitionRegistrar 實(shí)現(xiàn)類(lèi),實(shí)現(xiàn)方法直接手動(dòng)注冊(cè)一個(gè)名叫 rectangle 的 Bean 到 IOC 容器中。
- public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
- @Override
- public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) {
- RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Rectangle.class);
- // 注冊(cè)一個(gè)名字叫做 rectangle 的 bean
- beanDefinitionRegistry.registerBeanDefinition("rectangle", rootBeanDefinition);
- }
- }
第3步:創(chuàng)建配置類(lèi),導(dǎo)入 MyImportBeanDefinitionRegistrar 類(lèi)。
- @Import({Circle.class, MyImportSelector.class, MyImportBeanDefinitionRegistrar.class})
- @Configuration
- public class MainConfigThree {
- }
第4步:創(chuàng)建測(cè)試類(lèi)。
- 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();
- }
第5步:運(yùn)行結(jié)果
Circle sayHi()
Triangle sayHi()
Rectangle sayHi()
由此看一看到,Rectangle 對(duì)象也被注冊(cè)進(jìn)來(lái)了。
@Conditional 【Spring提供】
@Conditional 注釋可以實(shí)現(xiàn)只有在特定條件滿足時(shí)才啟用一些配置。
下面看一個(gè)簡(jiǎn)單的例子:
第1步:創(chuàng)建普通 Java 類(lèi) ConditionBean,該類(lèi)主要用來(lái)驗(yàn)證 Bean 是否成功加載。
- public class ConditionBean {
- public void sayHi() {
- System.out.println("ConditionBean sayHi()");
- }
- }
第2步:創(chuàng)建 Condition 實(shí)現(xiàn)類(lèi),@Conditional 注解只有一個(gè) Condition 類(lèi)型的參數(shù),Condition 是一個(gè)接口,該接口只有一個(gè)返回布爾值的 matches() 方法,該方法返回 true 則條件成立,配置類(lèi)生效。反之,則不生效。在該例子中我們直接返回 true。
- public class MyCondition implements Condition {
- @Override
- public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
- return true;
- }
- }
第3步:創(chuàng)建配置類(lèi),可以看到該配置的 @Conditional 傳了我們剛才創(chuàng)建的 Condition 實(shí)現(xiàn)類(lèi)進(jìn)去,用作條件判斷。
- @Configuration
- @Conditional(MyCondition.class)
- public class ConditionConfig {
- @Bean
- public ConditionBean conditionBean(){
- return new ConditionBean();
- }
- }
第4步:編寫(xiě)測(cè)試方法。
- public static void main(String[] args) {
- ApplicationContext context = new AnnotationConfigApplicationContext(ConditionConfig.class);
- ConditionBean conditionBean = context.getBean(ConditionBean.class);
- conditionBean.sayHi();
- }
第5步:結(jié)果分析
因?yàn)?Condition 的 matches 方法直接返回了 true,配置類(lèi)會(huì)生效,我們可以把 matches 改成返回 false,則配置類(lèi)就不會(huì)生效了。
除了自定義 Condition,Spring 還為我們擴(kuò)展了一些常用的 Condition。常用注解,可以參考:
SpringBoot 啟動(dòng)過(guò)程
在看源碼的過(guò)程中,我們會(huì)看到以下四個(gè)類(lèi)的方法經(jīng)常會(huì)被調(diào)用,我們需要對(duì)一下幾個(gè)類(lèi)有點(diǎn)印象:
- ApplicationContextInitializer
- ApplicationRunner
- CommandLineRunner
- SpringApplicationRunListener
下面開(kāi)始源碼分析,先從 SpringBoot 的啟動(dòng)類(lèi)的 run() 方法開(kāi)始看,以下是調(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 對(duì)象。
- 運(yùn)行 run() 方法。
創(chuàng)建 SpringApplication 對(duì)象
- 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");
- // 保存主配置類(lèi)(這里是一個(gè)數(shù)組,說(shuō)明可以有多個(gè)主配置類(lèi))
- this.primarySources = new LinkedHashSet(Arrays.asList(primarySources));
- // 判斷當(dāng)前是否是一個(gè) Web 應(yīng)用
- this.webApplicationType = WebApplicationType.deduceFromClasspath();
- // 從類(lèi)路徑下找到 META/INF/Spring.factories 配置的所有 ApplicationContextInitializer,然后保存起來(lái)
- this.setInitializers(this.getSpringFactoriesInstances(ApplicationContextInitializer.class));
- // 從類(lèi)路徑下找到 META/INF/Spring.factories 配置的所有 ApplicationListener,然后保存起來(lái)
- this.setListeners(this.getSpringFactoriesInstances(ApplicationListener.class));
- // 從多個(gè)配置類(lèi)中找到有 main 方法的主配置類(lèi)(只有一個(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();
- // 從類(lèi)路徑下找到 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é)開(kāi)頭提到過(guò)的4個(gè)監(jiān)聽(tīng)器中的方法與加載項(xiàng)目中組件到 IOC 容器中,而所有需要回調(diào)的監(jiān)聽(tīng)器都是從類(lèi)路徑下的 META-INF/Spring.factories中獲取,從而達(dá)到啟動(dòng)前后的各種定制操作。
SpringBoot 自動(dòng)配置原理
@SpringBootApplication 注解
SpringBoot 項(xiàng)目的一切都要從 @SpringBootApplication 這個(gè)注解開(kāi)始說(shuō)起。
@SpringBootApplication 標(biāo)注在某個(gè)類(lèi)上說(shuō)明:
- 這個(gè)類(lèi)是 SpringBoot 的主配置類(lèi)。
- SpringBoot 就應(yīng)該運(yùn)行這個(gè)類(lèi)的 main 方法來(lái)啟動(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)于組合注解文章的開(kāi)頭有講到),其主要組合了一下三個(gè)注解:
- @SpringBootConfiguration:該注解表示這是一個(gè) Spring Boot 的配置類(lèi),其實(shí)它就是一個(gè) @Configuration 注解而已。
- @ComponentScan:開(kāi)啟組件掃描。
- @EnableAutoConfiguration:從名字就可以看出來(lái),就是這個(gè)類(lèi)開(kāi)啟自動(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 的用法文章上面也有介紹哦。
我們?cè)?Registrar 類(lèi)中的 registerBeanDefinitions 方法上打上斷點(diǎn),可以看到返回了一個(gè)包名,該包名其實(shí)就是主配置類(lèi)所在的包。
一句話:@AutoConfigurationPackage 注解就是將主配置類(lèi)(@SpringBootConfiguration標(biāo)注的類(lèi))的所在包及下面所有子包里面的所有組件掃描到Spring容器中。所以說(shuō),默認(rèn)情況下主配置類(lèi)包及子包以外的組件,Spring 容器是掃描不到的。
@Import({AutoConfigurationImportSelector.class})
該注解給當(dāng)前配置類(lèi)導(dǎo)入另外的 N 個(gè)自動(dòng)配置類(lèi)。(該注解詳細(xì)用法上文有提及)。
配置類(lèi)導(dǎo)入規(guī)則
那具體的導(dǎo)入規(guī)則是什么呢?我們來(lái)看一下源碼。在開(kāi)始看源碼之前,先啰嗦兩句。就像小馬哥說(shuō)的,我們看源碼不用全部都看,不用每一行代碼都弄明白是什么意思,我們只要抓住關(guān)鍵的地方就可以了。
我們知道 AutoConfigurationImportSelector 的 selectImports就是用來(lái)返回需要導(dǎo)入的組件的全類(lèi)名數(shù)組的,那么如何得到這些數(shù)組呢?
在 selectImports 方法中調(diào)用了一個(gè) getAutoConfigurationEntry() 方法。
由于篇幅問(wèn)題我就不一一截圖了,我直接告訴你們調(diào)用鏈:在 `getAutoConfigurationEntry() -> getCandidateConfigurations() -> loadFactoryNames()``。
在這里 loadFactoryNames()方法傳入了 EnableAutoConfiguration.class 這個(gè)參數(shù)。先記住這個(gè)參數(shù),等下會(huì)用到。
loadFactoryNames() 中關(guān)鍵的三步:
- 從當(dāng)前項(xiàng)目的類(lèi)路徑中獲取所有 META-INF/spring.factories 這個(gè)文件下的信息。
- 將上面獲取到的信息封裝成一個(gè) Map 返回。
- 從返回的 Map 中通過(guò)剛才傳入的 EnableAutoConfiguration.class 參數(shù),獲取該 key 下的所有值。
META-INF/spring.factories 探究
聽(tīng)我這樣說(shuō)完可能會(huì)有點(diǎn)懵,我們來(lái)看一下 META-INF/spring.factories 這類(lèi)文件是什么就不懵了。當(dāng)然在很多第三方依賴(lài)中都會(huì)有這個(gè)文件,一般每導(dǎo)入一個(gè)第三方的依賴(lài),除了本身的jar包以外,還會(huì)有一個(gè) xxx-spring-boot-autoConfigure,這個(gè)就是第三方依賴(lài)自己編寫(xiě)的自動(dòng)配置類(lèi)。我們現(xiàn)在就以 spring-boot-autocongigure 這個(gè)依賴(lài)來(lái)說(shuō)。
可以看到 EnableAutoConfiguration 下面有很多類(lèi),這些就是我們項(xiàng)目進(jìn)行自動(dòng)配置的類(lèi)。
一句話:將類(lèi)路徑下META-INF/spring.factories 里面配置的所有 EnableAutoConfiguration 的值加入到 Spring 容器中。
HttpEncodingAutoConfiguration
通過(guò)上面方式,所有的自動(dòng)配置類(lèi)就被導(dǎo)進(jìn)主配置類(lèi)中了。但是這么多的配置類(lèi),明顯有很多自動(dòng)配置我們平常是沒(méi)有使用到的,沒(méi)理由全部都生效吧。
接下來(lái)我們以 HttpEncodingAutoConfiguration為例來(lái)看一個(gè)自動(dòng)配置類(lèi)是怎么工作的。為啥選這個(gè)類(lèi)呢?主要是這個(gè)類(lèi)比較的簡(jiǎn)單典型。
先看一下該類(lèi)標(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)記為配置類(lèi)。
- @ConditionalOnWebApplication:web應(yīng)用下才生效。
- @ConditionalOnClass:指定的類(lèi)(依賴(lài))存在才生效。
- @ConditionalOnProperty:主配置文件中存在指定的屬性才生效。
- @EnableConfigurationProperties({HttpProperties.class}):?jiǎn)?dòng)指定類(lèi)的ConfigurationProperties功能;將配置文件中對(duì)應(yīng)的值和 HttpProperties 綁定起來(lái);并把 HttpProperties 加入到 IOC 容器中。
因?yàn)锧EnableConfigurationProperties({HttpProperties.class})把配置文件中的配置項(xiàng)與當(dāng)前 HttpProperties 類(lèi)綁定上了。
然后在HttpEncodingAutoConfiguration 中又引用了 HttpProperties ,所以最后就能在 HttpEncodingAutoConfiguration中使用配置文件中的值了。
最終通過(guò) @Bean 和一些條件判斷往容器中添加組件,實(shí)現(xiàn)自動(dòng)配置。(當(dāng)然該Bean中屬性值是從 HttpProperties 中獲取)
HttpProperties
HttpProperties 通過(guò) @ConfigurationProperties 注解將配置文件與自身屬性綁定。
所有在配置文件中能配置的屬性都是在 xxxProperties 類(lèi)中封裝著;配置文件能配置什么就可以參照某個(gè)功能對(duì)應(yīng)的這個(gè)屬性類(lèi)。
- @ConfigurationProperties(
- prefix = "spring.http"
- )// 從配置文件中獲取指定的值和bean的屬性進(jìn)行綁定
- public class HttpProperties {
- }
總結(jié)
- SpringBoot啟動(dòng)會(huì)加載大量的自動(dòng)配置類(lèi)。
- 我們看需要的功能有沒(méi)有SpringBoot默認(rèn)寫(xiě)好的自動(dòng)配置類(lèi)。
- 我們?cè)賮?lái)看這個(gè)自動(dòng)配置類(lèi)中到底配置了那些組件(只要我們要用的組件有,我們就不需要再來(lái)配置了)。
- 給容器中自動(dòng)配置類(lèi)添加組件的時(shí)候,會(huì)從properties類(lèi)中獲取某些屬性。我們就可以在配置文件中指定這些屬性的值。xxxAutoConfiguration:自動(dòng)配置類(lèi)給容器中添加組件。xxxProperties:封裝配置文件中相關(guān)屬性。
用心看的小伙伴應(yīng)該發(fā)現(xiàn)了,其實(shí)很多需要待加載的類(lèi)都放在類(lèi)路徑下的META-INF/Spring.factories文件下,而不是直接寫(xiě)死這代碼中,這樣做就可以很方便我們自己或第三方去z做擴(kuò)展。
參考:
kil51.cn/JTg9D
blog.51cto.com/4247649/2118354
www.cnblogs.com/duanxz/p/3787757.html
www.jianshu.com/p/e22b9fef311c
blog.csdn.net/qq_26525215/article/details/53523970
http://www.woaijava.cc
本文轉(zhuǎn)載自微信公眾號(hào)「Java后端技術(shù)全?!?,可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系Java后端技術(shù)全棧公眾號(hào)。




































