SpringBoot JPA에서 순환 참조 문제와 그 해결 방법

순환 참조의 원인

Spring Boot는 @ResponseBody 어노테이션을 선언할 때 객체를 JSON 상태로 변환하기 위해 Jackson 라이브러리를 사용합니다. Jackson은 객체를 직렬화하여 JSON 형태로 변환하는데, 기본적으로 public 필드 또는 getter가 있는 필드만 직렬화 대상으로 취급합니다. 예를 들어, 다음과 같은 Member 클래스가 있습니다:

public class Member { 
    private String stringValue; 
    int intValue; 
    protected float floatValue; 
    public boolean booleanValue; 
// No Getter Setter 
}

위 클래스에서는 booleanValue만 public이므로 JSON으로 직렬화됩니다.

실제 순환 참조 문제를 보여주는 예시

Board와 Post 엔티티를 통해 순환 참조 문제를 살펴보겠습니다.

Board.java

@Entity  
@Getter  
@Setter  
@AllArgsConstructor  
@NoArgsConstructor  
public class Board {  
    @Id  
    @GeneratedValue(strategy = GenerationType.AUTO)  
    @Column(name = "board_id")  
    private Long id;  

    @Column(name = "board_name")  
    private String name;  

    @OneToMany(mappedBy = "board", cascade = CascadeType.ALL)  
    private List<Post> postList = new ArrayList<>();  
}

Post.java

@Entity  
@Data  
public class Post extends TimeEntity {  
    @Id  
    @GeneratedValue    @Column(name = "post_id")  
    private Long id;  
    @Column(nullable = false, name = "post_title")  
    private String title;   //제목  

    @Column(nullable = false, length = 3000, name = "post_content")  
    private String content; //내용  


    @ManyToOne(targetEntity = Board.class, fetch = FetchType.EAGER, optional = false)  
    @JoinColumn(name = "board_id", nullable = false)  
    private Board board;  
}

이 구성에서 Board의 postList를 직렬화하면 각 Post의 board 객체를 다시 직렬화하려고 하고, 이 과정이 반복되어 순환 참조가 발생합니다.

순환 참조 해결 방법

해결 방법으로는 여러 가지가 있습니다. 가장 효과적인 두 가지 방법은 다음과 같습니다.

1. @JsonManagedReference와 @JsonBackReference 사용

@JsonManagedReference는 직렬화에 포함되며, @JsonBackReference는 직렬화에서 제외됩니다. 이를 적용하면 다음과 같습니다:

Board.java

@Entity  
@Getter  
@Setter  
@AllArgsConstructor  
@NoArgsConstructor  
public class Board {  
    @Id  
    @GeneratedValue(strategy = GenerationType.AUTO)  
    @Column(name = "board_id")  
    private Long id;  

    @Column(name = "board_name")  
    private String name;  

    @JsonManagedReference  
    @OneToMany(mappedBy = "board", cascade = CascadeType.ALL)  
    private List<Post> postList = new ArrayList<>();  
}

Post.java

@Entity  
@Data  
public class Post extends TimeEntity {  
    @Id  
    @GeneratedValue    @Column(name = "post_id")  
    private Long id;  
    @Column(nullable = false, name = "post_title")  
    private String title;   //제목  

    @Column(nullable = false, length = 3000, name = "post_content")  
    private String content; //내용  

    @JsonBackReference  
    @ManyToOne(targetEntity = Board.class, fetch = FetchType.EAGER, optional = false)  
    @JoinColumn(name = "board_id", nullable = false)  
    private Board board;  
}

순환 참조 해결을 위한 실제 적용 사례

프로젝트에서 실제로 순환 참조 문제를 해결하기 위해 여러 방법을 적용할 수 있습니다. 위에서 설명한 @JsonManagedReference와 @JsonBackReference 외에도, DTO를 사용하는 방법은 데이터를 더 효율적으로 관리하고 API 응답을 최적화하는 데 도움을 줍니다.

DTO(Data Transfer Object)를 사용한 순환 참조 해결

DTO 사용 예시로 Author와 Book의 관계를 살펴보겠습니다. 이 예시에서는 간단한 도서 관리 시스템을 구축할 때 Author가 여러 Book을 가질 수 있는 관계를 설정합니다.

Author.java

@Entity
public class Author {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;

    @OneToMany(mappedBy = "author", cascade = CascadeType.ALL)
    private List<Book> books = new ArrayList<>();
}

Book.java

@Entity
public class Book {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String title;
    private String genre;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "author_id")
    private Author author;
}

AuthorDTO.java

public class AuthorDTO {
    private Long id;
    private String name;
    private List<BookDTO> books;

    public AuthorDTO(Author author) {
        this.id = author.getId();
        this.name = author.getName();
        this.books = author.getBooks().stream().map(BookDTO::new).collect(Collectors.toList());
    }
}

public class BookDTO {
    private Long id;
    private String title;
    private String genre;

    public BookDTO(Book book) {
        this.id = book.getId();
        this.title = book.getTitle();
        this.genre = book.getGenre();
    }
}

위 예시에서는 Author와 Book 사이의 순환 참조 문제를 DTO를 통해 해결합니다. AuthorDTO와 BookDTO는 각각 필요한 정보만을 포함하므로, 직렬화 과정에서 순환 참조가 발생하지 않습니다.

매핑 재설정을 통한 순환 참조 해결

때로는 양방향 매핑이 꼭 필요하지 않을 수 있습니다. 필요한 경우에만 양방향 매핑을 설정하고, 그렇지 않은 경우에는 단방향 매핑을 고려해보는 것이 좋습니다. 이 방법은 구조를 단순화하고 성능을 개선하는 데 도움이 될 수 있습니다.

순환 참조 문제는 많은 프로젝트에서 직면할 수 있는 과제입니다. 이를 해결하기 위해 다양한 접근 방법을 이해하고 적절히 적용하는 것은 프로젝트의 성공에 크게 기여할 수 있습니다. 순환 참조 문제를 해결하는 방법을 잘 이해하고, 상황에 맞게 적용하여 오류가 발생하지 않도록 주의해보자