如何在SpringBoot/Swagger中使枚举参数小写？

Question

我有以下endpoint

@GetMapping(value = "/mypath/{mychoice}")
public ResponseClass generateEndpoint(
        @PathVariable("mychoice") FormatEnum format,
    )  {

...

和下面的枚举用Jackson注释

@JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
public enum Format {
    AVRO,
    ORC,
    PARQUET,
    PROTOBUF
}

我希望，@JsonNaming注释会告诉斯威格用小写字母显示案例，但事实并非如此

将@JsonProperty添加到每个案例中也没有帮助。

它也不接受带有错误的小写URL

org.springframework.beans.TypeMismatchException: Failed to convert value of type 'java.lang.String' to required type 'FormatEnum'; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type [java.lang.String] to type [@org.springframework.web.bind.annotation.RequestParam FormatEnum] for value 'avro'; nested exception is java.lang.IllegalArgumentException: No enum constant FormatEnum.avro

设置

 spring.jackson.mapper.ACCEPT_CASE_INSENSITIVE_ENUMS = true 

无效（并且在代码中为true）。

看起来它只是没有使用Jackson来反序列化enum！




Answer 1

设置spring.jackson.mapper.ACCEPT_CASE_INSENSITIVE_ENUMS=true不起作用的原因可以在Konstantin Zyubin的回答中找到。

受上述答案的启发，我们可以有一个更通用的方法来处理请求参数中不区分大小写的枚举。

变流器等级

import org.springframework.core.convert.converter.Converter;

public class CaseInsensitiveEnumConverter<T extends Enum<T>> implements Converter<String, T> {
    private Class<T> enumClass;

    public CaseInsensitiveEnumConverter(Class<T> enumClass) {
        this.enumClass = enumClass;
    }

    @Override
    public T convert(String from) {
        return T.valueOf(enumClass, from.toUpperCase());
    }
}

添加配置

import com.example.enums.EnumA;
import com.example.enums.EnumB;
import com.example.enums.FormatEnum;
import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

@Configuration
public class AppConfig implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        List<Class<? extends Enum>> enums = List.of(EnumA.class, EnumB.class, FormatEnum.class);
        enums.forEach(enumClass -> registry.addConverter(String.class, enumClass,
                      new CaseInsensitiveEnumConverter<>(enumClass)));
    }
}

相关：杰克逊数据库枚举不区分大小写