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

 更新时间:2022年06月13日 14:13:18   作者:林先生拆坑日记。  
这篇文章主要介绍了关于@ConditionalOnProperty的作用及用法说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

@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注解来标示出该配置类是主配置类,当其它配置类与该类冲突时,以该类为主。这样就可以解决上述问题了

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 在java中使用dom解析xml的示例分析

    在java中使用dom解析xml的示例分析

    本篇文章介绍了,在java中使用dom解析xml的示例分析。需要的朋友参考下
    2013-05-05
  • java编写猜数字游戏

    java编写猜数字游戏

    这篇文章主要为大家详细介绍了java编写猜数字游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-05-05
  • MyBatis-Plus简介和快速入门教程

    MyBatis-Plus简介和快速入门教程

    MyBatis-Plus是一个MyBatis的增强工具,在MyBatis的基础上只做增强不做修改,为简化开发、提高效率而生,本文给大家介绍MyBatis-Plus简介和快速入门教程,需要的朋友参考下吧
    2021-09-09
  • Spring中存取Bean的相关注解举例详解

    Spring中存取Bean的相关注解举例详解

    这篇文章主要给大家介绍了关于Spring中存取Bean的相关注解,在没有使用注解获取对象之前,我们需要在配置文件中通过添加bean来将对象存储到Spring容器中,这对于我们来说是比较麻烦的,需要的朋友可以参考下
    2023-10-10
  • Java Servlet响应httpServletResponse过程详解

    Java Servlet响应httpServletResponse过程详解

    HttpServletResponse是处理http响应的对象,调用该对象的方法,设置到对象属性的内容,tomcat最终会组织为http响应报文
    2022-02-02
  • Feign远程调用丢失请求头问题

    Feign远程调用丢失请求头问题

    本文介绍了在服务端项目中如何解决资源访问限制问题,首先介绍了问题的产生,然后详细解析了源码,最后提出了解决方案,解决方案包括同步和异步两种,同步时直接向Spring容器注入RequestInterceptor拦截器
    2024-09-09
  • Window搭建部署RocketMQ步骤详解

    Window搭建部署RocketMQ步骤详解

    这篇文章主要介绍了Window搭建部署RocketMQ步骤详解,RocketMq是一个由阿里巴巴开源的消息中间件,脱胎去阿里每部使用的MetaQ,在设计上借鉴了Kafka。,需要的朋友可以参考下
    2019-06-06
  • Java实现一键生成表controller,service,mapper文件

    Java实现一键生成表controller,service,mapper文件

    这篇文章主要为大家详细介绍了如何利用Java语言实现一键生成表controller,service,mapper文件,文中的示例代码讲解详细,需要的可以收藏一下
    2023-05-05
  • 详述 DB2 分页查询及 Java 实现的示例

    详述 DB2 分页查询及 Java 实现的示例

    本篇文章主要介绍了详述 DB2 分页查询及 Java 实现的示例,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-09-09
  • Spring Boot异步输出Logback日志方法详解

    Spring Boot异步输出Logback日志方法详解

    这篇文章主要给大家介绍了关于Spring Boot异步输出Logback日志的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用Spring Boot具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-08-08

最新评论