如何在 Spring Boot 中优雅地裁剪 application.properties 属性值

2024-03-17 11:58:17

在 Spring Boot 中裁剪 application.properties 属性值

问题

在 Spring Boot 项目的 application.properties 文件中，我们经常需要裁剪某些属性值，以满足特定环境的要求。例如，如果 spring.profiles.active 的值为 preview-15，但我们只需要 preview 部分。

解决方法

裁剪 Spring Boot 中 application.properties 的属性值可以分以下几个步骤进行：

1. 使用 Spring Profiles

Spring Profiles 可以根据不同的环境配置不同的属性。对于不同的环境，我们可以使用不同的配置文件，例如 dev 和 prod。

2. 创建自定义属性转换器

为了裁剪属性值，我们可以创建一个自定义属性转换器。Spring 提供了 PropertySourcesPropertyResolver 类来注册自定义转换器。

// ProfileTrimConverter.java
@Component
public class ProfileTrimConverter implements Converter<String, String> {

    @Override
    public String convert(String source) {
        return source.substring(0, source.indexOf('-'));
    }
}

3. 注册自定义属性转换器

在 Spring Boot 主类中，我们可以注册自定义属性转换器。

// Application.java
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication app = new SpringApplication(Application.class);
        app.addInitializers((applicationContext) -> {
            PropertySourcesPropertyResolver resolver = new PropertySourcesPropertyResolver(
                    applicationContext.getEnvironment());
            resolver.registerConverter(String.class, String.class, new ProfileTrimConverter());
        });
        app.run(args);
    }
}

4. 使用 @Value 注解

现在，我们可以在需要裁剪值的类中使用 @Value 注解。

// MyBean.java
@Component
public class MyBean {

    @Value("${spring.config.import}")
    private String configImport;

    public String getConfigImport() {
        return configImport;
    }
}