SpringBoot自动配置

前言

SpringBoot比较与Spring的一大特点就是自动配置。由此我们不需要像Spring一样,需要写一大串xml配置,只需要引入依赖就可以各种零配置开箱即用。

概念

SpringBoo遵循"约定大于配置"原则,依靠注解对配置进行常规默认配置,来减少或不需要xml配置。当我们想要引入某种组件的时候,只要引入对应的starter即可。比如想要使用redis,引入redis的starter即可使用,不需要在xml上写redis配置。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

原理

@SpringBootApplication

自动配置的核心注解是@SpringBootApplication

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
        @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
    // ...
}

@SpringBootAplication中最重要的注解是@EnableAutoConfiguration,它的作用就如同他的名字一样,开启SpringBoot自动配置

@EnableAutoConfiguration

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    // ...
}

而在@EnableAutoConfiguration注解中重要的注解有两个。一个是@AutoConfigurationPackage,它默认情况下扫描主配置类(也就是标记@SpringBootAplication注解的类)所在的包及其自包下的组件并注册。不过这个与我们的自动配置无关,与我们有关的是:

@Import(AutoConfigurationImportSelector.class)

@Import注解导入了AutoConfigurationImportSelector类并使其声明为bean。

AutoConfigurationImportSelector()

AutoConfigurationImportSelector里面有个内部类AutoConfigurationGroup,其中有一个重要方法process(),在这个方法中调用了getAutoConfigurationEntry()

getAutoConfigurationEntry()是负责自动配置类的方法。

getAutoConfigurationEntry()调用了getCandidateConfigurations()

getCandidateConfigurations()中调用了SpringFactoriesLoader.loadFactoryNames(),注意第一个参数,getSpringFactoriesLoaderFactoryClass()返回的注解@EnableAutoConfiguration,这个是后面以及自定义starter的时候很重要的一点。

SpringFactoriesLoader.loadFactoryNames()

SpringFactoriesLoader.loadFactoryNames()中调用了loadSpringFactories()loadSpringFactories()方法以Map的形式返回缓存或者META/INF下spring.factories中所有的类名。

spring.factories和loadSpringFactories返回内容如下:

但是并不是loadSpringFactories()返回的类名都会自动配置,从loadFactoryNames()中可以看到只是获取了以@EnableAutoConfiguration路径名为key的类。

// factoryType是前面要注意的传入第一个参数@EnableAutoConfiguration
String factoryTypeName = factoryType.getName();
return loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());

也就是说实际可能要自动配置的类就是下面的262个(后面这262个类还会经过一次筛选,这边先不提)。


因此我们自定义一个starter的时候也需要把要自动配置的类路径下载EnableAutoConfiguration路径下。

总的来说,整的一个调用链如下:

按需配置

前面来说了,并不是所有的类名都会被自动配置。有些类的加载需要依靠其他类存在才会被加载。比如:

@Configuration
// 检查相关的类:RabbitTemplate 和 Channel是否存在
// 存在才会加载
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
@EnableConfigurationProperties(RabbitProperties.class)
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {
}

@ConditionalOnXXX是Spring提供的条件注解,只有这个注解内的条件都符合,标记的类才会被加载。

而筛选的代码就在getAutoConfigurationEntry()中的filter(),从下图中的debug中可以看到数量与上面的数量相比明显减少。

总结

SpringBoot通过@SpringBootApplication中的注解@EnableAutoConfiguration开启自动配置,通过SpringFactoriesLoader加载META-INF/spring.factories中的自动配置类。

其他

我在一些文章中看到是依靠AutoConfigurationImportSelector 中的selectImports()方法来实现自动加载,这个方法里也有调用getAutoConfigurationEntry()方法。但是我自己debug的时候发现并没有进selectImports()方法,而是AutoConfigurationGroup.process(),所以我以自己debug所看到的为正确思路。如果有什么问题请指出,谢谢。

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

推荐阅读更多精彩内容