18. Spring Boot中的配置属性绑定是什么？如何使用`@ConfigurationProperties`和`@Value`注解？

PangHu大约 3 分钟

在 Spring Boot 中，配置属性绑定是指将配置文件（如 application.properties 或 application.yml）中的属性自动绑定到 Java 对象或字段上，从而简化配置管理。Spring Boot 提供了两种主要方式来实现配置属性绑定：@ConfigurationProperties 注解和 @Value 注解。

1. `@ConfigurationProperties` 注解

@ConfigurationProperties 注解用于将一组相关的配置属性绑定到一个 Java 对象中。这种方式特别适合处理具有层次结构的配置属性，能够将多个相关配置绑定到一个 POJO（普通的 Java 对象）中。

1.1 使用 `@ConfigurationProperties` 注解

步骤 1：定义一个 POJO 类

创建一个 Java 类，并使用 @ConfigurationProperties 注解指定前缀。类中的字段名称应与配置文件中的属性名称相对应。

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

@Component
@ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {

    private String name;
    private int age;
    private String description;

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

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

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getDescription() {
        return description;
    }

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

步骤 2：配置文件中定义属性

在 application.properties 或 application.yml 中定义这些属性：

application.properties 示例：

myapp.name=Spring Boot Application
myapp.age=5
myapp.description=This is a demo application

application.yml 示例：

myapp:
  name: Spring Boot Application
  age: 5
  description: This is a demo application

步骤 3：使用配置属性

在 Spring Bean 中注入 MyAppProperties，然后使用这些属性：

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

@Service
public class MyAppService {

    private final MyAppProperties myAppProperties;

    @Autowired
    public MyAppService(MyAppProperties myAppProperties) {
        this.myAppProperties = myAppProperties;
    }

    public void printProperties() {
        System.out.println("Name: " + myAppProperties.getName());
        System.out.println("Age: " + myAppProperties.getAge());
        System.out.println("Description: " + myAppProperties.getDescription());
    }
}

1.2 启用 `@ConfigurationProperties` 绑定

确保你的主类或配置类上有 @EnableConfigurationProperties 注解，这样 Spring Boot 会自动扫描并注册使用了 @ConfigurationProperties 的 Bean。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

@SpringBootApplication
@EnableConfigurationProperties(MyAppProperties.class)
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

2. `@Value` 注解

@Value 注解用于将单个配置属性值直接注入到字段或方法参数中。与 @ConfigurationProperties 相比，@Value 更适合绑定单一配置属性。

2.1 使用 `@Value` 注解

示例：

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

@Component
public class MyAppConfig {

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

    @Value("${myapp.age}")
    private int age;

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

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

    public int getAge() {
        return age;
    }

    public String getDescription() {
        return description;
    }
}

在这个示例中，@Value 注解直接从配置文件中读取属性，并将它们注入到相应的字段中。

2.2 表达式支持

@Value 注解支持 SpEL（Spring 表达式语言），可以用于计算或转换属性值。

示例：

@Value("${myapp.age:25}")
private int age; // 如果 myapp.age 未配置，则使用默认值 25

@Value("#{systemProperties['user.home']}")
private String userHome; // 通过 SpEL 读取系统属性

3. `@ConfigurationProperties` vs `@Value`

用途：
- @ConfigurationProperties：适合将一组相关配置绑定到一个 Java 对象中，通常用于复杂的配置结构。
- @Value：适合绑定单个属性，适合简单的配置需求。
支持的功能：
- @ConfigurationProperties：支持嵌套属性绑定、数据验证、类型转换等高级功能。
- @Value：支持 SpEL 表达式，灵活性更高，但对于复杂结构不太适合。
性能：
- @ConfigurationProperties：性能更好，适合大量属性的绑定，因为它只在需要时初始化绑定。
- @Value：每次访问配置时都需要解析表达式，性能略低。

总结

@ConfigurationProperties：用于将一组相关配置属性绑定到一个 POJO 中，适合复杂的配置结构。通过 prefix 属性可以将配置文件中的属性映射到对象的字段上。
@Value：用于将单个配置属性绑定到字段或方法参数中，适合简单的配置需求，并支持 SpEL 表达式。

在实际应用中，建议根据具体场景选择合适的注解。如果需要绑定一组相关的配置，使用 @ConfigurationProperties 是更好的选择；如果只是需要简单地绑定单个属性，@Value 则更加方便和直接。