7. 웹 계층 개발

폼 객체 vs 엔티티 직접 사용

요구사항이 정말 단순할 때는 폼 객체(MemberForm) 없이 엔티티(Member)를 직접 등록과 수정 화면에서 사용해도 된다.  하지만 화면 요구사항이 복잡해지기 시작하면, 엔티티에 화면을 처리하기 위한 기능이 점점 증가한다.

결과적으로 엔티티는 점점 화면에 종속적으로 변하고, 이렇게 화면 기능 때문에 지저분해진 엔티티는 결국 유지보수하기 어려워진다. 실무에서 엔티티는 핵심 비즈니스 로직만 가지고 있고, 화면을 위한 로직은 없어야 한다.

화면이나 API에 맞는 폼 객체나 DTO를 사용하자. 그래서 화면이나 API 요구사항을 이것들로 처리하고, 엔티티는 최대한 순수하게 유지하자.

변경 감지와 병합(merge)

준영속 엔티티?
영속성 컨텍스트가 더는 관리하지 않는 엔티티를 말한다.
여기서는 itemService.saveItem(book)에서 수정을 시도하는 Book 객체다.

Book객체는 이미 DB에 한번 저장되어서 식별자가 존재한다.

이렇게 임의로 만들어낸 엔티티도 기존 식별자를 가지고 있으면 준영속 엔티티로 볼 수 있다.

JPA가 관리하는 영속상태의 엔티티는 변경 감지라는 게 일어난다.

하지만 아래 코드는 new Book()을 해서 직접 만든 객체이다. 이 객체는 JPA가 관리하지 않는다.

그래서 이 값을 변경해도 JPA가 그걸 감지해서 update 쿼리를 만들 수 없다.

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);

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

• 준영속 엔티티지만 변경 감지 기능 사용
• 병합( merge ) 사용

변경 감지 기능 사용

@Transactional
void update(Item itemParam) { //itemParam: 파리미터로 넘어온 준영속 상태의 엔티티
    Item findItem = em.find(Item.class, itemParam.getId()); //같은 엔티티를 조회한다.
    findItem.setPrice(itemParam.getPrice()); //데이터를 수정한다. 
}

영속성 컨텍스트에서 엔티티를 다시 조회한 후에 데이터를 수정하는 방법

Item findItem = em.find(Item.class, itemParam.getId());

• id(PK)를 기반으로 실제 DB에 있는 영속 상태 엔티티를 찾아온다.
• 즉 findItem은 영속 상태의 엔티티다.

findItem.setPrice(itemParam.getPrice());

• 데이터를 수정한다.
• 영속 상태의 엔티티를 수정했기에 변경 감지가 발생한다.

정리

트랜잭션 안에서 엔티티를 다시 조회, 변경할 값 선택

-> 트랜잭션 커밋 시점에 변경 감지(Dirty Checking)가 동작해서 데이터베이스에 UPDATE SQL 실행

병합 사용

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

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

병합: 기존에 있는 엔티티

병합 동작 방식

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

병합 시 동작 방식을 간단히 정리

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

주의
변경 감지 기능을 사용하면 원하는 속성만 선택해서 변경할 수 있지만, 병합을 사용하면 모든 속성이 변경된다.
병합 시 값이 없으면 null로 업데이트 할 위험도 있다.(병합은 모든 필드를 교체한다.)
예를들어 사용자가 특정 값을 안 넣고 전송 시 해당 값에는 null이 채워질 수 있다.
근데 병합을 사용하면 모든 속성들이 변경되므로 사용자가 미입력한 값이 null로 변경될 수 있는 위험이 있다.

상품 리포지토리의 저장 메서드 분석 ItemRepository

@Repository
public class ItemRepository {

    @PersistenceContext
    EntityManager em;
    
    public void save(Item item) {
        if (item.getId() == null) {
        	em.persist(item);
        } else {
        	em.merge(item);
        }
    }
    //...
}

• save()메서드는 식별자 값이 없으면(null) 새로운 엔티티로 판단해서 영속화(persist)하고 식별자가 있으면 병합(merge)
• 지금처럼 준영속 상태인 상품 엔티티를 수정할 때는 id값이 있으므로 병합 수행

새로운 엔티티 저장과 준영속 엔티티 병합을 편리하게 한번에 처리

상품 리포지토리에선 save() 메서드를 유심히 봐야 하는데, 이 메서드 하나로 저장과 수정(병합)을 다 처리한다.

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

 

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

참고: save() 메서드는 식별자를 자동 생성해야 정상 동작한다. 여기서 사용한 Item 엔티티의 식별자는 자동으로 생성되도록 @GeneratedValue를 선언했다. 따라서 식별자 없이 save() 메서드를 호출하면 persist()가 호출되면서 식별자 값이 자동으로 할당된다. 반면에 식별자를 직접 할당하도록 @Id만 선언했다고 가정하자. 이 경우 식별자를 직접 할당하지 않고, save()메서드를 호출하면 식별자가 없는 상태로 persist()를 호출한다. 그러면 식별자가 없다는 예외가 발생한다.

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

가장 좋은 해결 방법

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

• 컨트롤러에서 어설프게 엔티티를 생성하지 말기
  • 핵심은 변경 메서드를 사용할 때 변경에 필요한 값만 전달하자
  • 그렇지 않고 엔티티를 어설프게 만들어서 전달하면, 해당 엔티티에는 변경에 필요하지 않는 데이터까지 모두 포함해서 넘길 수 있다.
• 트랜잭션이 있는 서비스 계층에 식별자(id)와 변경할 데이터를 명확하게 전달하기(파라미터 or dto)
• 트랜잭션이 있는 서비스 계층에서 영속 상태의 엔티티를 조회하고, 엔티티의 데이터를 직접 변경하기
• 트랜잭션 커밋 시점에 변경 감지가 실행된다.

예시코드

@Controller
@RequiredArgsConstructor
public class ItemController {
    private final ItemService itemService;
    /**
     * 상품 수정, 권장 코드 */
    @PostMapping(value = "/items/{itemId}/edit")
    public String updateItem(@PathVariable Long itemId, 
                       @ModelAttribute("form") BookForm form) {
       
       itemService.updateItem(itemId, form.getName(), form.getPrice(), form.getStockQuantity());
       return "redirect:/items";
    }
}

@Service
@RequiredArgsConstructor
public class ItemService {
    
    private final ItemRepository itemRepository;
    
    /**
     * 영속성 컨텍스트가 자동 변경 
     * */
    @Transactional
    public void updateItem(Long id, String name, int price, int stockQuantity) {
       Item item = itemRepository.findOne(id);
       item.setName(name);
       item.setPrice(price);
       item.setStockQuantity(stockQuantity);
    } 
}

보통 업데이트는 위와 같이 단발성으로 업데이트를 하면 안된다.

item.change(name, price, stockQuantity) 이런 식으로 의미 있는 메서드를 사용하여 값을 수정해야지 단순히 setter을 사용하여 값을 수정하면 안 된다. 이렇게 해야 변경 지점이 엔티티로 가서 유지보수하기 용이하다.

command 컨트롤러 id 전송

@Controller
@RequiredArgsConstructor
public class OrderController {

    private final OrderService orderService;
    private final MemberService memberService;
    private final ItemService itemService;

    @PostMapping(value = "/order")
    public String order(@RequestParam("memberId") Long memberId,
                        @RequestParam("itemId") Long itemId, @RequestParam("count") int count) {

        orderService.order(memberId, itemId, count);

        return "redirect:/orders";
    }
}

// 주문
@Transactional
public Long order(Long memberId, Long itemId, int count) {
    // 엔티티 조회
    Member member = memberRepository.findOne(memberId);
    Item item = itemRepository.findOne(itemId);

    // 배송정보 생성
    Delivery delivery = new Delivery();
    delivery.setAddress(member.getAddress());

    // 주문상품 생성
    OrderItem orderItem = OrderItem.createOrderItem(item, item.getPrice(), count);

    // 주문 생성
    Order order = Order.createOrder(member, delivery, orderItem);

    // 주문 저장
    orderRepository.save(order);
    return order.getId();
}

컨트롤러 쪽에서 id값으로 엔티티를 찾아서 서비스로 넘겨도 된다.

하지만 이 방식보다는 컨트롤러 쪽에서 서비스 쪽으로 id를 넘기는게 더 깔끔하게 코드를 짤 수 있다.

주로 command성은 컨트롤러 레벨에서는 식별자만 서비스쪽으로 넘긴다.

실제 서비스 로직에서 엔티티를 찾아 코드를 작성한다.

이렇게 하면 트랜잭션 안에서 엔티티를 조회할 수 있어 해당 엔티티를 영속 상태로 관리할 수 있다.

이를 통해 엔티티가 바뀌게 되면 더티체킹을 적용할 수 있다.