[Spring Boot][5] 4-2. 검증1 - Validation

🏷 오류 코드와 메시지 처리1

오류 메시지들도 일괄적으로 관리하면 편하다😊
➡️ 어디서든 사용할 수 있기 때문에

지난 시간에 배웠던 메시지 기능을 생각해보며, errors 메시지 파일을 생성해보자❗️
➡️ messages.properties 를 사용해도 되지만, 오류 메시지를 구분하기 쉽게 errors.properties 라는 별도의 파일로 관리해보자.

1️⃣ 스프링 부트 메시지 설정 추가 - application.properties
➡️ spring.messages.basename=messages,errors

2️⃣ errors.properties 추가 - src/main/resources/errors.properties

required.item.itemName=상품 이름은 필수입니다. 
range.item.price=가격은 {0} ~ {1} 까지 허용합니다. 
max.item.quantity=수량은 최대 {0} 까지 허용합니다. 
totalPriceMin=가격 * 수량의 합은 {0}원 이상이어야 합니다. 현재 값 = {1}

✔️ ValidationItemControllerV2 - addItemV3() 추가

@PostMapping("/add")
    public String addItemV3(@ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes, Model model) {

        //검증 로직
        if (!StringUtils.hasText(item.getItemName())) {
            bindingResult.addError(new FieldError("item", "itemName", item.getItemName(), false, new String[]{"required.item.itemName"}, null, null));
        }
        if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
            bindingResult.addError(new FieldError("item", "price", item.getPrice(), false, new String[]{"range.item.price"}, new Object[]{1000, 1000000}, null));
        }
        if (item.getQuantity() == null || item.getQuantity() >= 9999) {
            bindingResult.addError(new FieldError("item", "quantity", item.getQuantity(), false, new String[]{"max.item.quantity"} ,new Object[]{9999}, null));
        }

        //특정 필드가 아닌 복합 룰 검증
        if (item.getPrice() != null && item.getQuantity() != null) {
            int resultPrice = item.getPrice() * item.getQuantity();
            if (resultPrice < 10000) {
                bindingResult.addError(new ObjectError("item",new String[]{"totalPriceMin"} ,new Object[]{10000, resultPrice}, null));
            }
        }

        //검증에 실패하면 다시 입력 폼으로
        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}";
    }

• codes : required.item.itemName 를 사용해서 메시지 코드를 지정한다.
  • 메시지 코드는 하나가 아니라 배열로 여러 값을 전달할 수 있는데, 순서대로 매칭해서 처음 매칭되는 메시지가 사용된다.
• arguments : Object[]{1000, 1000000} 를 사용해서 코드의 {0} , {1} 로 치환할 값을 전달한다.

✔️ 실행 결과

⬆️ 이렇게만 보면, errors.properties에서 적용된 건 지 정확히 알 수 없으므로, 테스트를 위해 errors.properties 의 내용을 수정 후 다시 테스트해보자!

⬆️ 메시지 뒤에 test추가
⬆️ 잘 적용된 것을 확인👍🏻

---

🏷 오류 코드와 메시지 처리2

그런데 FieldError , ObjectError 는 다루기 너무 번거로운데,,
오류 코드도 item.itemName 처럼 좀 더 자동화 할 수 있지 않을까🤔❓

💡 BindingResult 가 제공하는 rejectValue(), reject() 을 사용하면 FieldError , ObjectError 를 직접 생성하지 않고, 깔끔하게 검증 오류를 다룰 수 있다!!!!!!

✔️ ValidationItemControllerV2 - addItemV4() 추가

@PostMapping("/add")
    public String addItemV4(@ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes, Model model) {

        log.info("objectName={}", bindingResult.getObjectName());
        log.info("target={}", bindingResult.getTarget());

        if (!StringUtils.hasText(item.getItemName())) {
            bindingResult.rejectValue("itemName", "required");
        }
        if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
            bindingResult.rejectValue("price", "range", new Object[]{1000, 10000000}, null);
        }
        if (item.getQuantity() == null || item.getQuantity() >= 9999) {
            bindingResult.rejectValue("quantity", "max", new Object[]{9999}, null);
        }

        //특정 필드가 아닌 복합 룰 검증
        if (item.getPrice() != null && item.getQuantity() != null) {
            int resultPrice = item.getPrice() * item.getQuantity();
            if (resultPrice < 10000) {
                bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
            }
        }

        //검증에 실패하면 다시 입력 폼으로
        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}";
    }

➡️ 이렇게 실행했는데, errors.properties 에 있는 코드를 직접 입력하지 않았음에도 오류 메시지가 정상 출력되는데 어떻게 된 것일까❓

📌rejectValue()

 void rejectValue(@Nullable String field, String errorCode,
        @Nullable Object[] errorArgs, @Nullable String defaultMessage)

• field : 오류 필드명
• errorCode : 오류 코드(이 오류 코드는 메시지에 등록된 코드가 아니고, 뒤에서 설명할 messageResolver를 위한 오류 코드이다)
• errorArgs : 오류 메시지에서 {0} 을 치환하기 위한 값
• defaultMessage : 오류 메시지를 찾을 수 없을 때 사용하는 기본 메시지

✔️ 축약된 오류 코드

🤔 : FieldError() 를 직접 다룰 때는 오류 코드를 range.item.price 와 같이 모두 입력했어! 그런데 rejectValue() 를 사용하고부터는 오류 코드를 range 로 간단하게 바꿨는데도 오류 메시지를 잘 출력하는데,, 이게 왜 그런 거야?

😇 : 이걸 이해하려면 일단 MessageCodesResolver 를 먼저 이해해야 한단다^^

---

🏷 오류 코드와 메시지 처리3

• required.item.itemName : 상품 이름은 필수 입니다.
• range.item.price : 상품의 가격 범위 오류 입니다.
  ➡️ 오류 코드를 만들 때 다음과 같이 자세히 만들 수도 있고,

• required : 필수 값 입니다.
• range : 범위 오류 입니다.
  ➡️ 이처럼 매우 간단히 만들 수도 있다!

단순하게 만든다면, 범용성이 좋아 여러곳에서 사용이 가능하지만😀, 세밀하게 작성하기는 어렵다🥺
자세하게 만든다면, 세밀하게 작성할 수는 있지만😀, 범용성이 떨어진다🥺

가장 좋은 방법은
❗️범용성으로 사용하다가, 세밀하게 작성해야 하는 경우에는 세밀한 내용이 적용되도록 메시지에 단계를 두는 방법❗️이다

예를 들어

#Level1
required.item.itemName: 상품 이름은 필수 입니다. 

#Level2
required: 필수 값 입니다.

이와 같이, required 라는 오류 코드를 사용할 때,

1️⃣ required 만 있다면 "필수 값 입니다" 를 사용하고,
2️⃣ required.item.itemName 와 같이 객체명과 필드명을 조합한 세밀한 메시지 코드가 있다면 "상품 이름은 필수입니다" 라는 메시지를 높은 우선순위로 사용하는 것이다.

➡️ 스프링은 이러한 기능을 MessageCodesResolver 로 지원한다 👍🏻

---

🏷 오류 코드와 메시지 처리4

✔️ MessageCodesResolverTest

package hello.itemservice.validation;

import org.junit.jupiter.api.Test;
import org.springframework.validation.DefaultMessageCodesResolver;
import org.springframework.validation.MessageCodesResolver;

import static org.assertj.core.api.Assertions.*;

public class MessageCodesResolverTest {

    MessageCodesResolver codesResolver = new DefaultMessageCodesResolver();

    @Test
    // 객체 에러
    void messageCodesResolverObject() {
        String[] messageCodes = codesResolver.resolveMessageCodes("required", "item");
        assertThat(messageCodes).containsExactly("required.item", "required");
    }

    @Test
    // 필드 에러
    void messageCodesResolverField() {
        String[] messageCodes = codesResolver.resolveMessageCodes("required", "item", "itemName", String.class);
        assertThat(messageCodes).containsExactly(
                "required.item.itemName",
                "required.itemName",
                "required.java.lang.String",
                "required"
        );
    }

}

⬆️ 테스트 결과 👍🏻

MessageCodesResolver

• 검증 오류 코드로 메시지 코드들을 생성한다.
• MessageCodesResolver 인터페이스이고 DefaultMessageCodesResolver 는 기본 구현체이다.
• 주로 ObjectError , FieldError 과 함께 사용한다.

✔️ DefaultMessageCodesResolver 의 기본 메시지 생성 규칙

1️⃣ 객체 오류

객체 오류의 경우 다음 순서로 2가지 생성 
1.: code + "." + object name 
2.: code

예) 오류 코드: required, object name: item 
1.: required.item
2.: required

➡️ ObjectError reject("totalPriceMin")
다음 2가지 오류 코드를 자동으로 생성

• totalPriceMin.item
• totalPriceMin

2️⃣ 필드 오류

필드 오류의 경우 다음 순서로4가지 메시지 코드 생성
1.: code + "." + object name + "." + field
2.: code + "." + field
3.: code + "." + field type
4.: code

예) 오류 코드: typeMismatch, object name "user", field "age", field type: int 
1. "typeMismatch.user.age"
2. "typeMismatch.age"
3. "typeMismatch.int"
4. "typeMismatch

➡️ FieldError rejectValue("itemName", "required")
다음 4가지 오류 코드를 자동으로 생성

• required.item.itemName
• required.itemName
• required.java.lang.String
• required

3️⃣ 동작 방식

• rejectValue() , reject() 는 내부에서 MessageCodesResolver 를 사용한다. 여기에서 메시지 코드들을 생성한다.
• FieldError , ObjectError 의 생성자를 보면, 오류 코드를 하나가 아니라 여러 오류 코드를 가질 수 있다.
• MessageCodesResolver 를 통해서 생성된 순서대로 오류 코드를 보관한다.

4️⃣ 오류 메시지 출력

• 타임리프 화면을 렌더링 할 때 th:errors 가 실행된다.
• 만약 이때 오류가 있다면 생성된 오류 메시지 코드를 순서대로 돌아가면서 메시지를 찾는다.
• 그리고 없으면 디폴트 메시지를 출력한다.

---

🏷 오류 코드와 메시지 처리5

✔️오류 코드 관리 전략

핵심은 구체적인 것에서❗️ 덜 구체적인 것으로❗️

MessageCodesResolver 는 required.item.itemName 처럼 구체적인 것을 먼저 만들어주고, required 처럼 덜 구체적인 것을 가장 나중에 만든다.
➡️ 이렇게 하면 앞서 말한 것 처럼 메시지와 관련된 공통 전략을 편리하게 도입할 수 있다👍🏻

✔️ errors.properties 수정

#required.item.itemName=상품 이름은 필수입니다.
#range.item.price=가격은 {0} ~ {1} 까지 허용합니다.
#max.item.quantity=수량은 최대 {0} 까지 허용합니다.
#totalPriceMin=가격 * 수량의 합은 {0}원 이상이어야 합니다. 현재 값 = {1}

#==ObjectError==
#Level1
totalPriceMin.item=상품의 가격 * 수량의 합은 {0}원 이상이어야 합니다. 현재 값 = {1}

#Level2 - 생략
totalPriceMin=전체 가격은 {0}원 이상이어야 합니다. 현재 값 = {1}


#==FieldError==
#Level1
required.item.itemName=상품 이름은 필수입니다.
range.item.price=가격은 {0} ~ {1} 까지 허용합니다.
max.item.quantity=수량은 최대 {0} 까지 허용합니다.

#Level2 - 생략

#Level3
required.java.lang.String = 필수 문자입니다.
required.java.lang.Integer = 필수 숫자입니다.
min.java.lang.String = {0} 이상의 문자를 입력해주세요.
min.java.lang.Integer = {0} 이상의 숫자를 입력해주세요.
range.java.lang.String = {0} ~ {1} 까지의 문자를 입력해주세요.
range.java.lang.Integer = {0} ~ {1} 까지의 숫자를 입력해주세요.
max.java.lang.String = {0} 까지의 숫자를 허용합니다.
max.java.lang.Integer = {0} 까지의 숫자를 허용합니다.

#Level4
required = 필수 값 입니다.
min= {0} 이상이어야 합니다.
range= {0} ~ {1} 범위를 허용합니다.
max= {0} 까지 허용합니다.

크게 객체 오류와 필드 오류를 나누었고, 범용성에 따라 레벨을 나누어두었다!

itemName 의 경우 required 검증 오류 메시지가 발생하면 다음 코드 순서대로 메시지가 생성된다!
1️⃣ required.item.itemName
2️⃣ required.itemName
3️⃣ required.java.lang.String
4️⃣ required

이렇게 생성된 메시지 코드를 기반으로 순서대로 MessageSource 에서 메시지에서 찾는데,

구체적인 것에서 덜 구체적인 순서대로 찾는다❗️

• 메시지에 1번이 없으면 2번을 찾고,
• 2번이 없으면 3번을 찾는다.
• 이렇게 되면 만약에 크게 중요하지 않은 오류 메시지는 기존에 정의된 것을 그냥 재활용 하면 된다!

✔️ 실행

1️⃣ Level1,2 전부 주석해보자

2️⃣ Level3 전부 주석해보자

3️⃣ Level4 전부 주석해보자 ➡️ 못찾으면 코드에 작성한 디폴트 메시지를 사용한다.

4️⃣ Object 오류도 Level1, Level2로 재활용 가능하다.

---

🏷 오류 코드와 메시지 처리6

✔️ 스프링이 직접 만든 오류 메시지 처리

검증 오류 코드는 ⬇️아래와 같이⬇️ 2가지로 나눌 수 있다.
1️⃣ 개발자가 직접 설정한 오류 코드 ➡️ rejectValue() 를 직접 호출
2️⃣ 스프링이 직접 검증 오류에 추가한 경우(주로 타입 정보가 맞지 않음)

지금까지 학습한 메시지 코드 전략의 강점을 확인해보자!

1️⃣ 상품 입력 폼 price 필드에 숫자가 아닌 'A'를 넣어보자

2️⃣ 로그를 확인해보면 BindingResult 에 FieldError 가 담겨있고, 다음과 같은 메시지 코드들이 생성된 것을 확인할 수 있다.

• typeMismatch.item.price
• typeMismatch.price
• typeMismatch.java.lang.Integer
• typeMismatch

3️⃣ 스프링은 타입 오류가 발생하면 typeMismatch 라는 오류 코드를 사용한다.
이 오류 코드가 MessageCodesResolver 를 통하면서 4가지 메시지 코드가 생성된 것이다.

4️⃣ error.properties 에 다음 내용을 추가하자!

#추가
typeMismatch.java.lang.Integer=숫자를 입력해주세요. typeMismatch=타입 오류입니다.

5️⃣ 다시 실행해보면, 소스코드를 하나도 건들지 않고, 원하는 메시지를 단계별로 설정할 수 있다!

---

🏷 Validation 분리1

복잡한 검증 로직을 별도로 분리해보자😊
➡️Validator 라는 검증 로직을 전용으로 모아두는 클래스를 따로 만들어서 분리하자!

✔️ ItemValidator 생성

package hello.itemservice.web.validation;

import hello.itemservice.domain.item.Item;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.validation.Errors;
import org.springframework.validation.Validator;

@Component
public class ItemValidator implements Validator {

    @Override
    public boolean supports(Class<?> clazz) {
        return Item.class.isAssignableFrom(clazz);
    }

    @Override
    public void validate(Object target, Errors errors) {
        Item item = (Item) target;

        if (!StringUtils.hasText(item.getItemName())) {
            errors.rejectValue("itemName", "required");
        }
        if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
            errors.rejectValue("price", "range", new Object[]{1000, 10000000}, null);
        }
        if (item.getQuantity() == null || item.getQuantity() >= 9999) {
            errors.rejectValue("quantity", "max", new Object[]{9999}, null);
        }

        //특정 필드가 아닌 복합 룰 검증
        if (item.getPrice() != null && item.getQuantity() != null) {
            int resultPrice = item.getPrice() * item.getQuantity();
            if (resultPrice < 10000) {
                errors.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
            }
        }
    }
}

📌 스프링은 검증을 체계적으로 제공하기 위해 아래의 인터페이스를 제공한다

public interface Validator {
    boolean supports(Class<?> clazz);
    void validate(Object target, Errors errors);
}

• supports() {} : 해당 검증기를 지원하는 여부 확인
• validate(Object target, Errors errors) : 검증 대상 객체와 BindingResult

✔️ ItemValidator 직접 호출하기 ➡️ ValidationItemControllerV2 - addItemV5() 추가

@PostMapping("/add")
    public String addItemV5(@ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes, Model model) {
        // target : item
        // errors : bindingResult
        itemValidator.validate(item, bindingResult);

        // 검증에 실패하면 다시 입력 폼으로
        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}";
    }

💡 ItemValidator 를 스프링 빈으로 주입 받아서 직접 호출했음!

✔️ 실행 결과

⬆️ 정상적으로 오류 메시지가 잘 출력되는 것을 확인👍🏻 검증과 관련된 부분이 깔끔하게 분리되었다!

---

🏷 Validation 분리2

스프링이 Validator 인터페이스를 별도로 제공하는 이유는 체계적으로 검증 기능을 도입하기 위해서 이다!
그런데 바로 앞에서는 검증기를 직접 불러서 사용했다.
이렇게 그대~로 사용해도 되지만, Validator 인터페이스를 사용해서 검증기를 만들면 스프링의 추가적인 도움을 받을 수 있다😮

✔️ ValidationItemControllerV2 추가

@InitBinder
    public void init(WebDataBinder dataBinder) {
        dataBinder.addValidators(itemValidator);
    }

💡 WebDataBinder를 통해서 사용하기
➡️ WebDataBinder 는 스프링의 파라미터 바인딩의 역할을 해주고 검증 기능도 내부에 포함한다!!

이처럼 WebDataBinder 에 검증기를 추가하면 해당 컨트롤러에서는 검증기를 자동으로 적용할 수 있다👍🏻
(@InitBinder 해당 컨트롤러에만 영향을 준다)

✔️ @Validated 적용 ➡️ ValidationItemControllerV2 - addItemV6() 추가

@PostMapping("/add")
    // @Validated 애노테이션 추 : Item에 대해 자동으로 검증기가 실행됨
    public String addItemV6(@Validated @ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes, Model model) {

        // 검증에 실패하면 다시 입력 폼으로
        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}";
    }

validator를 직접 호출하는 부분이 사라지고, 대신에 검증 대상 앞에 @Validated 라는 애노테이션이 붙었다❗️

• @Validated 는 검증기를 실행하라는 애노테이션이다.
• 이 애노테이션이 붙으면 앞서 WebDataBinder 에 등록한 검증기를 찾아서 실행한다.

✔️ 실행 결과

⬆️ 정상적으로 오류 메시지가 잘 출력되는 것을 확인 👍🏻

---

검증2 까지만 했는데 얘 혼자 버전6 까지 있다뇨,,😂