SpringBoot中@ConditionalOnProperty使用详解

Herbie 的个人博客 / 0 / 0 / 创建于 3年前 / 更新于 3年前

我们经常在 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 协议》，转载必须注明作者和本文链接

58 声望

后端研发 @ 沈阳某公司

唯一应该试着超越的人，是昨天的自己。

讨论数量: 0

(=￣ω￣=)··· 暂无内容！

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容，与人为善，比聪明更重要！

帮助

后端研发 @ 沈阳某公司

私信

文章归档

1 篇 2022 年 2 月 1 篇 2020 年 10 月 1 篇 2020 年 6 月 1 篇 2019 年 11 月 1 篇 2019 年 10 月

3年前 SpringBoot中@ConditionalOnProperty使用详解 4年前 composer 报错：超出内存大小的问题（Allowed memory size ） 5年前 Mac Ox 使用 Docker 安装宝塔环境，并安装 SqlServer 扩展 5年前 MySQL 中 int (10) 和 int (11) 到底有什么区别？ 5年前 Laravel Eloquent 分表方法并使用模型关联

41 Laravel Eloquent 分表方法并使用模型关联 6 MySQL 中 int (10) 和 int (11) 到底有什么区别？ 0 Mac Ox 使用 Docker 安装宝塔环境，并安装 SqlServer 扩展 0 composer 报错：超出内存大小的问题（Allowed memory size ） 0 SpringBoot中@ConditionalOnProperty使用详解

成为赞助商