@ConditionalOnProperty注解控制配置文件是否生效

淩亂°似流年 2022-12-10 08:51 183阅读 0赞

近期，小刘在自己项目上发现一个注解，@ConditionalOnProperty注解。  
突然发觉自己不知道，特意来总结一下。  
我们的场景是这样的：有一个挡板服务【主要是起到日志兜底的作用】，提供给所有服务。每个服务可以用也可以不用。  
我们这个feignclient上就有这个注解：

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

**主要作用**：  
这个注解能够控制某个configuration是否生效。具体操作是通过其两个属性name以及havingValue来实现的，其中name用来从application.properties中读取某个属性值，如果该值为空，则返回false;如果值不为空，则将该值与havingValue指定的值进行比较，如果一样则返回true;否则返回false。如果返回值为false，则该configuration不生效；为true则生效。

@Configuration
    //如果synchronize在配置文件中并且值为true
    @ConditionalOnProperty(name = "synchronize", havingValue = "true")
    public class SecondDatasourceConfig { 
    
        @Bean(name = "SecondDataSource")
        @Qualifier("SecondDataSource")
        @ConfigurationProperties(prefix = "spring.second.datasource")
        public DataSource jwcDataSource() { 
            return DataSourceBuilder.create().build();
        }
    }