[Trouble Shooting] Jackson의 직렬화 관련 트러블 슈팅

벌써 다섯 번째 개인과제를 진행 중이다.

이번 과제는 [은행 환전]을 주제로 과제를 하면서 Jackson의 직렬화 관련하여 트러블 슈팅을 다루려고 한다.

 

GitHub 링크

 

1. 배경

1) 문제 상황

🚚 요청 URL : PUT localhost:8080/exhange/1/cancel

🚚 현상

→ IntelliJ 데이터베이스: exchange_request 테이블의 상태가 NORMAL에서 CANCELED로 정상적으로 반영되는 것을 확인

→ POSTMAN 응답 : 500 Internal Server Error 발생

<정상 응답 내용>

{
    "createdAt": "2024-11-28T23:09:31.424224",
    "modifiedAt": "2024-11-28T23:11:50.460609",
    "id": 1,
    "amountInKrw": 10000,
    "amountAfterExchange": 6.99,
    "status": "CANCELED"
}

 

<문제의 오류 메세지>

 

2) 원인 분석

1️⃣ ExchangeRequest 엔티티는 User와 Currency 엔티티와 ManyToOne 관계를 가짐

2️⃣ User와 Currency 엔티티는 각각 ExchangeRequest를 참조 - 양방향 연관관계

3️⃣ Jackson 라이브러리에서 Entity의 getter를 호출하고, 직렬화를 이용해 json으로 변환하게 전송가능한 형태로 바꾸어준다.

Entity의 getter를 호출하는 과정에서 연관된 엔티티를 계속해서 불러오다 보면 순환참조가 발생하여 Error가 발생하게 된 것이다.

 

즉, JPA에서 연관관계에서 양방향 관계를 가질 때 엔티티 간의 서로를 참조하는 구조에서 직렬화/역직렬화 시 JSON 변환 과정에서 순환참조가 발생했다.

-> 이를 적절히 처리하지 않으면 무한 루프가 발생하거나 성능 저하 또는 메모리 문제를 초래할 수 있다. 참고 블로그(1)

---

2. 절정

▶ 수정 전 로직

@ManyToOne(fetch = FetchType.LAZY)          // 데이터를 실제로 사용할 때 조회(지연로딩 방식)
@JoinColumn(name = "user_id", nullable = false)
@JsonBackReference              // 순환 참조 해결
private User user;                          // 고객 ID -> user와 N:1 관계 설정

@ManyToOne(fetch = FetchType.LAZY)          // 데이터를 실제로 사용할 때 조회(지연로딩 방식)
@JoinColumn(name = "to_currency_id", nullable = false)
private Currency currency;                // 환전 대상 통화 ID -> currency와 N:1 관계 설정

- Currency 필드에는 순환 참조를 방지하는 어노테이션이 없어 Jackson이 JSON 직렬화 과정에서 문제가 발생

 

▶ 수정 로직(방법 1)

@OneToMany(mappedBy = "currency", cascade = CascadeType.ALL, orphanRemoval = true)
@JsonManagedReference                  // 부모 관계로 설정
private List<ExchangeRequest> exchangeRequests = new ArrayList<>();

@OneToMany(mappedBy = "user",cascade = CascadeType.ALL, orphanRemoval = true)
@JsonManagedReference                    //부모 관계로 설정
private List<ExchangeRequest> exchangeRequests = new ArrayList<>();

@ManyToOne(fetch = FetchType.LAZY)         
@JoinColumn(name = "user_id", nullable = false)
@JsonBackReference                          // 자식 관계로 설정
private User user;                          

@ManyToOne(fetch = FetchType.LAZY)        
@JoinColumn(name = "to_currency_id", nullable = false)
@JsonBackReference                          // 자식 관계로 설정
private Currency currency;

➡️ @JsonManagedReference와 @JsonBackReference: 부모-자식 관계를 명시적으로 설정하여 직렬화 방향 제어 하는 방법 선택 참고블로그(2)

 

▶ 수정 로직(방법 2)

@ManyToOne(fetch = FetchType.LAZY)          // 데이터를 실제로 사용할 때 조회(지연로딩 방식)
@JoinColumn(name = "user_id", nullable = false)
@JsonIgnore// 순환 참조 에러 해결
private User user;                          // 고객 ID -> user와 N:1 관계 설정

@ManyToOne(fetch = FetchType.LAZY)          // 데이터를 실제로 사용할 때 조회(지연로딩 방식)
@JoinColumn(name = "to_currency_id", nullable = false)
@JsonIgnore                                 // 순환 참조 에러 해결
private Currency currency; 

➡️ @JsonBackReference를 @JsonIgnore로 변경

➡️ Currency 필드에도 @JsonIgnore 어노테이션 추가

➡️ @JsonIgnore를 사용하여 User와 Currency 필드를 JSON 직렬화 과정해서 완전히 무시하도록 설정

➡️ 순환 참조 문제와 직렬화 오류를 모두 해결할 수 있을 것

---

3. 결과

➡️ IntelliJ 데이터베이스 : exchange_request 테이블의 상태가 NORMAL에서 CANCELED로 정상적으로 변경되는 것을 확인

➡️ POSTMAN 응답 : Error 에러 발생 없이 정상 호출 확인

---

4. 결론

⭐️ @JsonBackReference VS @JsonIgnore

 

1. @JsonBackReference, @JsonManagedReference 사용  :

- @JsonBackReference는 직렬화 과정에서 해당 필드를 제외하지만, 반대쪽 필드에 @JsonManagedReference이 짝꿍으로 함께 필요하다!

  -> @JsonManagedReference와 @JsonBackReference는 부모-자식 관계를 명시적으로 설정하여 직렬화 방향 제어 하는 방법

  -> @JsonManagedReference는 역참조를 관리하는 객체에서 사용, @JsonBackReference는 역참조를 하지 않는 객체에서 사용

  -> 이 방법은 자식 엔티티를 직렬화하지 않기 때문에 무한 순환 참조 문제를 방지할 수 있다.

 

2. @JsonIgnore 사용:

- JSON 직렬화와 역직렬화 과정에서 필드를 완전히 무시한다.

  -> 간단하게 적용할 수 있는 방법이지만 @JsonIgnore 어노테이션을 사용하면 해당 필드를 완전히 무시하게 되므로 필요한 경우에는 부적합한 방법이라고 한다.