Entity 자체를 응답하거나 Entity를 포함하지 말자.

JSON의 무한 순환 구조는 왜 발생할까?  

나만의 옷장 서비스의 REST API 구현하면서 가장 고생한 부분이다.  

개발 초반에는 아무 생각 없이 DTO를 활용하지 않고 Entity를 직접 컨트롤러에서 반환했는데 객체가 또 다른 객체를 호출하고 그 객체가 또 다른 객체를 호출하는 무한 호출 현상이 발생했다.  예를 들어 무한 호출 현상을 대충 표현하자면 

a {
 b {
  c {
  }
 }
}


이런 식으로 a안에 b가 포함되어 b의 필드가 출력되고, 또 b의 필드에 c가 포함되어 c의 필드가 출력되고 만약에 c의 필드에 또다시 a필드가 포함되어 있다면 무한 호출 현상을 볼 수 있다. 결국에 서버가 죽어버리는 상황을 맞이하게 된다. 

 

위와 같이 무한 순환 구조가 발생하는 이유를 파악하기 위해서는 우선 객체를 JSON으로 어떤식으로 변환시키는지에 대한 확인이 필요했다. @RestController의 내부를 살펴보면 @ResponseBody 에노테이션을 포함하고 있는 것을 확인할 수 있다. @ResponseBody 에노테이션은 컨트롤러 메서드의 리턴 타입을 확인한 후 알맞은 MessageConverter를 찾아서 응답 형태로 변환시켜 준다. 위 프로젝트에서 사용한 Spring Boot는 기본적으로 Jackson 라이브러리를 포함하고 있어 객체를 반환할 때 기본적으로 Jackson 라이브러리에 포함되어 있는 MappingJackson2HttpMessageConverter를 이용하여 Json으로 Convert 한다.

 

따라서! 문제의 원인을 찾기 위해 MappingJackson2HttpMessageConverter의 변환 동작 방식을 살펴보자. 

 

MappingJackson2HttpMessageConverter의 동작 방식

MappingJackson2HttpMessageConverter는 JSON의 필드를 찾을 때 Getter(), Setter()를 이용하여 찾아낸다. 결국에 오류가 발생하는 이유는 어떤 Entity의 Getter(), Setter() 메서드를 통해 필드를 찾아내고, 만약에 그 필드가 Getter(), Setter()를 포함하고 있는 객체면 dfs 처럼 앞의 과정을 또 다시 반복하기 때문이다. 그렇기 때문에 MappingJackson2HttpMessageConverter의 동작 방식에 의해서 무한 호출 현상이 발생하는 것이다. 

 

따라서 무한 호출 현상을 피하기 위해서는 DTO 내에 순환 구조를 발생시킬 수 있는 객체를 포함시켜서는 안된다. 물론 아예 객체를 포함시키지 말라는 말이 아니라 순환 구조를 발생시킬 가능성이 있는 객체를 포함시켜서는 안된다는 의미이다. 

 

순환 구조를 발생시킬 가능성이 있는 객체를 포함시키지 말자

순환 구조를 방지하기 위한 완벽한 방법은 없다. 애초에 API를 설계할 때 이 부분을 신경써서 설계해야 한다. 순환 구조를 발생시킬 수 있는 객체는 무조건 제외하고 Entity를 직접 반환시키는 상황은 피해야 한다. (물론 JSON으로 변환시에 해당 필드를 무시하는 방식이 있지만 Entity와 API는 의존적이지 않은 것이 좋다) 

 

@Getter
public class ResponseForWardrobe extends Response {
    private Long id;
    private Integer likeCnt;
    private String memberName;
    private String email;
    private String name;
    private String isPublic;
    private String imageServerPath;

    @Builder
    public ResponseForWardrobe(Wardrobe wardrobe) {
        this.id = wardrobe.getId();
        this.memberName = wardrobe.getMember().getName();
        this.email = wardrobe.getMember().getEmail();
        this.name = wardrobe.getName();
        this.isPublic = wardrobe.getIsPublic();
        this.likeCnt = wardrobe.getLikeCnt();
        this.imageServerPath = wardrobe.getImage().getImageServerPath();
    }
}