2023.06.28 Spring

스프링 인프런 김영한

39. 프로젝트 준비 V2

앞서 만든 기능을 유지하기 위해, 컨트롤러와 템플릿 파일을 복사하자.
ValidationItemControllerV2 컨트롤러 생성

hello.itemservice.web.validation.ValidationItemControllerV1 복사
hello.itemservice.web.validation.ValidationItemControllerV2 붙여넣기

URL 경로 변경: validation/v1/ validation/v2/

템플릿 파일 복사
validation/v1 디렉토리의 모든 템플릿 파일을 validation/v2 디렉토리로 복사
/resources/templates/validation/v1/ /resources/templates/validation/v2/
addForm.html
editForm.html
item.html
items.html

/resources/templates/validation/v2/ 하위 4개 파일 모두 URL 경로 변경: validation/v1/
validation/v2/
addForm.html
editForm.html
item.html
items.html

실행
http://localhost:8080/validation/v2/items
실행 후 웹 브라우저의 URL이 validation/v2 으로 잘 유지되는지 확인해보기

40. BindingResult1

스프링이 제공하는 검증오류처리 방법이다. 여기서 핵심은 BindingResult이다

40.1 ValidationItemControllerV2 - addItemV1

메소드에 BindingResult를 넣어준다 뭔가 바인딩된게 담긴다고 생각하면된다.
addError()메소드를 호출하면 map error와 같은 역할을 하게된다.
FieldError객체를 아규먼트로 받는데 필드이름을 기준으로 할때를 의미한다.
첫번째 attribute에는 objectname
두번째는 필드이름
세번째는 메시지이다.

bindingResult.addError(new FieldError("item", "itemName", "상품 이름은 필수입니다."));
각각을 채워주면된다.

필드오류는 이렇게 처리하면된다.

global오류는 new ObjectError에 담으면된다.

bindingResult가 에러가 있다면 값을 보내면되는데 model에 알아서 스프링이 담아서 보내준다.

 @PostMapping("/add")
public String addItem(@ModelAttribute Item item,
                      BindingResult bindingResult,
                      RedirectAttributes redirectAttributes,
                      Model model) {
    //검증 오류 결과를 보관
    Map<String, String> errors = new HashMap<>();
    //검증 로직
    if (!StringUtils.hasText(item.getItemName())) {
        bindingResult.addError(new FieldError("item", "itemName", "상품 이름은 필수입니다."));
    }

    if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
        bindingResult.addError(new FieldError("item", "price", "가격은 1,000 ~ 1,000,000 까지 허용합니다."));
    }

    if (item.getQuantity() == null || item.getQuantity() >= 9999) {
        bindingResult.addError(new FieldError("item", "quantity", "수량은 최대 9,999 까지 허용합니다."));
    }

    //특정 필드가 아닌 복합 룰 검증
    if (item.getPrice() != null && item.getQuantity() != null) {
        int resultPrice = item.getPrice() * item.getQuantity();
        if (resultPrice < 10000) {
            bindingResult.addError(new ObjectError("item", "가격 * 수량의 합은 10,000원 이상이어야 합니다. 현재 값 = " + resultPrice));
        }
    }

    //검증에 실패하면 다시 입력 폼으로
    //if (!errors.isEmpty()) {
    if (bindingResult.hasErrors()) {
        log.info("errors : {}", bindingResult);
        return "validation/v2/addForm";
    }

    //성공 로직
    Item savedItem = itemRepository.save(item);
    redirectAttributes.addAttribute("itemId", savedItem.getId());
    redirectAttributes.addAttribute("status", true);
    return "redirect:/validation/v2/items/{itemId}";
}

주의할점!!!!
BindingResult bindingResult 파라미터의 위치는 @ModelAttribute Item item 다음에 와야 한다
BindingResult에 Item객체를 담기 때문에 미리 선언되어있어야 사용이 가능하다.

40.1.1 필드 오류 - FieldError

if (!StringUtils.hasText(item.getItemName())) {
    bindingResult.addError(new FieldError("item", "itemName", "상품 이름은 필수입니다."));
}

FieldError 생성자 요약

public FieldError(String objectName, String field, String defaultMessage) {}

필드에 오류가 있으면 FieldError 객체를 생성해서 bindingResult 에 담아두면 된다.
objectName : @ModelAttribute 이름
field : 오류가 발생한 필드 이름
defaultMessage : 오류 기본 메시지

40.1.2 글로벌 오류 - ObjectError

bindingResult.addError(new ObjectError("item", "가격 * 수량의 합은 10,000원 이상이어야 합니다. 현재 값 = " + resultPrice));

ObjectError 생성자 요약

public ObjectError(String objectName, String defaultMessage) {}

특정 필드를 넘어서는 오류가 있으면 ObjectError 객체를 생성해서 bindingResult 에 담아두면 된다.
objectName : @ModelAttribute 의 이름
defaultMessage : 오류 기본 메시지

40.2 validation/v2/addForm.html 수정

화면을 수정해줘야한다.

타임리프 스프링 검증 오류 통합 기능
타임리프는 스프링의 BindingResult 를 활용해서 편리하게 검증 오류를 표현하는 기능을 제공한다.
#fields : #fields 로 BindingResult 가 제공하는 검증 오류에 접근할 수 있다.
th:errors : 해당 필드에 오류가 있는 경우에 태그를 출력한다. th:if 의 편의 버전이다.
th:errorclass : th:field 에서 지정한 필드에 오류가 있으면 class 정보를 추가한다.

40.2.1 글로벌 오류 처리

    <div th:if="${#fields.hasGlobalErrors()}">
     <p class="field-error" th:each="err : ${#fields.globalErrors()}" th:text="$
    {err}">전체 오류 메시지</p>
    </div>

40.2.2 필드 오류 처리

<input type="text" id="itemName" th:field="*{itemName}" th:errorclass="field-error" class="form-control" placeholder="이름을 입력하세요">
<div class="field-error" th:errors="*{itemName}">
 상품명 오류
</div>

40.2.3 최종

 <form action="item.html" th:action th:object="${item}" method="post">
    <div th:if="${#fields.hasGlobalErrors()}">
        <p class="field-error" th:each="err : ${#fields.globalErrors()}"
           th:text="${err}">글로벌 오류 메시지</p>
    </div>
    <div>
        <label for="itemName" th:text="#{label.item.itemName}">상품명</label>
        <input type="text" id="itemName" th:field="*{itemName}"
               th:errorclass="field-error" class="form-control"
               placeholder="이름을 입력하세요">
        <div class="field-error" th:errors="*{itemName}">
            상품명 오류
        </div>
    </div>
    <div>
        <label for="price" th:text="#{label.item.price}">가격</label>
        <input type="text" id="price" th:field="*{price}"
               th:errorclass="field-error" class="form-control"
               placeholder="가격을 입력하세요">
        <div class="field-error" th:errors="*{price}">
            가격 오류
        </div>
    </div>
    <div>
        <label for="quantity" th:text="#{label.item.quantity}">수량</label>
        <input type="text" id="quantity" th:field="*{quantity}"
               th:errorclass="field-error" class="form-control"
               placeholder="수량을 입력하세요">
        <div class="field-error" th:errors="*{quantity}">
            수량 오류
        </div>
    </div>
</form>

<spring:hasBindErrors name="userVO">
jsp에서는 또 다른 태그를 사용해서 가져와야한다.
https://victorydntmd.tistory.com/179

오류가 있다면 처리해주는 삼항연산같은 것을 사용햇엇는데 아주 단순해졋다.
th:field가 아주 많이 사용된다. th:field에 itemName이라는 것에 오류가 잇다면 돌려주는 것이다.
th:field가 id name value등을 알아서 만들어주고 이런 역할도 해주는 것이다.

th:field에 오류가 발생하는 경우 error내용을 출력해주는 것이다.

검증과 오류 메시지 공식 메뉴얼을 보고 공부해보자.
https://www.thymeleaf.org/doc/tutorials/3.0/thymeleafspring.html#validation-and-error-messages

41. BindingResult2

심도잇게 내용을 추가해보자.
BindingResult는 스프링이 제공하는 검증 오류를 보관하는 객체이다.
검증 오류가 발생하면 여기에 보관하는 것이다.

BindingResult 가 있으면 @ModelAttribute 에 데이터 바인딩 시 오류가 발생해도 컨트롤러가 호출된다!

예) @ModelAttribute에 바인딩 시 타입 오류가 발생하면?
-> BindingResult 가 없으면 400 오류가 발생하면서 컨트롤러가 호출되지 않고, 오류 페이지로 이동한다.
-> BindingResult 가 있으면 오류 정보( FieldError )를 BindingResult 에 담아서 컨트롤러를 정상 호출한다.

41.1 BindingResult에 검증 오류를 적용하는 3가지 방법

1.@ModelAttribute 의 객체에 타입 오류 등으로 바인딩이 실패하는 경우 스프링이 FieldError 생성해서 BindingResult 에 넣어준다.
2.개발자가 직접 넣어준다.
3.Validator 사용 이것은 뒤에서 설명

41.2 타입 오류 확인

숫자가 입력되어야 할 곳에 문자를 입력해서 타입을 다르게 해서 BindingResult 를 호출하고 bindingResult 의 값을 확인해보자.
BindingResult가 오류가 낫다고 알려준다.

errors에 알아서 담아서 말해주는 것이다.
원래는 타입이 잘못되면 그냥 튕겨버린다.

41.3 주의할점!!!

BindingResult 는 검증할 대상 바로 다음에 와야한다.
순서가 중요하다. 예를 들어서 @ModelAttribute Item item , 바로 다음에 BindingResult 가 와야 한다.

BindingResult 는 Model에 자동으로 포함된다.

BindingResult와 Errors
org.springframework.validation.Errors
org.springframework.validation.BindingResult

BindingResult 는 인터페이스이고, Errors 인터페이스를 상속받고 있다.

실제 넘어오는 구현체는 BeanPropertyBindingResult 라는 것인데,
둘다 구현하고 있으므로 BindingResult 대신에 Errors 를 사용해도 된다.

Errors 인터페이스는 단순한 오류 저장과 조회 기능을 제공한다.
BindingResult 는 여기에 더해서 추가적인 기능들을 제공한다.
addError() 도 BindingResult 가 제공하므로 여기서는 BindingResult 를 사용하자.
주로 관례상 BindingResult 를 많이 사용한다.

41.4 정리

BindingResult , FieldError , ObjectError 를 사용해서 오류 메시지를 처리하는 방법을 알아보았다.
그런데 오류가 발생하는 경우 고객이 입력한 내용이 모두 사라진다. 이 문제를 해결해보자.

오류가 두가지이다 바인딩 자체가 실패하거나 비즈니스에서 오류가 발생하는 경우 두가지가 있다.

42. FieldError, ObjectError

목표
사용자 입력 오류 메시지가 화면에 남도록 하자.
예) 가격을 1000원 미만으로 설정시 입력한 값이 남아있어야 한다.
FieldError , ObjectError 에 대해서 더 자세히 알아보자.

값을 보전해줘야한다.
FieldError의 두번째 생성자를 쓰면 rejectedValue를 넣을 수있다.
거절된값 즉 사용자가 입력한 값이다.

42.1 ValidationItemControllerV2 - addItemV2

bindingResult.addError(new FieldError("item", "itemName", item.getItemName(), false, null, null, "상품 이름은 필수입니다."));
objectName, field, rejectedValue, bindingFailure, codes, argument, message

bindingFailure은 데이터가 잘들어왓으니 false?

42.2 FieldError생성자

파라미터 목록
objectName : 오류가 발생한 객체 이름
field : 오류 필드
rejectedValue : 사용자가 입력한 값(거절된 값)
bindingFailure : 타입 오류 같은 바인딩 실패인지, 검증 실패인지 구분 값 바인딩이되엇으면 false그냥 검증실패면 true
codes : 메시지 코드
arguments : 메시지에서 사용하는 인자
defaultMessage : 기본 오류 메시지
ObjectError 도 유사하게 두 가지 생성자를 제공한다. 코드를 참고하자

오류 발생시 사용자 입력 값 유지
new FieldError("item", "price", item.getPrice(), false, null, null, "가격은 1,000 ~ 1,000,000 까지 허용합니다.")
사용자의 입력 데이터가 컨트롤러의 @ModelAttribute 에 바인딩되는 시점에 오류가 발생하면 모델 객체에 사용자 입력 값을 유지하기 어렵다.

예를 들어서 가격에 숫자가 아닌 문자가 입력된다면 가격은 Integer 타입이므로 문자를 보관할 수 있는 방법이 없다.

그래서 오류가 발생한 경우 사용자 입력 값을 보관하는 별도의 방법이 필요하다.
그리고 이렇게 보관한 사용자 입력 값을 검증 오류 발생시 화면에 다시 출력하면 된다.

FieldError 는 오류 발생시 사용자 입력 값을 저장하는 기능을 제공한다.
여기서 rejectedValue 가 바로 오류 발생시 사용자 입력 값을 저장하는 필드다.
bindingFailure 는 타입 오류 같은 바인딩이 실패했는지 여부를 적어주면 된다.
여기서는 바인딩이 실패한 것은 아니기 때문에 false 를 사용한다

42.3 타임리프의 사용자 입력 값 유지

th:field="*{price}"
타임리프의 th:field 는 매우 똑똑하게 동작하는데, 정상 상황에는 모델 객체의 값을 사용하지만,
오류가 발생하면 FieldError 에서 보관한 값을 사용해서 값을 출력한다.

42.4 스프링의 바인딩 오류 처리

타입 오류로 바인딩에 실패하면 스프링은 FieldError 를 생성하면서 사용자가 입력한 값을 넣어둔다.
그리고 해당 오류를 BindingResult 에 담아서 컨트롤러를 호출한다.
따라서 타입 오류 같은 바인딩 실패시에도 사용자의 오류 메시지를 정상 출력할 수 있다.

2023.06.28

타임리프가 매우 편한 기능을 제공한다.
검증 자체가 어렵지는 않지만 써보고 싶다는 생각이 든다.
다음 프로젝트에 적용해보고 싶다.