java - 不同情况下具有枚举值的 ConfigurationProperties

Question

有一种行为我找不到相关文档。让我们假设以下代码。它应该在控制台中显示使用 foo.bar 属性配置的内容:

@SpringBootApplication
@Component
public class Test {
    @Autowired
    TestConfig testConfig;

    public static void main(String[] args) throws Exception {
        ConfigurableApplicationContext run = new SpringApplication(Test.class).run(args);
        Test test = run.getBean(Test.class);
        test.run();
    }

    public void run() throws Exception {
        testConfig.getBar().entrySet().forEach(e -> {
            System.out.println(e.getKey() + " " + e.getValue());
        });
    }

    @Configuration
    @ConfigurationProperties(ignoreUnknownFields = false, prefix = "foo")
    static class TestConfig {
        private Map<SomeEnum, String> bar = new HashMap<>();

        public Map<SomeEnum, String> getBar() {
            return bar;
        }

        public void setBar(Map<SomeEnum, String> bar) {
            this.bar = bar;
        }
    }
}

如果您在 application.yml 中设置以下属性(foo.bar[A_VALUE]:来自 application.yml)，它将被正确拾取并在控制台，没什么特别的

现在，如果您使用完全相同的代码，但这次您想要使用命令行参数覆盖 application.yml 中定义的属性并设置 --foo.bar[aValue]="from command line" 作为命令行 arg(请注意，这次我使用驼峰式大小写作为枚举引用)。它仍然在控制台中显示为“来自 application.yml”，而不是覆盖的属性。

如果我在命令行中选择大写枚举，在 application.yml 中选择驼峰式枚举，它仍然会向控制台显示相同的内容。

这是预期的行为吗？这种情况下的规则是什么？

根据我的测试，它与 https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config 中描述的完全相反

我已经使用 spring boot 1.2.5.RELEASE 和 1.3.0.RELEASE 进行了测试

谢谢你的时间

Answer 1

Spring 使用 StringToEnum 将字符串值转换为枚举。此类在内部使用 java.lang.Enum#valueOf 方法进行转换。枚举类创建一个 map ，然后在这个 map 上执行查找。因此，键必须与查找成功的确切大小写相匹配。

下面的测试用例将验证:

enum SomeEnum{
    A, B
}

public class EnumTest {

    public static void main(String[] args) {
        SomeEnum e1 = Enum.valueOf(SomeEnum.class, "A");
        System.out.println(e1);
        SomeEnum e2 = Enum.valueOf(SomeEnum.class, "a"); //throws exception
    }
}

因此，当 spring 无法转换从命令行传递的值时，它会回退到 application.yml 中定义的值。

---

编辑

如果您尝试以下组合:

foo.bar[A_VALUE]: from application.yml
foo.bar[A_VALUE]: from command line
{A_VALUE=from command line}

foo.bar[A_VALUE]: from application.yml
foo.bar[aValue]: from command line
{A_VALUE=from application.yml}

foo.bar[aValue]: from application.yml
foo.bar[A_VALUE]: from command line
{A_VALUE=from application.yml}

foo.bar[aValue]: from application.yml
foo.bar[aValue]: from command line
{A_VALUE=from command line}

第一个和第四个场景 - 由于键名完全相同，因此设置了第一个命令行属性。此属性被添加到已处理列表中，因此 YML 属性被忽略。

第 2 和第 3 种情况 - 由于键名不同，因此处理命令行和 YML 属性。第二次处理的 YML 覆盖从命令行设置的值。