Jacksonを使用したJSONの出力で、オブジェクトが循環参照を起こしているような場合、これを止める方法についてのメモ。

以下のように、JsonIdentityInfoアノテーションをクラスにつけるだけで良いです。これを使用することで、循環が検出された場合に、循環しているオブジェクトの内容を、ID文字列に置き換えてくれるようになります。

JPAエンティティなどをそのままJSON出力したいような場合には、OneToMany, ManyToOneを使用したオブジェクトの参照で、このようなニーズが度々発生します。

@Entity
@JsonIdentityInfo(property = "_id", generator = ObjectIdGenerators.UUIDGenerator::class)
data class Person(
        @Id
        var id: String = "",
        var name: String = "",
        @OneToMany(targetEntity = Schedule::class, mappedBy = "person")
        var schedules: MutableList<Schedule> = mutableListOf()
)

@Entity
@JsonIdentityInfo(property = "_id", generator = ObjectIdGenerators.UUIDGenerator::class)
data class Schedule(
        @Id
        var id: String = "",
        @ManyToOne(targetEntity = Person::class)
        var helper: Person = Person(),
        var title: String = "",
        var start: LocalDateTime = LocalDateTime.MIN,
        var end: LocalDateTime = LocalDateTime.MIN
)

例では、UUIDGeneratorを使用しているので、生成されるIDはUUIDになります。生成器には他にも種類があって、以下の中から選択できます。

  • UUIDGenerator
  • IntSequenceGenerator
  • StringIdGenerator
  • PropertyGenerator

また、循環参照を止めるためのアノテーションはJsonIdentityInfo以外にもあり、以下を選択することができます。

  • JsonIdentityInfo
  • JsonBackReference
  • JsonManagedReference

参考: https://qiita.com/sengoku/items/56bc6319759fee6d15e3