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
相关推荐
长栎几秒前
你写的 AI 品控规则三个月就过期——不是规则错了,是你没给它做"回归测试"
后端
snow@li几秒前
SpringBoot:AOP日志切面全景梳理/原理+流程+实战+避坑
java·开发语言·spring boot
沙湖遇雨2 分钟前
7.EventLoop 生命周期
后端
雨落倾城夏未凉4 分钟前
halcon核心-模板匹配定位(二)
后端
ma_king5 分钟前
Spring Boot 接入飞书自定义机器人
java·后端
2401_894915536 分钟前
部署 GEO 优化源码常见报错排查:端口、伪静态、缓存问题解决
java·运维·服务器·后端·缓存·开源
卷无止境6 分钟前
聊聊Web开发里的流式数据 从原理到FastAPI实战
后端·python·fastapi
Scene21610 分钟前
AgentScope 2.0:4. Message & Event —— 消息模型与事件流深度解析
后端
元界metalite10 分钟前
MyBatis 字段改名为何查询不报错?MetaLite ORM 如何做到类型安全?
后端
七牛开发者18 分钟前
Codex 实践系列 Vol.04:用 Goal 和 Plan 管住一个长任务
java·数据库·人工智能·github·copilot