Spring-boot @EnableAutoConfiguration源码分析

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

@EnableAutoConfiguration作用:从classpath中搜索所有的META-INF/spring.factories配置文件,然后将其中key为org.springframework.boot.autoconfigure.EnableAutoConfiguration的value加载到spring容器中

首先我们来做一个小实验:
1、创建一个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、创建一个spring-boot项目blog,引入刚刚创建的外部项目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这个类后,我们发现了getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes)这个方法。

getCandidateConfigurations方法

红框中的英文翻译后意思为:在META-INF / spring.factories中找不到自动配置类。 如果您使用自定义打包,请确保文件正确无误。

继续带着疑惑,我们试着点进loadFactoryNames这个方法中去一探究竟:

loadFactoryNames方法

噢,原来,这个方法通过是ClassLoader,去我们的classpath目录下的META-INF/spring.factoried文件中去查找以EnableAutoConfiguration这个类的全类名为key的值,然后把它们add到一个集合当中return出去。看完这个方法的源码后,我们回到上一个截图getCandidateConfigurations方法的源码,发现他在做了一个非空校验后,接着往上层返回。那我们找到调用getCandidateConfigurations方法的代码看看。

selectImports方法

我们追溯到了selectImports这个方法。阅读过Spring-Boot之@Enable*注解的工作原理这篇文章的读者肯定一下就看明白了,噢,原来这个方法获取到了List<String> configurations这个集合后,通过removeDuplicates方法做了去重、通过sort方法做了排序、通过getExclusions这个方法做了排除(那我们排除的依据从哪来呢?大家可以打开@EnableAutoConfiguration注解的源码一看便知,该注解给我们提供了两种方式排除我们不想注入到spring容器中的bean)......最后将configurations这个集合转为String[]返回,通过推荐的文章我们知道,selectImports()方法返回出去的数组是会被spring容器托管的,这下我们全知道了:
在springboot项目中,其他包下自动装配的bean,是需要在classpath下的META-INF/spring.factories文件中配置,才能被spring容器注入

so,我们按照springboot的要求,创建一个spring.factories并配置我们需要获取的bean runnable

spring.factories

META-INF/spring.factories

提醒一下:loadFactoryNamesselectImports方法的源码我们发现,key必须是EnableAutoConfiguration注解的全类名,value必须是你想自动装配的bean的全类名
再执行BlogApplication类试一试:

console result

完美地获取到了runnable这个对象

另外,拓展一下springboot为我们提供的starter包如何实现开箱即用。事实上,我们看到的springboot提供的starter包,都引用了很多我们比较熟悉的jar包,它也是通过我在上文中介绍的方式,将它想要注入的bean,配置到spring.factories文件中。例如:

spring-boot-autoconfiguration

我们打开spring.factories文件看一看

spring.properties文件冰山一角

看看,spring-boot-autoconfiguration这个项目注入了这么多其他项目的bean。

以上,就是Spring-boot @EnableAutoConfiguration源码分析的全部内容,望读者带着批判的心态阅读我的文章,发现错误,麻烦直接评论,共同学习,共同进步。
也可以观看spring-boot系列的其他文章,都是干货哟~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,802评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,109评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,683评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,458评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,452评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,505评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,901评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,550评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,763评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,556评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,629评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,330评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,898评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,897评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,140评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,807评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,339评论 2 342

推荐阅读更多精彩内容