当前位置： 首页>后端>正文

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

后端2024-04-24 15:02:33

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

文章内容，目前记录了以下注解：

  1. @Configuration的proxyBeanMethods属性
  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被加了代理：
【Spring Boot相关】@Configuration中的autoconfigure.condition,第1张
proxyBeanMethods = true

如果将proxyBeanMethods改成false：

@Configuration(proxyBeanMethods = false)
public class TestConfiguration {
  ...
}
打断点后截图：
【Spring Boot相关】@Configuration中的autoconfigure.condition,第2张
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 个注解，都是干货！


https://www.xamrdz.com/backend/3ww1932463.html

相关文章：