SpringBoot中@ConditionalOnProperty使用详解

我们经常在SpringBoot的自动配置中经常看到此注解，那他到底是干什么用的呢，接下来我们看看他的源码。

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({OnPropertyCondition.class})
public @interface ConditionalOnProperty {
    // 数组，获取对应property名称的值，与name不可同时使用
    String[] value() default {};

    // 配置属性名称的前缀，比如com.hb.env
    String prefix() default "";

    // 数组，配置属性完整名称或部分名称; 可与prefix组合使用，组成完整的配置属性名称，与value不可同时使用
    String[] name() default {};

    // 可与name组合使用，比较获取到的属性值与havingValue给定的值是否相同，相同才加载配置
    String havingValue() default "";

    // 缺少该配置属性时是否可以加载。如果为true，没有该配置属性时也会正常加载；反之则不会生效
    boolean matchIfMissing() default false;
}

通过@Conditional(OnPropertyCondition.class)代码，可以看出@ConditionalOnProperty属于@Conditional的衍生注解。是否生效由属性来判断。
比如配置：

com.hb.env.type=product

首先看matchIfMissing属性，默认情况下值为false。在matchIfMissing为false时，如果name值为空也就是上面那一行配置没有则不生效；如果name不为空，则将该值与havingValue指定的值进行比较，如果一样则自动配置生效，反之不会生效。

本作品采用《CC 协议》，转载必须注明作者和本文链接