「Spring」@ConfigurationProperties——从基础到源码，收藏起来

0. 阅读完本文你将会

• 使用@ConfigurationProperties从配置文件中获取属性
• 自定义属性转换器
• 了解@ConfigurationProperties与@Value的区别
• 探究@ConfigurationProperties背后的源码运作

1. 前言

我们使用Spring框架的时候，经常会从配置文件中获取配置属性，比如发送邮件的时候，需要获取收发件人以及邮箱服务器地址和端口号。

那么本文将会介绍如何获取配置属性这样的小知识点，并做一定的延伸。

2. 基础

2.1 准备工作

我们先在pom.xml中添加以下依赖项：

1. spring-boot-starter-parent

<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.6.7</version>
		<relativePath/>
</parent>
复制代码

2. spring-boot-starter-validation

用来验证定义的属性。

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

复制代码

2.2 定义配置类

官方文档建议我们最好将需要定义的属性分离出来，放在单独的POJO类里。

下面我们开始定义一个配置类：

package com.jay.mydemo.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConfigurationProperties(prefix = "mail")
public class MailConfigProperties {

    private String hostName;
    private int port;
    private String from;

    // default getters and setters
}

复制代码

我们使用了@Configuration，这样Spring就会在应用上下文中创建一个对应的Spring Bean。如果我们不使用这个注解，也可以在Application类中添加以下注解。

@EnableConfigurationProperties(MailConfigProperties.class)
复制代码

@ConfigurationProperties中定义了前缀mail。Spring会自动将POJO类与属性文件中前缀为mail的属性绑定。

Spring对绑定的属性比较宽松，比如以下的属性名都会绑到hostName上：

mail.hostName
mail.hostname
mail.host_name
mail.host-name
mail.HOST_NAME
复制代码

我们可以使用下面这个简单的属性文件来对应POJO类：

mail.hostname=smtp.163.com
mail.port=25
mail.from=jay.xu@example.com
复制代码

当然，从Spring Boot 2.2开始，我们已经不再需要使用@Component、@Configuration来注释配置类，同样也不需要@EnableConfigurationProperties。

Configuration properties scanning was enabled by default in Spring Boot 2.2.0 but as of Spring Boot 2.2.1 you must opt-in using @ConfigurationPropertiesScan.

因为Spring会通过类路径的扫描自动注册@ConfigurationProperties类。

你需要做的是在Application类中使用@ConfigurationPropertiesScan注解来扫描配置类的包地址，如：

@ConfigurationPropertiesScan("com.jay.mydemo.config")
复制代码

2.3 属性嵌套

我们创建一个MailCrendential类：

package com.jay.mydemo.config;

public class MailCrendential {

    private String username;

    private String password;

    // default getters and setters
}

复制代码

然后再更新MailConfigProperties类，在其中我们加入一个List、一个Map以及MailCrendential。

private List<String> recipients;
private Map<String, String> headers;
private MailCrendential mailCrendential;
复制代码

与此同时，我们更新application.properties：

# mail props
## basic
mail.hostname=smtp.163.com
mail.port=25
mail.from=jay.xu@example.com
## recipient list
mail.recipients[0]=recipients0@example.com
mail.recipients[1]=recipients1@example.com

## header map
mail.headers.redelivery=true
mail.headers.secure=true

## object
mail.mailCrendential.username=jayxu
mail.mailCrendential.password=password

复制代码

做到这一步，我们可以尝试创建一个测试类来打印看看配置是否无误。