Jackson 序列化简单的一个属性 ValueObject,如 Enum - 无需嵌套

问题描述

是否可以将 jackson 配置为序列化简单的值对象,只包装一个属性,像枚举一样序列化?

public final class ErrorCode {

  private final String value;

  public ErrorCode(@JsonProperty("value") final String value) {
    this.value = value;
  }

  public String getValue() {
    return value;
  }
}

现在序列化为...,"errorCode":{"value":"invalid.login"},... 但我想有,好像它是枚举,...,"errorCode":"invalid.login",...。 可以但只能通过每个周围类中的@JsonUnwrapped()

SorroundingClass {
  @JsonUnwrapped()
  private ErrorCode errorCode;  
  ...
}

我只想在一个地方配置它,最好在 ErrorCode 本身。

看着 flattening-nested-attributes-in-jackson 在我看来不可能,但我想确定一下。

解决方法

您可以通过实现自定义的 com.fasterxml.jackson.databind.JsonSerializer 序列化程序来实现这一点:

class SingleValueJsonSerializer extends JsonSerializer<Object> {

    @Override
    public void serialize(Object value,JsonGenerator gen,SerializerProvider serializers) throws IOException {
        if (value == null) {
            gen.writeNull();
            return;
        }
        final Field[] fields = value.getClass().getDeclaredFields();
        if (fields.length != 1) {
            throw new IOException("Do not use this serialiser for the class " + value.getClass().getSimpleName() + " which has" + fields.length + " fields!");
        }
        final Field first = fields[0];
        try {
            final Object fieldValue = first.get(value);
            gen.writeObject(fieldValue);
        } catch (IllegalAccessException e) {
            throw new IOException(e);
        }
    }
}

您可以在所需的类中定义它:

class Wrapper {

    @JsonSerialize(using = SingleValueJsonSerializer.class)
    private ErrorCode error;
    // other fields
}

或者通过在类级别定义来全局注册:

@JsonSerialize(using = SingleValueJsonSerializer.class)
class ErrorCode {