理解Spring Boot中的auto-configuration

翻譯一下Spring官網(wǎng)的文章敬鬓,加深自己對Spring Boot自動裝配的一些理解匹颤。

不管你是開發(fā)開源軟件或者商業(yè)軟件关摇,當(dāng)你在開發(fā)一個共享庫的時候杖小,那么可能你需要使用自動配置肆汹,自動配置可以捆綁在外部的jar包中,由Spring Boot提取予权。
快速學(xué)習(xí)的mode代碼:示例項(xiàng)目

下面將介紹自動配置的一些知識:

1.了解自動配置的bean

查看(脫掉)Spring的代碼(衣服),auto-configuration 就是一個實(shí)現(xiàn)了Configuration接口的類昂勉。使用@Conditional注解來限制何時讓auto-configuration 生效,通常auto-configuration 使用ConditionalOnClassConditionalOnMissingBean注解扫腺,這兩注解的確保只有當(dāng)我們擁有相關(guān)類的時候使得@Configuration注解生效岗照。

2.auto-configuration的目錄結(jié)構(gòu)

Spring Boot 會檢查所有jar包下的META-INF/spring.factories文件,這個文件中EnableAutoConfiguration 的KEY下面羅列了需要自動配置的類笆环,例如:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.mycorp.libx.autoconfigure.LibXAutoConfiguration,\
com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration

當(dāng)我們需要對配置類的加載順序排序的時候攒至,可以使用
@AutoConfigureAfter或者@AutoCOnfigureBefore注解。
例如躁劣,如果我們提供了一個特殊的web configuration,需要在WebMvcAutoConfiguration之后才對我們注解的類進(jìn)行加載迫吐。
如果想要自動排序,可以使用@AutoconfigureOrder注解账忘,這個注解類似于@Order志膀,但是它是專門給auto-configuration使用熙宇。

Auto-configuration 只有通過這種方式加載,確保 他們定義在一個特定的包空間下能夠被掃描溉浙。

3.Condition注解

我們在auto-configuration中看到不止一個使用了@Condition注解的類烫止,比如 @ConditionalOnMissingBean,那么下面就介紹一下auto-configuration中常用的注解

Class Conditions

@ConditionalOnClass@ConditionalOnMissingClass 注解允許擁有或缺失指定的類進(jìn)行配置戳稽,另外使用了ASM技術(shù) 來解析注解馆蠕,我們可以使用value屬性來引用出真實(shí)的類,即使這個類不會出現(xiàn)在正在運(yùn)行的程序類路徑中惊奇,如果希望指定類名互躬,可以使用name屬性

bean Conditions

ConditionalOnBeanConditionalOnMissingBean注解允許用于或確實(shí)指定的bean來進(jìn)行配置,我們可以使用value屬性配置一個特別的類型赊时《种或者用name配置特殊的名字,search屬性允許限制搜索ApplicationContext中的層次結(jié)構(gòu)祖秒。

@Configuration
 public  class MyAutoConfiguration { @Bean @ConditionalOnMissingBean public MyService myService(){...}
}

在這個方法中,myService如果還沒有存在Spring容器中舟奠,那么它將會在這個方法中得到創(chuàng)建竭缝。

這里特別需要注意bean的啟動順序,因?yàn)樵谧鲆粋€共享庫的時候影響十分深遠(yuǎn)沼瘫,所以抬纸,我們應(yīng)當(dāng)盡量使用@ConditionalOnBean@ConditionalOnMissingBena注解在auto-configuration的過程中。保證用戶在添加了自已定義的bean后能夠正常的加載系統(tǒng)耿戚。

@ConditionalOnBean@ConditionalOnMissingBean不會阻止被@Configuration注解的類加載湿故,所以這些條件應(yīng)當(dāng)去標(biāo)記具體包含的每個方法

Property Condition

@ConditionalOnProperty注解允許基于Spring的環(huán)境屬性進(jìn)行配置,使用prefixname參數(shù)來檢查指定的屬性值膜蛔,任何存在且不等于屬性false都將被匹配坛猪,更高級的檢查可以使用havingValuematchIfMissing屬性。

Resource Condition

@ConditionalOnResource注解去判斷指定的資源是否存在皂股,可以使用常規(guī)的Spring約束來指定資源墅茉,例如file://home/usr/test.dat

Web Application Condition

@ConditionalOnWebApplication@ConditionalOnNotWebApplication注解允許根據(jù)應(yīng)用是否是一個“web應(yīng)用程序”被包括配置呜呐。

SPEL表達(dá)式

@ConditionalOnExpression注釋允許基于一個的結(jié)果被包括配置使用SpEL表達(dá)就斤。

創(chuàng)建自定義的starter

一個完整的Spring Boot starter應(yīng)該包含下面這些組件:

  • autoconfigure 模塊包含了自動配置的代碼
  • starter模塊提供了一個autoconfigure的模塊和其他額外的依賴。

命名的問題

需要確保為我們的starter提供了一個合適名字蘑辑,不要讓模塊名字叫spring-boot等一系列不知所云的名稱洋机,即使你用的不同的Maven GroupId,我們應(yīng)當(dāng)讓模塊名稱更規(guī)范洋魂,容易理解绷旗。

例如我們正在創(chuàng)建一個acme的start模塊喜鼓,命名推薦叫做acme-spring-boot-autoconfigureacme-spring-boot-starter

final

starter其實(shí)是一個空的模塊刁标,它的唯一目的其實(shí)就是提供一個必要的依賴關(guān)系颠通,

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市膀懈,隨后出現(xiàn)的幾起案子顿锰,更是在濱河造成了極大的恐慌,老刑警劉巖启搂,帶你破解...
    沈念sama閱讀 222,590評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件硼控,死亡現(xiàn)場離奇詭異,居然都是意外死亡胳赌,警方通過查閱死者的電腦和手機(jī)牢撼,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,157評論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來疑苫,“玉大人熏版,你說我怎么就攤上這事『床簦” “怎么了撼短?”我有些...
    開封第一講書人閱讀 169,301評論 0 362
  • 文/不壞的土叔 我叫張陵,是天一觀的道長挺勿。 經(jīng)常有香客問我曲横,道長,這世上最難降的妖魔是什么不瓶? 我笑而不...
    開封第一講書人閱讀 60,078評論 1 300
  • 正文 為了忘掉前任禾嫉,我火速辦了婚禮,結(jié)果婚禮上蚊丐,老公的妹妹穿的比我還像新娘熙参。我一直安慰自己,他們只是感情好吠撮,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,082評論 6 398
  • 文/花漫 我一把揭開白布尊惰。 她就那樣靜靜地躺著,像睡著了一般泥兰。 火紅的嫁衣襯著肌膚如雪弄屡。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,682評論 1 312
  • 那天鞋诗,我揣著相機(jī)與錄音膀捷,去河邊找鬼。 笑死削彬,一個胖子當(dāng)著我的面吹牛全庸,可吹牛的內(nèi)容都是我干的秀仲。 我是一名探鬼主播,決...
    沈念sama閱讀 41,155評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼壶笼,長吁一口氣:“原來是場噩夢啊……” “哼神僵!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起覆劈,我...
    開封第一講書人閱讀 40,098評論 0 277
  • 序言:老撾萬榮一對情侶失蹤保礼,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后责语,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體炮障,經(jīng)...
    沈念sama閱讀 46,638評論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,701評論 3 342
  • 正文 我和宋清朗相戀三年坤候,在試婚紗的時候發(fā)現(xiàn)自己被綠了胁赢。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,852評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡白筹,死狀恐怖智末,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情徒河,我是刑警寧澤吹害,帶...
    沈念sama閱讀 36,520評論 5 351
  • 正文 年R本政府宣布,位于F島的核電站虚青,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏螺男。R本人自食惡果不足惜棒厘,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,181評論 3 335
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望下隧。 院中可真熱鬧奢人,春花似錦、人聲如沸淆院。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,674評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽土辩。三九已至支救,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間拷淘,已是汗流浹背各墨。 一陣腳步聲響...
    開封第一講書人閱讀 33,788評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留启涯,地道東北人贬堵。 一個月前我還...
    沈念sama閱讀 49,279評論 3 379
  • 正文 我出身青樓恃轩,卻偏偏與公主長得像,于是被迫代替她去往敵國和親黎做。 傳聞我的和親對象是個殘疾皇子叉跛,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,851評論 2 361

推薦閱讀更多精彩內(nèi)容