Spring Boot 的@ConditionalOnProperty注解

31 篇文章 1 订阅

在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;

}
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
@ConditionalOnProperty注解Spring Boot中的一个条件注解,用于根据指定的属性来决定是否加载或创建一个bean。该注解的作用是根据配置文件中的属性来动态控制bean的创建过程。 要验证@ConditionalOnProperty注解,您可以按照以下步骤进行操作: 1. 确保您已经添加了Spring Boot的依赖,以便可以使用该注解。 2. 在您的Spring Boot应用程序中选择一个合适的类(通常是配置类或启动类),并在该类上添加@ConditionalOnProperty注解。 3. 在@ConditionalOnProperty注解中,您需要指定一个或多个属性的名称和期望的。例如,假设您想要根据"myapp.feature.enabled"属性的来决定是否加载一个bean: ```java @Configuration @ConditionalOnProperty(name = "myapp.feature.enabled", havingValue = "true") public class MyFeatureConfig { // Bean definitions and other configurations } ``` 4. 在配置文件(通常是application.properties或application.yml)中添加相应的属性及其。例如,在application.properties文件中添加以下内容: ``` myapp.feature.enabled=true ``` 这将启用"MyFeatureConfig"类中的bean加载。 5. 运行您的Spring Boot应用程序,并确保启动过程中没有错误或警告。 如果配置文件中指定的属性与@ConditionalOnProperty注解中指定的期望匹配,那么该注解所标注的类或bean将会被加载或创建。如果不匹配,则该类或bean将被跳过。 请注意,@ConditionalOnProperty注解还有其他可用的属性,可以用于更复杂的条件匹配逻辑。您可以参考Spring Boot官方文档以获取更多详细信息和示例。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值