Spring在@ConditionalOnProperty注解使用详解

 更新时间:2023年11月22日 09:57:29   作者:杜小舟  
这篇文章主要介绍了Spring在@ConditionalOnProperty注解使用详解,@ConditionalOnProperty注解是Spring Boot的条件注解,主要用法是根据配置文件中的属性来控制某个配置类是否生效,或者控制某个Bean是否被创建,需要的朋友可以参考下

简单介绍

@ConditionalOnProperty注解是Spring Boot的条件注解,主要用法是根据配置文件中的属性来控制某个配置类是否生效,或者控制某个Bean是否被创建。

就比如我们常用的在yml中配置

server:
  port: 8080

能够起到启动服务以8080端口启动,而@ConditionalOnProperty注解则是符合条件注入到Bean中,下面结合一些案例代码做出介绍。

@ConditionalOnProperty 注解中的属性介绍

属性名称介绍
prefix指定属性前缀
name指定属性名称
havingValue用来指定期望的属性值,如果配置的值等于期望值则执行
matchIfMissing当配置文件中不存在指定属性时的处理方式,处理方式有两个,分别是 true 和 false,
true 是不存在指定属性时执行,false 是不执行,默认是 false

简单配置案例代码

控制配置类

yml中配置以下信息:

biz:
  access: true

下面是配置类的代码实现:

@Configuration
@ConditionalOnProperty(prefix = "biz", name = "access", havingValue = "true")
public class AccessConfiguration implements HandlerInterceptor {
}

这里需要注意的是,@ConditionalOnProperty注解只代表符合条件就执行注入,不代表它有@Configuration注解的作用,所以想控制一个配置类是就需要有@ConditionalOnProperty和@Configuration注解。

控制Bean创建

那么当我想想控制配置类中的某个Bean是否注入时该怎么做呢,看下面代码示例: yml中配置以下信息:

biz:
  access: true
@Configuration
public class AccessConfiguration implements HandlerInterceptor {
	
	@Bean
	@ConditionalOnProperty(prefix = "biz", name = "access", havingValue = "true")
    public YourBeanFile preHandle() {
        return new YourBeanFile();
    }

}

这样就能控制某个Bean的创建了。

复杂配置案例代码

控制配置类

yml中配置以下信息:

biz:
  access:
    token: true

下面是代码实现:

@Configuration
@ConditionalOnProperty(prefix = "biz.access", name = "token", havingValue = "true")
public class AccessConfiguration implements HandlerInterceptor {
}

可以看到复杂的配置与简单的配置有些不太一样,最后一个属性才是在@ConditionalOnProperty注解的name属性上。

控制Bean创建

yml中配置以下信息:

biz:
  access:
    token: true

代码实现:

@Configuration
public class AccessConfiguration implements HandlerInterceptor {
	
	@Bean
	@ConditionalOnProperty(prefix = "biz.access", name = "token", havingValue = "true")
    public YourBeanFile preHandle() {
        return new YourBeanFile();
    }

}

到此这篇关于Spring在@ConditionalOnProperty注解使用详解的文章就介绍到这了,更多相关@ConditionalOnProperty注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅析关于java的序列化和反序列化

    浅析关于java的序列化和反序列化

    这篇文章主要介绍了浅析关于java的序列化和反序列化,所谓序列化,就是把要传输的对象以及相关信息转换成字节数组进行存储的过程,而反序列化就是将字节数组再转回对象的过程,需要的朋友可以参考下
    2023-07-07
  • Java实现调用第三方相关接口

    Java实现调用第三方相关接口

    最近在做一个项目,需要调用第三方接口,本文主要介绍了Java实现调用第三方相关接口,具有一定的参考价值,感兴趣的可以了解一下
    2023-09-09
  • 一文教你利用Stream API批量Mock数据的方法

    一文教你利用Stream API批量Mock数据的方法

    在日常开发的过程中我们经常会遇到需要mock一些数据的场景,比如说 mock 一些接口的返回或者说 mock 一些测试消息用于队列生产者发送消息。本文将教你如何通过 Stream API 批量 Mock 数据,需要的可以参考一下
    2022-09-09
  • 基于MyBatis的简单使用(推荐)

    基于MyBatis的简单使用(推荐)

    下面小编就为大家带来一篇基于MyBatis的简单使用(推荐)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • 学会在Java中使用Optional功能

    学会在Java中使用Optional功能

    这篇文章主要介绍了学会在Java中使用Optional功能,在本文中,我们将了解如何、何时以及在哪里最好地应用Optional,具体相关内容需要的朋友可以参考下面文章内容
    2022-09-09
  • SpringMVC实现上传下载文件

    SpringMVC实现上传下载文件

    这篇文章主要为大家详细介绍了SpringMVC实现上传下载文件,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-09-09
  • Java数据结构之实现跳表

    Java数据结构之实现跳表

    今天带大家来学习Java数据结构的相关知识,文中对用Java实现跳表作了非常详细的图文解说及代码示例,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
    2021-05-05
  • java Swing实现弹窗效果

    java Swing实现弹窗效果

    这篇文章主要为大家详细介绍了java Swing实现弹窗效果,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-07-07
  • 浅谈Action+Service +Dao 功能

    浅谈Action+Service +Dao 功能

    下面小编就为大家带来一篇浅谈Action+Service +Dao 功能。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-07-07
  • springboot项目如何在linux服务器上启动、停止脚本

    springboot项目如何在linux服务器上启动、停止脚本

    这篇文章主要介绍了springboot项目如何在linux服务器上启动、停止脚本问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-05-05

最新评论