[스프링부트와JPA활용1]섹션7. 웹 계층 개발

강의1. 홈 화면과 레이아웃

package jpabook.jpashop.Controller;

import lombok.extern.slf4j.Slf4j;
import org.slf4j.Logger;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@Slf4j
public class HomeController {

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

@Slf4j 어노테이션을 쓰고, log.info("~~"); 를 컨트롤러 단에 붙여주면, 로그를 찍어준다.

이렇게

 

 

홈 화면을 띄우기 위해 html, css 설정해줬는데, 이거는 뭐 쉬우니까 포스트 안함

 

---

강의2. 회원 등록

package jpabook.jpashop.Controller;

import lombok.Getter;
import lombok.Setter;

import javax.validation.constraints.NotEmpty;

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

 

 

package jpabook.jpashop.Controller;

import jpabook.jpashop.service.MemberService;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
@RequiredArgsConstructor
public class MemberController {
    private final MemberService memberService;

    @GetMapping("/members/new")
    public String createForm(Model model){
        model.addAttribute("memberForm", new MemberForm());
        return "members/createMemberForm";
    }
}

"/members/new" 라는 요청이 오면, MemberForm 객체 (지금은 아무것도 들어있지 않은 껍데기 클래스)를 model에 실어서 createMemberForm.html로 넘긴다.

왜 빈 클래스를 굳이 만들어서 넘기냐면, validation이라던가 그런거를 같이 넘기기 떄문.

 

createMemberForm.html은 생략. 어쨋든 POST "members/new"로 값들 넘어옴

 

@PostMapping("/members/new")
public String create(@Valid MemberForm form){
    Address address = new Address(form.getCity(), form.getStreet(), form.getZipcode());//cmd+option+v
    Member member = new Member();
    member.setName(form.getName());
    member.setAddress(address);

    memberService.join(member);
    return "redirect:/"
}

 

@Valid 어노테이션을 붙이면, Form에 대해서 validation을 해준다. 

 

이렇게 하면 회원가입은 잘 되는데, 우리가 name에 notempty를 걸어놨었다. 

그래서 Name 필드를 비운 상태로 submit하면, whitelabel 에러페이지가 뜬다. 에러내용은 당연히 validation 관련.

 

원래 에러가 나면, 컨트롤러 안의 내용은 실행되지 않고 팅겨버리는데, 다음과 같이 BindingResult를 넣어주면, 에러내용을 담은채로 컨트롤러 안의 내용이 실행이 된다. 

result에 에러가 담겼다면, 다시 createMemberForm.html로 넘어가게 했다. 

이렇게 다시 빌드를 하고 name을 비운상태로 form 제출을 해보면, 

MemberForm 클래스에서 Name 필드에 @NotEmpty(message = "회원 이름은 필수입니다") 어노테이션에 담은 message가 아래 딱 뜬다. 

 

---

강의3. 회원 목록 조회

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

 

 

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

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

 

 

서버사이드렌더링으로 할때는 위에서 한것처럼 member entity 자체를 html에 넘겨줘도 괜찮지만, 

API를 만들때는 이유불문하고 절대 entity를 넘기면 안된다. 

API라는 것은 spec이다. Member 엔티티를 반환하게 되면, Member 엔티티에 필드를 추가하게 되면, 불필요한 필드까지 넘어갈 뿐더러 API spec이 변경된다. 그럼 이제 불완전하게 되고, 그걸 가져다 쓰는 개발팀은 고통을 받게 된다. 

 

그래서 dto로 만들어서 넘기는게 제일 깔끔하다. 

---

강의4. 상품 등록

package jpabook.jpashop.Controller;

import jpabook.jpashop.domain.Item.Book;
import jpabook.jpashop.service.ItemService;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;

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

        // Order에서 사용한 것 처럼 static 생성자 메서드를 사용하는게 setter를 사용하는 것보다 훨씬 좋다.
        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:/";
    }
}

 

현재 create함수에, book에 대한 정보들을 setter로 설정해놨는데, 

아래 사진의 Order 도메인에서 사용한 것 처럼 static 생성자 메서드를 사용하는게 setter를 사용하는 것 보다 더 좋다. 

실무에서는 setter를 다 날려버리고 코드 짠다고 한다. 

static 생성자 메소드

 

 

이렇게 하고 서버를 실행시켜서 상품 등록을 해보았으나 db에 저장이 안됐다.

이유는 간단하게 바로 찾을 수 있었는데, 

@Transactional(readonly=true) 때문이었다.

readOnly : 트랜잭션을 읽기 전용으로 설정한다. 특정 트랜잭션 안에서 쓰기 작업이 일어나는 것을 의도적으로 방지하기 위해 사용된다. insert,update,delete 작업이 진행되면 예외가 발생한다.

 

readOnly를 풀어주면 db에 잘 저장이 된다. 

Transactional에 다양한 옵션이 있는데, 어느 상황에 쓰이는지를 잘 알아두면 좋을 것 같다. 

오로지 find만 하는 service 라면, readOnly를 통해 수정삭제를 막아주는 것이 좋겠다.

혹은 이렇게 하면 된다. 

 

---

강의5. 상품 목록

---

강의6. 상품 수정

---

강의7. 변경 감지와 병합

ItemController

book에 Id가 존재한다. 이미 jpa로 갖다온 객체. 

 

준영속 엔티티

영속성 컨텍스트가 더는 관리하지 않는 엔티티를 말한다.
(여기서는 itemService.saveItem(book) 에서 수정을 시도하는 Book 객체다. Book 객체는 이미 DB 에 한번 저장되어서 식별자가 존재한다. 이렇게 임의로 만들어낸 엔티티도 기존 식별자를 가지고 있으면 준 영속 엔티티로 볼 수 있다.)

 

준영속 엔티티는 문제가 뭐냐면, jpa가 관리를 안하잖아요. jpa가 관리하는 영속 상태의 엔티티는 변경감지라는게 일어난다. 뭐가 변경되는지 jpa가 다 눈으로 보고 있단 말이예요. 그래서 transaction 커밋 시점에 아 너 이거 변경됬구나 하고 딱 바꿔치기를 한다. 

그런데 위에 캡처한 사진속 book 객체를 보면, 내가 new를 통해 만들었다. 즉, jpa가 관리하지 않는다. 그렇기 때문에 내가 아무리 저기에서 book 값을 바꿔치기 해도 db에 업데이트가 안일어난다. 

내가 new를 통해 book객체를 생성했다. 트랜잭션이 있다고 해도 jpa가 관리를 안하기 때문에 jpa가 이걸 update할 근거가 없는거다. 

 

그러면 이 준영속 엔티티는 어떻게 데이터를 수정할 수 있을까?

1. 변경 감지 기능 사용

2. 병합 ('merge') 사용

 

 

 

1. 변경 감지 기능 사용

ItemService.java 에 새로운 메서드 updateItem 추가

함수 마지막에 itemRepository.save(findItem); 을 해줄 필요가 있을까?

아무것도 호출할 필요가 없다. 

26번줄에 findItem으로 찾아온 얘는 영속 상태이다.

값을 세팅을 한 다음에 어떻게 되느냐, @Transactional에 의해서 트랜잭션이 커밋이 된다. 

커밋이 되면 jpa는 flush를 날린다.

flush를 날린다는게 뭐냐면, 영속성 컨텍스트에 있는 엔티티 중에 변경된 얘를 찾아 바뀐 것에 대해 업데이트 쿼리를 날려준다.

 

 

 

2. 병합 사용

ItemRepository.java

merge는 쉽게 말해서, 위에서 작성한 변경감지기능사용 코드 updateItem 함수를, 한줄로 해주는 것이다. 

 

병합 동작 방식

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

 

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

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

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

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

 

 

 

★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★

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

★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★

 

 

 

 

★★가장 좋은 해결 방법★★

1. 컨트롤러에서 어설프게 엔티티를 생성하지 말자

2. 트랜잭션이 있는 서비스 계층에 식별자(id)와 변경할 데이터를 명확하게 전달하라.

3. 트랜잭션이 있는 서비스 계층에서 영속 상태의 엔티티를 조회하고, 엔티티의 데이터를 직접 변경하자.

4. 트랜잭션 커밋 시점에 변경감지가 실행된다.

 

 

---

강의8. 상품 주문

조회가 아닌 주로 커맨드성 (ex. 주문) 같은 건 외부에서 컨트롤러 레벨에서는 식별자만 넘기고, 

실제 핵심 비즈니스 서비스에서 엔티티를 찾는다.

 

서비스 안에 메소드를 보면, 트랜잭션 안에서 엔티티를 조회해야 영속 상태로 진행이 된다. 그래야 상태도 변경할 수 있다. 

즉, 바깥에서 엔티티를 조회해서 서비스로 넘겨주지 말라. 서비스에서 엔티티를 조회하라. 

 

 

 

---

 

강의9. 주문 목록 검색, 취소