快捷導(dǎo)航

Spring在@ConditionalOnProperty注解使用詳解

更新時(shí)間：2023年11月22日 09:57:29 作者：杜小舟

這篇文章主要介紹了Spring在@ConditionalOnProperty注解使用詳解,@ConditionalOnProperty注解是Spring Boot的條件注解,主要用法是根據(jù)配置文件中的屬性來(lái)控制某個(gè)配置類是否生效,或者控制某個(gè)Bean是否被創(chuàng)建,需要的朋友可以參考下

簡(jiǎn)單介紹

@ConditionalOnProperty注解是Spring Boot的條件注解，主要用法是根據(jù)配置文件中的屬性來(lái)控制某個(gè)配置類是否生效，或者控制某個(gè)Bean是否被創(chuàng)建。

就比如我們常用的在yml中配置

server:
  port: 8080

能夠起到啟動(dòng)服務(wù)以8080端口啟動(dòng)，而@ConditionalOnProperty注解則是符合條件注入到Bean中，下面結(jié)合一些案例代碼做出介紹。

@ConditionalOnProperty 注解中的屬性介紹

屬性名稱	介紹
prefix	指定屬性前綴
name	指定屬性名稱
havingValue	用來(lái)指定期望的屬性值，如果配置的值等于期望值則執(zhí)行
matchIfMissing	當(dāng)配置文件中不存在指定屬性時(shí)的處理方式，處理方式有兩個(gè)，分別是 true 和 false， true 是不存在指定屬性時(shí)執(zhí)行，false 是不執(zhí)行，默認(rèn)是 false

簡(jiǎn)單配置案例代碼

控制配置類

yml中配置以下信息：

biz:
  access: true

下面是配置類的代碼實(shí)現(xiàn)：

@Configuration
@ConditionalOnProperty(prefix = "biz", name = "access", havingValue = "true")
public class AccessConfiguration implements HandlerInterceptor {
}

這里需要注意的是，@ConditionalOnProperty注解只代表符合條件就執(zhí)行注入，不代表它有@Configuration注解的作用，所以想控制一個(gè)配置類是就需要有@ConditionalOnProperty和@Configuration注解。

控制Bean創(chuàng)建

那么當(dāng)我想想控制配置類中的某個(gè)Bean是否注入時(shí)該怎么做呢，看下面代碼示例： yml中配置以下信息：

biz:
  access: true

@Configuration
public class AccessConfiguration implements HandlerInterceptor {
	
	@Bean
	@ConditionalOnProperty(prefix = "biz", name = "access", havingValue = "true")
    public YourBeanFile preHandle() {
        return new YourBeanFile();
    }

}

這樣就能控制某個(gè)Bean的創(chuàng)建了。

復(fù)雜配置案例代碼

控制配置類

yml中配置以下信息：

biz:
  access:
    token: true

下面是代碼實(shí)現(xiàn)：

@Configuration
@ConditionalOnProperty(prefix = "biz.access", name = "token", havingValue = "true")
public class AccessConfiguration implements HandlerInterceptor {
}

可以看到復(fù)雜的配置與簡(jiǎn)單的配置有些不太一樣，最后一個(gè)屬性才是在@ConditionalOnProperty注解的name屬性上。

控制Bean創(chuàng)建

yml中配置以下信息：

biz:
  access:
    token: true

代碼實(shí)現(xiàn)：

@Configuration
public class AccessConfiguration implements HandlerInterceptor {
	
	@Bean
	@ConditionalOnProperty(prefix = "biz.access", name = "token", havingValue = "true")
    public YourBeanFile preHandle() {
        return new YourBeanFile();
    }

}

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

您可能感興趣的文章: