JPA 활용 (2)

1. 애플리케이션 구현 준비

애플리케이션 아키텍쳐

 

계층형 구조 사용

• controller, web : 웹 계층
• service : 비즈니스 로직, 트랜잭션 처리
• repository : JPA 를 직접 사용하는 계층, 엔티티 매니저 사용
• domain : 엔티티가 모여 있는 계층, 모든 계층에서 사용

 

패키지 구조

• jpabook.jpashop
  • domain
  • exception
  • repository
  • service
  • web

개발 순서 : service, repository 계층 개발하고, 테이스 케이스 작성해서 검증, 마지막에 웹 계층 적용

 

 

2. 회원 도메인 개발

• 구현 기능
  • 회원 등록
  • 회원 목록 조회
• 순서
  
  • 회원 리포지토리 개발
  • 회원 서비스 개발
  • 회원 기능 테스트

 

회원 리포지토리 개발

[회원 리포지토리 코드]

@Repository //스프링 빈으로 등록(Component scan의 대상이 됨)
@RequiredArgsConstructor
public class MemberRepository {
//    @PersistenceContext //EntityManager 주입
//    private EntityManager em;
    private final EntityManager em;

    /*
     저장
     */
    public void save(Member member) {
        em.persist(member); //JPA가 저장
    }
    /*
    단건 조회
     */
    public Member findOne(Long id) {
        return em.find(Member.class, id); //(Entity Class, PK)
    }
    /*
    리스트 조회
     */
    public List<Member> findAll(){
        return em.createQuery("select m from Member m", Member.class) //createQuery(jpql, 반환타입)
                .getResultList(); //멤버를 리스트로 만들어줌
        /*
        * List<Member> result = em.createQuery("select m from Member m", Member.class)
        *         .getResultList();
        * return result;
        * -인라인 변수 단축키 : Ctrl + Alt + N
        * */

    }
    /*
    이름으로 회원 조회
     */
    public List<Member> findByName(String name) {
        return em.createQuery("select m from Member m where m.name = :name", Member.class)
                .setParameter("name", name) //첫 파라미터가 jpql :name에 바인딩됨
                .getResultList();
    }
}

 

 

회원 서비스 개발

[회원 서비스 코드]

@Service
@Transactional(readOnly = true)
//@AllArgsConstructor //필드 모든 것을 가지고 생성자 만들어줌.
@RequiredArgsConstructor //final이 있는 필드만 가지고 생성자 만들어줌-> 테스트케이스에서도 리파지토리 초기화를 빼먹으면 에러를 내주기 때문에 권장
public class MemberService {
    //@Autowired //Field Injection
    private final MemberRepository memberRepository;
    //생성자 주입시 final 권장

//   @Autowired //Setter Injection -> 테스트 코드 작성 시 Mock을 직접 주입해줄 수 있는 장점이 있다
//   but 조립 이후에 애플리케이션 동작 중에 바꿀 일이 없기 때문에 권장하지 않는다.
//    public void setMemberRepository(MemberRepository memberRepository) {
//        this.memberRepository = memberRepository;
//    }

//    @Autowired //생성자 인젝션(권장) -> 생성자가 딱 하나만 있는 경우에는 자동으로 Autowired해줘서 생략 가능
//    public MemberService(MemberRepository memberRepository) {
//        this.memberRepository = memberRepository;
//    }

    /*
            회원 가입
             */
    @Transactional //읽기 전용이 아닌 쓰기에는 readOnlt=true를 해버리면 데이터 변경이 안 됨 (false)
    public Long join(Member member){
        validateDuplicateMember(member); //중복 회원 검증
        memberRepository.save(member);
        return member.getId(); //Id 반환
    }

    //#JPA 유니크 제약 조건 알아보기
    private void validateDuplicateMember(Member member) { //중복 회원이면 예외 터짐
        //EXCEPTION
        List<Member> findMembers = memberRepository.findByName(member.getName());
        if(!findMembers.isEmpty()) {
            throw new IllegalStateException("이미 존재하는 회원입니다.");
        }
    }

    /*
    회원 전체 조회
     */
    public List<Member> findMembers() {
        return memberRepository.findAll();
    }
    /*
    단 건 조회
     */
    public Member findOne(Long memberId) {
        return memberRepository.findOne(memberId);
    }
	
    /*
    회원 수정
    */
    @Transactional
    public void update(Long id, String name) {
        Member member = memberRepository.findOne(id); //id로 찾아와서
        member.setName(name);//이름 변경
    }
}

실무에서는 검증 로직이 있어도 멀티 쓰레드 상황을 고려해서 회원 테이블 회원명 컬럼에 유니크 제약 조건을 추가하는 것이 안전하다.

 

[회원 기능 테스트]

• 테스트 요구사항
  • 회원 가입 성공
  • 회원 가입 할 때 같은 이름 있으면 예외 발생
  •  

@RunWith(SpringRunner.class) //Junit 쓸 때 Spring과 엮어서 쓰기 위함
@SpringBootTest //스프링 부트 띄우고 테스트
@Transactional
public class MemberServiceTest {
    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository;

    @Test
    public void 회원가입() throws Exception {
        //given
        Member member = new Member();
        member.setName("kim");

        //when
        Long saveId = memberService.join(member);

        //then
        assertEquals(member, memberRepository.findOne(saveId)); //kim과 memberRepository에서 찾아온 거랑 같아야함

    }

    @Test(expected = IllegalStateException.class)
    public void 중복_회원_예외() throws Exception {
        //given
        Member member1 = new Member();
        member1.setName("kim");

        Member member2 = new Member();
        member2.setName("kim");

        //when
        memberService.join(member1);
        memberService.join(member2); //예외가 발생해야 함

//        memberService.join(member1);
//        try {
//            memberService.join(member2);
//        } catch (IllegalStateException e) {
//            return;
//        }

        //then
        fail("예외가 발생해야 한다.");
    }
}

 

테스트 케이스는 격리된 환경에서 실행하고, 끝나면 데이터를 초기화하는 것이 좋다 그런 면에서 메모리 DB를 사용하는 것이 가장 이상적이다. 

테스트 케이스를 위한 스프링 환경과 일반적으로 애플리케이션을 실행하는 환경은 보통 다르므로 설정 파일을 다르게 사용하는 것이 좋다.

test/resources/application.yml에 테스트용 설정 파일을 추가한다.

spring:
logging.level:
  orghibernate.SQL: debug

 

 

3. 상품 도메인 개발

• 구현 기능
  • 상품 등록
  • 상품 목록 조회
  • 상품 수정

 

상품 엔티티 개발(비즈니스 로직 추가)

[상품 엔티티 코드] Item.java에 추가

 //===비즈니스 로직===//
    /*
    * stock 증가
    * */
    public void addStock(int quantity) {
        this.stockQuantity += quantity;
    }
    /*
     * stock 감소
     * */
    public void removeStock(int quantity) {
        int restStock = this.stockQuantity - quantity;
        if(restStock<0) {  //수량이 0보다 적어지는 것 방지
            throw new NotEnoughStockException("need more stock");
        }
        this.stockQuantity = restStock;
    }

 

• addStock() 메서드는 파라미터로 넘어온 수만큼 재고를 늘린다. 이 메서드는 재고가 증가하거나 상품 주문을 취소해서 재고를 다시 늘려야 할 때 사용한다.
• removeStrock()는 파라미터로 넘어온 수만큼 재고를 줄인다. 만약 재고가 부족하면 예외가 발생하고 주로 상품을 주문할 때 사용한다.

[예외  추가]

public class NotEnoughStockException extends RuntimeException {
    public NotEnoughStockException() {
    }

    public NotEnoughStockException(String message) {
        super(message);
    }

    public NotEnoughStockException(String message, Throwable cause) {
        super(message, cause);
    }

    public NotEnoughStockException(Throwable cause) {
        super(cause);
    }
}

 

[상품 리포지토리 코드]

@Repository
@RequiredArgsConstructor
public class ItemRepository {

    private final EntityManager em;

    public void save(Item item) {
        if (item.getId() == null) { //item은 저장하기 전까지 id값이 없음 -> 새로운 객체로 등록
            em.persist(item);
        } else {
            em.merge(item);
        }
    }

    //item 하나 조회
    public Item findOne(Long id) {
        return em.find(Item.class, id);
    }

    public List<Item> findAll() {
        return em.createQuery("select i from Item i", Item.class)
                .getResultList();
    }
}

 

• save() 
  • id가 없으면 신규로 보고 persist()실행
  • id가 있으면 이미 db에 저장된 엔티티를 수정한다고 보고, merge()실행

 

[상품 서비스 코드]

@Service
@Transactional(readOnly = true) //readOnly = true : 직관용
@RequiredArgsConstructor
public class ItemService {

    private final ItemRepository itemRepository;
    //상품 서비스는 상품 리포지토리에 단순하게 위임만하는 클래스
    //-> 트랜잭션 관리를 서비스 계층에서 할 수 있는 장점이 있음
    @Transactional
    public void saveItem(Item item) {
        itemRepository.save(item);
    }

    /*
    * 변경 감지 기능 사용 (merge 사용 보다는 변경 감지 사용)
    * */
    @Transactional
    public Item updateItem(Long itemId, String name, int price, int stockQuantity) {
        Item findItem = itemRepository.findOne(itemId); //아이디 기반으로 실제 db에 있는 영속상태 엔티티 찾아옴
        findItem.setName(name);
        findItem.setPrice(price);
        findItem.setStockQuantity(stockQuantity);
        return findItem;
    }
    public List<Item> findItems() {
        return itemRepository.findAll();
    }

    public Item findOne(Long itemId) {
        return itemRepository.findOne(itemId);
    }
}

 

상품 서비스는 상품 리포지토리에 단순히 위임만 하는 클래스이다.

 

4. 주문 도메인 개발

• 구현 기능
  • 상품 주문
  • 주문 내역 조회
  • 주문 취소

 

주문 엔티티 개발

[주문 엔티티 코드] order.java에 추가

   */
     //===생성 메서드 ===//
    //생성 지점 변경시 여기만 변경하면 됨
    //생성을 할 때부터 createOrder 호출, 주문 생성 메서드 이곳에서 응집해서 완결
    public static Order createOrder(Member member, Delivery delivery, OrderItem... orderItems) {
        Order order = new Order();
        order.setMember(member);
        order.setDelivery(delivery);
        for (OrderItem orderItem : orderItems) {
            order.addOrderItem(orderItem);
        }
        order.setStatus(OrderStatus.ORDER); //처음 상태를 ORDER상태로 강제로 지정
        order.setOrderDate(LocalDateTime.now()); //주문 시간 정보
        return order;
    }

    //===비즈니스 로직===//
    /*
    * 주문 취소
    * */
    public void cancel(){
        //배송이 끝나버리면 취소가 불가능
        if (delivery.getStatus() == DeliveryStatus.COMP) {
            throw new IllegalStateException("이미 배송완료된 상품은 취소가 불가능합니다.");
        }

        this.setStatus(OrderStatus.CANCEL); //order상태 cancel로 변경
        for (OrderItem orderItem : orderItems) {  //루프 돌면서 재고 원복
            orderItem.cancel();
        }
    }

    //===조회 로직===//
    /*
    * 전체 주문 가격 조회
    * */
    public int getTotalPrice() {
        int totalPrice = 0;
        for (OrderItem orderItem : orderItems) {
            totalPrice += orderItem.getTotalPrice();
        }
        return totalPrice;
    }

 

• 생성 메서드(createOrder()) : 주문 엔티티를 생성할 때 사용되는데, 주문 회원, 배송정보, 주문 상품의 정보를 받아서 실제 주문 엔티티를 생성한다.
  • 생성자 대신 왜 생성 메서드를 쓰는가? -> 정적 팩토리 메서드 패턴
  • https://johngrib.github.io/wiki/pattern/static-factory-method/

• 주문취소(cancel()) : 주문 상태를 취소로 변경하고 주문상품에 주문 취소를 알린다. 만약 이미 배송을 완료한 상품이면 주문을 취소하지 못하도록 예외 발생시킨다.
• 전체 주문 가격 조회 : 주문 시 사용한 전체 주문 가격을 조회한다. 로직을 보면 연관된 주문상품들의 가격을 조회해서 더한 값을 반환한다.

[주문 상품 엔티티 코드] OriderItem.java에 추가

    //===생성 메서드===//
    public static OrderItem createOrderItem(Item item, int orderPrice, int count) {
        OrderItem orderItem = new OrderItem();
        orderItem.setItem(item);
        orderItem.setOrderPrice(orderPrice);
        orderItem.setCount(count);

        item.removeStock(count);
        return orderItem;
    }

    //===비즈니스 로직===//
    public void cancel() { //재고 수량 원복
        getItem().addStock(count); //Item에서 가져와서 addStock에서 재고를 주문 수량 만큼 늘려줘야함(재고수량 원복)
    }

    //===조회 로직===//
    /*
    * 주문 상품 전체 가격 조회
    * */
    public int getTotalPrice() {
        return getOrderPrice() * getCount();
    }

 

• 생성 메서드(createOrderItem()) : 주문 상품, 가격, 수량 정보를 사용해서 주문상품 엔티티를 생성한다. 그리고 item.removeStock(count)를 호출해서 주문한 수량만큼 상품의 재고를 줄인다.
• 주문 취소(cancel()) : getItem().addStock(count)를 호출해서 취소한 주문 수량만큼 상품의 재고를 증가시킨다.
• 주문 가격 조회(getTotalPrice()) : 주문 가격에 수량을 곱한 값을 반환한다.

주문 리포지토리 개발

[주문 리포지토리 코드]

@Repository
@RequiredArgsConstructor
public class OrderRepository {
    private final EntityManager em;

    public void save(Order order) {
        em.persist(order);
    }

    public Order findOne(Long id) {
        return em.find(Order.class, id);
    }
}

주문 엔티티를 저장하고 검색하는 기능이 있다.

 

주문 서비스 개발

[주문 서비스 코드]

@Service
@Transactional(readOnly = true)
@RequiredArgsConstructor
public class OrderService {

    //엔티티 조회 때문에 의존관계 넣어둠
    private final OrderRepository orderRepository;
    private final MemberRepository memberRepository;
    private final ItemRepository itemRepository;

    /*
    * 주문
    * */
    @Transactional
    public Long order(Long memberId, Long itemId, int count) { //주문하기 위해서는 member, item, 몇 개 주문하는지 필요
        //엔티티 조회
        Member member = memberRepository.findOne(memberId);
        Item item = itemRepository.findOne(itemId);

        //배송정보 생성
        Delivery delivery = new Delivery();
        delivery.setAddress(member.getAddress()); //회원에 주소에 있는 값으로 배송한다.
        delivery.setStatus(DeliveryStatus.READY);


        //주문 상품 생성(생성 메서드 사용)
        OrderItem orderItem = OrderItem.createOrderItem(item, item.getPrice(), count);

        //주문 생성(생성 메서드 사용)
        Order order = Order.createOrder(member, delivery, orderItem);

        //주문 저장
        orderRepository.save(order); //하나만 저장을 해줘도 Orderitem이랑 delivery가 자동으로 persist 됨(cascade 떄문에)
        return order.getId(); //order의 식별자 값만 반환
    }

    /*
     * 주문 취소
     * */
    @Transactional
    public void cancelOrder(Long orderId) {
        //주문 엔티티 조회
        Order order = orderRepository.findOne(orderId);

        //주문 취소
        order.cancel();
    }
    
    /*
     * 검색
     * */
    public List<Order> findOrders(OrderSearch orderSearch) {
        return orderRepository.findAllByString(orderSearch);
    }
 }

주문 서비스는 주문 엔티티와 주문 상품 엔티티의 비즈니스 로직을 활용해서 주문, 주문 취소, 주문 내역 검색 기능을 제공한다. (예제에서는 단순화를 위해 한 번에 하나의 상품만 주문 가능)

 

• 주문(order()) : 주문하는 회원 식별자, 상품식별자, 주문 수량 정보를 받아서 실제 주문 엔티티를 생성한 후 저장한다.
• 주문 취소(cancelOrder()) :  주문 식별자를 받아서 주문 엔티티를 조회한 후 주문 엔티티에 주문 취소를 요청한다.

주문 서비스의 주문 메소드와 주문 취소 메소드를 보면 비즈니스 로직 대부분이 엔티티에 있다. 즉, 서비스 게층은 단순히 엔티티에 필요한 요청을 위임하는 역할을 한다. 이와 같이 엔티티가 비즈니스 로직을 가지고 객체 지향의 특성을 적극 활용하는 것을 도메인 모델 패턴이라한다.

반대로 엔티티에는 비즈니스 로직이 거의 없고 서비스 계층에서 대부분 비즈니스 로직을 처리하는 것을 트랜잭션 스크립트 패턴이라고 한다.

 

주문 기능 테스트

• 테스트 요구사항
  • 상품 주문이 성공해야 한다.
  • 상품을 주문할 때 재고 수량을 초과하면 안 된다.
  • 주문 취소가 성공해야한다.

[상품 주문 테스트 코드]

@RunWith(SpringRunner.class)
@SpringBootTest
@Transactional
public class OrderServiceTest {

    @Autowired EntityManager em;
    @Autowired OrderService orderService;
    @Autowired OrderRepository orderRepository;
    @Test
    public void 상품주문() throws Exception {
        //given
        Member member = createMember();

        Book book = createBook("시골 JPA", 10000, 10);

        //when
        int orderCount=2;
        Long orderId = orderService.order(member.getId(), book.getId(), orderCount);

        //then
        Order getOrder = orderRepository.findOne(orderId);
        assertEquals("상품 주문시 상태는 ORDER", OrderStatus.ORDER, getOrder.getStatus()); //주문 상태
        assertEquals("주문한 상품 종류 수가 정확해야 한다.", 1, getOrder.getOrderItems().size()); //주문 수
        assertEquals("주문 가격은 가격 * 수량이다.", 10000 * orderCount, getOrder.getTotalPrice()); //가격 계산 로직
        assertEquals("주문 수량만큼 재고가 줄어야 한다.", 8, book.getStockQuantity()); //재고
    }



    @Test(expected = NotEnoughStockException.class) //재고수량 초과되면 Exception 터져야함
    public void 상품주문_재고수량초과() throws Exception {
        //give
        Member member = createMember();
        Item item = createBook("시골 JPA", 10000, 10);

        int orderCount = 11;

        //when
        orderService.order(member.getId(), item.getId(), orderCount);

        //then
        fail("재고 수량 부족 예외가 발생해야 한다.");


    }
    @Test
    public void 주문취소() throws Exception {
        //given
        Member member = createMember();
        Book item = createBook("시골 JPA", 10000, 10);

        int orderCount=2;

        Long orderId = orderService.order(member.getId(), item.getId(), orderCount);
        //when
        orderService.cancelOrder(orderId);

        //then
        //재고가 정상적으로 잘 복구 되었는지, 주문 취소 상태가 변경 되었는지 검증
        Order getOrder = orderRepository.findOne(orderId);
        assertEquals("주문 취소시 상태는 CANCEL이다.", OrderStatus.CANCEL, getOrder.getStatus());
        assertEquals("주문이 취소된 상품은 재고가 증가해야 한다.", 10, item.getStockQuantity());

    }
    private Book createBook(String name, int price, int stockQuantity) {
        Book book = new Book();
        book.setName(name);
        book.setPrice(price);
        book.setStockQuantity(stockQuantity);
        em.persist(book);
        return book;
    }

    private Member createMember() {
        Member member = new Member();
        member.setName("회원1");
        member.setAddress(new Address("서울","강가","123-123"));
        em.persist(member);
        return member;
    }
}

Given에서 테스트를 위한 회원과 상품을 만들고 When에서 실제 상품을 주문하고 Then에서 주문 가격이 올바른지, 주문 후에 재고 수량이 정확하게 줄었는지 검증한다.

 

재고 수량을 초과해서 상품을 주문하게 되면 NotEnoughStockException 예외가 발생해야 한다.

 

주문 검색 기능 개발

[검색 조건 파라미터 OrderSearch]

@Getter
@Setter
public class OrderSearch {
    private String memberName; //회원 이름
    private OrderStatus orderStatus; //주문 상태[ORDER, CANCEL]

}

 

 

[주문 리포지토리 코드] OrderRepository.java에 추가

@Repository
@RequiredArgsConstructor
public class OrderRepository {
    private final EntityManager em;

    public void save(Order order) {
        em.persist(order);
    }

    public Order findOne(Long id) {
        return em.find(Order.class, id);
    }

    /*
    * 검색 기능
    * */
    public List<Order> findAll(OrderSearch orderSearch) {
        //JPQL
        return em.createQuery(" select o from Order o join o.member m" +
                        " where o.status = :status " +
                        " and m.name like :name ", Order.class)
                .setParameter("status", orderSearch.getOrderStatus())
                .setParameter("name", orderSearch.getMemberName())
                .setMaxResults(1000) //최대 1000건
                .getResultList();
    }

 

findAll(OrderSearch orderSearch) 메서드는 검색 조건에 동적으로 쿼리를 생성해서 주문 엔티티를 조회한다.

 

JPQL로 처리

public List<Order> findAllByString(OrderSearch orderSearch) {
        //language=JPAQL
        String jpql = "select o From Order o join o.member m";
        boolean isFirstCondition = true;
        //주문 상태 검색
        if (orderSearch.getOrderStatus() != null) {
            if (isFirstCondition) {
                jpql += " where";
                isFirstCondition = false;
            } else {
                jpql += " and";
            }
            jpql += " o.status = :status";
        }
        //회원 이름 검색
        if (StringUtils.hasText(orderSearch.getMemberName())) {
            if (isFirstCondition) {
                jpql += " where";
                isFirstCondition = false;
            } else {
                jpql += " and";
            }
            jpql += " m.name like :name";
        }
        TypedQuery<Order> query = em.createQuery(jpql, Order.class)
                .setMaxResults(1000); //최대 1000건
        if (orderSearch.getOrderStatus() != null) {
            query = query.setParameter("status", orderSearch.getOrderStatus());
        }
        if (StringUtils.hasText(orderSearch.getMemberName())) {
            query = query.setParameter("name", orderSearch.getMemberName());
        }
        return query.getResultList();
    }

JPQL 쿼리를 문자로 생성하는 것은 번거롭고, 실수로 인한 버그가 발생할 수 있다. 

 

JPA Criteria

/**
     * JPA Criteria
     */
    public List<Order> findAllByCriteria(OrderSearch orderSearch) {
        CriteriaBuilder cb = em.getCriteriaBuilder();
        CriteriaQuery<Order> cq = cb.createQuery(Order.class);
        Root<Order> o = cq.from(Order.class);
        Join<Object, Object> m = o.join("member", JoinType.INNER);

        List<Predicate> criteria = new ArrayList<>();

        //주문 상태 검색
        if (orderSearch.getOrderStatus() != null) {
            Predicate status = cb.equal(o.get("status"), orderSearch.getOrderStatus());
            criteria.add(status);
        }
        //회원 이름 검색
        if (StringUtils.hasText(orderSearch.getMemberName())) {
            Predicate name =
                    cb.like(m.<String>get("name"), "%" + orderSearch.getMemberName() + "%");
            criteria.add(name);
        }

        cq.where(cb.and(criteria.toArray(new Predicate[criteria.size()])));
        TypedQuery<Order> query = em.createQuery(cq).setMaxResults(1000);
        return query.getResultList();
    }

JPA Criteria는 JPA 표준 스펙이지만 실무에서 사용하기 너무 너무 복잡하다. 이를 위한 다른 대안으로 Querydsl이 있다.

 

 

5. 웹 계층 개발

홈 화면과 레이아웃

홈 컨트롤러 등록

 

@Controller
public class HelloController {
    @GetMapping("hello")
    public String hello(Model model) {
        model.addAttribute("data", "hello!!");
        return "hello";
    }
}

 

[home.html]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head th:replace="~{fragments/header :: header}">
    <title>Hello</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
<div class="container">
    <div th:replace="~{fragments/bodyHeader :: bodyHeader}" />
    <div class="jumbotron">
        <h1>HELLO SHOP</h1>
        <p class="lead">회원 기능</p>
        <p>
            <a class="btn btn-lg btn-secondary" href="/members/new">회원 가입</a>
            <a class="btn btn-lg btn-secondary" href="/members">회원 목록</a>
        </p>
        <p class="lead">상품 기능</p>
        <p>
            <a class="btn btn-lg btn-dark" href="/items/new">상품 등록</a>
            <a class="btn btn-lg btn-dark" href="/items">상품 목록</a>
        </p>
        <p class="lead">주문 기능</p>
        <p>
            <a class="btn btn-lg btn-info" href="/order">상품 주문</a>
            <a class="btn btn-lg btn-info" href="/orders">주문 내역</a>
        </p>
    </div>
    <div th:replace="~{fragments/footer :: footer}" />
</div> <!-- /container -->
</body>
</html>

 

[fragments/header.html]

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head th:fragment="header">
  <!-- Required meta tags -->
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1, shrinkto-fit=no">
  <!-- Bootstrap CSS -->
  <link rel="stylesheet" href="/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T"
        crossorigin="anonymous">
  <!-- Custom styles for this template -->
  <link href="/css/jumbotron-narrow.css" rel="stylesheet">
  <!-- Latest compiled and minified CSS -->
  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css">

  <!-- jQuery library -->
  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>

  <!-- Popper JS -->
  <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.0/umd/popper.min.js"></script>

  <!-- Latest compiled JavaScript -->
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js"></script>
  <title>Hello, world!</title>
</head>

 

[fragments/bodyHeader.html]

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<div class="header" th:fragment="bodyHeader">
  <ul class="nav nav-pills pull-right">
    <li><a href="/">Home</a></li>
  </ul>
  <a href="/"><h3 class="text-muted">HELLO SHOP</h3></a>
</div>

 

[fragments/footer.html]

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<div class="footer" th:fragment="footer">
  <p>&copy; Hello Shop V2</p>
</div>

 

예쁜 디자인을 위해 부트스트랩 사용

• resources/static 하위에 css, js 추가
• resources/static/css/jumbotron-narrow.css 추가

[jumbotron-narrow.css]

/* Space out content a bit */
body {
    padding-top: 20px;
    padding-bottom: 20px;
}
/* Everything but the jumbotron gets side spacing for mobile first views */
.header,
.marketing,
.footer {
    padding-left: 15px;
    padding-right: 15px;
}
/* Custom page header */
.header {
    border-bottom: 1px solid #e5e5e5;
}
/* Make the masthead heading the same height as the navigation */
.header h3 {
    margin-top: 0;
    margin-bottom: 0;
    line-height: 40px;
    padding-bottom: 19px;
}
/* Custom page footer */
.footer {
    padding-top: 19px;
    color: #777;
    border-top: 1px solid #e5e5e5;
}
/* Customize container */
@media (min-width: 768px) {
    .container {
        max-width: 730px;
    }
}
.container-narrow > hr {
    margin: 30px 0;
}
/* Main marketing message and sign up button */
.jumbotron {
    text-align: center;
    border-bottom: 1px solid #e5e5e5;
}
.jumbotron .btn {
    font-size: 21px;
    padding: 14px 24px;
}
/* Supporting marketing content */
.marketing {
    margin: 40px 0;
}
.marketing p + h4 {
    margin-top: 28px;
}
/* Responsive: Portrait tablets and up */
@media screen and (min-width: 768px) {
    /* Remove the padding we set earlier */
    .header,
    .marketing,
    .footer {
        padding-left: 0;
        padding-right: 0;
    }
    /* Space out the masthead */
    .header {
        margin-bottom: 30px;
    }
    /* Remove the bottom border on the jumbotron for visual effect */
    .jumbotron {
        border-bottom: 0;
    }
}

 

회원 등록

폼 객체를 사용해서 화면 계층과 서비스 계층을 명확하게 분리한다.

@Getter@Setter
public class MemberForm {

    @NotEmpty(message = "회원 이름은 필수 입니다.")
    private String name;
    private String city;
    private String street;
    private String zipcode;
}

 

회원 등록 컨트롤러

@Controller
@RequiredArgsConstructor
public class MemberController {

    private final MemberService memberService;

    //form 화면 열기
    @GetMapping(value = "/members/new") ///member/new로 Get 방식으로 오면 이 컨트롤러를 타서 createMemberForm이 열림
    public String createForm(Model model) {
        model.addAttribute("memberForm", new MemberForm()); //컨트롤러에서 뷰로 넘어갈 때 memberForm담아서 넘김
        return "members/createMemberForm";
    }

    //데이터를 실제 등록하기
    @PostMapping(value ="/members/new") //createMemberForm에서 submit 누르면 post로 넘어와서 받아야함
    public String create(@Valid MemberForm form, BindingResult result) { //MemberForm이 이제 파라미터로 넘어옴
        if(result.hasErrors()) { //error가 있으면 createMemberForm으로 리턴
            return "members/createMemberForm";
        }

        Address address = new Address(form.getCity(), form.getStreet(), form.getZipcode());

        Member member = new Member();
        member.setName(form.getName()); //form에서 Name 가져옴
        member.setAddress(address);

        memberService.join(member); //저장
        return "redirect:/"; //저장되고 재로딩되면 안 좋은 경우가 생기기 때문에 redirect 사용하기
    }

    //회원 조회하기
    @GetMapping(value ="/members")
    public String list(Model model) { //model 객체를 통해 화면에 데이터 전달
//        List<Member> members = memberService.findMembers(); //데이터 다 끌어옴
//        model.addAttribute("members", members);
        model.addAttribute("members", memberService.findMembers()); //inline 변경
        return "members/memberList";
    }
}

 

• 회원 조회
  • 조회한 상품을 뷰에 전달하기 위해 스프링 MVC가 제공하는 모델(Model)객체에 보관
  • 실행할 뷰 이름 반환

[회원 등록 폼 화면]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head th:replace="~{fragments/header :: header}" />
<style>
  .fieldError {
    border-color: #bd2130;
  }
</style>
<body>
<div class="container">
  <div th:replace="~{fragments/bodyHeader :: bodyHeader}"/>
  <form role="form" action="/members/new" th:object="${memberForm}" method="post">
    <div class="form-group">
      <label th:for="name">이름</label>

      <input type="text" th:field="*{name}" class="form-control" placeholder="이름을 입력하세요"
             th:class="${#fields.hasErrors('name')}? 'form-control fieldError' : 'form-control'">
      <p th:if="${#fields.hasErrors('name')}" th:errors="*{name}">Incorrect date</p>
    </div>
    <div class="form-group">
      <label th:for="city">도시</label>

      <input type="text" th:field="*{city}" class="form-control" placeholder="도시를 입력하세요">
    </div>
    <div class="form-group">
      <label th:for="street">거리</label>
      <input type="text" th:field="*{street}" class="form-control" placeholder="거리를 입력하세요">
    </div>
    <div class="form-group">
      <label th:for="zipcode">우편번호</label>
      <input type="text" th:field="*{zipcode}" class="form-control" placeholder="우편번호를 입력하세요">
    </div>
    <button type="submit" class="btn btn-primary">Submit</button>
  </form>
  <br/>
  <div th:replace="~{fragments/footer :: footer}" />
</div> <!-- /container -->
</body>
</html>

 

[회원 목록 뷰]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head th:replace="~{fragments/header :: header}" />
<body>
<div class="container">
  <div th:replace="~{fragments/bodyHeader :: bodyHeader}" />
  <div>
    <table class="table table-striped">
      <thead>
      <tr>
        <th>#</th>
        <th>이름</th>
        <th>도시</th>
        <th>주소</th>
        <th>우편번호</th>
      </tr>
      </thead>
      <tbody>
      <tr th:each="member : ${members}">
        <td th:text="${member.id}"></td>
        <td th:text="${member.name}"></td>
        <td th:text="${member.address?.city}"></td>
        <td th:text="${member.address?.street}"></td>
        <td th:text="${member.address?.zipcode}"></td>
      </tr>
      </tbody>
    </table>
  </div>
  <div th:replace="~{fragments/footer :: footer}" />
</div> <!-- /container -->
</body>
</html>

 

참고로 요구사항이 단순할 때에는 폼 객체(MemberForm)없이 엔티티(Member)를 직접 등록과 수정 화면에서 사용해도 되지만 복잡해지면 엔티티에 화면을 처리하기 위한 기능이 점점 증가하기 때문에 엔티티는 점점 화면에 종속적으로 변하고, 이렇게 되면 유지보수가 어려워진다.

실무에서는 엔티티는 핵심 비즈니스 로직만 가지고 있고, 화면을 위한 로직은 없어야 한다. 화면이나 API에 맞는 폼 객체나 DTO를 사용하자. 그래서 화면이나 API 요구사항을 이것들로 처리하고, 엔티티는 최대한 순수하게 유지해야한다.

 

상품 등록

[상품 등록 폼]

package jpabook.jpashop.controller;

import lombok.Getter;
import lombok.Setter;

@Getter @Setter
public class BookForm {
    private Long id; //상품 수정이 있어서 id값이 있어야 함

    private String name; //상품 공통속성
    private int price; //공통 속성
    private int stockQuantity; //공통 속성

    private String author;
    private String isbn;

}

 

[상품 등록 컨트롤러]

@Controller
@RequiredArgsConstructor
public class ItemController {

    private final ItemService itemService;

    /*
     * 상품 등록
     * */
    @GetMapping("/items/new")
    public String createForm(Model model) {
        model.addAttribute("form", new BookForm());
        return "items/createItemForm";
    }

    @PostMapping("/items/new")
    public String create(BookForm form) {
        Book book = new Book();
        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:/"; //저장된 책 목록
    }

    /*
     * 상품 목록
     * */
    @GetMapping("/items")
    public String list(Model model) {
        List<Item> items = itemService.findItems();
        model.addAttribute("items", items);
        return "items/itemList";
    }
    /*
     * 상품 수정
     * */
    @GetMapping("items/{itemId}/edit")
    public String updateItemForm(@PathVariable("itemId") Long itemId, Model model) {
        Book item = (Book) itemService.findOne(itemId); //원래 반환 타입이 Item인데 예제 단순하게 하기위해 책만 가져오기 위해 Book으로 캐스팅

        BookForm form = new BookForm();
        form.setId(item.getId()); //form을 업데이트하는데 book entity를 보내는 것이 아닌 book form을 보냄
        form.setName(item.getName());
        form.setPrice(item.getPrice());
        form.setStockQuantity(item.getStockQuantity());
        form.setAuthor(item.getAuthor());
        form.setIsbn(item.getIsbn());

        model.addAttribute("form", form);
        return "items/updateItemForm";
    }
    /*
    * 상품 수정, 권장 코드
    * */
    @PostMapping("items/{itemId}/edit")//form 객체 넘어옴
    public String updateItem(@PathVariable("itemId") Long itemId, @ModelAttribute("form") BookForm form) {
//        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);
        itemService.updateItem(itemId, form.getName(), form.getPrice(), form.getStockQuantity());
        return "redirect:/items";
    }
}

 

•  상품 등록
  • 상품 등록 폼에서 데이터를 입력하고 Submit 버튼을 누르면 /items/new를 POST 방식으로 요청
  • 상품 저장 끝나면 상품 목록 화면(redirect:/items)로 리다이렉트한다.
• 상품 목록
  • model 에 담아둔 상품 목록인 items를 꺼내서 상품 정보를 출력
• 상품 수정 폼 이동
  • 수정 버튼을 선택하면 /items/{itemId}/edit URL을 GET 방식으로 요청
  • 그 결과로 updateItemForm() 메서드를 실행하는데 이 메서드는 itemService.findOne(itemId)를 호출해서 수정할 상품을 조회한다.
  • 조회 결과를 모델 객체에 담아서 뷰(items/updateItemForm)에 전달
• 상품 수정 실행
  • 상품 수정 폼 HTML에는 상품의 id(hidden), 상품명, 가격, 수량 정보 있다.
  • 상품 수정 폼에서 정보를 수정하고 Submit 버튼을 누른다.
  • /items/{itemId}/edit URL을 POST 방식으로 요청하고 updateItem() 메서드를 실행
  •  이 때 컨트롤러에 파라미터로 넘어온 item 엔티티 인스턴스는 현재 준영속 상태이므로 영속성 컨텍스트의 지원을 받을 수 없고 데이터를 수정해도 변경 감지 기능은 동작하지 않는다.

[상품 등록 뷰]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head th:replace="~{fragments/header :: header}" />
<body>
<div class="container">
  <div th:replace="~{fragments/bodyHeader :: bodyHeader}"/>
  <form th:action="@{/items/new}" th:object="${form}" method="post">
    <div class="form-group">
      <label th:for="name">상품명</label>
      <input type="text" th:field="*{name}" class="form-control"
             placeholder="이름을 입력하세요">
    </div>
    <div class="form-group">
      <label th:for="price">가격</label>
      <input type="number" th:field="*{price}" class="form-control"
             placeholder="가격을 입력하세요">
    </div>
    <div class="form-group">
      <label th:for="stockQuantity">수량</label>
      <input type="number" th:field="*{stockQuantity}" class="form-control" placeholder="수량을 입력하세요">
    </div>
    <div class="form-group">
      <label th:for="author">저자</label>
      <input type="text" th:field="*{author}" class="form-control"
             placeholder="저자를 입력하세요">
    </div>
    <div class="form-group">
      <label th:for="isbn">ISBN</label>
      <input type="text" th:field="*{isbn}" class="form-control"
             placeholder="ISBN을 입력하세요">
    </div>
    <button type="submit" class="btn btn-primary">Submit</button>
  </form>
  <br/>
  <div th:replace="~{fragments/footer :: footer}" />
</div> <!-- /container -->
</body>
</html>

 

[상품 목록 뷰]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head th:replace="~{fragments/header :: header}" />
<body>
<div class="container">
  <div th:replace="~{fragments/bodyHeader :: bodyHeader}"/>
  <div>
    <table class="table table-striped">
      <thead>
      <tr>
        <th>#</th>
        <th>상품명</th>
        <th>가격</th>
        <th>재고수량</th>
        <th></th>
      </tr>
      </thead>
      <tbody>
      <tr th:each="item : ${items}">
        <td th:text="${item.id}"></td>
        <td th:text="${item.name}"></td>
        <td th:text="${item.price}"></td>
        <td th:text="${item.stockQuantity}"></td>
        <td>
          <a href="#" th:href="@{/items/{id}/edit (id=${item.id})}" class="btn btn-primary" role="button">수정</a>
        </td>
      </tr>
      </tbody>
    </table>
  </div>
  <div th:replace="~{fragments/footer :: footer}"/>
</div> <!-- /container -->
</body>
</html>

 

[상품 수정 폼 화면]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head th:replace="~{fragments/header :: header}" />
<body>
<div class="container">
  <div th:replace="~{fragments/bodyHeader :: bodyHeader}"/>
  <form th:object="${form}" method="post">
    <!-- id -->
    <input type="hidden" th:field="*{id}" />

    <div class="form-group">
      <label th:for="name">상품명</label>
      <input type="text" th:field="*{name}" class="form-control" placeholder="이름을 입력하세요" />
    </div>

    <div class="form-group">
      <label th:for="price">가격</label>
      <input type="number" th:field="*{price}" class="form-control" placeholder="가격을 입력하세요" />
    </div>

    <div class="form-group">
      <label th:for="stockQuantity">수량</label>
      <input type="number" th:field="*{stockQuantity}" class="form-control" placeholder="수량을 입력하세요" />
    </div>

    <div class="form-group">
      <label th:for="author">저자</label>
      <input type="text" th:field="*{author}" class="form-control" placeholder="저자를 입력하세요" />
    </div>

    <div class="form-group">
      <label th:for="isbn">ISBN</label>
      <input type="text" th:field="*{isbn}" class="form-control" placeholder="ISBN을 입력하세요" />
    </div>

    <button type="submit" class="btn btn-primary">Submit</button>

  </form>
  <div th:replace="~{fragments/footer :: footer}" />
</div> <!-- /container -->
</body>
</html>

 

상품 주문

[상품 주문 컨트롤러]

@Controller
@RequiredArgsConstructor
public class OrderController {
    private final OrderService orderService;
    private final MemberService memberService;
    private final ItemService itemService;

    /*
     * 상품 주문
     * */
    @GetMapping("/order")
    public String createForm(Model model) {
        List<Member> members = memberService.findMembers();
        List<Item> items = itemService.findItems();

        model.addAttribute("members", members);
        model.addAttribute("items", items);

        return "order/orderForm";
    }

    @PostMapping("/order")
    public String order(@RequestParam("memberId") Long memberId,
                        @RequestParam("itemId") Long itemId,
                        @RequestParam("count") int count) {
        orderService.order(memberId, itemId, count);
        return "redirect:/orders";
    }

    /*
     * 주문 내역
     * */
    @GetMapping("/orders")
    public String orderList(@ModelAttribute("orderSearch") OrderSearch orderSearch, Model model) {
        List<Order> orders = orderService.findOrders(orderSearch);
        model.addAttribute("orders", orders);

        return "order/orderList";
    }

    /*
     * 주문 취소
     * */
    @PostMapping("/orders/{orderId}/cancel")
    public String cancelOrder(@PathVariable("orderId") Long orderId) {
        orderService.cancelOrder(orderId);
        return "redirect:/orders";
    }
}

 

• 주문 폼 이동
  • 메인 화면에서 상품 주문을 선택하면 /order를 GET 방식으로 호출
  • OrderController의 createForm() 메서드
  • 주문 화면에는 주문할 고객 정보와 상품 정보가 필요하므로 model 객체에 담아서 뷰에 넘겨줌
• 주문 실행
  • 주문할 회원과 상품 그리고 수량 선택해서 Submit 버튼 누르면 /order URL을 POST 방식으로 호출
  • 컨트롤러의 order() 메서드를 실행
  • 이 메서드는 고객 식별자(memberId), 주문할 상품 식별자(itemId), 수량(count) 정보를 받아서 주문 서비스에 주문을 요청
  • 주문이 끝나면 상품 주문 내역이 있는 /orders URL로 리다이렉트

 

[상품 주문 폼]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head th:replace="~{fragments/header :: header}" />
<body>
<div class="container">
  <div th:replace="~{fragments/bodyHeader :: bodyHeader}"/>
  <form role="form" action="/order" method="post">
    <div class="form-group">
      <label for="member">주문회원</label>
      <select name="memberId" id="member" class="form-control">
        <option value="">회원선택</option>
        <option th:each="member : ${members}"
                th:value="${member.id}"
                th:text="${member.name}" />
      </select>
    </div>
    <div class="form-group">
      <label for="item">상품명</label>
      <select name="itemId" id="item" class="form-control">
        <option value="">상품선택</option>
        <option th:each="item : ${items}"
                th:value="${item.id}"
                th:text="${item.name}" />
      </select>
    </div>
    <div class="form-group">
      <label for="count">주문수량</label>
      <input type="number" name="count" class="form-control" id="count"
             placeholder="주문 수량을 입력하세요">
    </div>
    <button type="submit" class="btn btn-primary">Submit</button>
  </form>
  <br/>
  <div th:replace="~{fragments/footer :: footer}" />
</div> <!-- /container -->
</body>
</html>

 

 

[주문 목록 검색 화면]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head th:replace="~{fragments/header :: header}"/>
<body>
<div class="container">
  <div th:replace="~{fragments/bodyHeader :: bodyHeader}"/>
  <div>
    <div>
      <form th:object="${orderSearch}" class="form-inline">
        <div class="form-group mb-2">
          <input type="text" th:field="*{memberName}" class="form-control" placeholder="회원명"/>
        </div>
        <div class="form-group mx-sm-1 mb-2">
          <select th:field="*{orderStatus}" class="form-control">
            <option value="">주문상태</option>
            <option th:each="status : ${T(jpabook.jpashop.domain.OrderStatus).values()}"
                    th:value="${status}"
                    th:text="${status}">option
            </option>
          </select>
        </div>
        <button type="submit" class="btn btn-primary mb-2">검색</button>
      </form>
    </div>
    <table class="table table-striped">
      <thead>
      <tr>
        <th>#</th>
        <th>회원명</th>
        <th>대표상품 이름</th>
        <th>대표상품 주문가격</th>
        <th>대표상품 주문수량</th>
        <th>상태</th>
        <th>일시</th>
        <th></th>
      </tr>
      </thead>
      <tbody>
      <tr th:each="item : ${orders}">
        <td th:text="${item.id}"></td>
        <td th:text="${item.member.name}"></td>
        <td th:text="${item.orderItems[0].item.name}"></td>
        <td th:text="${item.orderItems[0].orderPrice}"></td>
        <td th:text="${item.orderItems[0].count}"></td>
        <td th:text="${item.status}"></td>
        <td th:text="${item.orderDate}"></td>
        <td>
          <a th:if="${item.status.name() == 'ORDER'}" href="#"
             th:href="'javascript:cancel('+${item.id}+')'" class="btn btn-danger">CANCEL</a>
        </td>
      </tr>
      </tbody>
    </table>
  </div>
  <div th:replace="~{fragments/footer :: footer}"/>
</div> <!-- /container -->
</body>
<script>
  function cancel(id) {
    var form = document.createElement("form");
    form.setAttribute("method", "post");
    form.setAttribute("action", "/orders/" + id + "/cancel");
    document.body.appendChild(form);
    form.submit();
  }
</script>
</html>

 

 

6. 변경 감지와 병합(merge)

준영속 엔티티

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

Book 객체는 이미 DB에 한 번 저장되어서 식별자가 존재한다. 이렇게 임의로 만들어낸 엔티티도 기존 식별자를 가지고 있으면 준영속 엔티티로 볼수 있다.

 

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

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

변경감지 기능 사용

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

 

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

트랜잭션 안에서 엔티티를 다시 조회, 변경할 값 선택 -> 트랜잭션 커밋 시점에 변경감지(Dirty Checking)이 동작해서 데이터베이스에 UPDATE SQL 실행한다.

 

병합사용

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

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

 

 

1. merge()를 실행한다.

2. 파라미터로 넘어온 준영속 엔티티의 식별자 값으로 1차 캐시에서 엔티티를 조회한다.

3. 만약 1차 캐시에 엔티티가 없으면 데이터베이스에서 엔티티를 조회하고, 1차 캐시에 저장한다.

4. 조회한 영속 엔티티(mergeMember)에 member 엔티티 값을 채워 넣는다. (member 엔티티의 모든 값을 mergeMember에 밀어 넣는다. 이때 mergeMember 의 "회원1"이라는 이름이 "회원명변경"으로 바뀐다.)

5. 영속 상태인 mergeMember을 반환한다. 

 

병합시 동작 방식

1. 준영속 엔티티의 식별자 값으로 영속 엔티티를 조회한다.

2. 영속 엔티티의 값을 준영속 엔티티의 값으로 모두 교체한다.(병합한다.)

3. 트랜잭션 커밋 시점에 변경 감지 기능이 동작해서 데이터베이스에 UPDATE SQL이 실행

 

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

 

[ItemRepository.java]

@Repository
@RequiredArgsConstructor
public class ItemRepository {

    private final EntityManager em;

    public void save(Item item) {
        if (item.getId() == null) { //item은 저장하기 전까지 id값이 없음 -> 새로운 객체로 등록
            em.persist(item);
        } else {
            em.merge(item);
        }
    }

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

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

상품 리포지토리에서 save() 메서드를 잘 봐야하는데 이 메서드 하나로 저장과 수정(병합)을 다 처리한다. 즉 신규 데이터를 저장하는 것뿐만 아니라 변경된 데이터의 저장이라는 의미도 포함돼서 저장과 수정을 구분하지 않아도 되므로 클라이언트의 로직이 단순해진다. 

 

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

 

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

 

해결 방법

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

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

[ItemController.java]

  /*
    * 상품 수정, 권장 코드
    * */
    @PostMapping("items/{itemId}/edit")//form 객체 넘어옴
    public String updateItem(@PathVariable("itemId") Long itemId, @ModelAttribute("form") BookForm form) {
        itemService.updateItem(itemId, form.getName(), form.getPrice(), form.getStockQuantity());
        return "redirect:/items";
    }

 

[ItemService.java]

/*
* 변경 감지 기능 사용 (merge 사용 보다는 변경 감지 사용)
* 영속성 컨텍스트가 자동 변경
* */
@Transactional
public Item updateItem(Long itemId, String name, int price, int stockQuantity) {
    Item findItem = itemRepository.findOne(itemId); //아이디 기반으로 실제 db에 있는 영속상태 엔티티 찾아옴
    findItem.setName(name);
    findItem.setPrice(price);
    findItem.setStockQuantity(stockQuantity);
    return findItem;
}