TOC

Джексон - Custom Serializer

Джексон - Custom Serializer

1. обзор

Это краткое руководство покажет, как сериализовать объект Java с помощью Jackson 2, используяCustom Serializer.

Если вы хотите копнуть глубже и изучитьother cool things you can do with the Jackson 2 - переходите кthe main Jackson tutorial.

2. Стандартная сериализация графа объектов

Давайте определим 2 простых объекта и посмотрим, как Джексон сериализует их без какой-либо специальной логики: 

public class User {
    public int id;
    public String name;
}
public class Item {
    public int id;
    public String itemName;
    public User owner;
}

Теперь давайте сериализуем сущностьItem с сущностьюUser: 

Item myItem = new Item(1, "theItem", new User(2, "theUser"));
String serialized = new ObjectMapper().writeValueAsString(myItem);

Это приведет к полному представлению JSON для обеих сущностей: 

{
    "id": 1,
    "itemName": "theItem",
    "owner": {
        "id": 2,
        "name": "theUser"
    }
}

3. Пользовательский сериализатор наObjectMapper

Теперьlet’s simplify the JSON output выше путем сериализации толькоid объектаUser, а не всего объектаUser; мы хотели бы получить следующий, более простой JSON: 

{
    "id": 25,
    "itemName": "FEDUfRgS",
    "owner": 15
}

Проще говоря, нам нужноdefine a custom Serializer для объектовItem: 

public class ItemSerializer extends StdSerializer {

    public ItemSerializer() {
        this(null);
    }

    public ItemSerializer(Class t) {
        super(t);
    }

    @Override
    public void serialize(
      Item value, JsonGenerator jgen, SerializerProvider provider)
      throws IOException, JsonProcessingException {

        jgen.writeStartObject();
        jgen.writeNumberField("id", value.id);
        jgen.writeStringField("itemName", value.itemName);
        jgen.writeNumberField("owner", value.owner.id);
        jgen.writeEndObject();
    }
}

Теперь нам нужно зарегистрировать этот настраиваемый сериализатор сObjectMapper для классаItem и выполнить сериализацию: 

Item myItem = new Item(1, "theItem", new User(2, "theUser"));
ObjectMapper mapper = new ObjectMapper();

SimpleModule module = new SimpleModule();
module.addSerializer(Item.class, new ItemSerializer());
mapper.registerModule(module);

String serialized = mapper.writeValueAsString(myItem);

Вот и все - теперь у нас есть более простая настраиваемая сериализация объектовItem→User в формате JSON.

4. Пользовательский сериализатор в классе

Мы также можемregister the serializer directly on the class вместоObjectMapper: 

@JsonSerialize(using = ItemSerializer.class)
public class Item {
    ...
}

Теперь при выполненииstandard serialization: 

Item myItem = new Item(1, "theItem", new User(2, "theUser"));
String serialized = new ObjectMapper().writeValueAsString(myItem);

Мы получим собственный вывод JSON, созданный сериализатором, указанный через@JsonSerialize: 

{
    "id": 25,
    "itemName": "FEDUfRgS",
    "owner": 15
}

Это полезно, когда кObjectMapper невозможно получить доступ и настроить напрямую.

5. Заключение

В этой статье показано, как с помощью сериализаторов добраться до настраиваемого вывода JSON с помощью Jackson 2.

Реализация всех этих примеров и фрагментов кодаcan be found on GitHub - это проект на основе Maven, поэтому его должно быть легко импортировать и запускать как есть.

Related