关于@ConditionalOnProperty的作用及用法说明
作者:林先生拆坑日记。 时间:2023-11-24 02:39:19
@ConditionalOnProperty作用及用法
在spring boot中有时候需要控制配置类是否生效,可以使用@ConditionalOnProperty注解来控制@Configuration是否生效.
通过其两个属性name以及havingValue来实现的,其中name用来从application.properties中读取某个属性值。
如果该值为空,则返回false;
如果值不为空,则将该值与havingValue指定的值进行比较,如果一样则返回true;否则返回false。
如果返回值为false,则该configuration不生效;为true则生效。
例子1
@Configuration
@ConditionalOnProperty(prefix = "filter",name = "loginFilter",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 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使用注意事项
前几天使用@ConditionalOnProperty注解配置多个过滤器的过程中碰到了一个问题,在这里记录下
先简单介绍下@ConditionalOnProperty注解的功能吧,之后笔者再描述自身遇到的那些问题的时候,会更好理解一些
@ConditionalOnProperty的功能
它主要是通过自身的两个属性来控制自动配置是否生效,这两个属性分别是name、havingValue。只有当配置文件(application.properties或者bootstrap.yml)中和name相同的属性的值和注解上havingValue的值相同时,该配置文件才会生效,如下方代码:
配置类
@ConditionalOnProperty(value = "muyichen.auth.test", havingValue = "true")
@Component
public class AuthorizationFilterImpl implements AuthorizationFilter {
//具体的过滤逻辑
}
配置文件
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注解来标示出该配置类是主配置类,当其它配置类与该类冲突时,以该类为主。这样就可以解决上述问题了
来源:https://blog.csdn.net/weixin_41930050/article/details/106223855
![](/images/zang.png)
![](/images/jiucuo.png)
猜你喜欢
C#使用XML序列化操作菜单的方法
Android应用框架之应用启动过程详解
java 使用JDBC构建简单的数据访问层实例详解
c# 爬取优酷电影信息(1)
spring强行注入和引用实例解析
Spring Boot web项目的TDD流程
MyBatis动态SQL标签用法实例详解
Java BufferWriter写文件写不进去或缺失数据的解决
Android编程基于自定义View实现绚丽的圆形进度条功能示例
![](https://img.aspxhome.com/file/2023/7/84737_0s.png)
Spring Boot实现异步请求(Servlet 3.0)
JVM类加载,垃圾回收
![](https://img.aspxhome.com/file/2023/1/61771_0s.png)
MyBatis使用动态表或列代码解析
IDEA中Mybatis的MGB使用逆向工程配置的详细教程
![](https://img.aspxhome.com/file/2023/3/88583_0s.png)
Java创建线程的两种方式
SpringMVC适配器模式作用范围介绍
![](https://img.aspxhome.com/file/2023/2/122952_0s.png)
IntelliJ IDEA 安装教程2019.09.23(最新版)
![](https://img.aspxhome.com/file/2023/5/58175_0s.jpg)
C#开启线程的四种示例
jdk15的安装与配置全过程记录
![](https://img.aspxhome.com/file/2023/6/85516_0s.jpg)
C#中调用SAPI实现语音合成的2种方法
Android小程序实现简易QQ界面
![](https://img.aspxhome.com/file/2023/1/122081_0s.jpg)