Spring Boot 的@ConditionalOnProperty注解

最新推荐文章于 2025-03-10 17:15:49 发布

wangooo

最新推荐文章于 2025-03-10 17:15:49 发布

阅读量404

点赞数

分类专栏： Spring Java 文章标签： spring java

本文链接：https://blog.csdn.net/wangooo/article/details/119967720

版权

Spring 同时被 2 个专栏收录

54 篇文章

订阅专栏

Java

31 篇文章

订阅专栏

本文详细探讨了SpringBoot中@ConditionalOnProperty注解的使用，该注解在自动配置如Http编码、数据源类型等核心功能时起着关键作用。通过分析源码，我们可以了解到如何根据配置属性来决定特定配置类是否生效，包括属性的前缀、完整名称、匹配条件以及缺失时的行为。掌握这一特性有助于我们更灵活地定制SpringBoot应用的自动配置行为。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在Spring Boot的源码中，比如涉及到Http编码的自动配置、数据源类型的自动配置等大量的使用到了@ConditionalOnProperty的注解。

@ConditionalOnProperty注解源码：

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {

    // 数组，获取对应property名称的值，与name不可同时使用
    String[] value() default {};

    // 配置属性名称的前缀，比如spring.http.encoding
    String prefix() default "";

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

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

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

}