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

相关文章

  • 手动添加jar包进Maven本地库内的方法

    手动添加jar包进Maven本地库内的方法

    这篇文章主要介绍了手动添加jar包进Maven本地库内的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • 详解Spring Security 简单配置

    详解Spring Security 简单配置

    本篇文章主要介绍了详解Spring Security 简单配置,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05
  • JavaSE学习之内部类及常用API

    JavaSE学习之内部类及常用API

    这篇文章主要介绍了JavaSE中的内部类和几个常用的API,文中的示例代码介绍详细,对我们学习JavaSEI有一定的帮助,感兴趣的小伙伴可以跟随小编一起学习一下
    2021-12-12
  • Java实现二分查找BinarySearch算法

    Java实现二分查找BinarySearch算法

    这篇文章主要介绍了Java实现二分查找BinarySearch算法,二分查找针对的是一个有序的数据集合,每次都通过跟区间的中间元素对比,将待查找的区间缩小为之前的一半,直到找到要查找的元素,或者区间被缩小为 0,需要的朋友可以参考下
    2023-12-12
  • dockerfile-maven-plugin极简教程(推荐)

    dockerfile-maven-plugin极简教程(推荐)

    这篇文章主要介绍了dockerfile-maven-plugin极简教程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-10-10
  • Spring Boot全局异常处理与日志监控全解析

    Spring Boot全局异常处理与日志监控全解析

    本文给大家介绍Spring Boot全局异常处理与日志监控全解析,通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2025-08-08
  • 详解Java SSM项目部署上线配置方法(阿里云服务器ECS + 云数据库RDS MySQL)(宝塔)

    详解Java SSM项目部署上线配置方法(阿里云服务器ECS + 云数据库RDS MySQL)(宝塔)

    这篇文章主要介绍了Java SSM项目部署上线(阿里云服务器ECS + 云数据库RDS MySQL)(宝塔)的图文教程,本文通过图文并茂的形式给大家介绍的非常详细,感兴趣的朋友一起看看吧
    2024-01-01
  • 前端dist包放到后端springboot项目下一起打包图文教程

    前端dist包放到后端springboot项目下一起打包图文教程

    这篇文章主要介绍了前端dist包放到后端springboot项目下一起打包的相关资料,具体步骤包括前端打包、将前端文件复制到后端项目的static目录、后端打包、验证部署成功等,需要的朋友可以参考下
    2025-01-01
  • Spring Security6.3.x的使用指南与注意事项

    Spring Security6.3.x的使用指南与注意事项

    Spring Security 6.3.1基于现代化架构,提供简洁配置、增强默认安全性和OAuth2.1/OIDC支持,采用LambdaDSL和组件化设计,涵盖用户认证、方法级权限控制及资源服务器配置,强调PasswordEncoder、HTTPS、CSRF保护等最佳实践,下面是Spring Security 6.3.1 的使用指南,一起学习吧
    2025-08-08
  • SpringBoot实现防篡改防重放的操作步骤

    SpringBoot实现防篡改防重放的操作步骤

    你的SpringBoot接口还在“裸奔”吗?或者想让接口像“钢铁侠战衣”一样防篡改、防重放?今天,我们将用5个“超能力”技巧,手把手教你实现接口安全加固,彻底告别“抓包改参数”和“重放攻击”,需要的朋友可以参考下
    2025-07-07

最新评论