Spring Boot通过@ConditionalOnProperty来控制Configuration是否生效

青旅半醒 2023-07-22 09:06 33阅读 0赞

## 代码 ##

@Configuration
    @ConditionalOnProperty(prefix = "swagger",value = {"enable"},havingValue = "true")
    public class SwaggerConfiguration {
    
    }

## 使用方法 ##

> 通过其两个属性**name**以及**havingValue**来实现的，其中**name**用来从**application.properties**中读取某个属性值。  
> **如果该值为空，则返回false**;  
> **如果值不为空，则将该值与havingValue指定的值进行比较，如果一样则返回true;否则返回false。**  
> **如果返回值为false，则该configuration不生效；为true则生效。**

## 说明 ##

@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;//是否可以松散匹配，至今不知道怎么使用的  
    } 
    }