【Spring Boot相关】@Configuration中的autoconfigure.condition

记录一些关于AutoConfiguration中的注解,如@Configuration@ConditionalOnClass@ConditionalOnMissingBean等。

文章内容,目前记录了以下注解:

  1. @ConfigurationproxyBeanMethods属性
  2. @ConditionalOnClass,since spring-boot 1.0
  3. @ConditionalOnMissingBean,since spring-boot 1.0

比如RabbitAutoConfiguration类源码使用了很多自动装配的注解:

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
@EnableConfigurationProperties(RabbitProperties.class)
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {

    @Configuration(proxyBeanMethods = false)
    @ConditionalOnMissingBean(ConnectionFactory.class)
    protected static class RabbitConnectionFactoryCreator {

        @Bean
        public CachingConnectionFactory rabbitConnectionFactory(RabbitProperties properties...) throws Exception {
        ...
    }
    ...
}

1. 首先是@Configuration的proxyBeanMethods属性

1.1 @Configuration类本身是否受CGLIB影响:

参考:Use @Configuration(proxyBeanMethods=false) wherever possible #9068
几乎所有的auto-configuration类都有加@Configuration注解,那么意味着CGLIB会给这些配置类加上代理类,这造成了系统的一些额外的开销以及没有必要给这些Configuration类加代理。
例如:proxyBeanMethods = true时,表示TestConfiguration也会被CGLIB生成代理:

@Configuration(proxyBeanMethods = true)
public class TestConfiguration {
  ...
}

打个断点可以看到TestConfiguration被加了代理:
proxyBeanMethods = true

如果将proxyBeanMethods改成false:

@Configuration(proxyBeanMethods = false)
public class TestConfiguration {
  ...
}

打断点后截图:
proxyBeanMethods = false
@Configuration内部的@Bean是否受CGLIB影响

参考:When to set proxyBeanMethods to false in Springs @Configuration?
参考:@Configuration属性proxyBeanMethods详解

  • 设置为true,@Bean 注解标注的方法获取对象时会直接从 IOC 容器之中获取,确保被@Bean标注的方法只会被调用一次(即不会创建新的bean,而是会走bean的生命周期的行为——单例)。
  • 设置为false, 那么直接调用方法获取bean,每次都会直接调用被@Bean标注的方法,从而创建新的bean,且不会走bean的生命周期的行为。

示例:

@Configuration(proxyBeanMethods = true)
public class TestConfiguration {
    @Bean
    public ServiceA serviceA() {
        return new ServiceA(serviceC());
    }

    @Bean ServiceB serviceB() {
        return new ServiceB(serviceC());
    }

    @Bean
    ServiceC serviceC() {
        return new ServiceC();
    }
}

ServiceA的代码(ServiceB代码相似):

public class ServiceA {
    private ServiceC serviceC;

    public ServiceA(ServiceC serviceC) {
        this.serviceC = serviceC;
        System.out.println(serviceC);
    }
}

如果proxyBeanMethods = true时,打印:

com.faj.configuration.ServiceC@671ea6ff
com.faj.configuration.ServiceC@671ea6ff

如果proxyBeanMethods = false时,打印:

com.faj.configuration.ServiceC@4c1d59cd
com.faj.configuration.ServiceC@297c9a9b

2. @ConditionalOnClass

参考: How does spring-boot @ConditionalOnClass work?
【写的挺好的一篇文章】SpringBoot:注解@ConditionalOnClass(X.class),X不存。。。

@Conditional that only matches when the specified classes are on the classpath.

这个注解很好理解,如果这个类在classpath里,那么就触发引入条件。
上述RabbitAutoConfiguration定义的@ConditionalOnClass({ RabbitTemplate.class, Channel.class }),通俗的说就是工程中引用了rabbitmq的包才会创建这个Configuration。

关于@ConditionalOnClass注解,比较多的文章都写到,假如我们没有引入rabbitmq的包,那么RabbitTemplate.class在编绎的时候就会报错。但如果引入了这个包,编绎倒是通过了,但On Conditional条件不就总是被匹配了吗?
关于这个问题,@ConditionalOnClass类上有说明:

A value can be safely specified on Configuration classes as the annotation metadata is parsed by using ASM before the class is loaded.
...
Since this annotation is parsed by loading class bytecode, it is safe to specify classes here that may ultimately not be on the classpath.

上述两段解释了为什么只引入了RabbitAutoConfiguration所以的包:spring-boot-autoconfigure.jar,而没有引入rabbitmq相关的包的时候,确不会报classNotFound的错,因为他用了字节码加载,在类加载前就使用了ASM来读取(是一个Java 字节码操控框架,可以直接产生二进制class文件)。

我们在引入的时候,可以使用name来配置:
@ConditionalOnClass(name ="de.MyService")。

3. @ConditionalOnMissingBean

参考:Stackoverflow - What does the spring annotation @ConditionalOnMissingBean do?

分两部分:探讨@ConditionalOnMissingBean的作用,以为什么情况下会使用这个注解。

3.1 @ConditionalOnMissingBean的作用

Conditional that only matches when no beans meeting the specified requirements are already contained in the BeanFactory.

即当声明的Bean不存在时,被定义的Bean才会生效。如文章一开始的示例,当我们在自己的代码中定义了ConnectionFactory时,RabbitConnectionFactoryCreator就不生效了,也就是说如果我们什么都没有,那么RabbitMQ就会自动帮我们生成一个ConnectionFactory。

    @ConditionalOnMissingBean(ConnectionFactory.class)
    protected static class RabbitConnectionFactoryCreator {
      ...
    }
3.2 什么时候使用@ConditionalOnMissingBean

it is strongly recommended to use this condition on auto-configuration classes only.

Spring文档中有写,最好只在auto-configuration的时候使用这个注解。比如:

  • 当Spring context中没有真正的database定义时,auto-configuration可以帮忙定义一个in-memory的database。
  • 或者定义一个默认的bean,但允许被重写。(比如实现一套安全认证方式,但也允许客户端重写并拥有自己的安全认证方式。)

参考:Spring Boot 最核心的 25 个注解,都是干货!

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

推荐阅读更多精彩内容