SpringBoot --条件注解与属性绑定

1. 条件注解

如果注解指定的条件成立,则触发指定行为。在前文介绍自动配置机制时,也可以看到在SpringBoot的源码中使用了该注解。

常用的条件注解主要有以下四个:

  • @ConditionalOnClass:如果类路径中存在这个类,则触发指定行为
  • @ConditionalOnMissingClass:如果类路径中不存在这个类,则触发指定行为
  • @ConditionalOnBean:如果容器中存在这个Bean(组件),则触发指定行为
  • @ConditionalOnMissingBean:如果容器中不存在这个Bean(组件),则触发指定行为

在注解中,也可以设置属性值来完善判断条件。例如:@ConditionalOnBean(value=组件类型,name=组件名字):判断容器中是否有这个类型的组件,并且名字是指定的值。

2. 属性绑定

与条件注解类似,在自动配置机制中,SpringBoot也使用到了相关注解。这里就对属性绑定进行介绍。

@ConfigurationProperties注解可以声明组件的属性和配置文件哪些前缀开始项进行绑定。假如我们自己定义了一个配置类,需要获取到配置文件中指定前缀下的配置值,那么我们就可以在配置类上声明该注解,并在注解中指定配置前缀,配置类中的属性值就会与配置文件中大哥配置一一绑定。

由于SpringBoot 默认只扫描自己主程序所在的包,如果导入第三方包,即使组件上标注了 @Component@ConfigurationProperties 注解也没用,因为组件扫描不到。那么,如果要使第三方包的属性绑定生效,我们该怎么做呢?

可以使用@EnableConfigurationProperties快速注册注解,在注解中声明第三方包中属性绑定的属性类,这样该属性类就可以和配置文件进行绑定。

总结

  • 如果我们要将容器中自己编写的任意组件(Bean)的属性值和配置文件的配置项的值进行绑定:
    • 给容器中注册组件(@Component、@Bean)
    • 使用@ConfigurationProperties 声明组件和配置文件的哪些配置项进行绑定
  • 如果我们要激活第三方包的属性绑定(第三方已经使用@ConfigurationProperties 声明组件和配置文件的哪些配置项进行绑定):
    • 使用@EnableConfigurationProperties
相关推荐
码事漫谈20 小时前
移动语义的里里外外:从 std::move 的幻象到性能的现实
后端
武子康20 小时前
大数据-99 Spark Streaming 数据源全面总结:原理、应用 文件流、Socket、RDD队列流
大数据·后端·spark
双向3320 小时前
CI/CD 实战:GitHub Actions 自动化部署 Spring Boot 项目
后端
shark_chili20 小时前
从入门到精通:Linux系统性能问题定位与解决方案大全
后端
bobz96520 小时前
OVS-DOCA 符合 vDPA 设计
后端
bobz96520 小时前
OVS-DOCA 和 VPP-DPDK 对比
后端
阿杆20 小时前
同事嫌参数校验太丑,我直接掏出了更优雅的 SpEL Validator
java·spring boot·后端
无奈何杨21 小时前
CoolGuard增加枚举字段支持,条件编辑优化,展望指标取值不同
前端·后端
这里有鱼汤21 小时前
小白必看:QMT里的miniQMT入门教程
后端·python
brzhang21 小时前
当AI接管80%的执行,你“不可替代”的价值,藏在这20%里
前端·后端·架构