SpringBoot自動裝配原理

傳統(tǒng)的Spring項目會有很多的配置文件主籍,比如我們要使用Redis,一般除了對應的依賴的jar包我們還需要在application.xml里面配置JedisConnectionFactory眷蜈、JedisPoolConfig、RedisTemplate阿迈。但是如果使用SpringBoot的話,系統(tǒng)會根據(jù)pom.xml里面的jar包稚伍,自動生成這些類并且注入到IOC容器當中弯予。

  1. 傳統(tǒng)Spring項目中需要配置
<bean id="jedisConnectionFactory" class="...JedisConnectionFactory"></bean>
<bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig"></bean>
<bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate"></bean>
  1. 而使用SpringBoot的話,除了pom.xml引入相應的jar包外个曙,只需要在application.properties配置對應的屬性值即可

以Redis舉例

  1. 從spring-boot-autoconfigure.jar/META-INF/spring.factories中獲取120多個默認功能配置類锈嫩,其中包括redis的功能配置類RedisAutoConfiguration的全限定名,一般一個功能配置類圍繞該功能垦搬,負責管理創(chuàng)建多個相關的功能類呼寸,比如RedisAutoConfiguration負責:JedisConnectionFactory、RedisTemplate悼沿、StringRedisTemplate這3個功能類的創(chuàng)建
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
  1. RedisAutoConfiguration配置類生效的一個條件是@ConditionalOnClass :JedisConnection.class, RedisOperations.class, Jedis.class,所以會去classpath下去查找對應的class文件
@Configuration
@ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class })
@EnableConfigurationProperties(RedisProperties.class)
public class RedisAutoConfiguration {}
  1. 如果pom.xml有對應的jar包,就能匹配到對應依賴class:JedisConnection.class, RedisOperations.class, Jedis.class
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
  1. 匹配成功,這個功能配置類才會生效骚灸,同時會注入默認的屬性配置類@EnableConfigurationProperties(RedisProperties.class)
@ConfigurationProperties(prefix = "spring.redis")
public class RedisProperties {
    private int database = 0;
    private String url;
    private String host = "localhost";
    private String password;
    private int port = 6379;
  1. Redis功能配置里面會根據(jù)條件生成最終的JedisConnectionFactory糟趾、RedisTemplate,條件就是IOC環(huán)境里面,沒有用戶自定義的@ConditionalOnMissingBean(RedisConnectionFactory.class)甚牲、RedisTemplate
@Configuration
@ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class })
@EnableConfigurationProperties(RedisProperties.class)
public class RedisAutoConfiguration {
        @Bean
        @ConditionalOnMissingBean(RedisConnectionFactory.class)
        public JedisConnectionFactory redisConnectionFactory()
                throws UnknownHostException {
            return applyProperties(createJedisConnectionFactory());
        }

        @Bean
        @ConditionalOnMissingBean(name = "redisTemplate")
        public RedisTemplate<Object, Object> redisTemplate(
                RedisConnectionFactory redisConnectionFactory)
                        throws UnknownHostException {
            RedisTemplate<Object, Object> template = new RedisTemplate<Object, Object>();
            template.setConnectionFactory(redisConnectionFactory);
            return template;
        }
}
  1. 最終創(chuàng)建好的默認裝配類义郑,會通過功能配置類里面的 @Bean注解,注入到IOC當中

原理和結果分析

通過各種注解丈钙,SpringApplication.run(Application.class, args)在運行時非驮,會讀取spring-boot-autoconfigure.jar里面的spring.factories配置文件,配置文件中有所有自動裝配類的配置類的className雏赦,然后生成對應功能的Configuration類劫笙,這些功能配置類要生效的話,會去classpath中找是否有該類的依賴類(也就是pom.xml必須有對應功能的jar包才行)星岗,然后配置類里再通過判斷生成最后的功能類填大,并且配置類里面注入了默認屬性值類,功能類可以引用并賦默認值俏橘。生成功能類的原則是自定義優(yōu)先允华,沒有自定義時才會使用自動裝配類。

綜上所述寥掐,要想自動裝配一個類需要滿足2個條件:

  1. spring.factories里面有這個類的配置類(一個配置類可以創(chuàng)建多個圍繞該功能的依賴類)
  2. pom.xml里面需要有對應的jar包

整個過程的結果是兩件事情:

  1. 根據(jù)各種判斷和依賴靴寂,最終生成了業(yè)務需要的類并且注入到IOC容器當中了
  2. 自動裝配生成的類賦予了一些默認的屬性值

依賴的注解

  • @SpringBootApplication:sb項目應用啟動類的注解,其實是3個注解的組合:@SpringBootConfiguration召耘、@EnableAutoConfiguration百炬、@ComponentScan,其中在自動裝配中起作用的是第二個

  • @EnableAutoConfiguration:表示SB應用啟動自動裝配的功能(包括加載對應的Bean到IOC容器中污它,且根據(jù)默認配置對屬性賦值)

  • @Import(EnableAutoConfigurationImportSelector.class):這個注解比較厲害收壕,可以把沒有注冊到IOC中的Bean強行注冊到IOC中,表示啟動自動配置功能需要引入EnableAutoConfigurationImportSelector.class才行

  • @Configuration

  • @ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class }):表示讓RedisAutoConfiguration配置類起作用的話妓灌,必須有包含這些類的jar包才行

  • @EnableConfigurationProperties(RedisProperties.class):表示默認引用RedisProperties.class里面的配置

  • @ConditionalOnMissingBean(RedisConnectionFactory.class):這是個很厲害的注解,實現(xiàn)自動裝配時自定義優(yōu)先蜜宪。表示如果用戶沒有自定義注入RedisConnectionFactory.class類虫埂,才會使用默認的JedisConnectionFactory。

自動裝配的過程

  1. 通過各種注解實現(xiàn)了類與類之間的依賴關系圃验,容器在啟動的時候Application.run掉伏,會調用EnableAutoConfigurationImportSelector.class的selectImports方法(其實是其父類的方法)

  2. selectImports方法最終會調用SpringFactoriesLoader.loadFactoryNames方法來獲取一個全面的常用BeanConfiguration列表

  3. loadFactoryNames方法會讀取FACTORIES_RESOURCE_LOCATION(也就是spring-boot-autoconfigure.jar 下面的spring.factories),獲取到所有的Spring相關的Bean的全限定名ClassName澳窑,大概120多個

  4. selectImports方法繼續(xù)調用filter(configurations, autoConfigurationMetadata);這個時候會根據(jù)這些BeanConfiguration里面的條件斧散,來一一篩選,最關鍵的是
    @ConditionalOnClass摊聋,這個條件注解會去classpath下查找鸡捐,jar包里面是否有這個條件依賴類,所以必須有了相應的jar包麻裁,才有這些依賴類箍镜,才會生成IOC環(huán)境需要的一些默認配置Bean

  5. 最后把符合條件的BeanConfiguration注入默認的EnableConfigurationPropertie類里面的屬性值,并且注入到IOC環(huán)境當中

參考資料

主要是取自這個大佬的內容煎源,不過這篇博客內容量太大色迂,功力太深
http://www.reibang.com/p/83693d3d0a65

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市手销,隨后出現(xiàn)的幾起案子歇僧,更是在濱河造成了極大的恐慌,老刑警劉巖锋拖,帶你破解...
    沈念sama閱讀 221,406評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件诈悍,死亡現(xiàn)場離奇詭異,居然都是意外死亡兽埃,警方通過查閱死者的電腦和手機写隶,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,395評論 3 398
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來讲仰,“玉大人慕趴,你說我怎么就攤上這事”啥福” “怎么了冕房?”我有些...
    開封第一講書人閱讀 167,815評論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長趁矾。 經(jīng)常有香客問我耙册,道長,這世上最難降的妖魔是什么毫捣? 我笑而不...
    開封第一講書人閱讀 59,537評論 1 296
  • 正文 為了忘掉前任详拙,我火速辦了婚禮帝际,結果婚禮上,老公的妹妹穿的比我還像新娘饶辙。我一直安慰自己蹲诀,他們只是感情好,可當我...
    茶點故事閱讀 68,536評論 6 397
  • 文/花漫 我一把揭開白布弃揽。 她就那樣靜靜地躺著脯爪,像睡著了一般。 火紅的嫁衣襯著肌膚如雪矿微。 梳的紋絲不亂的頭發(fā)上痕慢,一...
    開封第一講書人閱讀 52,184評論 1 308
  • 那天,我揣著相機與錄音涌矢,去河邊找鬼掖举。 笑死,一個胖子當著我的面吹牛娜庇,可吹牛的內容都是我干的塔次。 我是一名探鬼主播,決...
    沈念sama閱讀 40,776評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼思灌,長吁一口氣:“原來是場噩夢啊……” “哼俺叭!你這毒婦竟也來了恭取?” 一聲冷哼從身側響起泰偿,我...
    開封第一講書人閱讀 39,668評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎蜈垮,沒想到半個月后耗跛,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,212評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡攒发,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 38,299評論 3 340
  • 正文 我和宋清朗相戀三年调塌,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片惠猿。...
    茶點故事閱讀 40,438評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡羔砾,死狀恐怖,靈堂內的尸體忽然破棺而出偶妖,到底是詐尸還是另有隱情姜凄,我是刑警寧澤,帶...
    沈念sama閱讀 36,128評論 5 349
  • 正文 年R本政府宣布趾访,位于F島的核電站态秧,受9級特大地震影響,放射性物質發(fā)生泄漏扼鞋。R本人自食惡果不足惜申鱼,卻給世界環(huán)境...
    茶點故事閱讀 41,807評論 3 333
  • 文/蒙蒙 一愤诱、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧捐友,春花似錦淫半、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,279評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至脆粥,卻和暖如春砌溺,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背变隔。 一陣腳步聲響...
    開封第一講書人閱讀 33,395評論 1 272
  • 我被黑心中介騙來泰國打工规伐, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人匣缘。 一個月前我還...
    沈念sama閱讀 48,827評論 3 376
  • 正文 我出身青樓猖闪,卻偏偏與公主長得像,于是被迫代替她去往敵國和親肌厨。 傳聞我的和親對象是個殘疾皇子培慌,可洞房花燭夜當晚...
    茶點故事閱讀 45,446評論 2 359