Spring 注解 @ConfigurationProperties 工作原理

最新推荐文章于 2025-02-19 08:36:30 发布
原创 最新推荐文章于 2025-02-19 08:36:30 发布 · 3.8k 阅读 · 2 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文解析了@ConfigurationProperties注解的使用方式及原理，详细介绍了如何通过该注解将外部配置属性绑定到Spring Boot应用的配置属性对象上，实现配置的灵活管理和注入。

概述

注解@ConfigurationProperties的使用举例 :

@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
// ServerProperties 是一个配置属性对象，会以一个bean的形式注册到容器
public class ServerProperties {

	/**
	 * Server HTTP port.
	 */
	private Integer port;

	/**
	 * Network address to which the server should bind.
	 */
	private InetAddress address;
	
	//	...
}

当在一个bean组件上使用了@ConfigurationProperties注解时，指定的配置属性将会被设置到该bean。这一注解背后的工作机制，主要是由框架通过BeanPostProcessor ConfigurationPropertiesBindingPostProcessor来完成的。ConfigurationPropertiesBindingPostProcessor的作用是绑定PropertySources到@ConfigurationProperties注解的bean实例。这是一个框架内部工具，在实例化每一个bean时，框架会使用它将@ConfigurationProperties注解中指定前缀的外部配置属性项加载进来设置到bean相应的属性上。这里的PropertySources能够从上下文中的Environment对象获取外部配置属性项。

针对上面ServerProperties配置属性对象的例子，可以认为ConfigurationPropertiesBindingPostProcessor的效果是:

  • 输入 : ServerProperties配置属性对象，属性值尚未填充
  • 处理 : ConfigurationPropertiesBindingPostProcessor获取@ConfigurationProperties注解中prefix值，也就是server,获取外部配置文件中前缀为server的配置项，设置ServerProperties配置属性对象对应的成员变量
  • 输出 : ServerProperties配置属性对象，属性值已经填充 (其实就是输入对象，不过属性被填充)

关于 ConfigurationPropertiesBindingPostProcessor更进一步的工作原理，可以参考以下分析 :
Spring BeanPostProcessor : ConfigurationPropertiesBindingPostProcessor

参考文章

Springboot Servlet Web 项目中内置BeanPostProcessor清单
Spring BeanPostProcessor : ConfigurationPropertiesBindingPostProcessor

@ConfigurationProperties(prefix = ““)来绑定属性
蔡定努
09-16 2万+
application.yml： person: lastName: 张三 #属性 age: 27 #属性 boss: false #属性 birth: 2011/12/15 #属性 # maps: {job: 医生,gender: 男} maps: #map job: 医生 gender: 男 lists: #list ...
@ConfigurationProperties 注解完全指南-从入门到精通 Spring 配置属性绑定
最新发布
2401_89221704的博客
10-08 695
是 Spring Boot 配置属性绑定的核心注解。通过prefix参数实现类型安全的配置管理，告别硬编码，拥抱灵活配置！🚀// Getter 和 Setter public CustomEnum getStatus() { return status;
SpringBoot 源码分析 - @ConfigurationProperties原理
qq_33240556的博客
07-19 741
是Spring Boot提供的一种简化配置属性绑定的注解，允许你将配置文件中的属性批量绑定到一个Bean的字段上。下面是对。
@ConfigurationProperties 注解原理
爱琴孩的博客
06-18 2394
注解是 SpringBoot 提供的一种更加便捷来处理配置文件中的属性值的方式，可以通过自动绑定和类型转换等机制，将指定前缀的属性集合自动绑定到一个Bean对象上。
@ConfigurationProperties注解的工作原理
追逐消失的记忆
11-22 2970
@ConfigurationProperties是springboot新加入的注解，主要用于配置文件中的指定键值对映射到一个java实体类上。那么它是怎么发挥作用的呢？下面我们将揭开@ConfigurationProperties的魔法。 1 概述 ConfigurationPropertiesBindingPostProcessor这个bean后置处理器，就是来处理bean属性的绑定的，这个bean后置处理器后文将称之为properties后置处理器。你需要知道以下几件事： ioc容器context的e
springboot中@ConfigurationProperties注解的工作原理
gs_albb的博客
12-21 2万+
@ConfigurationProperties是springboot新加入的注解，主要用于配置文件中的指定键值对映射到一个java实体类上。那么它是怎么发挥作用的呢？下面我们将揭开@ConfigurationProperties的魔法。 参考文章 spring boot 源码解析13-@ConfigurationProperties是如何生效的 https://blog.youkuaiyun.com/q...
深入解析Spring Boot中的@ConfigurationProperties注解
web15185420056的博客
12-06 1847
是Spring Boot提供的一个注解，用于将外部配置属性绑定到Java对象上。通过使用这个注解，开发者可以将配置文件（如或）中的属性值自动映射到Java类的字段上，从而实现配置的集中管理和类型安全。首先，定义一个Java类，用于绑定配置属性。使用注解标记该类，并指定前缀（prefix）。@Component：指定配置属性的前缀为app。@Component：将该类注册为Spring Bean，使其可以被Spring容器管理。
Spring Boot技术知识点：如何理解@ConfigurationProperties注解
06-20
下面将详细介绍`@ConfigurationProperties`的使用方法、工作原理以及相关知识点。 1. **使用场景** - 当我们需要从配置文件中读取大量相关的属性时，如数据库连接信息、邮件服务器配置等。 - 需要将配置参数与...
Spring注解篇：@ConfigurationProperties详解！
喵手的博客
02-19 2668
在Spring Boot框架中，注解提供了一种将外部配置（如application.properties或application.yml文件中的属性）绑定到Java对象的便捷方式。这种机制简化了配置管理，使得配置的变更更加灵活和动态。本文将详细介绍注解的使用方法、工作原理以及在实际开发中的应用。通过深入的源码解析、丰富的使用案例和场景分析，以及对优缺点的全面考量，读者将能够深入理解的实用性和灵活性。注解用于将配置文件中的属性绑定到一个组件的Bean上。它通常与@Component@Service或。
@ConfigurationProperties & @EnableConfigurationProperties 注解
Bananaaay的博客
09-16 4542
本文对@ConfigurationProperties以及@EnableConfigurationProperties实现绑定外部属性的方式和实现原理进行学习总结。文章如有错误，欢迎指正，一起沟通学习！如果你想要绑定和验证一些外部属性(例如，从Propertiesyamlyml文件)，和@Value是其中两个常用的注解用来外部化和注入配置属性。通过@import完成的引入中主要完成及的引入完成标注的类的查找并组装成加入registry,如果其指定的是构造器绑定，也会在这一步完成。完成及引入。
Spring Boot源码之旅五十@ConfigurationProperties原理一
smart_an的专栏
03-29 1171
作者简介：大家好，我是哥，前中兴通讯、美团架构师，现某互联网公司联系qq：184480602，加我进群，大家一起学习，一起进步，一起对抗互联网寒冬学习必须往深处挖，挖的越深，基础越扎实！
configurationproperties_Spring Boot中@ConfigurationProperties注解实现原理源码解析
weixin_39926311的博客
11-27 385
0. 开源项目推荐Pepper Metrics是我与同事开发的一个开源工具(https://github.com/zrbcool/pepper-metrics)，其通过收集jedis/mybatis/httpservlet/dubbo/motan的运行性能统计，并暴露成prometheus等主流时序数据库兼容数据，通过grafana展示趋势。其插件化的架构也非常方便使用者扩展并集成其他开源组件。 ...
@ConfigurationProperties原理浅析
随笔
06-10 933
背景 用springboot开发总会涉及Properties的处理，@ConfigurationProperties这个注解就是用来处理配置文件到属性类的映射问题的，用起来挺简单的，但是到底咋回事一直也没去了解过，现在看看到底怎么一回事。 试水 还是先放上一段代码好说话。 //pom <dependency> <groupId>org.springframework.boot</groupId> <artifactId>sp...
Spring Boot中@ConfigurationProperties注解实现原理源码解析
aizhexi1884的博客
09-26 327
0. 开源项目推荐 Pepper Metrics是我与同事开发的一个开源工具(https://github.com/zrbcool/pepper-metrics)，其通过收集jedis/mybatis/httpservlet/dubbo/motan的运行性能统计，并暴露成prometheus等主流时序数据库兼容数据，通过grafana展示趋势。其插件化的架构也非常方便使用者扩展并集成其他...
Spring Boot @ConfigurationProperties（原理三）
qq_32868023的博客
03-19 1305
Binder负责对一个Bindable进行绑定，一个Bindable的属性可能是一个java对象、数组、集合、Map等各种情况，需要递归的去绑定java对象的属性，数组、集合、Map的元素，其流程简单来说就是：从配置属性源中获取到对应的值，将这个值转化为所需要的类型。本节主要分析下属性绑定过程中配置值获取的过程，主要涉及ConfigurationPropertyName、ConfigurationProperty、ConfigurationPropertySource、值获取的过程
@ConfigurationProperties注解原理与实战
热门推荐
大宇的博客，欢迎访问
03-29 7万+
一、@ConfigurationProperties 基本使用 在 SpringBoot 中，当想需要获取到配置文件数据时，除了可以用 Spring 自带的 @Value 注解外，SpringBoot 还提供了一种更加方便的方式：@ConfigurationProperties。只要在 Bean 上添加上了这个注解，指定好配置文件的前缀，那么对应的配置文件数据就会自动填充到 Be......
ConfigurationProperties配置文件原理
qq992519778的博客
06-20 582
ConfigurationProperties配置文件原理ConfigurationProperties配置原理 ConfigurationProperties配置原理 我们知道@EnableConfigurationProperties和@ConfigurationProperties的注解是配合使用的。那么我们分别分析下这两个注解的作用。 @EnableConfigurationProperties @Target(ElementType.TYPE) @Retention(RetentionPolicy
Spring Boot @ConfigurationProperties（原理五）
qq_32868023的博客
03-20 853
Binder负责对一个Bindable进行绑定，一个Bindable的属性可能是一个java对象、数组、集合、Map等各种情况，需要递归的去绑定java对象的属性，数组、集合、Map的元素，其流程简单来说就是：从配置属性源中获取到对应的值，将这个值转化为所需要的类型。本节主要分析下Binder的绑定逻辑和绑定上下文Context
@ConfigurationProperties 实现原理
03-02
### Spring Framework `@ConfigurationProperties` 注解实现机制 #### 配置属性绑定过程 当使用 `@ConfigurationProperties` 注解时，Spring Boot 提供了一种便捷的方式来将外部配置文件中的属性批量注入到 Java 对象中。此功能依赖于松散绑定的特性来匹配环境变量或应用属性文件中的键值对[^1]。 对于带有 `@ConfigurationProperties` 的类而言，在实例化过程中会触发一系列事件用于解析并填充对象字段： - **元数据收集**：通过反射获取目标类及其父类声明的所有字段信息； - **条件判断**：验证这些字段上是否存在其他限定符（如校验约束），以及它们是否满足特定条件； - **转换服务调用**：利用内置或自定义 Converter 将字符串形式的数据转化为实际所需类型； - **最终赋值操作**：完成从配置源读取过来的内容向 Bean 属性的成功映射。 ```java import org.springframework.boot.context.properties.ConfigurationProperties; import javax.validation.constraints.NotNull; @ConfigurationProperties(prefix = "app.datasource") public class DataSourceProperties { @NotNull private String url; public void setUrl(String url) { this.url = url; } // getters... } ``` 上述代码片段展示了如何创建一个简单的 `DataSourceProperties` 类，并指定其前缀为 `"app.datasource"`。这意味着所有以该字符串开头的应用程序配置项都将被自动加载到这里面对应的成员变量里去[^3]。 #### 表达式支持与复杂场景处理 除了基本类型的直接映射外，还允许开发者借助 SpEL (Spring Expression Language) 来构建更加灵活多变的表达逻辑。例如可以动态计算某些默认值或者基于上下文做出不同响应等行为。 ```properties app.datasource.url=jdbc:mysql://${MYSQL_HOST:localhost}:3306/mydb?useSSL=false&serverTimezone=UTC ``` 这里 `${}` 语法表示如果存在名为 MYSQL_HOST 的系统属性则采用之；否则回退至 localhost 这一固定地址作为数据库连接串的一部分参数。 #### 自动装配与其他组件协作 为了使此类配置能够生效，通常还需要配合 `@EnableConfigurationProperties` 或者直接标注在主应用程序启动入口处以便让容器识别并管理起来。另外值得注意的是，虽然两者都涉及到外部化配置的概念，但是区别在于 `@Value` 是面向单个属性逐个注入的方式工作，而 `@ConfigurationProperties` 则更倾向于整体性的封装和维护一组关联紧密的相关设置集合[^4]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值