關(guān)于@ConditionalOnProperty的作用及用法說(shuō)明

更新時(shí)間：2022年06月13日 14:13:18 作者：林先生拆坑日記。

這篇文章主要介紹了關(guān)于@ConditionalOnProperty的作用及用法說(shuō)明，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

@ConditionalOnProperty作用及用法

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

通過(guò)其兩個(gè)屬性name以及havingValue來(lái)實(shí)現(xiàn)的，其中name用來(lái)從application.properties中讀取某個(gè)屬性值。

如果該值為空，則返回false;
如果值不為空，則將該值與havingValue指定的值進(jìn)行比較，如果一樣則返回true;否則返回false。
如果返回值為false，則該configuration不生效；為true則生效。

例子1

@Configuration
@ConditionalOnProperty(prefix = "filter",name = "loginFilter",havingValue = "true")
public class FilterConfig {
?? ?//prefix為配置文件中的前綴,
?? ?//name為配置的名字
?? ?//havingValue是與配置的值對(duì)比值,當(dāng)兩個(gè)值相同返回true,配置類生效.
? ? @Bean
? ? public FilterRegistrationBean getFilterRegistration() {
? ? ? ? FilterRegistrationBean filterRegistration ?= new FilterRegistrationBean(new LoginFilter());
? ? ? ? filterRegistration.addUrlPatterns("/*");
? ? ? ? return filterRegistration;
? ? }
}

例子2

? ? @Bean
? ? @ConditionalOnProperty(name="spring.redis.host")
? ? RedissonClient redissonSingle() {
? ? ? ? Config config = new Config();
? ? ? ? SingleServerConfig serverConfig = config.useSingleServer()
? ? ? ? ? ? ? ? .setAddress("redis://" + redssionProperties.getHost() + ":" + redssionProperties.getPort())
? ? ? ? ? ? ? ? .setTimeout(redssionProperties.getTimeout())
? ? ? ? ? ? ? ? .setConnectionPoolSize(redssionProperties.getConnectionPoolSize())
? ? ? ? ? ? ? ? .setConnectionMinimumIdleSize(redssionProperties.getConnectionMinimumIdleSize());
? ? ? ? if(StringUtils.isNotBlank(redssionProperties.getPassword())) {
? ? ? ? ? ? serverConfig.setPassword(redssionProperties.getPassword());
? ? ? ? }
? ? ? ? return Redisson.create(config);
? ? }

@ConditionalOnProperty使用注意事項(xiàng)

前幾天使用@ConditionalOnProperty注解配置多個(gè)過(guò)濾器的過(guò)程中碰到了一個(gè)問(wèn)題，在這里記錄下

先簡(jiǎn)單介紹下@ConditionalOnProperty注解的功能吧，之后筆者再描述自身遇到的那些問(wèn)題的時(shí)候，會(huì)更好理解一些

@ConditionalOnProperty的功能

它主要是通過(guò)自身的兩個(gè)屬性來(lái)控制自動(dòng)配置是否生效，這兩個(gè)屬性分別是name、havingValue。只有當(dāng)配置文件（application.properties或者bootstrap.yml）中和name相同的屬性的值和注解上havingValue的值相同時(shí)，該配置文件才會(huì)生效，如下方代碼：

配置類

@ConditionalOnProperty(value = "muyichen.auth.test", havingValue = "true")
@Component
public class AuthorizationFilterImpl implements AuthorizationFilter {
?? ?//具體的過(guò)濾邏輯
}

配置文件

muyichen.auth.test=true

使用過(guò)程中遇到的問(wèn)題

當(dāng)筆者嘗試給兩個(gè)以上的過(guò)濾器添加該屬性時(shí)，應(yīng)用程序啟動(dòng)報(bào)錯(cuò)，如下圖：

***************************
APPLICATION FAILED TO START
***************************

Description:

Parameter 0 of method authorizationFilter in com.muyichen.demo.config.WebConfiguration required a single bean, but 2 were found:

造成這個(gè)問(wèn)題的主要原因是：AuthorizationFilter是筆者自己定義的一個(gè)過(guò)濾器接口，它繼承了Filter接口，但并沒(méi)有做任何實(shí)現(xiàn)，當(dāng)servlet開(kāi)始識(shí)別過(guò)濾器時(shí)，由于AuthorizationFilter接口并沒(méi)有做主從讀取邏輯的配置，所以servlet無(wú)法判別哪個(gè)是主要的過(guò)濾器配置，當(dāng)幾個(gè)容器間的配置出現(xiàn)沖突時(shí)，無(wú)法判別以誰(shuí)為主。