Spring环境变量覆盖配置属性时出现重复条目问题

问题背景 #

在yaml中配置带连字符的Map键：

topics:
  names:
    user: topic1
    user-payment: topic2

通过@ConfigurationProperties绑定到Map<String, String>后，设置环境变量（如TOPICS_NAMES_USER_PAYMENT=topic3或TOPICS_NAMES_USERPAYMENT=topic3）会生成额外的Map条目（如user.payment或userpayment），需要消除这些无效条目。

可行解决办法 #

1. 启用特定配置类的严格绑定（推荐，Spring Boot 2.6+） #

在配置类上通过binding = Binding.STRICT禁用宽松绑定，仅匹配严格对应的键：

import org.springframework.boot.context.properties.Binding;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Map;

@Component
@ConfigurationProperties(prefix = "topics.names", binding = Binding.STRICT)
public class TopicProperties {
    private Map<String, String> names;

    // Getter & Setter
    public Map<String, String> getNames() {
        return names;
    }

    public void setNames(Map<String, String> names) {
        this.names = names;
    }
}

严格绑定模式下，只有与yaml中键命名风格完全匹配的环境变量才会生效。若无法使用TOPICS_NAMES_USER-PAYMENT这类带连字符的环境变量命名，可尝试下面的方案。

2. 手动过滤Map中的无效条目 #

在配置类的setter方法中，手动过滤掉不符合预期命名规则的键（比如只保留原始yaml中存在的键）：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.HashMap;
import java.util.Map;

@Component
@ConfigurationProperties(prefix = "topics")
public class TopicProperties {
    // 初始化时保留yaml中的原始键
    private Map<String, String> names = new HashMap<>(Map.of("user", "topic1", "user-payment", "topic2"));

    public void setNames(Map<String, String> incomingNames) {
        incomingNames.forEach((key, value) -> {
            // 仅更新原始存在的键，过滤额外生成的键
            if (names.containsKey(key)) {
                names.put(key, value);
            }
        });
    }

    public Map<String, String> getNames() {
        return names;
    }
}

这种方式会忽略所有原始Map中不存在的键，只更新已有的条目，彻底消除额外生成的无效键。

3. 全局禁用宽松绑定（不推荐） #

在application.yml中添加配置关闭全局宽松绑定，会影响所有配置类的绑定逻辑，仅在必要时使用：

spring:
  main:
    relaxed-binding-enabled: false

内容的提问来源于stack exchange，提问作者ByeBye