快捷導(dǎo)航

SpringBoot中@ConditionalOnProperty注解的使用方法詳解

更新時間：2024年01月18日 11:27:26 作者：cloneme01

這篇文章主要介紹了SpringBoot中@ConditionalOnProperty注解的使用方法詳解,在開發(fā)基于SpringBoot框架的項目時,會用到下面的條件注解,有時會有需要控制配置類是否生效或注入到Spring上下文中的場景,可以使用@ConditionalOnProperty注解來控制,需要的朋友可以參考下

前言

在開發(fā)基于SpringBoot框架的項目時，會用到下面的條件注解，有時會有需要控制配置類是否生效或注入到Spring上下文中的場景

可以使用@ConditionalOnProperty注解來控制@Configuration的注解是否生效。

實現(xiàn)原理

@ConditionalOnProperty通過havingValue與配置文件中的值進行對比，如果對比值返回TRUE則配置類生效，反之失效。

Spring Boot 對 @Conditional 注解為我們做了細化，類似的注解共有14個，這些注解都定義在 org.springframework.boot.autoconfigure.condition包下。

在這里插入圖片描述

注解說明

這些注解都可以應(yīng)用在 TYPE 上，也就是說，Spring 自動掃描的一切類 (@Configuration, @Component, @Service, @Repository, @Controller) 都可以通過添加相應(yīng)的 @ConditionalOnXxxx 來判斷是否加載；
這些注解都可以應(yīng)用在 METHOD 上，所以有 @Bean 標(biāo)記的方法也可以應(yīng)用這些注解；
都使用了 @Conditional 注解來標(biāo)記，OnBeanCondition 等自定義 Condition 也是實現(xiàn)了 Condition 接口。

源碼分析

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({OnPropertyCondition.class})
public @interface ConditionalOnProperty {
    // NAME和VALUE的互為別名，在使用時是互斥的
    String[] value() default {};
    String[] name() default {};
	// 配置項前綴，如果完整配置為：servicex.swagger.config.enabled，則prefix為：servicex.swagger.config
    String prefix() default ""; 
	// 用havingValue與配置項的值進行對比，一致返回TRUE，不一致返回FALSE.
    String havingValue() default "";
	// 如果配置文件中, 沒有該配置項, 判斷是否加載BEAN, 默認(rèn)為false。
    boolean matchIfMissing() default false;
}

案例分析

配置信息

// 假設(shè)YML中的配置如下：
servicex.swagger.config.enabled=true

注解示例①

// 即使配置文件中沒有"servicex.swagger.config.enabled"該配置，
// 依然加載SwaggerAutoConfiguration，因為matchIfMissing = true。
@Configuration
@EnableAutoConfiguration
@ConditionalOnProperty(name = "servicex.swagger.config.enabled", matchIfMissing = true)
public class SwaggerAutoConfiguration {
}

注解示例②

// 既指定prefix也指定name，因為配置項為true，所以會加載SwaggerAutoConfiguration。
@Configuration
@EnableAutoConfiguration
@ConditionalOnProperty(prefix = "servicex.swagger.config", name = "enabled")
public class SwaggerAutoConfiguration {
}

注解示例③

// 只指定name或者value，因為配置項為true，所以會加載SwaggerAutoConfiguration。
@Configuration
@EnableAutoConfiguration
@ConditionalOnProperty(name = "servicex.swagger.config.enabled")
public class SwaggerAutoConfiguration {
}

注解示例④

// 只指定name或者value，因為配置項為true，havingValue也為true，所以會加載SwaggerAutoConfiguration。
@Configuration
@EnableAutoConfiguration
@ConditionalOnProperty(name = "servicex.swagger.config.enabled", havingValue = "true")
public class SwaggerAutoConfiguration {
}

注解示例⑤

// 只指定name或者value，因為配置項為true，havingValue為false，所以不會加載SwaggerAutoConfiguration。
@Configuration
@EnableAutoConfiguration
@ConditionalOnProperty(name = "servicex.swagger.config.enabled", havingValue = "false")
public class SwaggerAutoConfiguration {
}

servicex.swagger.config.enabled	havingValue	是否會加載	描述
true	true	√	對比值相同則加載
false	false	√	對比值相同則加載
true	false	×	對比值不相同則不會加載
false	true	×	對比值不相同則不會加載
true	/	√	加載(如果havingValue不設(shè)置，是否加載由配置項決定)
false	/	×	不加載(如果havingValue不設(shè)置，是否加載由配置項決定)

常見注解

ConditionalOnProperty
ConditionalOnResource
// 當(dāng)某個Bean在應(yīng)用上下文存在時，才會加載
ConditionalOnBean
@ConditionalOnBean(MyAutoConfiguration.class)
public class SwaggerAutoConfiguration {
}
// 當(dāng)某個Bean在應(yīng)用上下文不存在時，才會加載
ConditionalOnMissingBean
// 當(dāng)某個Bean在CLASS-PATH存在時，才會加載
ConditionalOnClass
// 當(dāng)某個Bean在CLASS-PATH不存在時，才會加載
ConditionalOnMissingClass
// 當(dāng)表達式的返回值為TRUE時，才會加載
ConditionalOnExpression
@ConditionalOnExpression("${servicex.swagger.config.enabled:true} and ${swagger.config.enabled:true}")
public class SwaggerAutoConfiguration {
}
// 指定資源在CLASS-PATH存在時，才會加載
ConditionalOnResource
@ConditionalOnResource(resources = "/banner.txt")
public class SwaggerAutoConfiguration {
}

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

您可能感興趣的文章: