关于@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 面试题和答案 -(上)

    Java 面试题和答案 -(上)

    本文主要介绍Java 面试题和答案,这里整理了Java面试中出现的各种题型,和相应知识点,有需要的小伙伴可以好好参考下,帮助大家面试成功
    2016-09-09
  • Java String类字符串的理解与认知

    Java String类字符串的理解与认知

    String字符串和char字符不同,char使用单引号,只能表示一个字符,字符串就是一段文本。String是个类。这个类使用final修饰,所以这个类是不可以继承扩充和修改它的方法的
    2021-10-10
  • Java Enum和String及int的相互转化示例

    Java Enum和String及int的相互转化示例

    这篇文章主要介绍了Java Enum和String及int的相互转化示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • SpringBoot集成ShedLock实现分布式定时任务流程详解

    SpringBoot集成ShedLock实现分布式定时任务流程详解

    ShedLock是一个锁,官方解释是他永远只是一个锁,并非是一个分布式任务调度器。一般shedLock被使用的场景是,你有个任务,你只希望他在单个节点执行,而不希望他并行执行,而且这个任务是支持重复执行的
    2023-02-02
  • spring cloud oauth2 feign 遇到的坑及解决

    spring cloud oauth2 feign 遇到的坑及解决

    这篇文章主要介绍了spring cloud oauth2 feign 遇到的坑及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • Java中BorderLayout布局管理器的两种排列方式

    Java中BorderLayout布局管理器的两种排列方式

    这篇文章主要介绍了Java中BorderLayout布局管理器的两种排列方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-12-12
  • 详解java各种集合的线程安全

    详解java各种集合的线程安全

    这篇文章主要介绍了详解java各种集合的线程安全,小编觉得挺不错的,这里分享给大家,供需要的朋友参考。
    2017-10-10
  • Java基础之数组模拟循环队列

    Java基础之数组模拟循环队列

    这篇文章主要介绍了Java基础之数组模拟循环队列,文中有非常详细的代码示例,对正在学习java基础的小伙伴们也有非常好的帮助,需要的朋友可以参考下
    2021-04-04
  • Java为何需要平衡方法调用与内联

    Java为何需要平衡方法调用与内联

    这篇文章主要介绍了Java为何需要平衡方法调用与内联,帮助大家更好的理解和使用Java,感兴趣的朋友可以了解下
    2021-01-01
  • Java集合的定义与Collection类使用详解

    Java集合的定义与Collection类使用详解

    这篇文章主要介绍了Java集合的定义及Collection工具类使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2022-11-11

最新评论