Spring中的@ConditionalOnProperty注解使用详解

 更新时间:2024年01月17日 08:43:32   作者:qq_53639759  
这篇文章主要介绍了Spring中的@ConditionalOnProperty注解使用详解,在 spring boot 中有时候需要控制配置类是否生效,可以使用 @ConditionalOnProperty 注解来控制 @Configuration 是否生效,需要的朋友可以参考下

@ConditionalOnProperty

在 spring boot 中有时候需要控制配置类是否生效,可以使用 @ConditionalOnProperty 注解来控制 @Configuration 是否生效.

示例:

配置类代码

@AutoConfiguration
@ConditionalOnProperty(prefix = "yudao.tenant", value = "enable", havingValue = true) // 允许使用 yudao.tenant.enable=false 禁用多租户
@EnableConfigurationProperties(TenantProperties.class)
public class YudaoTenantAutoConfiguration {
	xxxxxxxxxxxxxxxx
}

配置文件代码

yudao:
  tenant: # 多租户相关配置项
    enable: true

所以当enable=true是,该配置类才会生效

@ConditionalOnProperty源码

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//
package org.springframework.boot.autoconfigure.condition;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.context.annotation.Conditional;
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({OnPropertyCondition.class})
public @interface ConditionalOnProperty {
    String[] value() default {};
    String prefix() default "";
    String[] name() default {};
    String havingValue() default "";
    boolean matchIfMissing() default false;
}

havingValue 和 matchIfMissing 区别

  • havingValue: 表示要匹配的属性值的属性名。当配置文件中该属性的值为指定的值时,类或方法将被条件注解所影响。如果配置文件中未设置该属性,或者属性值不等于指定的值,则类或方法不会被条件注解所影响。
  • matchIfMissing: 表示在配置文件中未找到该属性时是否匹配。默认为 false,表示只有在配置文件中设置了该属性时才会匹配。如果设置为 true,则即使配置文件中未设置该属性,也会匹配。当配置文件中未找到该属性时,如果 matchIfMissing 为 true,则类或方法将被条件注解所影响;如果 matchIfMissing 为 false,则类或方法不会被条件注解所影响。

因此,havingValue 和 matchIfMissing 的区别在于,havingValue 用于指定要匹配的属性值,而 matchIfMissing 用于控制类或方法是否在属性未找到时被条件注解所影响。

到此这篇关于Spring中的@ConditionalOnProperty注解使用详解的文章就介绍到这了,更多相关@ConditionalOnProperty注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringCloud开启session共享并存储到Redis的实现

    SpringCloud开启session共享并存储到Redis的实现

    这篇文章主要介绍了SpringCloud开启session共享并存储到Redis的实现方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-02-02
  • 关于maven下载慢的问题

    关于maven下载慢的问题

    这篇文章主要介绍了关于maven下载慢的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-04-04
  • jmeter接口测试教程及接口测试流程详解(全网仅有)

    jmeter接口测试教程及接口测试流程详解(全网仅有)

    Jmeter是由Apache公司开发的一个纯Java的开源项目,即可以用于做接口测试也可以用于做性能测试。本文给大家分享jmeter接口测试教程及接口测试流程,感兴趣的朋友跟随小编一起看看吧
    2021-12-12
  • Java使用协同过滤算法的代码示例

    Java使用协同过滤算法的代码示例

    在Java中实现协同过滤算法通常需要一些步骤,包括加载用户-项目评分数据、计算相似度、生成推荐等,以下是一个简化的基于用户的协同过滤算法的代码示例,感兴趣的小伙伴跟着小编一起来看看吧
    2024-06-06
  • java注解之运行时修改字段的注解值操作

    java注解之运行时修改字段的注解值操作

    这篇文章主要介绍了java注解之运行时修改字段的注解值操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • Spring Shell打Jar包时常用小技巧

    Spring Shell打Jar包时常用小技巧

    这篇文章主要介绍了Spring Shell打Jar包时常用小技巧,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-10-10
  • SpringBoot 微信退款功能的示例代码

    SpringBoot 微信退款功能的示例代码

    这篇文章主要介绍了SpringBoot 微信退款功能的实现,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-06-06
  • Java手机号最新校验规则

    Java手机号最新校验规则

    在Java中,进行手机号校验通常使用正则表达式(Regex)来匹配手机号的格式,以下是一个基于当前(截至2024年)中国手机号规则的校验方法,感兴趣的朋友跟随小编一起看看吧
    2024-05-05
  • java上界通配符(? extends Type)的使用

    java上界通配符(? extends Type)的使用

    在Java中,? extends Type是一个上界通配符,本文主要介绍了java上界通配符(? extends Type)的使用,具有一定的参考价值,感兴趣的可以了解一下
    2024-01-01
  • java中获取json的所有key方法

    java中获取json的所有key方法

    下面小编就为大家分享一篇java中获取json的所有key方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-03-03

最新评论