专栏首页SpringBoot 核心技术SpringBoot使用@ConstructorBinding注解进行配置属性绑定

SpringBoot使用@ConstructorBinding注解进行配置属性绑定

SpringBoot2.2版本发行后一些新的功能也渐渐的浮出了水面,在之前版本SpringBoot的配置文件与类之间的属性绑定(@ConfigurationProperties)是通过Setter方法来进行绑定对应的配置值,而从2.2版本开始支持了构造函数的方式进行绑定。

免费教程专题

恒宇少年在博客整理三套免费学习教程专题,由于文章偏多特意添加了阅读指南,新文章以及之前的文章都会在专题内陆续填充,希望可以帮助大家解惑更多知识点。

博客原文:http://blog.yuqiyu.com/springboot-constructor-binding-properties.html

@ConstructorBinding注解

这个注解是SpringBoot在2.2发行版中添加的,添加该注解的属性配置类不再需要添加Setter方法,不过需要添加构造函数,根据构造函数进行实例化属性配置类。

创建项目

使用IDEA创建一个SpringBoot项目,在pom.xml中添加依赖如下所示:

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
  </dependency>

  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
    <exclusions>
      <exclusion>
        <groupId>org.junit.vintage</groupId>
        <artifactId>junit-vintage-engine</artifactId>
      </exclusion>
    </exclusions>
  </dependency>
</dependencies>

配置信息

本章主要是讲解怎么把application.yml或者application.properties配置文件的内容自动映射绑定到配置类的对应属性字段上,所以我们需要在application.yml文件中添加部分我们自定义的配置内容,如下所示:

# 自定义配置
minbox:
  config:
    author: 恒宇少年 - 于起宇
    blog-address: http://blog.yuqiyu.com

配置类

我们对应application.yml的配置信息,对应编写一个名为MinBoxConfig的映射配置类,如下所示:

/**
 * 配置类
 *
 * @author 恒宇少年
 */
@ConfigurationProperties(prefix = PREFIX)
@ConstructorBinding
public class MinBoxConfig {
    /**
     * 映射绑定 "minbox.config"前缀的配置信息
     */
    public static final String PREFIX = "minbox.config";
    /**
     * 配置信息:作者
     */
    private String author;
    /**
     * 配置信息:博客地址
     */
    private String blogAddress;

    public MinBoxConfig(String author, String blogAddress) {
        this.author = author;
        this.blogAddress = blogAddress;
    }

    public String getAuthor() {
        return author;
    }

    public String getBlogAddress() {
        return blogAddress;
    }
}

在之前的版本我们都是使用@Configuration@ConfigurationProperties这两个注解来进行配置映射,从SpringBoot2.2.1.RELEASE版本开始我们不再需要添加@Configuration,只要通过@ConfigurationPropertiesScan结合@ConfigurationProperties搭配使用即可,会自动扫描指定package下的属性配置类进行绑定。

在属性配置类上添加@ConstructorBinding注解,即可实现构造函数的方式进行对应字段设置值,我们只需要把绑定赋值的参数通过构造函数的方式定义。

在上面代码中MinBoxConfig配置类构造函数内有两个参数:authorblogAddress,所以在实例化MinBoxConfig对象时,只会从application.yml对应获取到这两个配置内容进行赋值。

运行测试

使用IDEA创建项目时会自动在src/test/java/{packages}创建@SpringBootTest注解的测试类,我们通过测试类来验证配置是否已经赋值给了配置类,如下所示:

@SpringBootTest
class SpringbootConstructorBindingPropertiesApplicationTests {

    @Autowired
    private MinBoxConfig minBoxConfig;

    @Test
    void printConfig() {
        System.out.println("作者名称:" + minBoxConfig.getAuthor());
        System.out.println("作者博客地址:" + minBoxConfig.getBlogAddress());
    }

}

运行printConfig()方法后输出内容如下所示:

作者名称:恒宇少年 - 于起宇
作者博客地址:http://blog.yuqiyu.com

敲黑板,划重点

@ConfigurationProperties这个注解可以让我们的配置文件的内容直接映射到Java配置类,而且通过扫描的方式自动注册到IOC,极大地方便了我们在项目中使用配置内容。

代码示例

如果您喜欢本篇文章请为源码仓库点个Star,谢谢!!! 本篇文章示例源码可以通过以下途径获取,目录为SpringBoot2.x/springboot-constructor-binding-properties

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • SpringBoot2.x基础篇:谈谈SpringBoot内提供的这几种配置绑定

    SpringBoot在不断地版本迭代中陆续提供了不同的配置参数绑定的方式,我们可以单独获取一个配置参数也可以将一系列的配置映射绑定到JavaBean的属性字段,...

    恒宇少年
  • 第三十七章:基于SpringBoot架构以及参数装载完成接口安全认证

    恒宇少年
  • ApiBoot DataSource Switch 使用文档

    ApiBoot是一款基于SpringBoot1.x,2.x的接口服务集成基础框架, 内部提供了框架的封装集成、使用扩展、自动化完成配置,让接口开...

    恒宇少年
  • 分割中英文,并且中文不能分割一半?

    题目:编写一个截取字符串的函数,输入为一个字符串和字节数,输出为按字节截取的字符串。但是要保证汉字不被截半个,如“我ABC”4,应该截为“我AB”,输入“我AB...

    格姗知识圈
  • 写给大忙人的Flink的Data Types

    二、Flink 是如何处理 Data Type 的 首先Flink会根据自身的序列化器进行序列化,如果不行,则默认回退到 Kryo 序列化器进行序列化。

    shengjk1
  • 快速入门Flink (9) —— DataStream API 开发之【Time 与 Window】

    Event Time:是事件创建的时间。它通常由事件中的时间戳描述,例如采集的日志数据中, 每一条日志都会记录自己的生成时间,Flink 通过时间戳分配器访问事...

    公众号-猿人菌
  • 用 C# 开发自己的语音识别程序

    3、在控制台点击“百度语音”服务,点击“创建应用”,填写必填项,勾选额外接口,点击立即创建获取秘钥。在应用列表中查看自己的id

    prepared
  • Newbe.Mahua 1.15 支持发送语音

    很遗憾,我们带来了一个没有彩蛋的版本更新。该版本增加了发送语音的接口,并改进了项目模板,修复了一些Bug。在此感谢LollipopGeneral 的 PR。

    newbe36524
  • 数据团队规划布局感悟(三)

    今天重点讲讲我对感悟(一)中提及的“解决方案设计团队”的看法。其实这个名字是我瞎起的,对应的是大家熟知的“算法团队”或者“机器学习团队”。

    用户2936994
  • VIE结构下的期权探析

    对于期权,大家对他或许是既期待又怀疑,一方面,阿里等大牌公司上市后,大量握有期权的员工都成了百万富翁,千万富翁。另一方面,上市后有些公司的期权价值被稀释,不如B...

    java达人

扫码关注云+社区

领取腾讯云代金券