如何在jackson / Spring启动中允许对枚举进行不区分大小写的映射?

时间:2018-03-08 14:27:59

标签: java spring spring-boot enums jackson

注意:这不是重复的。另一个问题不是关于Spring请求参数的自动编组。它有一个解决方案,您可以使用jackson手动编组对象。

我想允许开发人员使用可以与不区分大小写匹配的枚举创建请求对象。其他字段/属性可能需要区分大小写的匹配,但枚举应该不区分大小写。

到目前为止我找到的唯一方法(initBinding)要求您在编译时指定确切的枚举类。我正在寻找一种更通用的方法来将JSON请求中的字符串编组到枚举中。

我发现的唯一现有方式:

@RestController
public class TestController
{
    //...elided...

    @InitBinder
    public void initBinder(final WebDataBinder webdataBinder)
    {
        webdataBinder.registerCustomEditor( MyEnum.class, new CaseInsensitiveEnumConverter() );
    }
}

但这需要使用预先知道的枚举进行编译。

2 个答案:

答案 0 :(得分:4)

你可以看到类org.springframework.core.convert.support.StringToEnumConverterFactory,所以你可以像这样自定义你自己的converterFactory。

public class MyStringToEnumConverterFactory implements ConverterFactory<String, Enum> {

@Override
public <T extends Enum> Converter<String, T> getConverter(Class<T> targetType) {
    return new StringToEnum(getEnumType(targetType));
}

private class StringToEnum<T extends Enum> implements Converter<String, T> {

    private final Class<T> enumType;

    public StringToEnum(Class<T> enumType) {
        this.enumType = enumType;
    }

    @Override
    public T convert(String source) {
        if (source.isEmpty()) {
            // It's an empty enum identifier: reset the enum value to null.
            return null;
        }

        return (T) Enum.valueOf(this.enumType, source.trim().toUpperCase());
    }
}

private static Class<?> getEnumType(Class targetType) {
    Class<?> enumType = targetType;
    while (enumType != null && !enumType.isEnum()) {
        enumType = enumType.getSuperclass();
    }
    if (enumType == null) {
        throw new IllegalArgumentException(
                "The target type " + targetType.getName() + " does not refer to an enum");
    }
    return enumType;
}
}

并添加到ConverterRegistry。

@Configuration
public class MyConfiguration {

@Bean
public ConverterRegistry initConverter(ConverterRegistry registry) {
    registry.addConverterFactory(new MyStringToEnumConverterFactory());
    return registry;
}
}

希望能帮到你!

答案 1 :(得分:0)

从spring 2.0开始,足以在application.properties中设置以下内容:

spring.jackson.mapper.accept-case-insensitive-enums = true