[JPA/Error] 무한 참조 문제 해결하기 @JsonIgnoreProperties 활용

안녕하세요! 오늘은 JPA를 사용하여 데이터베이스 모델을 구축할 때 자주 마주치는 무한 참조 문제와 이를 해결하는 방법에 대해 이야기하려고 합니다. 특히, @JsonIgnoreProperties 어노테이션을 사용하여 양방향 관계에서 발생하는 무한 참조 문제를 해결하는 방법을 살펴보겠습니다.

문제 상황

데이터 모델에 양방향 관계가 있는 경우, 예를 들어 Album과 Image 엔티티가 서로를 참조하는 경우, JSON 으로 직렬화할 때 무한 참조 문제가 발생할 수 있습니다. Jackson 라이브러리는 객체를 JSON 으로 변환할 때 이러한 양방향 참조를 처리하지 못하고 무한 루프에 빠질 수 있습니다.

 

문제의 예

Album 엔티티와 Image 엔티티가 서로를 참조하는 구조는 다음과 같습니다.

@Entity
public class Album {
    // ...

    @OneToMany(mappedBy = "album", cascade = CascadeType.ALL, orphanRemoval = true)
    private List<Image> images;

    // ...
}

@Entity
public class Image {
    // ...

    @ManyToOne
    @JoinColumn(name = "album_id")
    private Album album;

    // ...
}

이 구조에서 Album 엔티티를 JSON으로 변환하려고 할 때, Album은 Image 목록을 포함하고, 각 Image는 다시 Album을 참조합니다. 이로 인해 무한 참조 문제 가 발생합니다.

JPA 양방향 무한 참조 로그

해결 방법 @JsonIgnoreProperties

@JsonIgnoreProperties 어노테이션을 사용하여 무한 참조 문제를 해결할 수 있습니다. 이 어노테이션은 특정 속성을 JSON 직렬화 과정에서 제외시키는 역할을 합니다.

Image 엔티티에서 Album 엔티티에 대한 참조를 가질 때, @JsonIgnoreProperties 를 사용하여 images 속성을 직렬화 에서 제외 시킵니다.

@Entity
public class Image {
    // ...

    @JsonIgnoreProperties({"images"})
    @ManyToOne
    @JoinColumn(name = "album_id")
    private Album album;

    // ...
}

이 설정으로 Image 엔티티가 JSON으로 변환될 때, album 필드 내부의 images 속성은 무시 됩니다. 따라서 Album 엔티티를 직렬화할 때 무한 참조 문제가 발생하지 않습니다.

결론

@JsonIgnoreProperties 어노테이션은 JPA 에서 양방향 관계를 가진 엔티티들을 JSON 으로 변환할 때 무한 참조 문제를 해결하는 간단하고 효과적인 방법입니다. 이 방법을 사용함으로써, 데이터 모델을 안전하게 JSON 으로 직렬화할 수 있으며, RESTful API 개발 시 유용하게 활용할 수 있습니다. 감사합니다~~~