面试题：如何在 Spring Boot 中定义和读取自定义配置？

在 Spring Boot 中，定义和读取自定义配置是非常常见的需求。Spring Boot 提供了多种灵活的方式来实现这一点，以下是详细的方法和步骤：

1. 定义自定义配置

自定义配置可以通过 application.properties 或 application.yml 文件定义，也可以通过环境变量或命令行参数传递。

1.1 在 `application.properties` 中定义

# 自定义配置
app.name=MyApp
app.version=1.0.0
app.description=This is a Spring Boot application

1.2 在 `application.yml` 中定义

# 自定义配置
app:
  name: MyApp
  version: 1.0.0
  description: This is a Spring Boot application

2. 读取自定义配置

Spring Boot 提供了多种方式来读取自定义配置，以下是常用的方法：

2.1 使用 `@Value` 注解

@Value 注解可以直接将配置文件中的值注入到字段或方法参数中。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyAppConfig {

    @Value("${app.name}")
    private String appName;

    @Value("${app.version}")
    private String appVersion;

    @Value("${app.description}")
    private String appDescription;

    public void printConfig() {
        System.out.println("App Name: " + appName);
        System.out.println("App Version: " + appVersion);
        System.out.println("App Description: " + appDescription);
    }
}

2.2 使用 `@ConfigurationProperties` 注解

@ConfigurationProperties 注解可以将配置文件中的属性绑定到一个 Java 对象中，适合读取多个相关配置。

2.2.1 定义配置类

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {

    private String name;
    private String version;
    private String description;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

2.2.2 使用配置类

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class MyAppService {

    private final AppConfig appConfig;

    @Autowired
    public MyAppService(AppConfig appConfig) {
        this.appConfig = appConfig;
    }

    public void printConfig() {
        System.out.println("App Name: " + appConfig.getName());
        System.out.println("App Version: " + appConfig.getVersion());
        System.out.println("App Description: " + appConfig.getDescription());
    }
}

2.3 使用 `Environment` 对象

Environment 对象可以直接读取配置文件中的属性。

import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class MyAppConfig {

    private final Environment env;

    public MyAppConfig(Environment env) {
        this.env = env;
    }

    public void printConfig() {
        System.out.println("App Name: " + env.getProperty("app.name"));
        System.out.println("App Version: " + env.getProperty("app.version"));
        System.out.println("App Description: " + env.getProperty("app.description"));
    }
}

3. 嵌套配置

如果配置是嵌套的，可以使用 . 分隔符来定义和读取。

3.1 在 `application.yml` 中定义嵌套配置

app:
  info:
    name: MyApp
    version: 1.0.0
    description: This is a Spring Boot application

3.2 读取嵌套配置

使用 @ConfigurationProperties 注解读取嵌套配置：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app.info")
public class AppInfoConfig {

    private String name;
    private String version;
    private String description;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

4. 验证配置

Spring Boot 支持使用 JSR-303 注解对配置属性进行验证。

4.1 添加依赖

在 pom.xml 中添加以下依赖：

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

4.2 在配置类中添加验证注解

import javax.validation.constraints.NotEmpty;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

@Component
@ConfigurationProperties(prefix = "app")
@Validated
public class AppConfig {

    @NotEmpty
    private String name;

    @NotEmpty
    private String version;

    private String description;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

如果配置属性不符合验证规则，Spring Boot 会启动失败并抛出异常。

5. 总结

定义自定义配置：通过 application.properties 或 application.yml 文件定义。
读取自定义配置：
- 使用 @Value 注解直接注入。
- 使用 @ConfigurationProperties 注解绑定到 Java 对象。
- 使用 Environment 对象动态读取。
嵌套配置：使用 . 分隔符定义和读取。
配置验证：使用 JSR-303 注解对配置属性进行验证。