JPA 활용 1 - 변경 감지와 병합(merge)

코드

해당 내용을 설명하기 전 강의에 있는 코드는 아래 Github링크를 참조하자.

• https://github.com/rhqudco/SpringLearn/tree/master/jpashop

변경 감지와 병합

영속 상태의 엔티티는 변경이 감지되면 따로 persist 하지 않아도 JPA가 커밋 시점에 DB에 알아서 반영을 해준다.
이것을 변경감지(Dirty Checking)라고 한다.

문제는 준영속 엔티티다.
준영속 엔티티?
영속성 컨텍스트가 더는 관리하지 않는 엔티티를 말한다.
예를 들어 이미 DB에 저장했던 값을 다시 조회해서 JPA가 식별할 수 있는 식별자가 있고, 그것을 다시 객체 상태로 만든 것을 준영속 상태의 객체라고 한다.

@PostMapping("/items/{itemId}/edit")
public String updateItem(@ModelAttribute("form") BookForm form, @PathVariable String itemId) {
    Book book = new Book();
    book.setId(form.getId());
    book.setName(form.getName());
    book.setPrice(form.getPrice());
    book.setStockQuantity(form.getStockQuantity());
    book.setAuthor(form.getAuthor());
    book.setIsbn(form.getIsbn());
    itemService.saveItem(book);
    return "redirect:/items";
}

해당 객체는 Book book = new Book();을 통해 새로 만든 객체지만 이미 DB에 들어갔다가 다시 나온 객체를 수정하기 때문에 준영속 상태의 객체이다.

준영속 엔티티는 JPA가 관리하는 객체가 아니기 때문에 변경감지(Dirty Checking)가 일어나지 않아서 트랜잭션 안에서 어떤 짓을 해도 값이 바뀌지 않는다.
그래서 itemService.saveItem(book);을 통해 다시 저장을 했다.

준영속 엔티티를 수정하는 2가지 방법

• 변경 감지 기능 사용
• 병합(merge) 사용

변경 감지 기능 사용

@Transactional
public void updateItem(Long itemId, Book bookParam) {
    Item findItem = itemRepository.findOne(itemId); // JPA가 관리하는 영속성 객체
    findItem.setPrice(bookParam.getPrice());
    findItem.setName(bookParam.getName());
    findItem.setStockQuantity(bookParam.getStockQuantity());
    // itemRepository.save(findItem); 을 호출할 필요가 없음
    // JPA가 flush를 날려서 변경 감지(dirty checking)를 해서 커밋해 업데이트 쿼리를 날려줌
}

영속성 컨텍스트에서 엔티티를 다시 조회한 후에 데이터를 수정하는 방법이다.
트랜잭션 안에서 엔티티를 다시 조회(itemRepository.findOne(itemId)이때 영속성 컨텍스트에 등록), 변경할 값 선택
-> 트랜잭션 커밋 시점에 변경 감지(Dirty Checking)이 동작해서 데이터베이스에 UPDATE SQL 실행

병합 사용

병합은 준영속 상태의 엔티티를 영속 상태로 변경할 때 사용하는 기능이다.

@Transactional
void update(Item itemParam) { //itemParam: 파리미터로 넘어온 준영속 상태의 엔티티
  Item mergeItem = em.merge(item);
}

merge는 같은 식별자로 데이터를 찾고(이때 영속성 컨텍스트에 등록), 파라미터로 넘어온 값으로 모든 데이터를 바꾼뒤 커밋 시점에 데이터를 바꾼 값으로 반영시킨다.

사진

병합 동작 방식

1. merge()를 실행한다.
2. 파리미터로 넘어온 준영속 엔티티의 식별자 값으로 1차 캐시에서 엔티티를 조회한다.
   1. 만약 1차 캐시에 엔티티가 없으면 데이터베이스에서 엔티티를 조회하고, 1차 캐시에 저장한다.
3. 조회한 영속 엔티티(mergeMember) 에 member엔티티의 값을 채워 넣는다. (member엔티티의 모든 값을 mergeMember에 밀어 넣는다. 이때 mergeMember의 “회원1”이라는 이름이 “회원명변경”으로 바뀐다.)
4. 영속 상태인 mergeMember를 반환한다.

간단하게 정리하면 다음과 같다.

1. 준영속 엔티티의 식별자 값으로 영속 엔티티를 조회한다.
2. 영속 엔티티의 값을 준영속 엔티티의 값으로 모두 교체한다.(병합한다)
3. 트랜잭션 커밋 시점에 변경 감지 기능이 동작해서 데이터베이스에 UPDATE SQL이 실행된다.

주의 : 변경 감지 기능을 사용하면 원하는 속성만 선택해서 변경할 수 있지만, 병합을 사용하면 모든 속성이 변경된다. 병합시 값이 없으면 null로 업데이트 할 위험도 있다.(병합은 모든 필드를 교체함)

병합 코드

public void save(Item item) {
    if(item.getId() == null) {
        em.persist(item);
        // id 값이 없기 때문에 (신규 등록이기 때문에) 신규 등록 역할
    } else {
        em.merge(item);
        // id 값이 있기 때문에 (중복 등록이기 때문에) 업데이트 역할
    }
}

save() 메서드를 유심히 봐야 하는데, 이 메서드 하나로 저장과 수정(병합)을 다 처리한다.
코드를 보면 식별자 값이 없으면 새로운 엔티티로 판단해서 persist()로 영속화하고 만약 식별자 값이 있으면 이미 한번 영속화 되었던 엔티티로 판단해서 merge()로 수정(병합)한다.
결국 여기서의 저장(save)이라는 의미는 신규 데이터를 저장하는 것뿐만 아니라 변경된 데이터의 저장이라는 의미도 포함한다.
이렇게 함으로써 이 메서드를 사용하는 클라이언트는 저장과 수정을 구분하지 않아도 되므로 클라이언트의 로직이 단순해진다.

여기서 사용하는 수정(병합)은 준영속 상태의 엔티티를 수정할 때 사용한다.
영속 상태의 엔티티는 변경 감지(dirty checking)기능이 동작해서 트랜잭션을 커밋할 때 자동으로 수정되므로 별도의 수정 메서드를 호출할 필요가 없고 그런 메서드도 없다.

참고 : 실무에서는 보통 업데이트 기능이 매우 재한적이다. 그런데 병합은 모든 필드를 변경해버리고, 데이터가 없으면 null로 업데이트 해버린다. 병합을 사용하면서 이 문제를 해결하려면, 변경 폼 화면에서 모든 데이터를 항상 유지해야 한다. 실무에서는 보통 변경가능한 데이터만 노출하기 때문에, 병합을 사용하는 것이 오히려 번거롭다.

가장 좋은 해결 방법

엔티티를 변경할 때는 항상 변경 감지를 사용하자!

• 컨트롤러에서 어설프게 엔티티를 생성하지 말자.
• 트랜잭션이 있는 서비스 계층에 식별자(id)와 변경할 데이터를 명확하게 전달하자.(파라미터 or dto)
• 트랜잭션이 있는 서비스 계층에서 영속 상태의 엔티티를 조회하고, 엔티티의 데이터를 직접 변경하자.
• 트랜잭션 커밋 시점에 변경 감지가 실행된다.

// Service
@Transactional
public void updateItem(Long itemId, String name, int price, int stockQuantity) {
    Item findItem = itemRepository.findOne(itemId); // JPA가 관리하는 영속성 객체
    findItem.setName(name);
    findItem.setPrice(price);
    findItem.setStockQuantity(stockQuantity);
}
// Controller
@PostMapping("/items/{itemId}/edit")
public String updateItem(@ModelAttribute("form") BookForm form, @PathVariable Long itemId) {
    itemService.updateItem(itemId, form.getName(), form.getPrice(), form.getStockQuantity());
    return "redirect:/items";
}

출처 : 인프런 김영한 지식공유자님 강의 - 실전! 스프링 부트와 JPA 활용1 - 웹 애플리케이션 개발