@ConditionalOnProperty的用法

  在spring boot中，当需要控制配置类是否生效时可以使用@ConditionalOnProperty注解来控制@Configuration是否生效。当然也可以控制@Component等注解。这是个很好用的注解，分享给大家。

ConditionalOnProperty原码分析：

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {
    String[] value() default {}; //数组，获取对应property名称的值，与name不可同时使用  
    String prefix() default "";//property名称的前缀，可有可无  
    String[] name() default {};//数组，property完整名称或部分名称（可与prefix组合使用，组成完整的property名称），与value不可同时使用  
    String havingValue() default "";//可与name组合使用，比较获取到的属性值与havingValue给定的值是否相同，相同才加载配置  
    boolean matchIfMissing() default false;//缺少该property时是否可以加载。如果为true，没有该property也会正常加载；反之报错  
    boolean relaxedNames() default true;//是否可以松散匹配，至今不知道怎么使用的  
}

使用方法：

application.yml 配置:

swagger:
  enable: true

使用方法

1. 指定prefix+name

 指定prefix+name，配置项的值不是false或“false”，加载Bean

@Configuration
@EnableSwagger2
@ConditionalOnProperty(name = "swagger.enable", havingValue = "true")
public class SwaggerConfig {
}

2. 只指定name 或者 value

只指定name 或者 value(name和value不能都为空，也不能都有值)，要写完整配置项路径，配置项的值不是false或“false”，加载Bean

@Configuration
@EnableSwagger2
@ConditionalOnProperty(value = "swagger.enable")
public class SwaggerConfig {
}

3.指定了havingValue

指定了havingValue，要把配置项的值与havingValue对比，一致则加载Bean

@Configuration
@EnableSwagger2
@ConditionalOnProperty(prefix = "swagger", name = "enable", havingValue = "true")
public class SwaggerConfig {
}

config.person.enable=true，havingValue=“true”，加载Bean

config.person.enable=false，havingValue=“false”，加载Bean

config.person.enable=ok，havingValue=“ok”，加载Bean

config.person.enable=false，havingValue=“true”，不加载Bean

config.person.enable=ok，havingValue=“no”，不加载Bean

当然havingValue也可以不设置，只要配置项的值不是false或“false”，都加载Bean

config.person.enable=ok，不设置havingValue，加载Bean

config.person.enable=false，不设置havingValue，不加载Bean

4.配置项是false，havingValue = false"

配置项是false，havingValue = false"，两者相等，加载Bean

5.配置项是false，不设置havingValue

配置项是false，不设置havingValue，不加载Bean

6.缺少配置，但配置了matchIfMissing = true

配置文件缺少配置，但配置了matchIfMissing = true，加载Bean，否则不加载。

📢文章下方有交流学习区！一起学习进步！也可以前往官网，加入官方微信交流群💪💪💪

📢创作不易，如果觉得文章不错，可以点赞👍收藏📁评论📒

📢你的支持和鼓励是我创作的动力❗❗❗  

官网：Doker 多克;官方旗舰店：淘宝网 - 淘！我喜欢