JPA OneToMany 필드의 StackOverflowError

우선 발생하는 에러는 순환 참조로 인해 발생한 에러로 JPA를 사용하다 보면 제법 자주 만나볼 수 있는 에러다. 자세한 내용은 구글에 JPA 양방향 순환참조를 검색해보자.

기존에 잘 돌아가던 기능이었는데 Collection을 List -> Set으로 바꿨다고 갑자기 발생하는 이유가 뭘까? List와 Set에 대해서 간략하게 알아보자. JPA(hibernate) 내부에서 어떻게 동작하는지는 다른 글에서 알아보고 이번 글에서는 각 Collection 타입의 특징을 몇개 짚어보자.

• List Collection

  • 순서가 있는 데이터의 모임
  • 중복을 허용한다.
  • 대표적으로 ArrayList 와 LinkedList 가 있다.

• Set Collection

  • 순서가 없는 데이터의 모임(구현체에 따라 순서가 있는 경우도 있다.)
  • 중복을 허용하지 않는다.
  • 대표적으로 HashSet 이 있다.

이 중에서 우리가 주목해야 할 특징은 중복 여부이다. 앞서 테스트 케이스에서 성공 케이스와 실패 케이스를 살펴보면 자식객체가 2개 이상일 경우에만 에러가 발생했는데 이 때 코드가 동작하는 순서는 아래와 같다.

1. Parent 객체를 생성한다.
2. Parent 객체에 종속된 Child 객체를 생성해서 Parent.childs(MutableSet) 필드에 추가한다.
3. Child 객체를 하나 더 생성해서 마찬가지로 Parent.childs 필드에 추가한다.
4. 이 때 childs 필드에 이미 객체가 존재하므로 추가하려는 객체와 동일한 객체인지 확인한다. - 이 때 에러 발생
5. 동일한 객체가 아닐 경우 Parent.childs 필드에 객체를 추가한다.

동일한 객체인지 판단할때 에러가 발생하는 이유를 알고자 하면 우선 Set Collection이 중복 체크를 어떻게 하는지 알아야 한다.

자바 계열의 언어에선 모든 객체가 Object class를 상속받은 채로 생성된다(최상위 클래스). 이 Object 클래스에는 equals, hashcode 메서드가 구현되어 있는데 Set Collection이 객체의 중복 여부를 체크할 때 이 두 메서드를 사용해서 중복 여부를 판단한다. 즉, Child 객체의 중복여부를 판단하기 위해서 Child 객체의 모든 필드값을 다 읽는 작업을 하게 되는데 이 때 Child.parent -> Parent.childs -> Child.parent -> Parent.childs … 와 같은 순환참조 에러가 발생하게 된다.

equals, hashcode 메서드 호출 중 에러가 발생하므로 이 두 메서드를 오버라이딩 해주면 해결할 수 있다. Parent는 건드릴 필요 없고 Child만 재정의 해주면 되는데 설명은 그만하고 수정된 코드를 보자.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

@Entity
@Table(name = "child")
data class Child(
   @get:Id
   @get:GeneratedValue(strategy = GenerationType.IDENTITY)
   var id: Long,

   @get:ManyToOne(cascade = [CascadeType.DETACH], fetch = FetchType.LAZY)
   @get:JoinColumn(name = "parent_id")
   var parent: Parent
) {
   override fun equals(other: Any?): Boolean {
       return this.id == (other as SponsorshipGoalModel).id
   }

   override fun hashCode(): Int {
       return this.id.hashCode()
   }
}