小伙伴們是否想起曾經(jīng)被 SSM 整合支配的恐懼?相信很多小伙伴都是有過這樣的經(jīng)歷的,一大堆配置問題,各種排除掃描,導(dǎo)入一個(gè)新的依賴又得添加新的配置。自從有了 SpringBoot 之后,咋們就起飛了!各種零配置開箱即用,而我們之所以開發(fā)起來能夠這么爽,自動(dòng)配置的功勞少不了,今天我們就一起來討論一下 SpringBoot 自動(dòng)配置原理。
本文主要分為三大部分:
SpringBoot 源碼常用注解拾遺
SpringBoot 啟動(dòng)過程
SpringBoot 自動(dòng)配置原理
1. SpringBoot 源碼常用注解拾遺
這部分主要講一下 SpringBoot 源碼中經(jīng)常使用到的注解,以掃清后面閱讀源碼時(shí)候的障礙。
組合注解
當(dāng)可能大量同時(shí)使用到幾個(gè)注解到同一個(gè)類上,就可以考慮將這幾個(gè)注解到別的注解上。被注解的注解我們就稱之為組合注解。
元注解:可以注解到別的注解上的注解。
組合注解:被注解的注解我們就稱之為組合注解。
@Value 【Spring 提供】
@Value 就相當(dāng)于傳統(tǒng) xml 配置文件中的 value 字段。
假設(shè)存在代碼:
上面代碼等價(jià)于的配置文件:
我們知道配置文件中的 value 的取值可以是:
字面量
通過 ${key} 方式從環(huán)境變量中獲取值
通過 ${key} 方式全局配置文件中獲取值
#{SpEL}
所以,我們就可以通過 @Value(${key}) 的方式獲取全局配置文件中的指定配置項(xiàng)。
@ConfigurationProperties 【SpringBoot 提供】
如果我們需要取 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è)類去訪問全局配置文件中的屬性值了。
下面看一個(gè)實(shí)例:
1.在主配置文件中添加如下配置
2.創(chuàng)建配置類,由于篇幅問題這里省略了 setter、getter 方法,但是實(shí)際開發(fā)中這個(gè)是必須的,否則無法成功注入。另外,@Component 這個(gè)注解也還是需要添加的。
這里 @ConfigurationProperties 有一個(gè) prefix 參數(shù),主要是用來指定該配置項(xiàng)在配置文件中的前綴。
3.測(cè)試,在 SpringBoot 環(huán)境中,編寫個(gè)測(cè)試方法,注入 Person 類,即可通過 Person 對(duì)象取到配置文件的值。
@Import 【Spring 提供】
@Import 注解支持導(dǎo)入普通 java 類,并將其聲明成一個(gè)bean。主要用于將多個(gè)分散的 java config 配置類融合成一個(gè)更大的 config 類。
@Import 注解在 4.2 之前只支持導(dǎo)入配置類。
在4.2之后 @Import 注解支持導(dǎo)入普通的 java 類,并將其聲明成一個(gè) bean。
@Import 三種使用方式
直接導(dǎo)入普通的 Java 類。
配合自定義的 ImportSelector 使用。
配合 ImportBeanDefinitionRegistrar 使用。
1. 直接導(dǎo)入普通的 Java 類
1.創(chuàng)建一個(gè)普通的 Java 類。
2.創(chuàng)建一個(gè)配置類,里面沒有顯式聲明任何的 Bean,然后將剛才創(chuàng)建的 Circle 導(dǎo)入。
3.創(chuàng)建測(cè)試類。
4.運(yùn)行結(jié)果:
Circle sayHi()
可以看到我們順利的從 IOC 容器中獲取到了 Circle 對(duì)象,證明我們?cè)谂渲妙愔袑?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。
2.創(chuàng)建 ImportSelector 實(shí)現(xiàn)類,selectImports 返回 Triangle 的全類名。
3.創(chuàng)建配置類,在原來的基礎(chǔ)上還導(dǎo)入了 MyImportSelector。
4.創(chuàng)建測(cè)試類
5.運(yùn)行結(jié)果:
Circle sayHi()
Triangle sayHi()
可以看到 Triangle 對(duì)象也被 IOC 容器成功的實(shí)例化出來了。
3. 配合 ImportBeanDefinitionRegistrar 使用
ImportBeanDefinitionRegistrar 也是一個(gè)接口,它可以手動(dòng)注冊(cè)bean到容器中,從而我們可以對(duì)類進(jìn)行個(gè)性化的定制。(需要搭配 @Import 與 @Configuration 一起使用。)
1.創(chuàng)建普通 Java 類 Rectangle。
2.創(chuàng)建 ImportBeanDefinitionRegistrar 實(shí)現(xiàn)類,實(shí)現(xiàn)方法直接手動(dòng)注冊(cè)一個(gè)名叫 rectangle 的 Bean 到 IOC 容器中。
3.創(chuàng)建配置類,導(dǎo)入 MyImportBeanDefinitionRegistrar 類。
4.創(chuàng)建測(cè)試類。
5.運(yùn)行結(jié)果
Circle sayHi()
Triangle sayHi()
Rectangle sayHi()
嗯對(duì),Rectangle 對(duì)象也被注冊(cè)進(jìn)來了。
@Conditional 【Spring提供】
@Conditional 注釋可以實(shí)現(xiàn)只有在特定條件滿足時(shí)才啟用一些配置。
下面看一個(gè)簡(jiǎn)單的例子:
1.創(chuàng)建普通 Java 類 ConditionBean,該類主要用來驗(yàn)證 Bean 是否成功加載。
2.創(chuàng)建 Condition 實(shí)現(xiàn)類,@Conditional 注解只有一個(gè) Condition 類型的參數(shù),Condition 是一個(gè)接口,該接口只有一個(gè)返回布爾值的 matches() 方法,該方法返回 true 則條件成立,配置類生效。反之,則不生效。在該例子中我們直接返回 true。
3.創(chuàng)建配置類,可以看到該配置的 @Conditional 傳了我們剛才創(chuàng)建的 Condition 實(shí)現(xiàn)類進(jìn)去,用作條件判斷。
4.編寫測(cè)試方法。
5.結(jié)果分析
因?yàn)?Condition 的 matches 方法直接返回了 true,配置類會(huì)生效,我們可以把 matches 改成返回 false,則配置類就不會(huì)生效了。
除了自定義 Condition,Spring 還為我們擴(kuò)展了一些常用的 Condition。常用注解
2. SpringBoot 啟動(dòng)過程
在看源碼的過程中,我們會(huì)看到以下四個(gè)類的方法經(jīng)常會(huì)被調(diào)用,我們需要對(duì)一下幾個(gè)類有點(diǎn)印象:
ApplicationContextInitializer
ApplicationRunner
CommandLineRunner
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 對(duì)象。
運(yùn)行 run() 方法。
創(chuàng)建 SpringApplication 對(duì)象
運(yùn)行 run() 方法
小結(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)用。
該注解的定義如下:
可以看到 SpringBootApplication 注解是一個(gè)組合注解(關(guān)于組合注解文章的開頭有講到),其主要組合了一下三個(gè)注解:
@SpringBootConfiguration:該注解表示這是一個(gè) SpringBoot 的配置類,其實(shí)它就是一個(gè) @Configuration 注解而已。
@ComponentScan:開啟組件掃描。
@EnableAutoConfiguration:從名字就可以看出來,就是這個(gè)類開啟自動(dòng)配置的。嗯,自動(dòng)配置的奧秘全都在這個(gè)注解里面。
@EnableAutoConfiguration 注解
先看該注解是怎么定義的:
@AutoConfigurationPackage
從字面意思理解就是自動(dòng)配置包。點(diǎn)進(jìn)去可以看到就是一個(gè) @Import 注解:@Import({Registrar.class}),導(dǎo)入了一個(gè) Registrar 的組件。關(guān)于 @Import 的用法文章上面也有介紹哦。
我們?cè)?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ī)則
那具體的導(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è)類比較的簡(jiǎn)單典型。
先看一下該類標(biāo)有的注解:
@Configuration:標(biāo)記為配置類。
@ConditionalOnWebApplication:web應(yīng)用下才生效。
@ConditionalOnClass:指定的類(依賴)存在才生效。
@ConditionalOnProperty:主配置文件中存在指定的屬性才生效。
@EnableConfigurationProperties({HttpProperties.class}):?jiǎn)?dòng)指定類的ConfigurationProperties功能;將配置文件中對(duì)應(yīng)的值和 HttpProperties 綁定起來;并把 HttpProperties 加入到 IOC 容器中。
因?yàn)?@EnableConfigurationProperties({HttpProperties.class})把配置文件中的配置項(xiàng)與當(dāng)前 HttpProperties 類綁定上了。
然后在 HttpEncodingAutoConfiguration 中又引用了 HttpProperties ,所以最后就能在 HttpEncodingAutoConfiguration 中使用配置文件中的值了。
最終通過 @Bean 和一些條件判斷往容器中添加組件,實(shí)現(xiàn)自動(dòng)配置。(當(dāng)然該Bean中屬性值是從 HttpProperties 中獲取)
HttpProperties
HttpProperties 通過 @ConfigurationProperties 注解將配置文件與自身屬性綁定。
所有在配置文件中能配置的屬性都是在 xxxProperties 類中封裝著;配置文件能配置什么就可以參照某個(gè)功能對(duì)應(yīng)的這個(gè)屬性類。
小結(jié):
SpringBoot啟動(dòng)會(huì)加載大量的自動(dòng)配置類。
我們看需要的功能有沒有SpringBoot默認(rèn)寫好的自動(dòng)配置類。
我們?cè)賮砜催@個(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)零配置,開箱即用了吧!
歡迎工作一到五年的Java工程師朋友們加入我的個(gè)人粉絲群(Java填坑之路:×××)群內(nèi)提供免費(fèi)的Java架構(gòu)學(xué)習(xí)資料(里面有高可用、高并發(fā)、高性能及分布式、Jvm性能調(diào)優(yōu)、Spring源碼,MyBatis,Netty,Redis,Kafka,Mysql,Zookeeper,Tomcat,Docker,Dubbo,Nginx等多個(gè)知識(shí)點(diǎn)的架構(gòu)資料)
合理利用自己每一分每一秒的時(shí)間來學(xué)習(xí)提升自己,不要再用"沒有時(shí)間“來掩飾自己思想上的懶惰!趁年輕,使勁拼,給未來的自己一個(gè)交代!
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn,海內(nèi)外云服務(wù)器15元起步,三天無理由+7*72小時(shí)售后在線,公司持有idc許可證,提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國(guó)服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案,具有“安全穩(wěn)定、簡(jiǎn)單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢(shì),專為企業(yè)上云打造定制,能夠滿足用戶豐富、多元化的應(yīng)用場(chǎng)景需求。
網(wǎng)站名稱:這樣講SpringBoot自動(dòng)配置原理,你應(yīng)該能明白了吧-創(chuàng)新互聯(lián)
分享URL:http://www.rwnh.cn/article26/jdscg.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供網(wǎng)站內(nèi)鏈、網(wǎng)頁(yè)設(shè)計(jì)公司、網(wǎng)站營(yíng)銷、ChatGPT、網(wǎng)站排名、外貿(mào)建站
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來源: 創(chuàng)新互聯(lián)
猜你還喜歡下面的內(nèi)容