SpringBoot中@ConditionalOnProperty来控制Bean注册是否生效

心已赠人 2022-12-11 10:27 248阅读 0赞

**@ConditionalOnProperty**  
这是一个springboot自动化配置的注解，它可以作用于接口、类、枚举、注解、方法之上,以实现不同配置注册不同的Bean.

**源码**

@Retention(RetentionPolicy.RUNTIME)
    @Target({  ElementType.TYPE, ElementType.METHOD })
    @Documented
    //组合了OnPropertyCondition,检查属性是否在环境中定义。
    //关于OnPropertyCondition详细内容可以参考https://blog.csdn.net/qq_31615049/article/details/90551789
    @Conditional(OnPropertyCondition.class)
    public @interface ConditionalOnProperty { 
    
    	/** * 数组,获取对应property名称的值,与name不可同时使用 */
    	String[] value() default { };
    
    	/** * 配置属性名称的前缀,用点分隔,例如"acme.system.feature" * @return the prefix */
    	String prefix() default "";
    
    	/** * 数组,配置属性完整名称或部分名称 * 可与prefix组合使用,组成完整的配置属性名称，与value不可同时使用 * 例如,如果prefix是app.config和一个name是my-value,完整键将是app.config.my-value */
    	String[] name() default { };
    
    	/** * 属性期望值的字符串表示形式。 * 比较获取到的属性值与havingValue给定的值是否相同，相同才加载配置 */
    	String havingValue() default "";
    
    	/** * 如果属性未设置，条件是否匹配,默认不匹配 */
    	boolean matchIfMissing() default false;
    }

**属性值设置规则:**  
havingValue 指定属性的值  
matchIfMissing 默认不启用时  
![在这里插入图片描述][2020093010402418.png_pic_center]  
**简单示例**

application.yml
    my:
      test:
        bean1: a
        bean2: b
        bean3:

@Configuration
    public class Configs { 
    
        @Bean
        @ConditionalOnProperty(name = "bean1", prefix = "my.test", havingValue = "a")
        public void MyBean1() { 
            System.out.println("MyBean1");
        }
    
        @Bean
        @ConditionalOnProperty(name = "bean2", prefix = "my.test", havingValue = "a")
        public void MyBean2() { 
            System.out.println("MyBean2");
        }
    
          @Bean
        @ConditionalOnProperty(name = "bean3", prefix = "my.test", havingValue = "")
        public void MyBean3() { 
            System.out.println("MyBean3");
        }
    
        @Bean
        @ConditionalOnProperty(name = "bean4", prefix = "my.test", havingValue = "")
        public void MyBean4() { 
            System.out.println("MyBean4");
        }
    
        @Bean
        @ConditionalOnProperty(name = "bean5", prefix = "my.test", havingValue = "", matchIfMissing = true)
        public void MyBean5() { 
            System.out.println("MyBean5");
        }
    }
    输出结果:
    MyBean1
    MyBean3
    MyBean5

[2020093010402418.png_pic_center]: /images/20221123/a11c123ba5104dceb9ed9fc0945e543f.png