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注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

IntelliJ IDEA修改新建文件自动生成注释的user名
今天小编就为大家分享一篇关于IntelliJ IDEA修改新建文件自动生成注释的user名，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
2018-10-10
解决idea找不到类could not find artifact问题
本文总结了解决Java项目中找不到类的问题的常见解决方案,包括刷新Maven项目、清理IDEA缓存、Maven Clean Install、重新Package、解决依赖冲突和手动导入依赖包等方法
2025-01-01
详解java面试题中的i++和++i
这篇文章主要介绍了java面试题中的i++和++i的相关资料,需要的朋友可以参考下
2018-03-03
Spring Cloud中使用Feign,@RequestBody无法继承的解决方案
这篇文章主要介绍了Spring Cloud中使用Feign,@RequestBody无法继承的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-10-10
java+jdbc+mysql+socket搭建局域网聊天室
这篇文章主要为大家详细介绍了java+jdbc+mysql+socket搭建局域网聊天室，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-01-01
springboot带有进度条的上传功能完整实例
这篇文章主要介绍了springboot带有进度条的上传功能,结合完整实例形式分析了springboot带进度条上传的原理、实现步骤与相关操作技巧,需要的朋友可以参考下
2019-11-11
Spring Boot实现跨域访问实现代码
本文通过实例代码给大家介绍了Spring Boot实现跨域访问的知识，然后在文中给大家介绍了spring boot 服务器端设置允许跨域访问的方法，感兴趣的朋友一起看看吧
2017-07-07
利用Java如何获取Mybatis动态生成的sql接口实现
MyBatis 的强大特性之一便是它的动态SQL,下面这篇文章主要给大家介绍了关于利用Java如何获取Mybatis动态生成的sql接口实现的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2022-01-01
Java Swing JCheckBox复选框的实现方法
这篇文章主要介绍了Java Swing JCheckBox复选框的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-12-12
JAVA实现读取txt文件内容的方法
本篇文章主要介绍了JAVA实现读取txt文件内容的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-01-01