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

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

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

@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: https://blog.minbox.org

配置类

我们对应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()方法后输出内容如下所示:

作者名称:恒宇少年 - 于起宇
作者博客地址:https://blog.minbox.org

敲黑板,划重点

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

代码示例

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

相关文章
|
6天前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
125 73
|
1天前
|
Java Spring 容器
【SpringFramework】Spring IoC-基于注解的实现
本文主要记录基于Spring注解实现IoC容器和DI相关知识。
33 21
|
8天前
|
Java Maven Spring
SpringBoot配置跨模块扫描问题解决方案
在分布式项目中,使用Maven进行多模块开发时,某些模块(如xxx-common)没有启动类。如何将这些模块中的类注册为Spring管理的Bean对象?本文通过案例分析,介绍了两种解决方案:常规方案是通过`@SpringBootApplication(scanBasePackages)`指定扫描路径;推荐方案是保持各模块包结构一致(如com.xxx),利用SpringBoot默认扫描规则自动识别其他模块中的组件,简化配置。
SpringBoot配置跨模块扫描问题解决方案
|
6天前
|
存储 Java Spring
【Spring】获取Bean对象需要哪些注解
@Conntroller,@Service,@Repository,@Component,@Configuration,关于Bean对象的五个常用注解
|
6天前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
15天前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
63 14
|
2月前
|
缓存 IDE Java
SpringBoot入门(7)- 配置热部署devtools工具
SpringBoot入门(7)- 配置热部署devtools工具
55 1
SpringBoot入门(7)- 配置热部署devtools工具
|
2月前
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
45 4
|
2月前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
129 2
|
2月前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
56 2