SLF4J StackOverflowError

이번에 상속 관계를 정의함으로써 Wardrobe, Cloth, Record 엔티티의 중복 기능인 댓글 기능과 좋아요 기능을 슈퍼 타입 엔티티인 PostEntity로 이관시키는 리팩토링을 진행했다. 

 

문제 발생

공통 로직들을 각각의 Service가 아닌 PostServcie로 이동시키는 작업을 진행하고 있었는데, 댓글 달기 메서드인 writeComment()에서 StackOverflowError가 터지면서 로직이 중단되는 상황이 발생했다.  StackOverflowError를 발생시키는 부분은 SLF4J에서 엔티티의 toString()을 호출하며 발생하는 부분이였다.  엔티티의 toString()을 추가 시켜주는 부분은 lombok의 @Data이기 때문에 이 부분에 문제가 있을 것이라 판단하였다.  

 

 

문제 원인

@Override
public String toString() {
    return "PostEntity{" +
            "id=" + id +
            ", number='" + number + '\'' +
            ", comment=" + Comment +
            '}';
}

 

위의 toString()은 @Data를 선언할 경우 자동으로 생성되는 것이다. 그런데 여기서 PostEntity의 toString()에서 comment를 호출하는 과정에 comment는 객체이기 때문에 객체를 출력하기 위해 comment의 toString()을 호출하게 된다. 그렇다면 comment에도 @Data가 선언되어 있기 때문에 comment도 자신의 필드에 존재하는 postEntity의 toString()을 호출하게 되고 또 다시 postEntity는 comment의 toString()을 호출하게 된다. 이러면서 메서드의 무한 호출이 진행되어 메서드 스택이 넘쳐서 StackOverflowError가 발생하게 된다.

 

해결책 

해결책은 간단하다. 서로를 바라보고 있는 엔티티에 한해서는 @Data를 사용하지 않거나 toString()을 오버라이드하여 재정의 하는 것이다.