[JPA] orphanRemoval 옵션을 사용할 때 Update 주의사항

😂  배경

프로젝트 개발 중 특정 엔티티에 10개가 넘는 필드를 업데이트를 해달라는 비즈니스 요구사항이 있었다.

그래서 10개가 넘는 필드를 각각 업데이트하는 메서드를 작성했는데.. 보기에 별로 좋아 보이지 않았다.

 

필자는 JPA의 save() 메서드가 통해 저장과 변경에 대한 기능을 한 번에 제공하고 있다는 걸 알고 있었다. 그래서 빌더 패턴으로 기존 ID, 값, 변경된 값을 추가한  새로운 엔티티를 만들어서 save()를 통해 업데이트하는 게 보기에도 좋고 효율적으로 보였다. 생각대로 코드를 작성하고 테스트 한 뒤 나름 결과에 만족했다.

 

그러던 어느 날 운영 팀에서 연락이 온다.

 

"업데이트를 했더니 연결된 데이터가 다 사라졌는데요?"

 "????"

 

운영 중에 클라이언트가 업데이트를 했는데, 데이터가 다 사라졌다고 한다. 무슨 일인가 싶어서 서둘러 코드를 확인했다.

원인

업데이트 코드 작성 이후 나중에 추가된 연관관계에 orphanRemoval=true가 되어있던 게 문제였다.

 

다른 개발자가 해당 엔티티에는 orphanRemoval 옵션과 함께 연관 관계를 추가했는데, 막상 기존 업데이트 로직은 수정하지 않았다. 그래서 이후에 업데이트 API를 호출했을 때 해당 연관 관계 필드에는 null 값이 들어가게 되고, 결국 orphanRemoval 옵션에 의해 삭제가 되어버린 것이다.

해결

문제를 해결하는 방법은 업데이트 빌더에 해당 연관관계를 추가해서 수정하거나 update 메서드를 다시 열심히 만드는 방식 2가지였다.

 

필자는 후자를 선택했다. 같은 문제가 발생하지 않으리라는 보장이 없었기 때문이다.

마무리

다행히 DB는 백업이 되고 있었기 때문에 대부분의 데이터를 복구하는 데 성공했다.

사라졌던 데이터가 그렇게 중요한 데이터가 아니었고, 복구가 가능했기 때문에 다행이었다.

 

덕분에 DB 백업의 중요성에 대해 다시 한번 생각하게 되었고, 이후 동일한 요구사항이 있을 때 더 이상 save()를 이용한 업데이트 로직을 작성하지 않고 Dirty Checking을 활용한 update 메서드를 생성해서 로직을 작성하게 되었다.

 

 

[ 포스팅 관련 알면 좋은 지식 ]

 

1. orphanRemoval 특징

 

orphanRemoval 옵션을 true로 하면 기존 NULL처리된 자식을 삭제 처리한다.

PK(JoinColumn) 값이 NULL로 변한 자식은 고아객체. 즉, 연결된 점이 없는 객체이다. 

orphanRemoval 옵션은 이러한 고아객체를 삭제하는 역할을 한다.

 

2. JPA update

 

JPA는 save메서드를 통해 저장과 변경에 대한 기능을 한 번에 제공한다.

 

JPA는 Dirty Checking을 통해 영속화된 엔티티들의 변경을 자동으로 감지해서 수정 쿼리를 DB에 전달한다.
영속화된 엔티티는 save메서드를 사용하지 않아도 JPA에 의해 변경 사항이 자동으로 DB에 적용된다.

+ Reference

https://tecoble.techcourse.co.kr/post/2021-08-15-jpa-cascadetype-remove-vs-orphanremoval-true/

JPA CascadeType.REMOVE vs orphanRemoval = true