SpringBoot - @ConditionalOnProperty注解使用详解

原创

已于 2022-06-30 14:33:29 修改 · 8k 阅读

标签

#spring boot #java

收录于

于 2022-06-30 11:49:59 首次发布

写在前面

在开发基于SpringBoot框架的项目时，会用到下面的条件注解，有时会有需要控制配置类是否生效或注入到Spring上下文中的场景，可以使用@ConditionalOnProperty注解来控制@Configuration的注解是否生效。

实现原理

@ConditionalOnProperty通过havingValue与配置文件中的值进行对比，如果对比值返回TRUE则配置类生效，反之失效。
Spring Boot 对 @Conditional 注解为我们做了细化，类似的注解共有14个，这些注解都定义在 org.springframework.boot.autoconfigure.condition包下。
在这里插入图片描述

注解说明

A. 这些注解都可以应用在 TYPE 上，也就是说，Spring 自动扫描的一切类 (@Configuration, @Component, @Service, @Repository, @Controller) 都可以通过添加相应的 @ConditionalOnXxxx 来判断是否加载；
B. 这些注解都可以应用在 METHOD 上，所以有 @Bean 标记的方法也可以应用这些注解；
C. 都使用了 @Conditional 注解来标记，OnBeanCondition 等自定义 Condition 也是实现了 Condition 接口。

源码分析

@Retention(RetentionPolicy.RUNTIME)
@Target({
   
   ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({
   
   OnPropertyCondition.class})
public @interface ConditionalOnProperty {
   
   
    // NAME和VALUE的互为别名，在使用时是互斥的
    String[] value() default {
   
   <