SpringBoot(二):SpringBoot自動(dòng)配置原理

springboot 自動(dòng)配置 主要通過@EnableAutoConfiguration,@Conditional,@EnableConfigurationProperties或者@ConfigurationProperties幾個(gè)注解來進(jìn)行自動(dòng)配置。
@EnableAutoConfiguration開啟自動(dòng)配置,主要作用就是調(diào)用core包里的loadFactoryNames()戚揭,將autoconfig包里的已經(jīng)寫好的自動(dòng)配置加載進(jìn)來。
@Conditional條件注解携取,通過判斷類路徑下有沒有相應(yīng)配置的jar包來確定是否加載和自動(dòng)配置這個(gè)類,
@EnableConfigurationProperties的作用就是,給自動(dòng)配置提供具體的配置參數(shù),只需要寫在application.properties中伟墙,就可以通過映射寫入配置類的Pojo屬性中。

一.@EnableAutoConfiguration

@Enable*注釋并不是SpringBoot新發(fā)明的注釋滴铅,Spring 3框架就引入了這些注釋,用這些注釋替代XML配置文件就乓。比如:
@EnableTransactionManagement注釋汉匙,它能夠聲明事務(wù)管理
@EnableWebMvc注釋,它能啟用Spring MVC
@EnableScheduling注釋生蚁,它可以初始化一個(gè)調(diào)度器噩翠。

這些注釋事實(shí)上都是簡單的配置,通過@Import注釋導(dǎo)入邦投。

從啟動(dòng)類的@SpringBootApplication進(jìn)入伤锚,在里面找到了@EnableAutoConfiguration,
1.png
2.png
@EnableAutoConfiguration里通過@Import導(dǎo)入了EnableAutoConfigurationImportSelector,
3.png
進(jìn)入他的父類AutoConfigurationImportSelector
4.png
找到selectImports()方法,他調(diào)用了getCandidateConfigurations()方法志衣,在這里屯援,這個(gè)方法又調(diào)用了Spring Core包中的loadFactoryNames()方法。這個(gè)方法的作用是念脯,會(huì)查詢META-INF/spring.factories文件中包含的JAR文件狞洋。
5.png
當(dāng)找到spring.factories文件后,SpringFactoriesLoader將查詢配置文件命名的屬性绿店。
6.png
7.png
Jar文件在org.springframework.boot.autoconfigure的spring.factories
8.png
spring.factories內(nèi)容如下(截取部分),在這個(gè)文件中吉懊,可以看到一系列Spring Boot自動(dòng)配置的列表

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\
org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.neo4j.Neo4jDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.neo4j.Neo4jRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.solr.SolrRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,\


下面我們來看自動(dòng)配置redis的細(xì)節(jié),RedisAutoConfiguration:

RedisAutoConfiguration

redis.png

這個(gè)類進(jìn)行了簡單的Spring配置假勿,聲明了Redis所需典型Bean借嗽,和其它很多類一樣,重度依賴于Spring Boot注釋:
1)@ConditionOnClass激活一個(gè)配置转培,當(dāng)類路徑中存在這個(gè)類時(shí)才會(huì)配置該類
2)@EnableConfigurationProperties自動(dòng)映射一個(gè)POJO到Spring Boot配置文件(默認(rèn)是application.properties文件)的屬性集恶导。
3)@ConditionalOnMissingBean啟用一個(gè)Bean定義,但必須是這個(gè)Bean之前未定義過才有效堡距。
還可以使用@ AutoConfigureBefore注釋甲锡、@AutoConfigureAfter注釋來定義這些配置類的載入順序兆蕉。

著重了解@Conditional注釋,Spring 4框架的新特性

此注釋使得只有在特定條件滿足時(shí)才啟用一些配置缤沦。SrpingBoot的AutoConfig大量使用了@Conditional虎韵,它會(huì)根據(jù)運(yùn)行環(huán)境來動(dòng)態(tài)注入Bean。這里介紹一些@Conditional的使用和原理缸废,并自定義@Conditional來自定義功能包蓝。

  • @Conditional是SpringFramework的功能,SpringBoot在它的基礎(chǔ)上定義了
  • @ConditionalOnClass企量,@ConditionalOnProperty等一系列的注解來實(shí)現(xiàn)更豐富的內(nèi)容测萎。

具體幾個(gè)@Conditon*注解的含義

@ConditionalOnBean

僅僅在當(dāng)前上下文中存在某個(gè)對象時(shí),才會(huì)實(shí)例化一個(gè)Bean

@ConditionalOnClass

某個(gè)class位于類路徑上届巩,才會(huì)實(shí)例化一個(gè)Bean)硅瞧,該注解的參數(shù)對應(yīng)的類必須存在,否則不解析該注解修飾的配置類

@ConditionalOnExpression

當(dāng)表達(dá)式為true的時(shí)候恕汇,才會(huì)實(shí)例化一個(gè)Bean

@ConditionalOnMissingBean

僅僅在當(dāng)前上下文中不存在某個(gè)對象時(shí)腕唧,才會(huì)實(shí)例化一個(gè)Bean,該注解表示瘾英,如果存在它修飾的類的bean枣接,則不需要再創(chuàng)建這個(gè)bean,可以給該注解傳入?yún)?shù)例如@ConditionOnMissingBean(name = "example")缺谴,這個(gè)表示如果name為“example”的bean存在但惶,這該注解修飾的代碼塊不執(zhí)行

@ConditionalOnMissingClass

某個(gè)class類路徑上不存在的時(shí)候,才會(huì)實(shí)例化一個(gè)Bean

@ConditionalOnNotWebApplication

不是web應(yīng)用時(shí)湿蛔,才會(huì)執(zhí)行


2.Properties系列注釋

@EnableConfigurationProperties
@ConfigurationProperties(prefix = "may")

在需要注入配置的類上加上這個(gè)注解膀曾,prefix的意思是,以該前綴打頭的配置阳啥,以下是例子

@ConfigurationProperties(prefix = "may")  
public class User {  
    private String name;  
    private String gender;  
    
   //省略setter,getter方法
  
}  

application.yml中的配置

may
name: youjie
gender: man

如果不用系統(tǒng)初始的application.yml配置類妓肢,而是使用自己的如youjie.yml,可以如下配置

@ConfigurationProperties(prefix = "may",locations = "classpath:youjie.yml")
public class User2 {
private String name;
private String gender;

   //省略setter,getter方法
  
}  

過時(shí):由于Spring-boot 1.5.2版本移除了苫纤,locations這個(gè)屬性,因此上述這種方式在最新的版本中過時(shí)碉钠。
@PropertySource

Spring-boot 1.5.2版本之后,采用下面這種方式

@Component
//@PropertySource只能加載.properties文件卷拘,需要將上面的yml文件喊废,改為.properties文件
@PropertySource("classpath:may.properties")
@ConfigurationProperties(prefix="may")
public class User2 {
private String name;
private String gender;

   //省略setter,getter方法
  
}  

@EnableConfigurationProperties

最后注意在spring Boot入口類加上@EnableConfigurationProperties

@SpringBootApplication  
@EnableConfigurationProperties({User.class,User2.class})  
public class DemoApplication {  
  
    public static void main(String[] args) {  
        SpringApplication.run(DemoApplication.class, args);  
    }  
}  

其實(shí)這里@EnableConfigurationProperties({User.class,User2.class}) 可以省略

config.png
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市栗弟,隨后出現(xiàn)的幾起案子污筷,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件瓣蛀,死亡現(xiàn)場離奇詭異陆蟆,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)惋增,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進(jìn)店門叠殷,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人诈皿,你說我怎么就攤上這事林束。” “怎么了稽亏?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵壶冒,是天一觀的道長。 經(jīng)常有香客問我截歉,道長胖腾,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任瘪松,我火速辦了婚禮胸嘁,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘凉逛。我一直安慰自己,他們只是感情好群井,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布状飞。 她就那樣靜靜地躺著,像睡著了一般书斜。 火紅的嫁衣襯著肌膚如雪诬辈。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天荐吉,我揣著相機(jī)與錄音焙糟,去河邊找鬼。 笑死样屠,一個(gè)胖子當(dāng)著我的面吹牛穿撮,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播痪欲,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼悦穿,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了业踢?” 一聲冷哼從身側(cè)響起栗柒,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎知举,沒想到半個(gè)月后瞬沦,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體太伊,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年逛钻,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了僚焦。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,040評論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡绣的,死狀恐怖叠赐,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情屡江,我是刑警寧澤芭概,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站惩嘉,受9級特大地震影響罢洲,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜文黎,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一惹苗、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧耸峭,春花似錦桩蓉、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至本涕,卻和暖如春业汰,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背菩颖。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工样漆, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人晦闰。 一個(gè)月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓放祟,卻偏偏與公主長得像,于是被迫代替她去往敵國和親呻右。 傳聞我的和親對象是個(gè)殘疾皇子舞竿,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,979評論 2 355

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