JavaのJacksonで@JsonManagedReferenceと@JsonBackReferenceを使いこなす方法

@JsonManagedReferenceと@JsonBackReferenceアノテーションは、親子関係のような双方向の参照を持つJavaオブジェクトをJSON構造として扱うために使用されます。これらのアノテーションを適切に組み合わせることで、循環参照による無限ループ（StackOverflowError）を回避しながら、安全にシリアライズを行うことができます。

それぞれの役割は以下の通りです。

• @JsonManagedReference：前方参照（フォワードリファレンス）を表し、シリアライズ（Javaオブジェクト → JSON）の過程で含められます。
• @JsonBackReference：逆参照（バックリファレンス）を表し、シリアライズの過程で省略されます。デシリアライズ（JSON → Javaオブジェクト）の際には、両者の関連付けが自動的に復元されます。

以下の例では、@JsonManagedReferenceと@JsonBackReferenceアノテーションの実際の実装方法を示します。

コード例

import java.util.*;
import com.fasterxml.jackson.annotation.JsonManagedReference;
import com.fasterxml.jackson.annotation.JsonBackReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.core.JsonProcessingException;

public class ManagedReferenceBackReferenceTest {
    public static void main(String args[]) throws JsonProcessingException {
        BackReferenceBeanTest testBean = new BackReferenceBeanTest(110, "Sai Chaitanya");
        ManagedReferenceBeanTest bean = new ManagedReferenceBeanTest(135, "Adithya Ram", testBean);
        testBean.addEmployees(bean);
        ObjectMapper mapper = new ObjectMapper();
        String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(bean);
        System.out.println(jsonString);
    }
}

class ManagedReferenceBeanTest {
    public int empId = 115;
    public String empName = "Raja Ramesh";

    @JsonManagedReference
    public BackReferenceBeanTest manager;

    public ManagedReferenceBeanTest(int empId, String empName, BackReferenceBeanTest manager) {
        this.empId = empId;
        this.empName = empName;
        this.manager = manager;
    }
}

class BackReferenceBeanTest {
    public int empId = 125;
    public String empName = "Jai Dev";

    @JsonBackReference
    public List<ManagedReferenceBeanTest> list;

    public BackReferenceBeanTest(int empId, String empName) {
        this.empId = empId;
        this.empName = empName;
        list = new ArrayList<ManagedReferenceBeanTest>();
    }

    public void addEmployees(ManagedReferenceBeanTest managedReferenceBeanTest) {
        list.add(managedReferenceBeanTest);
    }
}

出力結果

{
    "empId" : 135,
    "empName" : "Adithya Ram",
    "manager" : {
        "empId" : 110,
        "empName" : "Sai Chaitanya"
    }
}

出力結果を見ると、@JsonManagedReferenceを付けたフィールド（manager）はJSONに正常に出力されている一方で、@JsonBackReferenceを付けたフィールド（list）は出力から除外されていることがわかります。この仕組みにより、親子間で互いを参照し合うオブジェクトグラフでも、無限ループを発生させることなくJSONへの変換が可能になります。