理解Spring Boot中的auto-configuration

翻译一下Spring官网的文章,加深自己对Spring Boot自动装配的一些理解。

不管你是开发开源软件或者商业软件,当你在开发一个共享库的时候,那么可能你需要使用自动配置,自动配置可以捆绑在外部的jar包中,由Spring Boot提取。
快速学习的mode代码:示例项目

下面将介绍自动配置的一些知识:

1.了解自动配置的bean

查看(脱掉)Spring的代码(衣服),auto-configuration 就是一个实现了Configuration接口的类。使用@Conditional注解来限制何时让auto-configuration 生效,通常auto-configuration 使用ConditionalOnClassConditionalOnMissingBean注解,这两注解的确保只有当我们拥有相关类的时候使得@Configuration注解生效。

2.auto-configuration的目录结构

Spring Boot 会检查所有jar包下的META-INF/spring.factories文件,这个文件中EnableAutoConfiguration 的KEY下面罗列了需要自动配置的类,例如:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.mycorp.libx.autoconfigure.LibXAutoConfiguration,\
com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration

当我们需要对配置类的加载顺序排序的时候,可以使用
@AutoConfigureAfter或者@AutoCOnfigureBefore注解。
例如,如果我们提供了一个特殊的web configuration,需要在WebMvcAutoConfiguration之后才对我们注解的类进行加载。
如果想要自动排序,可以使用@AutoconfigureOrder注解,这个注解类似于@Order,但是它是专门给auto-configuration使用。

Auto-configuration 只有通过这种方式加载,确保 他们定义在一个特定的包空间下能够被扫描。

3.Condition注解

我们在auto-configuration中看到不止一个使用了@Condition注解的类,比如 @ConditionalOnMissingBean,那么下面就介绍一下auto-configuration中常用的注解

Class Conditions

@ConditionalOnClass@ConditionalOnMissingClass 注解允许拥有或缺失指定的类进行配置,另外使用了ASM技术 来解析注解,我们可以使用value属性来引用出真实的类,即使这个类不会出现在正在运行的程序类路径中,如果希望指定类名,可以使用name属性

bean Conditions

ConditionalOnBeanConditionalOnMissingBean注解允许用于或确实指定的bean来进行配置,我们可以使用value属性配置一个特别的类型。或者用name配置特殊的名字,search属性允许限制搜索ApplicationContext中的层次结构。

@Configuration
 public  class MyAutoConfiguration { @Bean @ConditionalOnMissingBean public MyService myService(){...}
}

在这个方法中,myService如果还没有存在Spring容器中,那么它将会在这个方法中得到创建。

这里特别需要注意bean的启动顺序,因为在做一个共享库的时候影响十分深远,所以,我们应当尽量使用@ConditionalOnBean@ConditionalOnMissingBena注解在auto-configuration的过程中。保证用户在添加了自已定义的bean后能够正常的加载系统。

@ConditionalOnBean@ConditionalOnMissingBean不会阻止被@Configuration注解的类加载,所以这些条件应当去标记具体包含的每个方法

Property Condition

@ConditionalOnProperty注解允许基于Spring的环境属性进行配置,使用prefixname参数来检查指定的属性值,任何存在且不等于属性false都将被匹配,更高级的检查可以使用havingValuematchIfMissing属性。

Resource Condition

@ConditionalOnResource注解去判断指定的资源是否存在,可以使用常规的Spring约束来指定资源,例如file://home/usr/test.dat

Web Application Condition

@ConditionalOnWebApplication@ConditionalOnNotWebApplication注解允许根据应用是否是一个“web应用程序”被包括配置。

SPEL表达式

@ConditionalOnExpression注释允许基于一个的结果被包括配置使用SpEL表达

创建自定义的starter

一个完整的Spring Boot starter应该包含下面这些组件:

  • autoconfigure 模块包含了自动配置的代码
  • starter模块提供了一个autoconfigure的模块和其他额外的依赖。

命名的问题

需要确保为我们的starter提供了一个合适名字,不要让模块名字叫spring-boot等一系列不知所云的名称,即使你用的不同的Maven GroupId,我们应当让模块名称更规范,容易理解。

例如我们正在创建一个acme的start模块,命名推荐叫做acme-spring-boot-autoconfigureacme-spring-boot-starter

final

starter其实是一个空的模块,它的唯一目的其实就是提供一个必要的依赖关系,

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

推荐阅读更多精彩内容