[springboot] 실전! 스프링부트와 JPA 활용 1 - 5. 웹 계층 개발

지난번까지 주문 관련한 로직을 작성해 보았다.

이번에는 웹 계층에 대한 개발을 진행보고자 한다.

 

 

웹 계층 개발

• 홈 화면
• 회원 기능
  • 회원 등록
  • 회원 조회
• 상품 기능
  • 상품 등록
  • 상품 수정 (변경 감지와 병합)
  • 상품 조회
• 주문 기능
  • 상품 주문
  • 주문 내역 조회
  • 주문 취소

 

 

홈 화면과 레이아웃

홈 컨트롤러 등록

@Controller
@Slf4j
public class HomeController {

    @RequestMapping("/")
    public String home() {
        log.info("home controller");
        return "home";
    }
}

 

스프링부트 타임리프 기본 설정

spring:
  thymeleaf:
    prefix: classpath:/templates/
    suffix: .html

• spring.thymleaf.prefix
  • thymleaf 템플릿 파일이 위치한 디렉토리 지정. 여기서는 classpath:/templates/로 지정되어 있으며, classpath 상에 있는 templates 디렉토리에서 템플릿 파일을 찾도록 설정되어 있다.
• spring.thymeleaf.suffix
  • thymleaf 템플릿 파일의 확장자를 지정한다. Thymeleaf 템플릿 파일은 기본적으로 HTML 형식이다.

 

Controller에서 반환한 "home"과 스프링부트 설정 prefix, suffix 정보를 사용하여 렌더링 할 뷰(.html)를 찾는다.

 

교안에서는 타임리프 코드와 css 코드를 추가하는 부분이 있다. 하지만 나는 스프링부트와 JPA 공부가 핵심이기 때문에 해당 부분은 붙여 넣고 자세하게 살펴보지 않고 빠르게 넘어가겠다.

 

 

 

 

회원 등록

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

 

회원 등록 폼 객체

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

    @GetMapping(value = "/members/new")
    public String createForm(Model model) {
        model.addAttribute("memberForm", new MemberForm());
        return "/members/createMemberForm";
    }
    
    @PostMapping(value = "/members/new")
    public String create(@Valid MemberForm form, BindingResult result) {
        if(result.hasErrors()) {
            return "members/createMemberForm";
        }

        Address address = new Address(form.getCity(), form.getStreet(), form.getZipcode());
        Member member = new Member();
        member.setName(form.getName());
        member.setAddress(address);
        memberService.join(member);
        return "redirect:/";
    }
}

• @RequiredArgsConstructor
  • Lombok annotation으로, 생성자를 자동으로 생성해 주는 어노테이션이다. final로 선언된 필드에 대한 생성자를 생성해 준다. 여기서는 MemberService 필드에 대한 생성자가 생성된다.
• Model
  • spring이 제공하는 모델 객체로, 뷰에 전달할 데이터를 담는다.
  • 즉, model.addAttribute("memberForm", new MemberForm()) 에서 memberForm이라는 이름으로 새로운 MemberForm 객체를 모델에 추가한다. 이후에 뷰에서 이 데이터를 사용할 수 있다.
• return "/members/createMemberForm"
  • members/createMemberForm 뷰를 반환한다. 이경로에 해당하는 뷰 템플릿을 렌더링 하게 된다.
• @Valid
  • Java Bean Validation에서 사용되는 어노테이션 중 하나다. 주로 메서드나 클래스의 파라미터에 붙어, 해당 파라미터의 값이 유효한지 검증하는 역할을 한다.
  • 폼을 전송받는 DTO나 커맨드 객체에 @Valid를 사용하면 해당 객체의 필드에 설정된 유효성 검사 어노테이션들에 따라 입력값이 검증된다.
• BindingResult
  • 스프링에서 유효성 검증 결과를 저장하고 오류를 관리하는 인터페이스다. 주로 컨트롤러에서 폼 데이터의 유효성을 검사한 결과를 받아 처리할 때 사용된다.
  • @Valid나 @Validated 어노테이션이 붙은 객체(주로 폼 객체)에 대한 유효성 검사를 수행하고, 검사 결과를 담고 있다. 만약 검증 과정에서 오류가 발생한다면, 이 오류 정보를 BindingResult에 저장하게 된다.
  • result.hasErrors()
    • 유효성 검사에서 오류가 발생했는지 여부를 확인할 수 있다.
• return "redirect:/"
  • 회원가입이 성공하면 홈페이지로 리다이렉트 한다.

 

 

 

 

회원 목록 조회

회원 목록 컨트롤러 추가

@GetMapping(value = "/members")
    public String list(Model model) {
        List<Member> members = memberService.findMembers();
        model.addAttribute("members", members);
        return "members/memberList";
    }

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

 

참고사항) 폼 객체 vs 엔티티 직접 사용

요구사항이 정말 단순할 때에는 폼 객체(MemberForm) 없이 엔티티(Member)를 직접 등록과 수정화면에서 사용해도 된다. 하지만 화면 요구사항이 복잡해지기 시작하면, 엔티티에 화면을 처리하기 위한 기능이 점점 증가한다. 결과적으로 엔티티는 점점 화면에 종속적으로 변하고, 이렇게 화면 기능 때문에 지저분해진 엔티티는 결국 유지보수하기 어려워진다.
실무에서 엔티티는 핵심 비즈니스 로직만 가지고 있고, 화면을 위한 로직은 없어야 한다. 화면이나 API에 맞는 폼 객체나 DTO를 사용하자. 그래서 화면이나 API 요구사항을 이것들로 처리하고, 엔티티는 최대한 순수하게 유지하자.

 

 

 

 

상품 등록

상품 등록 폼

@Getter
@Setter
public class BookForm {
    
    private Long 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(value = "/items/new")
    public String createForm(Model model) {
        model.addAttribute("form", new BookForm());
        return "items/createItemForm";
    }
    
    @PostMapping(value = "/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:/items";
    }
}

• 상품 등록 폼에서 데이터를 입력하고 Submit 버튼을 클릭하면 /items/new를 POST 방식으로 요청
• 상품 저장이 끝나면 상품 목록 화면 (redirect:/items)으로 리다이렉트

 

 

 

상품 목록

상품 목록 컨트롤러

  @GetMapping(value = "/items")
    public String list(Model model) {
        List<Item> items = itemService.findItems();
        model.addAttribute("items", items);
        return "items/itemList";
    }

 

 

 

상품 수정

상품 수정과 관련된 컨트롤러 코드

// 상품 수정 폼
    @GetMapping(value = "/items/{itemId}/edit")
    public String updateItemForm(@PathVariable("itemId") Long itemId, Model model) {
        Book item = (Book) itemService.findOne(itemId);

        BookForm form = new BookForm();
        form.setId(item.getId());
        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(value = "/items/{itemId}/edit")
    public String updateItem(@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);
        return "redirect:/items";
    }

 

상품 수정 폼 이동

1. 수정 버튼을 선택하면 /items/{itemId}/edit URL을 GET 방식으로 요청
2. 그 결과로 updateItemForm() 메서드를 실행하는데 이 메서드는 itemService.findOne(itemId)를 호출해서 수정할 상품을 조회
3. 조회 결과를 모델 객체에 담아서 뷰(items/updateItemForm)에 전달

 

상품 수정 실행

상품 수정 폼 HTML에는 상품의 id(hidden), 상품명, 가격, 수량 정보 있음

1. 상품 수정 폼에서 정보를 수정하고 Submit 버튼을 선택
2. /items/{itemId}/edit URL을 POST 방식으로 요청하고 updateItem() 메서드를 실행
3. 이때 컨트롤러에 파라미터로 넘어온 item 엔티티 인스턴스는 현재 준영속 상태다. 따라서 영속성 컨텍스트의 지원을 받을 수 없고 데이터를 수정해도 변경 감지 기능은 동작 X → (이게 무슨 말일까..?)

 

 

상품 수정 실행에서 3번째 문장이 잘 이해가 되지 않는다. 도대체 무슨 의미인지 아래에 정리를 해보자.

 

 

변경 감지와 병합(merge)

정말로 중요한 내용이니 꼭! 완벽하게 이해하시는 것을 권장하셨다!

 

 

준영속 엔티티란?

영속성 컨텍스트가 더는 관리하지 않는 엔티티를 말한다.
여기서는 itemService.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 실행

Dirty Checking(더티 체킹)이란?
Dirty checking(더티 체킹)은 주로 데이터 변경 여부를 검사하는 기술입니다. 더티 체킹은 특히 데이터베이스와 관련이 있으며, 어떤 데이터가 변경되었는지 여부를 판단하기 위해 사용됩니다.

 

 

병합 사용

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

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

 

 

병합: 기존에 있는 엔티티

 

병합 동작 방식

 1. merge(member)를 실행한다.

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

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

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

 4. 영속 상태인 mergeMember를 반환한다.

책 자바 ORM 표준 JPA 프로그래밍 3.6.5 참고

 

 

 

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

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

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

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

 

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

 

 

 

Item Repository의 저장 메서드 분석 

@Repository
@RequiredArgsConstructor
public class ItemRepository {

    private final EntityManager em;

    public void save(Item item) {
        if (item.getId() == null) {
            em.persist(item);
        } else {
            em.merge(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() 메서드는 식별자 값이 없으면(null) 새로운 엔티티로 판단해서 영속화(persist)하고 식별자가 있으면 병합(merge)한다.
• 위의 코드처럼 준영속 상태인 상품(Item) 엔티티를 수정할 때는 id값이 있으므로 병합 수행

 

 

 

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

 

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

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

 

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

 

 

참고 사항)

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

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

 

 

 

가장 좋은 해결 방법

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

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

 

ItemController

@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";
    }
}

 

ItemSerivce

 /**
     * 영속성 컨텍스트가 자동 변경
     */
    @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);
    }

 

 

 

상품 주문

상품 주문 Controller

@Controller
@RequiredArgsConstructor
public class OrderController {
    
    private final OrderService orderService;
    private final MemberService memberService;
    private final ItemService itemService;
    
    @GetMapping(value = "/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(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";
    }
}

 

주문 폼 이동

• 메인화면에서 상품 주문을 선택하면 /order를 GET 방식으로 호출
• OrderController의 createForm() 메서드
• 주문 화면에는 주문할 고객정보와 상품 정보가 필요하므로 model 객체에 담아서 뷰에 넘겨줌
  
  

 

주문 실행

• 주문할 회원과 상품 그리고 수량을 선택해서 Submit 버튼을 누르면 /order URL을 POST 방식으로 호출
• Controller의 order() 메서드 실행
• 이 메서드는 고객 식별자(memberId), 주문할 상품 식별자(itemId), 수량(count) 정보를 받아서 주문 서비스에 주문을 요청
• 주문이 끝나면 상품 주문 내역이 있는 /orders URL로 리다이렉트

 

 

주문 목록 검색, 삭제

주문 목록 검색 및 삭제 Controller

@GetMapping(value = "/orders")
    public String orderList(@ModelAttribute("orderSearch")OrderSearch orderSearch, Model model) {

        List<Order> orders = orderService.findOrders(orderSearch);
        model.addAttribute("orders", orders);

        return "order/orderList";
    }
    
    @PostMapping(value = "/orders/{orderId}/cancel") 
    public String cancelOrder(@PathVariable("orderId") Long orderId) {
        orderService.cancelOrder(orderId);
        return "redirect:/orders";
    }