9. 如何在 Spring Boot 中定义和读取自定义配置？

PangHu大约 3 分钟

在 Spring Boot 中，定义和读取自定义配置非常方便。Spring Boot 提供了多种方式来定义和读取自定义的配置属性，这些配置属性可以存放在 application.properties、application.yml 文件中，或者通过外部化配置（如命令行参数、环境变量）进行配置。以下是如何在 Spring Boot 中定义和读取自定义配置的详细步骤。

1. 定义自定义配置

首先，你可以在 application.properties 或 application.yml 文件中定义自定义配置。

1.1 在 `application.properties` 中定义配置

示例：

myapp.custom.property1=value1
myapp.custom.property2=value2

1.2 在 `application.yml` 中定义配置

示例：

myapp:
  custom:
    property1: value1
    property2: value2

2. 读取自定义配置

读取自定义配置有几种常见的方式，包括使用 @Value 注解、使用 @ConfigurationProperties 注解、以及通过 Environment 对象读取。

2.1 使用 `@Value` 注解读取配置

@Value 注解是最简单的方式之一，直接在类中注入配置值。

示例：

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

@Component
public class MyAppConfig {

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

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

    // Getters and additional logic
    public String getProperty1() {
        return property1;
    }

    public String getProperty2() {
        return property2;
    }
}

2.2 使用 `@ConfigurationProperties` 注解读取配置

如果有大量的配置属性，建议使用 @ConfigurationProperties 注解将这些配置绑定到一个 POJO 中。

Step 1: 创建 POJO

示例：

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

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

    private String property1;
    private String property2;

    // Getters and Setters
    public String getProperty1() {
        return property1;
    }

    public void setProperty1(String property1) {
        this.property1 = property1;
    }

    public String getProperty2() {
        return property2;
    }

    public void setProperty2(String property2) {
        this.property2 = property2;
    }
}

Step 2: 使用 @EnableConfigurationProperties

确保在你的主类或配置类中启用了 @EnableConfigurationProperties 注解。

示例：

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);
    }
}

Step 3: 注入 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("Property 1: " + myAppProperties.getProperty1());
        System.out.println("Property 2: " + myAppProperties.getProperty2());
    }
}

2.3 使用 `Environment` 对象读取配置

Environment 是 Spring 提供的一个接口，允许从多种源读取配置属性。

示例：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class MyAppConfig {

    private final Environment environment;

    @Autowired
    public MyAppConfig(Environment environment) {
        this.environment = environment;
    }

    public void printProperties() {
        String property1 = environment.getProperty("myapp.custom.property1");
        String property2 = environment.getProperty("myapp.custom.property2");
        System.out.println("Property 1: " + property1);
        System.out.println("Property 2: " + property2);
    }
}

3. 外部化配置

Spring Boot 的强大之处在于它支持将配置外部化。这意味着你可以通过以下几种方式覆盖 application.properties 或 application.yml 中定义的配置值：

命令行参数：在启动应用时通过 --myapp.custom.property1=value 的方式传递。
环境变量：可以通过设置环境变量来覆盖配置值，例如 export MYAPP_CUSTOM_PROPERTY1=value。
外部配置文件：通过在 config 文件夹中放置配置文件或者通过 spring.config.location 指定配置文件位置。

4. 使用 Profiles 实现多环境配置

Spring Boot 允许通过 Profiles 来支持多环境配置，例如开发、测试、生产环境。可以为不同的环境创建不同的配置文件：

application-dev.properties / application-dev.yml
application-test.properties / application-test.yml
application-prod.properties / application-prod.yml

通过设置 spring.profiles.active 来选择当前激活的 Profile：

spring.profiles.active=dev

总结

定义自定义配置：在 application.properties 或 application.yml 中定义自定义配置。
读取配置：使用 @Value 注解、@ConfigurationProperties 注解或 Environment 对象读取配置。
外部化配置：通过命令行参数、环境变量或外部配置文件覆盖默认配置。
Profiles 支持：通过 Profiles 支持多环境配置，根据环境选择不同的配置文件。

通过这些方法，Spring Boot 提供了灵活、强大的配置管理能力，能够满足各种场景下的配置需求。