快捷導(dǎo)航

Spring中的@ConditionalOnProperty注解使用詳解

更新時(shí)間：2024年01月17日 08:43:32 作者：qq_53639759

這篇文章主要介紹了Spring中的@ConditionalOnProperty注解使用詳解,在 spring boot 中有時(shí)候需要控制配置類是否生效,可以使用 @ConditionalOnProperty 注解來控制 @Configuration 是否生效,需要的朋友可以參考下

@ConditionalOnProperty

在 spring boot 中有時(shí)候需要控制配置類是否生效,可以使用 @ConditionalOnProperty 注解來控制 @Configuration 是否生效.

示例：

配置類代碼

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

配置文件代碼

yudao:
  tenant: # 多租戶相關(guān)配置項(xiàng)
    enable: true

所以當(dāng)enable=true是，該配置類才會(huì)生效

@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 區(qū)別

havingValue: 表示要匹配的屬性值的屬性名。當(dāng)配置文件中該屬性的值為指定的值時(shí)，類或方法將被條件注解所影響。如果配置文件中未設(shè)置該屬性，或者屬性值不等于指定的值，則類或方法不會(huì)被條件注解所影響。
matchIfMissing: 表示在配置文件中未找到該屬性時(shí)是否匹配。默認(rèn)為 false，表示只有在配置文件中設(shè)置了該屬性時(shí)才會(huì)匹配。如果設(shè)置為 true，則即使配置文件中未設(shè)置該屬性，也會(huì)匹配。當(dāng)配置文件中未找到該屬性時(shí)，如果 matchIfMissing 為 true，則類或方法將被條件注解所影響；如果 matchIfMissing 為 false，則類或方法不會(huì)被條件注解所影響。

因此，havingValue 和 matchIfMissing 的區(qū)別在于，havingValue 用于指定要匹配的屬性值，而 matchIfMissing 用于控制類或方法是否在屬性未找到時(shí)被條件注解所影響。

到此這篇關(guān)于Spring中的@ConditionalOnProperty注解使用詳解的文章就介紹到這了,更多相關(guān)@ConditionalOnProperty注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

相關(guān)文章

解決創(chuàng)建springboot后啟動(dòng)報(bào)錯(cuò):Failed?to?bind?properties?under‘spri
在Spring?Boot項(xiàng)目中,application.properties和application.yml是用于配置參數(shù)的兩種文件格式,properties格式簡(jiǎn)潔但不支持層次結(jié)構(gòu),而yml格式支持層次性,可讀性更好,在yml文件中,要注意細(xì)節(jié),比如冒號(hào)后面需要空格
2024-10-10
SpringBoot使用maven指定依賴包的版本(解決示例)
我們?cè)谑褂肁依賴的時(shí)候,這個(gè)依賴有引入了第三方B依賴,這時(shí)候我想指定B依賴的版本號(hào),下面?zhèn)€大家分享解決示例,對(duì)SpringBoot maven依賴包相關(guān)配置方法感興趣的朋友一起看看吧
2024-04-04
AndroidQ沙盒機(jī)制之分區(qū)存儲(chǔ)適配
這篇文章主要介紹了AndroidQ沙盒機(jī)制之分區(qū)存儲(chǔ)適配，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
2020-06-06
Springboot整合Socket實(shí)現(xiàn)單點(diǎn)發(fā)送,廣播群發(fā),1對(duì)1,1對(duì)多實(shí)戰(zhàn)
本文主要介紹了Springboot整合Socket實(shí)現(xiàn)單點(diǎn)發(fā)送,廣播群發(fā),1對(duì)1,1對(duì)多實(shí)戰(zhàn)，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
2022-08-08
SpringBoot中的ThreadLocal保存請(qǐng)求用戶信息的實(shí)例demo
線程局部變量,創(chuàng)建一個(gè)線程變量后,針對(duì)這個(gè)變量可以讓每個(gè)線程擁有自己的變量副本,每個(gè)線程是訪問的自己的副本,與其他線程的相互獨(dú)立,本文介紹SpringBoot中的ThreadLocal保存請(qǐng)求用戶信息,需要的朋友可以參考下
2024-05-05
MyBatis中的SQL映射文件配置結(jié)果映射的操作指南
MyBatis?是一款優(yōu)秀的?ORM?框架，它提供了多種配置方式來定義?SQL?語句以及結(jié)果映射規(guī)則，本文將介紹?MyBatis?中的?SQL?映射文件如何配置結(jié)果映射，包括常規(guī)類型、集合類型等多種情況,需要的朋友可以參考下
2023-07-07
java集合collection接口與子接口及實(shí)現(xiàn)類
這篇文章主要介紹了java集合collection接口與子接口及實(shí)現(xiàn)類，文章圍繞主題展開詳細(xì)的內(nèi)容介紹，具有一定的參考價(jià)值，需要的朋友可以參考一下
2022-07-07
java獲取linux服務(wù)器上的IP操作
這篇文章主要介紹了java獲取linux服務(wù)器上的IP操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧
2020-08-08
Spring中Feign的調(diào)用流程詳解
這篇文章主要介紹了Spring中Feign的調(diào)用流程詳解,分析過了創(chuàng)建的代理是FeignInvocationHandler,那我們就打斷點(diǎn),停在它的反射方法上,看看到底做了什么,需要的朋友可以參考下
2023-11-11
Springboot項(xiàng)目出現(xiàn)java.lang.ArrayStoreException的異常分析
這篇文章介紹了Springboot項(xiàng)目出現(xiàn)java.lang.ArrayStoreException的異常分析，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
2021-12-12