Spring Boot中如何自定义属性配置

在 Spring Boot 中，自定义属性配置是一种常见的需求。通过定义自定义的属性文件（例如 application.properties 或 application.yml），你可以灵活地配置应用的各种参数，并且通过 Spring Boot 提供的功能，轻松地将这些配置映射到 Java 类中。

以下是如何在 Spring Boot 中自定义属性配置的步骤及代码示例。

步骤 1: 创建自定义配置属性文件

通常情况下，我们使用 application.properties 或 application.yml 文件来定义配置项。假设我们在 application.properties 文件中定义一个自定义属性：

application.properties

app.custom.name=MySpringBootApp
app.custom.version=1.0.0
app.custom.enableFeature=true

步骤 2: 创建 Java 类映射配置

Spring Boot 提供了一个非常方便的方式来将配置文件中的属性绑定到 Java 类中。为此，我们需要创建一个 @ConfigurationProperties 注解的类，这个类将自动绑定 application.properties 中的属性。

CustomConfig.java

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

@Component
@ConfigurationProperties(prefix = "app.custom")
public class CustomConfig {

    private String name;
    private String version;
    private boolean enableFeature;

    // Getter and Setter

    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 boolean isEnableFeature() {
        return enableFeature;
    }

    public void setEnableFeature(boolean enableFeature) {
        this.enableFeature = enableFeature;
    }
}

• @ConfigurationProperties：表示该类是一个配置属性类，并且通过 prefix 属性指定要映射的配置文件前缀（例如这里是 app.custom）。
• @Component：将该类注册为 Spring Bean，以便在其他类中可以注入使用。

步骤 3: 启用配置属性扫描

要使得 @ConfigurationProperties 起作用，我们需要在启动类或其他配置类上添加 @EnableConfigurationProperties 注解。虽然 @SpringBootApplication 注解已经包含了 @EnableAutoConfiguration，但为了确保自定义配置类能够正常加载，建议手动启用。

Application.java

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

@SpringBootApplication
@EnableConfigurationProperties(CustomConfig.class)  // 启用自定义配置属性类
public class Application {

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

步骤 4: 使用自定义配置属性

一旦配置类成功加载，我们可以在任何需要的地方注入 CustomConfig 类并使用它的配置属性。

SomeService.java

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

@Service
public class SomeService {

    private final CustomConfig customConfig;

    @Autowired
    public SomeService(CustomConfig customConfig) {
        this.customConfig = customConfig;
    }

    public void printCustomConfig() {
        System.out.println("App Name: " + customConfig.getName());
        System.out.println("App Version: " + customConfig.getVersion());
        System.out.println("Is Feature Enabled: " + customConfig.isEnableFeature());
    }
}

步骤 5: 启动应用并查看结果

当你启动 Spring Boot 应用时，Spring 会自动加载 application.properties 文件中的自定义配置，并将这些值注入到 CustomConfig 类中。你可以通过调用 SomeService.printCustomConfig() 方法来验证这些值。

总结

1. 在 application.properties 或 application.yml 文件中定义自定义的配置属性。
2. 创建一个 Java 类，通过 @ConfigurationProperties 注解将配置文件中的属性映射到类的字段中。
3. 使用 @EnableConfigurationProperties 启用自定义的配置类（或者通过 @SpringBootApplication 自动启用）。
4. 在需要的地方通过 @Autowired 注入配置类，获取配置值。

这种方式非常方便，尤其适用于管理大量的配置项，且这些配置项需要在多个地方使用的场景。