Динамические имена свойств Джексона

Я хотел бы сериализовать объект таким образом, чтобы одно из полей называлось по-разному в зависимости от типа поля. Например:

public class Response {
    private Status status;
    private String error;
    private Object data;
        [ getters, setters ]
    }

Здесь я хотел бы, чтобы поле data было сериализовано с чем-то вроде data.getClass.getName() вместо того, чтобы всегда иметь поле с именем data, которое содержит другой тип в зависимости от ситуации.

Как я могу добиться такого трюка с помощью Джексона?

Ответ 1

Использование пользовательского JsonSerializer.

public class Response {
  private String status;
  private String error;

  @JsonProperty("p")
  @JsonSerialize(using = CustomSerializer.class)
  private Object data;

  // ...
}

public class CustomSerializer extends JsonSerializer<Object> {
  public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
    jgen.writeStartObject();
    jgen.writeObjectField(value.getClass().getName(), value);
    jgen.writeEndObject();
  }
}

И затем предположим, что вы хотите сериализовать следующие два объекта:

public static void main(String... args) throws Exception {
  ObjectMapper mapper = new ObjectMapper();
  Response r1 = new Response("Error", "Some error", 20);
  System.out.println(mapper.writeValueAsString(r1));
  Response r2 = new Response("Error", "Some error", "some string");
  System.out.println(mapper.writeValueAsString(r2));
}

Первый напечатает:

{"status":"Error","error":"Some error","p":{"java.lang.Integer":20}}

И второй:

{"status":"Error","error":"Some error","p":{"java.lang.String":"some string"}}

Я использовал имя p для объекта-обертки, так как он будет просто служить p laceholder. Если вы хотите удалить его, вам придется написать собственный сериализатор для всего класса, т.е. A JsonSerializer<Response>.

Ответ 2

мое собственное решение.

@Data
@EqualsAndHashCode
@ToString
@JsonSerialize(using = ElementsListBean.CustomSerializer.class)
public class ElementsListBean<T> {

    public ElementsListBean()
    {
    }

    public ElementsListBean(final String fieldName, final List<T> elements)
    {
        this.fieldName = fieldName;
        this.elements = elements;
    }

    private String fieldName;

    private List<T> elements;

    public int length()
    {
        return (this.elements != null) ? this.elements.size() : 0;
    }

    private static class CustomSerializer extends JsonSerializer<Object> {
        public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException,
                JsonProcessingException
        {
            if (value instanceof ElementsListBean) {
                final ElementsListBean<?> o = (ElementsListBean<?>) value;
                jgen.writeStartObject();
                jgen.writeArrayFieldStart(o.getFieldName());
                for (Object e : o.getElements()) {
                    jgen.writeObject(e);
                }
                jgen.writeEndArray();
                jgen.writeNumberField("length", o.length());
                jgen.writeEndObject();
            }
        }
    }
}

Ответ 3

У меня было более простое решение с использованием аннотации @JsonAnyGetter, и оно работало как шарм.

import java.util.Collections;
import java.util.Map;

public class Response {
    private Status status;
    private String error;

    @JsonIgnore
    private Object data;

    [getters, setters]

    @JsonAnyGetter
    public Map<String, Object> any() {
        //add the custom name here
        //use full HashMap if you need more than one property
        return Collections.singletonMap(data.getClass().getName(), data);
    }
}

Нет необходимости в оболочке, без необходимости использования специального сериализатора.

Ответ 4

Вы можете использовать аннотацию JsonTypeInfo, которая точно сообщит Jackson, и вам не нужно писать собственный сериализатор. Здесь можно включить эту информацию, но для вашего конкретного вопроса вы должны использовать As.WRAPPER_OBJECT и Id.CLASS. Например:

public static class Response {
    private Status status;
    private String error;
    @JsonTypeInfo(include = As.WRAPPER_OBJECT, use = Id.CLASS)
    private Object data;
}

Это, однако, не будет работать на примитивный тип, например String или Integer. В любом случае вам не нужна эта информация для примитивов, так как они изначально представлены в JSON, и Джексон знает, как с ними справиться. Добавленный бонус с использованием аннотации заключается в том, что вы получаете десериализацию бесплатно, если вам когда-либо понадобится. Вот пример:

public static void main(String[] args) throws Exception {
    ObjectMapper mapper = new ObjectMapper();
    Response r1 = new Response("Status", "An error", "some data");
    Response r2 = new Response("Status", "An error", 10);
    Response r3 = new Response("Status", "An error", new MyClass("data"));
    System.out.println(mapper.writeValueAsString(r1));
    System.out.println(mapper.writeValueAsString(r2));
    System.out.println(mapper.writeValueAsString(r3));
}

@JsonAutoDetect(fieldVisibility=Visibility.ANY)
public static class MyClass{
    private String data;
    public MyClass(String data) {
        this.data = data;
    }
}

и результат:

{"status":"Status","error":"An error","data":"some data"}
{"status":"Status","error":"An error","data":10}
{"status":"Status","error":"An error","data":{"some.package.MyClass":{"data":"data"}}}