Spring Boot转换枚举忽略大小写

Question

我有一个暴露 Rest API 的 spring-boot 应用程序。此 API 接受枚举列表 batchStatus 作为查询参数。这个batchStatus 用于根据批次的状态过滤所有批次。

当尝试调用这个 rest api 时，我收到以下错误

{
  "timestamp": 1552587376808,
  "status": 400,
  "error": "Bad Request",
  "message": "Failed to convert value of type 'java.lang.String[]' to required type 'java.util.List'; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type [java.lang.String] to type [@io.swagger.annotations.ApiParam @javax.validation.Valid @org.springframework.web.bind.annotation.RequestParam com.netshell.test.spring.conversion.rest.api.model.BatchStatus] for value 'active'; nested exception is java.lang.IllegalArgumentException: No enum constant com.netshell.test.spring.conversion.rest.api.model.BatchStatus.active",
  "path": "/batch/status"
}

Spring 在 BatchStatus 中寻找 active 而不是 ACTIVE。

深入了解 spring ConversionService 我发现了两个转换器
1. StringToEnumConverterFactory（来自 spring-core）
2. StringToEnumIgnoringCaseConverterFactory（来自spring-boot）

spring-boot 中是否有任何机制强制使用第二个转换器？

进一步调试显示，这两个转换器都注册到 ConversionService，但是有 multiple instances of conversionService 每个转换器的数量不同。这种情况下spring如何选择使用哪个conversionService呢？

枚举BatchStatus创建如下

public enum BatchStatus {
    ACTIVE("active"),
    FAILED("failed"),
    HOLD("hold");

    private String value;
    BatchStatus(String value) {
        this.value = value;
    }

    @Override
    @JsonValue
    public String toString() {
        return String.valueOf(value);
    }

    @JsonCreator
    public static BatchStatus fromValue(String text) {
        for (BatchStatus b : BatchStatus.values()) {
            if (String.valueOf(b.value).equals(text)) {
                return b;
            }
        }
        return null;
    }
}

Answer 1

查看 Spring 项目的问题跟踪器可以找到 this 问题，它基本上要求公开 StringToEnumIgnoringCaseConverterFactory 类。
不过，这似乎不会很快发生，因为this 仍在进行中。

您可以尝试通过WebMvcConfigurer#addFormatters 配置Converter

@Configuration
class CustomWebMvcConfigurer implements WebMvcConfigurer {
    @Override
    public void addFormatters(final FormatterRegistry registry) {
        ApplicationConversionService.configure(registry);
    }
}

ApplicationConversionService#configure 将通过调用addApplicationConverters 方法为您注册StringToEnumIgnoringCaseConverterFactory

/** Spring Framework code */
public static void addApplicationConverters(ConverterRegistry registry) {
    ...
    registry.addConverterFactory(new StringToEnumIgnoringCaseConverterFactory());
}

顺便说一句，这是对StringToEnumIgnoringCaseConverterFactory 的唯一引用，所以这是你唯一的希望； )（不要使用Reflection！忍住冲动）