@ConditionalOnProperty详细理解和使用

最新推荐文章于 2025-10-11 16:07:40 发布

原创

最新推荐文章于 2025-10-11 16:07:40 发布 · 3k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#Conditional #OnProperty注解 #按条件加载bean

在Spring应用程序开发的过程中，可能需要根据配置属性的存在和值有条件地创建一些bean，@ConditionalOnProperty注解用于仅在环境属性存在且具有特定值时才启用 bean 注册。

注解源码

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

//配置属性名称的前缀
    String prefix() default "";

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

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

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

value以及 prefix +