Spring-boot @EnableAutoConfiguration源碼分析

閱讀本文前,請先閱讀作者的另一篇文章Spring-Boot之@Enable*注解的工作原理

@EnableAutoConfiguration作用:從classpath中搜索所有的META-INF/spring.factories配置文件夹抗,然后將其中key為org.springframework.boot.autoconfigure.EnableAutoConfiguration的value加載到spring容器中

首先我們來做一個小實驗:
1、創(chuàng)建一個spring項目jianshu-starter

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.bamu.jianshu</groupId>
    <artifactId>jianshu-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

    <name>jianshu-starter</name>
    <description>The first Spring Boot project</description>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>4.3.11.RELEASE</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

2、編寫configuration類,注入到spring容器中

@Configuration
public class RunnableConfiguration {
    @Bean
    public Runnable runnable() {
        return () -> {};
    }
}

3极舔、創(chuàng)建一個spring-boot項目blog,引入剛剛創(chuàng)建的外部項目jianshu-starter

//...
<dependency>
      <groupId>com.bamu.jianshu</groupId>
      <artifactId>jianshu-starter</artifactId>
      <version>1.0-SNAPSHOT</version>
</dependency>
//...

4链瓦、在blog項目中編寫啟動類BlogApplication

@SpringBootApplication
public class BlogApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(BlogApplication.class, args);
        //獲取jianshu-starter項目中定義的bean runnable
        System.out.println(context.getBean("runnable").getClass().getName());
        context.close();
    }
}

5、啟動

console result

咦?@SpringBootApplication注解中不是為我們配置了@EnableAutoConfiguration了嗎慈俯?為什么這里獲取不到外部項目注入到spring容器中的bean呢渤刃?

為了解答這個疑惑,我們查閱@EnableAutoConfiguration注解中import進去的Selector的源碼贴膘,追溯到AutoConfigurationImportSelector這個類后卖子,我們發(fā)現(xiàn)了getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes)這個方法。

getCandidateConfigurations方法

紅框中的英文翻譯后意思為:在META-INF / spring.factories中找不到自動配置類刑峡。 如果您使用自定義打包洋闽,請確保文件正確無誤。

繼續(xù)帶著疑惑突梦,我們試著點進loadFactoryNames這個方法中去一探究竟:

loadFactoryNames方法

噢诫舅,原來,這個方法通過是ClassLoader宫患,去我們的classpath目錄下的META-INF/spring.factoried文件中去查找以EnableAutoConfiguration這個類的全類名為key的值刊懈,然后把它們add到一個集合當(dāng)中return出去⊥尴校看完這個方法的源碼后虚汛,我們回到上一個截圖getCandidateConfigurations方法的源碼,發(fā)現(xiàn)他在做了一個非空校驗后皇帮,接著往上層返回卷哩。那我們找到調(diào)用getCandidateConfigurations方法的代碼看看。

selectImports方法

我們追溯到了selectImports這個方法属拾。閱讀過Spring-Boot之@Enable*注解的工作原理這篇文章的讀者肯定一下就看明白了将谊,噢,原來這個方法獲取到了List<String> configurations這個集合后捌年,通過removeDuplicates方法做了去重瓢娜、通過sort方法做了排序、通過getExclusions這個方法做了排除(那我們排除的依據(jù)從哪來呢礼预?大家可以打開@EnableAutoConfiguration注解的源碼一看便知眠砾,該注解給我們提供了兩種方式排除我們不想注入到spring容器中的bean)......最后將configurations這個集合轉(zhuǎn)為String[]返回,通過推薦的文章我們知道托酸,selectImports()方法返回出去的數(shù)組是會被spring容器托管的褒颈,這下我們?nèi)懒耍?br> 在springboot項目中,其他包下自動裝配的bean励堡,是需要在classpath下的META-INF/spring.factories文件中配置谷丸,才能被spring容器注入

so,我們按照springboot的要求应结,創(chuàng)建一個spring.factories并配置我們需要獲取的bean runnable

spring.factories

META-INF/spring.factories

提醒一下:loadFactoryNamesselectImports方法的源碼我們發(fā)現(xiàn)刨疼,key必須是EnableAutoConfiguration注解的全類名泉唁,value必須是你想自動裝配的bean的全類名
再執(zhí)行BlogApplication類試一試:

console result

完美地獲取到了runnable這個對象

另外,拓展一下springboot為我們提供的starter包如何實現(xiàn)開箱即用揩慕。事實上亭畜,我們看到的springboot提供的starter包,都引用了很多我們比較熟悉的jar包迎卤,它也是通過我在上文中介紹的方式拴鸵,將它想要注入的bean,配置到spring.factories文件中蜗搔。例如:

spring-boot-autoconfiguration

我們打開spring.factories文件看一看

spring.properties文件冰山一角

看看劲藐,spring-boot-autoconfiguration這個項目注入了這么多其他項目的bean。

以上樟凄,就是Spring-boot @EnableAutoConfiguration源碼分析的全部內(nèi)容聘芜,望讀者帶著批判的心態(tài)閱讀我的文章,發(fā)現(xiàn)錯誤不同,麻煩直接評論厉膀,共同學(xué)習(xí),共同進步二拐。
也可以觀看spring-boot系列的其他文章服鹅,都是干貨喲~

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市百新,隨后出現(xiàn)的幾起案子企软,更是在濱河造成了極大的恐慌,老刑警劉巖饭望,帶你破解...
    沈念sama閱讀 211,042評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件仗哨,死亡現(xiàn)場離奇詭異,居然都是意外死亡铅辞,警方通過查閱死者的電腦和手機厌漂,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,996評論 2 384
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來斟珊,“玉大人苇倡,你說我怎么就攤上這事《诓龋” “怎么了旨椒?”我有些...
    開封第一講書人閱讀 156,674評論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長堵漱。 經(jīng)常有香客問我综慎,道長,這世上最難降的妖魔是什么勤庐? 我笑而不...
    開封第一講書人閱讀 56,340評論 1 283
  • 正文 為了忘掉前任示惊,我火速辦了婚禮好港,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘涝涤。我一直安慰自己媚狰,他們只是感情好岛杀,可當(dāng)我...
    茶點故事閱讀 65,404評論 5 384
  • 文/花漫 我一把揭開白布阔拳。 她就那樣靜靜地躺著,像睡著了一般类嗤。 火紅的嫁衣襯著肌膚如雪糊肠。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,749評論 1 289
  • 那天遗锣,我揣著相機與錄音货裹,去河邊找鬼。 笑死精偿,一個胖子當(dāng)著我的面吹牛弧圆,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播笔咽,決...
    沈念sama閱讀 38,902評論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼搔预,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了叶组?” 一聲冷哼從身側(cè)響起拯田,我...
    開封第一講書人閱讀 37,662評論 0 266
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎甩十,沒想到半個月后船庇,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,110評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡侣监,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,451評論 2 325
  • 正文 我和宋清朗相戀三年鸭轮,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片橄霉。...
    茶點故事閱讀 38,577評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡窃爷,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出酪劫,到底是詐尸還是另有隱情吞鸭,我是刑警寧澤,帶...
    沈念sama閱讀 34,258評論 4 328
  • 正文 年R本政府宣布覆糟,位于F島的核電站刻剥,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏滩字。R本人自食惡果不足惜造虏,卻給世界環(huán)境...
    茶點故事閱讀 39,848評論 3 312
  • 文/蒙蒙 一御吞、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧漓藕,春花似錦陶珠、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,726評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至栗竖,卻和暖如春暑脆,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背狐肢。 一陣腳步聲響...
    開封第一講書人閱讀 31,952評論 1 264
  • 我被黑心中介騙來泰國打工添吗, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人份名。 一個月前我還...
    沈念sama閱讀 46,271評論 2 360
  • 正文 我出身青樓碟联,卻偏偏與公主長得像,于是被迫代替她去往敵國和親僵腺。 傳聞我的和親對象是個殘疾皇子鲤孵,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,452評論 2 348

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