Jackson-动态添加枚举值时,EnumValues序列化失败

时间:2019-10-31 15:27:30

标签: java spring-boot spring-mvc serialization jackson

我正在使用Spring Boot,当它尝试使用BeanJackson转换为JSON时出现错误。

首次调用此函数(在@RestController内部)时,它可以正常工作:

@GetMapping
public UserDto getUser() {
    UserDto userDto = // get the user 
    // userDto.getRoles() is an enum, let's call it XEnum, with 20 entries
    return userDto;
}

此后,将一个新值动态添加到XEnum,因此该枚举现在有21个条目。

调用上面的函数时,出现此错误:

org.springframework.http.converter.HttpMessageNotWritableException: Could not write JSON: 41; nested exception is com.fasterxml.jackson.databind.JsonMappingException: 41 (through reference chain: ...UserDto["roles"]->java.util.ArrayList[21])
    at org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.writeInternal(AbstractJackson2HttpMessageConverter.java:296)
    at org.springframework.http.converter.AbstractGenericHttpMessageConverter.write(AbstractGenericHttpMessageConverter.java:103)
    at org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodProcessor.writeWithMessageConverters(AbstractMessageConverterMethodProcessor.java:290)
    at org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.handleReturnValue(RequestResponseBodyMethodProcessor.java:180)
    ...
Caused by: java.lang.ArrayIndexOutOfBoundsException: 41
    at com.fasterxml.jackson.databind.util.EnumValues.serializedValueFor(EnumValues.java:79)
    at com.fasterxml.jackson.databind.ser.std.EnumSerializer.serialize(EnumSerializer.java:132)
    at com.fasterxml.jackson.databind.ser.std.EnumSerializer.serialize(EnumSerializer.java:27)
    at com.fasterxml.jackson.databind.ser.impl.IndexedListSerializer.serializeContentsUsing(IndexedListSerializer.java:142)

在我的实际情况下,41是枚举中新条目的序数值。

UserDto类如下所示:

public class UserDto implements Serializable {

    private static final long serialVersionUID = 475464704956181923L;

    private XEnum currentRole;
    private List<XEnum> roles;
    ...
}

Jackson是否具有枚举的缓存,因此找不到新值?如果是这样,我可以刷新它吗?

编辑:

我找到了问题的根源。

在序列化过程中使用的Jackson EnumSerializer内,serialize方法如下所示:

@Override
public final void serialize(Enum<?> en, JsonGenerator gen, SerializerProvider serializers)
    throws IOException
{
    // [JACKSON-684]: serialize as index?
    if (_serializeAsIndex(serializers)) {
        gen.writeNumber(en.ordinal());
        return;
    }
    // [databind#749]: or via toString()?
    if (serializers.isEnabled(SerializationFeature.WRITE_ENUMS_USING_TO_STRING)) {
        gen.writeString(en.toString());
        return;
    }
    gen.writeString(_values.serializedValueFor(en)); // this line is evaluated !!
}

_values包含预先解析的值,并且不包含新的Enum条目。

是否有一种仅对某些SerializationFeature.WRITE_ENUMS_USING_TO_STRING启用EnumSerializer的方法?因为如果我全局打开它,可能会有副作用。

1 个答案:

答案 0 :(得分:1)

由于EnumSerializer#serialize方法和com.fasterxml.jackson.databind.util.EnumValues类被标记为final,因此很难扩展其行为。在这种情况下,最简单的解决方案是为XEnum

编写自定义序列化程序
class DynamicEnumJsonSerializer extends JsonSerializer<Enum> {

    @Override
    public void serialize(Enum value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeString(value.toString());
    }
}

您可以按如下所示进行注册:

@JsonSerialize(using = DynamicEnumJsonSerializer.class)
enum XEnum {
    X, Y, Z
}
相关问题