剖析Spring Boot配置文件合并机制，揭秘List合并方案

2023-09-21 18:47:40

Spring Boot提供了多种方式加载配置文件，其中一种重要的特性是配置文件的叠加与合并能力。通过这种方式，不同环境或层级的配置可以被正确地应用到应用程序中。本文将重点探讨如何在Spring Boot中实现List属性的有效合并。

配置文件的层级关系与合并机制

Spring Boot支持多种配置文件来源，如application.properties, bootstrap.yml, application-dev.yml等。这些配置文件按优先级加载和覆盖，最终形成一个完整的配置集。对于大部分非集合类型的属性，这种叠加机制工作得相当好；但对于List这样的集合类型，由于缺乏明确的合并策略，默认行为可能会导致意料之外的结果。

List合并问题分析

当两个或多个配置文件都包含相同的List属性时，Spring Boot并不会自动进行列表内容上的合并。相反，它会使用最后加载的那个配置值来覆盖之前的所有值。这就可能导致部分配置信息丢失或被错误地替代。

示例场景

考虑以下两份配置文件：

application.properties
```
myApp.features=feature1,feature2
```
application-dev.properties
```
myApp.features=feature3
```

在这个例子中，myApp.features属性在开发环境下将只有feature3，而原本的feature1和feature2信息完全丢失。

解决方案与实现

使用@ConfigurationProperties注解

Spring Boot提供了@ConfigurationProperties注解，允许开发者自定义配置文件属性映射到Java对象的方式。通过这种方式，我们可以更好地控制属性合并行为。

示例代码

首先，定义一个包含List字段的Java类，并使用@ConfigurationProperties进行标记：

@ConfigurationProperties(prefix = "myApp")
public class MyAppConfig {
    private List<String> features;

    public void setFeatures(List<String> features) {
        this.features = features;
    }

    public List<String> getFeatures() {
        return features;
    }
}

然后，在Spring Boot的配置类中启用这个属性绑定：

@Configuration
@EnableConfigurationProperties(MyAppConfig.class)
public class MyAppConfigClass {
    
}

通过这种方式，我们可以手动控制列表元素的添加与合并逻辑。

实现自定义MergeStrategy

对于更加复杂的List属性合并需求，可以考虑实现Spring Boot提供的MergeStrategy接口。这个接口允许开发者在配置加载过程中插入自定义的属性合并策略。

示例代码

下面是一个简单的自定义合并策略示例：

@Component
public class ListMergeStrategy implements MergeStrategy {

    @Override
    public Object merge(String key, Object sourceValue, Object targetValue) {
        if (targetValue instanceof Collection && sourceValue != null) {
            Collection<String> collection = new LinkedList<>((Collection<String>) targetValue);
            ((List<String>)sourceValue).forEach(collection::add);
            return collection;
        }
        return sourceValue;
    }

    @Override
    public boolean supports(Object source, Object target) {
        return target instanceof Collection && !(target instanceof Map) && source != null;
    }
}