【Java】Jacksonの@JsonIdentityInfoアノテーションとは？使い方と重要性を解説

JavaのJSON処理ライブラリ「Jackson」において、@JsonIdentityInfoアノテーションは、オブジェクト間に親子関係（双方向参照）が存在する場合に活躍する重要なアノテーションです。

@JsonIdentityInfoの役割

このアノテーションは、シリアライズ（直列化）およびデシリアライズ（復元）の過程でオブジェクトの同一性（アイデンティティ）を明示するために使用されます。

通常、親オブジェクトが子オブジェクトを参照し、その子が再び親を参照するような構造の場合、Jacksonは無限ループに陥りStackOverflowErrorが発生します。@JsonIdentityInfoを付与することで、同じオブジェクトは2回目以降IDのみが出力され、循環参照の問題を回避できます。

また、ObjectIdGenerators.PropertyGeneratorは、オブジェクト識別子として使用する値をPOJOのプロパティから取得することを示す抽象プレースホルダークラスです。

構文

@Target(value={ANNOTATION_TYPE,TYPE,FIELD,METHOD,PARAMETER})
@Retention(value=RUNTIME)
public @interface JsonIdentityInfo

コード例

以下は、UserクラスとAddressクラスが互いを参照する双方向関係の例です。両クラスに@JsonIdentityInfoを付与し、識別子としてuserIdプロパティを指定しています。

import java.util.*;
import java.io.*;
import com.fasterxml.jackson.annotation.JsonIdentityInfo;
import com.fasterxml.jackson.annotation.ObjectIdGenerators;
import com.fasterxml.jackson.databind.ObjectMapper;
public class JsonIdentityInfoTest {
    public static void main(String[] args) throws IOException {
        ObjectMapper mapper = new ObjectMapper();
        User user = new User(115, "Raja", "Ramesh");
        Address address = new Address(125, "Madhapur", "Hyderabad", user);
        user.addAddress(address);
        String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(address);
        System.out.println(jsonString);
    }
}
// Userクラス
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "userId")
class User {
    private int userId;
    private String firstName;
    private String lastName;
    private List<Address> addresses;
    public User(int userId, String firstName, String lastName) {
        this.userId = userId;
        this.firstName = firstName;
        this.lastName = lastName;
        this.addresses = new ArrayList<Address>();
    }
    public int getUserId() {
        return userId;
    }
    public String getFirstName() {
        return firstName;
    }
    public String getLastName() {
        return lastName;
    }
    public void addAddress(Address address) {
        addresses.add(address);
    }
}
// Addressクラス
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "userId")
class Address {
    private int userId;
    private String city;
    private String street;
    private User user;
    public Address(int userId, String street, String city, User user) {
        this.userId = userId;
        this.street = street;
        this.city = city;
        this.user = user;
    }
    public int getUserId() {
        return userId;
    }
    public String getStreet() {
        return street;
    }
    public String getCity() {
        return city;
    }
    public User getUser() {
        return user;
    }
}

出力結果

{
  "userId" : 125,
  "city" : "Hyderabad",
  "street" : "Madhapur",
  "user" : {
      "userId" : 115,
      "firstName" : "Raja",
      "lastName" : "Ramesh"
    }
}

まとめ

@JsonIdentityInfoを使用すると、親子関係や相互参照を持つオブジェクトグラフでも安全にJSON変換が行えます。特にJPAエンティティなど双方向リレーションを持つクラスを扱う際には、無限再帰を防ぐために必須となるアノテーションです。