SpringBoot中@ConditionalOnProperty注解的使用方法詳解
前言
在開(kāi)發(fā)基于SpringBoot框架的項(xiàng)目時(shí),會(huì)用到下面的條件注解,有時(shí)會(huì)有需要控制配置類是否生效或注入到Spring上下文中的場(chǎng)景
可以使用@ConditionalOnProperty注解來(lái)控制@Configuration的注解是否生效。
實(shí)現(xiàn)原理
@ConditionalOnProperty通過(guò)havingValue與配置文件中的值進(jìn)行對(duì)比,如果對(duì)比值返回TRUE則配置類生效,反之失效。
Spring Boot 對(duì) @Conditional 注解為我們做了細(xì)化,類似的注解共有14個(gè),這些注解都定義在 org.springframework.boot.autoconfigure.condition包下。
注解說(shuō)明
- 這些注解都可以應(yīng)用在 TYPE 上,也就是說(shuō),Spring 自動(dòng)掃描的一切類 (@Configuration, @Component, @Service, @Repository, @Controller) 都可以通過(guò)添加相應(yīng)的 @ConditionalOnXxxx 來(lái)判斷是否加載;
- 這些注解都可以應(yīng)用在 METHOD 上,所以有 @Bean 標(biāo)記的方法也可以應(yīng)用這些注解;
- 都使用了 @Conditional 注解來(lái)標(biāo)記,OnBeanCondition 等自定義 Condition 也是實(shí)現(xiàn)了 Condition 接口。
源碼分析
@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE, ElementType.METHOD}) @Documented @Conditional({OnPropertyCondition.class}) public @interface ConditionalOnProperty { // NAME和VALUE的互為別名,在使用時(shí)是互斥的 String[] value() default {}; String[] name() default {}; // 配置項(xiàng)前綴,如果完整配置為:servicex.swagger.config.enabled,則prefix為:servicex.swagger.config String prefix() default ""; // 用havingValue與配置項(xiàng)的值進(jìn)行對(duì)比,一致返回TRUE,不一致返回FALSE. String havingValue() default ""; // 如果配置文件中, 沒(méi)有該配置項(xiàng), 判斷是否加載BEAN, 默認(rèn)為false。 boolean matchIfMissing() default false; }
案例分析
配置信息
// 假設(shè)YML中的配置如下: servicex.swagger.config.enabled=true
注解示例①
// 即使配置文件中沒(méi)有"servicex.swagger.config.enabled"該配置, // 依然加載SwaggerAutoConfiguration,因?yàn)閙atchIfMissing = true。 @Configuration @EnableAutoConfiguration @ConditionalOnProperty(name = "servicex.swagger.config.enabled", matchIfMissing = true) public class SwaggerAutoConfiguration { }
注解示例②
// 既指定prefix也指定name,因?yàn)榕渲庙?xiàng)為true,所以會(huì)加載SwaggerAutoConfiguration。 @Configuration @EnableAutoConfiguration @ConditionalOnProperty(prefix = "servicex.swagger.config", name = "enabled") public class SwaggerAutoConfiguration { }
注解示例③
// 只指定name或者value,因?yàn)榕渲庙?xiàng)為true,所以會(huì)加載SwaggerAutoConfiguration。 @Configuration @EnableAutoConfiguration @ConditionalOnProperty(name = "servicex.swagger.config.enabled") public class SwaggerAutoConfiguration { }
注解示例④
// 只指定name或者value,因?yàn)榕渲庙?xiàng)為true,havingValue也為true,所以會(huì)加載SwaggerAutoConfiguration。 @Configuration @EnableAutoConfiguration @ConditionalOnProperty(name = "servicex.swagger.config.enabled", havingValue = "true") public class SwaggerAutoConfiguration { }
注解示例⑤
// 只指定name或者value,因?yàn)榕渲庙?xiàng)為true,havingValue為false,所以不會(huì)加載SwaggerAutoConfiguration。 @Configuration @EnableAutoConfiguration @ConditionalOnProperty(name = "servicex.swagger.config.enabled", havingValue = "false") public class SwaggerAutoConfiguration { }
servicex.swagger.config.enabled | havingValue | 是否會(huì)加載 | 描述 |
true | true | √ | 對(duì)比值相同則加載 |
false | false | √ | 對(duì)比值相同則加載 |
true | false | × | 對(duì)比值不相同則不會(huì)加載 |
false | true | × | 對(duì)比值不相同則不會(huì)加載 |
true | / | √ | 加載(如果havingValue不設(shè)置,是否加載由配置項(xiàng)決定) |
false | / | × | 不加載(如果havingValue不設(shè)置,是否加載由配置項(xiàng)決定) |
常見(jiàn)注解
ConditionalOnProperty ConditionalOnResource // 當(dāng)某個(gè)Bean在應(yīng)用上下文存在時(shí),才會(huì)加載 ConditionalOnBean @ConditionalOnBean(MyAutoConfiguration.class) public class SwaggerAutoConfiguration { } // 當(dāng)某個(gè)Bean在應(yīng)用上下文不存在時(shí),才會(huì)加載 ConditionalOnMissingBean // 當(dāng)某個(gè)Bean在CLASS-PATH存在時(shí),才會(huì)加載 ConditionalOnClass // 當(dāng)某個(gè)Bean在CLASS-PATH不存在時(shí),才會(huì)加載 ConditionalOnMissingClass // 當(dāng)表達(dá)式的返回值為TRUE時(shí),才會(huì)加載 ConditionalOnExpression @ConditionalOnExpression("${servicex.swagger.config.enabled:true} and ${swagger.config.enabled:true}") public class SwaggerAutoConfiguration { } // 指定資源在CLASS-PATH存在時(shí),才會(huì)加載 ConditionalOnResource @ConditionalOnResource(resources = "/banner.txt") public class SwaggerAutoConfiguration { }
到此這篇關(guān)于SpringBoot中@ConditionalOnProperty注解的使用方法詳解的文章就介紹到這了,更多相關(guān)@ConditionalOnProperty注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring Boot中進(jìn)行 文件上傳和 文件下載功能實(shí)現(xiàn)
開(kāi)發(fā)Wb應(yīng)用時(shí),文件上傳是很常見(jiàn)的一個(gè)需求,瀏覽器 通過(guò) 表單形式 將 文件 以 流的形式傳遞 給 服務(wù)器,服務(wù)器再對(duì)上傳的數(shù)據(jù)解析處理,下面將通過(guò)一個(gè)案例講解使用 SpringBoot 實(shí)現(xiàn) 文件上傳,感興趣的朋友一起看看吧2024-07-07Java中的引用和動(dòng)態(tài)代理的實(shí)現(xiàn)詳解
這篇文章主要介紹了Java中的引用和動(dòng)態(tài)代理的實(shí)現(xiàn)詳解,涉及Java中的引用類型,JVMGC的可達(dá)性分析,代理模式等相關(guān)內(nèi)容,具有一定參考價(jià)值,需要的朋友可以了解下。2017-11-11Java通過(guò)百度API實(shí)現(xiàn)圖片車牌號(hào)識(shí)別
這段時(shí)間做項(xiàng)目需要用java程序進(jìn)行車牌識(shí)別,因此嘗試做了下這個(gè)程序,本代碼功能是通過(guò)調(diào)用百度API實(shí)現(xiàn)的,感興趣的可以了解一下2021-06-06Spring Security OAuth 自定義授權(quán)方式實(shí)現(xiàn)手機(jī)驗(yàn)證碼
這篇文章主要介紹了Spring Security OAuth 自定義授權(quán)方式實(shí)現(xiàn)手機(jī)驗(yàn)證碼,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-02-02Java對(duì)zip,rar,7z文件帶密碼解壓實(shí)例詳解
在日常業(yè)務(wù)中,會(huì)遇到一些瑣碎文件需要打包到一個(gè)壓縮包中上傳,業(yè)務(wù)方在后臺(tái)接收到壓縮包后自行解壓,然后解析相應(yīng)文件。而且可能涉及安全保密,因此會(huì)在壓縮時(shí)帶上密碼,要求后臺(tái)業(yè)務(wù)可以指定密碼進(jìn)行解壓。本文將用Java解決這一問(wèn)題,需要的可以參考一下2022-07-07java監(jiān)聽(tīng)器的實(shí)現(xiàn)和原理詳解
這篇文章主要給大家介紹了關(guān)于java監(jiān)聽(tīng)器實(shí)現(xiàn)和原理的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家學(xué)習(xí)或者使用java具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-08-08SpringBoot中使用Jsoup爬取網(wǎng)站數(shù)據(jù)的方法
這篇文章主要介紹了SpringBoot中使用Jsoup爬取網(wǎng)站數(shù)據(jù)的方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-06-06