SpringBoot使用@ConstructorBinding注解进行配置属性绑定
SpringBoot2.2
版本发行后一些新的功能也渐渐的浮出了水面,在之前版本SpringBoot
的配置文件与类之间的属性绑定(@ConfigurationProperties
)是通过Setter
方法来进行绑定对应的配置值,而从2.2
版本开始支持了构造函数
的方式进行绑定。
@ConstructorBinding注解
这个注解是SpringBoot
在2.2发行版中添加的,添加该注解的属性配置类不再需要添加Setter
方法,不过需要添加构造函数
,根据构造函数进行实例化属性配置类。
创建项目
使用IDEA创建一个SpringBoot
项目,在pom.xml
中添加依赖如下所示:
1 | <dependencies> |
配置信息
本章主要是讲解怎么把application.yml
或者application.properties
配置文件的内容自动映射绑定到配置类的对应属性字段上,所以我们需要在application.yml
文件中添加部分我们自定义的配置内容,如下所示:
1 | # 自定义配置 |
配置类
我们对应application.yml
的配置信息,对应编写一个名为MinBoxConfig
的映射配置类,如下所示:
1 |
|
在之前的版本我们都是使用@Configuration
、@ConfigurationProperties
这两个注解来进行配置映射,从SpringBoot2.2.1.RELEASE
版本开始我们不再需要添加@Configuration
,只要通过@ConfigurationPropertiesScan
结合@ConfigurationProperties
搭配使用即可,会自动扫描指定package
下的属性配置类进行绑定。
在属性配置类上添加@ConstructorBinding
注解,即可实现构造函数的方式进行对应字段设置值,我们只需要把绑定赋值的参数通过构造函数的方式定义。
在上面代码中
MinBoxConfig
配置类构造函数内有两个参数:author
、blogAddress
,所以在实例化MinBoxConfig
对象时,只会从application.yml
对应获取到这两个配置内容进行赋值。
运行测试
使用IDEA
创建项目时会自动在src/test/java/{packages}
创建@SpringBootTest
注解的测试类,我们通过测试类来验证配置是否已经赋值给了配置类,如下所示:
1 |
|
运行printConfig()
方法后输出内容如下所示:
1 | 作者名称:恒宇少年 - 于起宇 |
敲黑板,划重点
@ConfigurationProperties
这个注解可以让我们的配置文件的内容直接映射到Java
配置类,而且通过扫描的方式自动注册到IOC
,极大地方便了我们在项目中使用配置内容。
代码示例
如果您喜欢本篇文章请为源码仓库点个Star
,谢谢!!!
本篇文章示例源码可以通过以下途径获取,源码分支为2.x
,目录为springboot-constructor-binding-properties
:
SpringBoot使用@ConstructorBinding注解进行配置属性绑定
https://blog.minbox.org/springboot-constructor-binding-properties.html