ジャクソン–カスタムシリアライザー

投稿日: 2019-10-19 2022-10-21
タグ: Data, Jackson, JSON

1. 概要

このクイックチュートリアルでは、カスタムシリアライザーを使用してJackson2でJavaエンティティをシリアル化する方法を示します。

より深く掘り下げてジャクソン2でできる他のクールなことを学びたい場合は、メインのジャクソンチュートリアルに進んでください。

2. オブジェクトグラフの標準シリアル化

2つの単純なエンティティを定義し、Jacksonがカスタムロジックなしでこれらをシリアル化する方法を見てみましょう。

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のカスタムシリアライザー**

ここで、は、 User オブジェクト全体ではなく、Userのidのみをシリアル化することにより、上記のJSON出力を簡略化します。次のより単純なJSONを取得したいと思います。

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

簡単に言うと、ItemオブジェクトのカスタムSerializerを定義する必要があります。

public class ItemSerializer extends StdSerializer<Item> {
    
    public ItemSerializer() {
        this(null);
    }
  
    public ItemSerializer(Class<Item> 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();
    }
}

次に、このカスタムシリアライザーをItemクラスのObjectMapperに登録し、シリアル化を実行する必要があります。

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. クラスのカスタムシリアライザー

ObjectMapper ではなく、クラスに直接シリアライザーを登録することもできます。

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

ここで、標準シリアル化を実行する場合：

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

@JsonSerialize を介して指定された、シリアライザーによって作成されたカスタムJSON出力を取得します。

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

これは、ObjectMapperに直接アクセスして構成できない場合に役立ちます。

5. 結論

この記事では、Serializersを使用してJackson2でカスタムJSON出力を取得する方法を説明しました。

これらすべての例とコードスニペットの実装は、GitHub にあります。これはMavenベースのプロジェクトであるため、そのままインポートして実行するのは簡単です。

getdocs

13036