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

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

相关文章

  • 使用MQ消息队列的优缺点详解

    使用MQ消息队列的优缺点详解

    这篇文章主要介绍了使用MQ消息队列的优缺点详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-07-07
  • Idea进行pull的时候Your local changes would be overwritten by merge.

    Idea进行pull的时候Your local changes would be

    这篇文章主要介绍了Idea进行pull的时候Your local changes would be overwritten by merge.具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • 关于Spring Bean实例过程中使用反射和递归处理的Bean属性填充问题

    关于Spring Bean实例过程中使用反射和递归处理的Bean属性填充问题

    本文带领大家一起学习下在Spring Bean实例过程中如何使用反射和递归处理的Bean属性填充,需要在类 AbstractAutowireCapableBeanFactory 的 createBean 方法中添加补全属性方法,具体操作方法跟随小编一起学习下吧
    2021-06-06
  • 详解Java中的有参构造方法与无参构造方法

    详解Java中的有参构造方法与无参构造方法

    这篇文章主要详细介绍了Java中有参构造方法与无参构造方法,文中有详细的代码示例,让大家清晰明了的了解到有参构造方法与无参构造方法、以及应用,需要的朋友可以参考下
    2023-06-06
  • 详解Java中的File文件类以及FileDescriptor文件描述类

    详解Java中的File文件类以及FileDescriptor文件描述类

    在Java中File类可以用来新建文件和目录对象,而FileDescriptor类则被用来表示文件或目录的可操作性,接下来我们就来详解Java中的File文件类以及FileDescriptor文件描述类
    2016-06-06
  • Java读取txt文件中的数据赋给String变量方法

    Java读取txt文件中的数据赋给String变量方法

    今天小编就为大家分享一篇Java读取txt文件中的数据赋给String变量方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-07-07
  • Java多线程执行处理业务时间太久解决方法代码示例

    Java多线程执行处理业务时间太久解决方法代码示例

    这篇文章主要介绍了Java多线程执行处理业务时间太久解决方法代码示例的相关资料,具有一定借鉴价值,需要的朋友可以参考下。
    2017-12-12
  • Mybatis-Plus自动填充更新操作相关字段的实现

    Mybatis-Plus自动填充更新操作相关字段的实现

    数据库表中应该都要有create_time、update_time字段;那么在开发中,对于这些共有字段的处理应该要进行统一,这样就可以简化我们的开发过程。那么本文就对Mybatis-Plus中的字段自动填充进行记录
    2021-11-11
  • Java实现英文句子中的单词顺序逆序输出的方法

    Java实现英文句子中的单词顺序逆序输出的方法

    这篇文章主要介绍了Java实现英文句子中的单词顺序逆序输出的方法,涉及java字符串遍历、判断、截取、输出等相关操作技巧,需要的朋友可以参考下
    2018-01-01
  • Javaweb基础入门HTML之table与form

    Javaweb基础入门HTML之table与form

    HTML的全称为超文本标记语言,是一种标记语言。它包括一系列标签.通过这些标签可以将网络上的文档格式统一,使分散的Internet资源连接为一个逻辑整体。HTML文本是由HTML命令组成的描述性文本,HTML命令可以说明文字,图形、动画、声音、表格、链接等
    2022-03-03

最新评论