关于@ConditionalOnProperty的作用及用法说明

关于@ConditionalOnProperty的作用及用法说明

目录@ConditionalOnProperty作用及用法例子1例子2@ConditionalOnProperty使用注意事项@ConditionalOnProperty的功能使用过程中遇到的问题解决办法

@ConditionalOnProperty作用及用法

在spring boot中有时候需要控制配置类是否生效,可以使用@ConditionalOnProperty注解来控制@Cohttp://nfiguration是否生效.

通过其两个属性name以及havingValue来实现的，其中name用来从application.properties中读取某个属性值。

如果该值为空，则返回false;如果值不为空，则将该值与havingValue指定的值进行比较，如果一样则返回true;否则返回false。如果返回值为false，则该configuration不生效；为true则生效。

例子1

@Configuration

@ConditionalOnProperty(prefix = "filter",name = "loginFilter"http://,havingValue = "true")

public class FilterConfig {

//prefix为配置文件中的前缀,

//name为配置的名字

//havingValue是与配置的值对比值,当两个值相同返回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 serverCotPhVuHiNBpnfig = 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使用注意事项

前几天使用@ConditionalOnProperty注解配置多个过滤器的过程中碰到了一个问题，在这里记录下

先简单介绍下@ConditionalOnProperty注解的功能吧，之后笔者再描述自身遇到的那些问题的时候，会更好理解一些

@ConditionalOnProperty的功能

它主要是通过自身的两个属性来控制自动配置是否生效，这两个属性分别是name、havingValue。只有当配置文件（application.properties或者bootstrap.yml）中和name相同的属性的值和注解上havingValue的值相同时，该配置文件才会生效，如下方代码：

配置类

@ConditionalOnProperty(value = "muyichen.auth.test", havingValue = "true")

@Component

public class AuthorizationFilterImpl implements AuthotPhVuHiNBprizationFilter {

//具体的过滤逻辑

}

配置文件

muyichen.auth.test=true

使用过程中遇到的问题

当笔者尝试给两个以上的过滤器添加该属性时，应用程序启动报错，如下图：

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

Description:

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

造成这个问题的主要原因是：AuthorizationFilter是笔者自己定义的一个过滤器接口，它继承了Filter接口，但并没有做任何实现，当servlet开始识别过滤器时，由于AuthorizationFilter接口并没有做主从读取逻辑的配置，所以servlet无法判别哪个是主要的过滤器配置，当几个容器间的配置出现冲突时，无法判别以谁为主。

解决办法

可以给某个主要的配置类加上@Primary注解来标示出该配置类是主配置类，当其它配置类与该类冲突时，以该类为主。这样就可以解决上述问题了

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。