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

🏷 Bean Validation - 소개

검증 기능을 지금처럼 매번 코드로 작성하는 것은 상당히 번거롭다☹️
특히 특정 필드에 대한 검증 로직은
대부분 빈 값인지 아닌지, 특정 크기를 넘는지 아닌지와 같이 매우 일반적인 로직이다.

public class Item {
      private Long id;
      
      @NotBlank
      private String itemName;
      
      @NotNull
      @Range(min = 1000, max = 1000000)
      private Integer price;
      
      @NotNull
      @Max(9999)
      private Integer quantity;
      //...

⬆️ 위 코드와 같이, 검증 로직을 모든 프로젝트에 적용할 수 있게 공통화, 표준화 한 것을 바로 Bean Validation이라고 한다!

💡 Bean Validation 이란❓
먼저 Bean Validation은 특정한 구현체가 아니라 Bean Validation 2.0(JSR-380)이라는 기술 표준이다.
쉽게 이야기해서 검증 애노테이션과 여러 인터페이스의 모음이다.
마치 JPA가 표준 기술이고 그 구현체로 하이버네이트가 있는 것과 같다!

📌 하이버네이트 Validator 관련 링크

• 공식 사이트
• 공식 메뉴얼
• 검증 애노테이션 모음

---

🏷 Bean Validation - 시작

Bean Validation 기능을 어떻게 사용하는지 코드로 알아보자!
먼저 스프링과 통합하지 않고, 순수한 Bean Validation 사용법 부터 테스트 코드로 알아보자😀

✔️ Bean Validation 의존관계 추가

build.gradle
➡️ implementation 'org.springframework.boot:spring-boot-starter-validation'

✔️ 테스트 코드 작성 : Item - Bean Validation 애노테이션 적용

package hello.itemservice.domain.item;
import lombok.Data;
import org.hibernate.validator.constraints.Range;
import javax.validation.constraints.Max;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

@Data
public class Item {
    private Long id;
    
    @NotBlank
    private String itemName;
      
    @NotNull
    @Range(min = 1000, max = 1000000)
    private Integer price;
      
    @NotNull
    @Max(9999)
    private Integer quantity;
    
    public Item() {
	}
    
    public Item(String itemName, Integer price, Integer quantity) {
          this.itemName = itemName;
          this.price = price;
          this.quantity = quantity;
	} 
}

검증 애노테이션

• @NotBlank : 빈값 + 공백만 있는 경우를 허용하지 않는다.
• @NotNull : null 을 허용하지 않는다.
• @Range(min = 1000, max = 1000000) : 범위 안의 값이어야 한다.
• @Max(9999) : 최대 9999까지만 허용한다

✔️ BeanValidationTest - Bean Validation 테스트 코드 작성

package hello.itemservice.validation;

import hello.itemservice.domain.item.Item;
import org.junit.jupiter.api.Test;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.util.Set;

public class BeanValidationTest {

    @Test
    void beanValidation() {
        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();

        Item item = new Item();
        item.setItemName(" "); //공백
        item.setPrice(0);
        item.setQuantity(10000);

        Set<ConstraintViolation<Item>> violations = validator.validate(item);
        for (ConstraintViolation<Item> violation : violations) {
            System.out.println("violation = " + violation);
            System.out.println("violation = " + violation.getMessage());
        }

    }
}

✔️ 검증기 생성 및 검증 실행

1️⃣ 검증기 생성

ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
Validator validator = factory.getValidator();

⬆️ 위와 같이 검증기를 생성한다!
(이후 스프링과 통합하는 과정에서 이 코드는 사용하지 않기 때문에, 그냥 이런게 있구나~ 정도로 알고 넘어가자😊)

2️⃣ 검증 실행

Set<ConstraintViolation<Item>> violations = validator.validate(item);

⬆️ 검증 대상(item)을 직접 검증기에 넣고 그 결과를 받는다. Set 에는 ConstraintViolation 이라는 검증 오류가 담기는데, 결과가 비어있다면, 검증 오류가 없는 것이다!

---

🏷 Bean Validation - 프로젝트 준비 V3

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

1️⃣ ValidationItemControllerV3 컨트롤러 생성

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

2️⃣ 템플릿 파일 복사

• validation/v2 디렉토리의 모든 템플릿 파일을 validation/v3 디렉토리로 복사
• /resources/templates/validation/v3/ 하위 4개 파일 모두 URL 경로 변경

3️⃣ 실행
-http://localhost:8080/validation/v3/items 실행 후 웹 브라우저의 URL이 validation/v3 으로 잘 유지되는지 확인!

---

🏷 Bean Validation - 스프링 적용

✔️ ValidationItemControllerV3 코드 수정

package hello.itemservice.web.validation;

import hello.itemservice.domain.item.Item;
import hello.itemservice.domain.item.ItemRepository;
import hello.itemservice.domain.item.SaveCheck;
import hello.itemservice.domain.item.UpdateCheck;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.mvc.support.RedirectAttributes;

import javax.validation.Valid;
import java.util.List;

@Slf4j
@Controller
@RequestMapping("/validation/v3/items")
@RequiredArgsConstructor
public class ValidationItemControllerV3 {

    private final ItemRepository itemRepository;

    @GetMapping
    public String items(Model model) {
        List<Item> items = itemRepository.findAll();
        model.addAttribute("items", items);
        return "validation/v3/items";
    }

    @GetMapping("/{itemId}")
    public String item(@PathVariable long itemId, Model model) {
        Item item = itemRepository.findById(itemId);
        model.addAttribute("item", item);
        return "validation/v3/item";
    }

    @GetMapping("/add")
    public String addForm(Model model) {
        model.addAttribute("item", new Item());
        return "validation/v3/addForm";
    }

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

        //특정 필드가 아닌 복합 룰 검증
        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/v3/addForm";
        }

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

    @GetMapping("/{itemId}/edit")
    public String editForm(@PathVariable Long itemId, Model model) {
        Item item = itemRepository.findById(itemId);
        model.addAttribute("item", item);
        return "validation/v3/editForm";
    }

//    @PostMapping("/{itemId}/edit")
    public String edit(@PathVariable Long itemId, @Validated @ModelAttribute Item item, BindingResult bindingResult) {

        //특정 필드가 아닌 복합 룰 검증
        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/v3/editForm";
        }

        itemRepository.update(itemId, item);
        return "redirect:/validation/v3/items/{itemId}";
    }

    @PostMapping("/{itemId}/edit")
    public String editV2(@PathVariable Long itemId, @Validated(UpdateCheck.class) @ModelAttribute Item item, BindingResult bindingResult) {

        //특정 필드가 아닌 복합 룰 검증
        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/v3/editForm";
        }

        itemRepository.update(itemId, item);
        return "redirect:/validation/v3/items/{itemId}";
    }

}

검증기 부분을 빼고, addItemV1~V5 를 모두 지운 뒤,
addItemV6 ➡️ addItem 으로 바꾼다!!

그런데 실행해보면 검증기 부분이 빠졌음에도 Bean Validator 가 잘 동작하는 것을 확인할 수 있다🤔

➡️ 스프링 부트가 spring-boot-starter-validation 라이브러리를 넣으면 자동으로 Bean Validator를 인지하고 스프링에 통합한다❗️
➡️ LocalValidatorFactoryBean 을 글로벌 Validator로 등록한다.
➡️ 이 Validator는 @NotNull 같은 애노테이션을 보고 검증을 수행한다.
➡️ 이렇게 글로벌 Validator가 적용되어 있기 때문에 @Valid , @Validated 만 적용하면 된다.

✔️ 검증 순서

1️⃣ @ModelAttribute 각각의 필드에 타입 변환 시도

• 성공하면 다음으로
• 실패하면 typeMismatch 로 FieldError 추가

2️⃣ Validator 적용

💡@ModelAttribute ➡️ 각각의 필드 타입 변환시도 ➡️ 변환에 성공한 필드만 BeanValidation 적용💡

---

🏷 Bean Validation - 에러 코드

Bean Validation이 기본으로 제공하는 오류 메시지를 좀 더 자세히 변경하고 싶으면 어떻게 할까🤔❓

• Bean Validation 을 적용하고 bindingResult 에 등록된 검증 오류 코드를 보자.
• 오류 코드가 애노테이션 이름으로 등록되는데 이것은 마치 typeMismatch 와 유사하다!
• NotBlank 라는 오류 코드를 기반으로 MessageCodesResolver 를 통해 다양한 메시지 코드가 순서대로 생성된다.

@NotBlank

• NotBlank.item.itemName
• NotBlank.itemName
• NotBlank.java.lang.String
• NotBlank

@Range

• Range.item.price
• Range.price
• Range.java.lang.Integer
• Range

✔️ 메시지 등록

errors.properties 수정

#Bean Validation 추가 
NotBlank={0} 공백X 
Range={0}, {2} ~ {1} 허용 
Max={0}, 최대 {1}

⬆️ {0} 은 필드명이고, {1}, {2} ...은 각 애노테이션 마다 다름

✔️ BeanValidation 메시지 찾는 순서

1️⃣ 생성된 메시지 코드 순서대로 messageSource 에서 메시지 찾기

2️⃣ 애노테이션의 message 속성 사용 ➡️ @NotBlank(message = "공백! {0}")

3️⃣ 라이브러리가 제공하는 기본 값 사용 ➡️ 공백일 수 없습니다.

---

🏷 Bean Validation - 오브젝트 오류

**Bean Validation에서 특정 필드(FieldError)가 아닌 해당 오브젝트 관련 오류(ObjectError)는 어떻게 처리할 수 있을까🤔❓

@Data
@ScriptAssert(lang = "javascript", script = "_this.price * _this.quantity >= 10000")

public class Item {
	//...
}

⬆️ @ScriptAssert() 를 사용하면 된다❗️

⬆️ 실행해보면 잘 동작하지만, 실제로 사용하기에는 제약이 많고 복잡하다☹️

따라서 오브젝트 오류(글로벌 오류)의 경우 @ScriptAssert 을 억지로 사용하는 것 보다는 다음과 같이 오브젝트 오류 관련 부분만 직접 자바 코드로 작성하는 것을 권장한다!

✔️ ValidationItemControllerV3 - 글로벌 오류 추가

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

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

⬆️ 실행 구우우웃

---

🏷 Bean Validation - 수정에 적용

수정에도 검증 기능을 추가해보자😀

✔️ ValidationItemControllerV3 - edit() 변경

@PostMapping("/{itemId}/edit")
    public String edit(@PathVariable Long itemId, @Validated @ModelAttribute Item item, BindingResult bindingResult) {

        // 특정 필드가 아닌 복합 룰 검증
        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/v3/editForm";
        }

        itemRepository.update(itemId, item);
        return "redirect:/validation/v3/items/{itemId}";
    }

• edit() : Item 모델 객체에 @Validated 를 추가
• 검증 오류가 발생하면 editForm 으로 이동하는 코드 추가

✔️ validation/v3/editForm.html 변경

<style>
	.container {
		max-width: 560px;
    }
	.field-error {
  		border-color: #dc3545;
        color: #dc3545;
	}
    </style>

⬆️ .field-error css 추가

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

⬆️ 글로벌 오류 메시지

✔️ 실행

⬆️ 실행 결과 👍🏻

---

🏷 Bean Validation - 한계

✔️ 등록시 기존 요구사항

• 타입 검증
  • 가격, 수량에 문자가 들어가면 검증 오류 처리
• 필드 검증
  • 상품명 : 필수, 공백X
  • 가격 : 1000원 이상, 백만원 이하
  • 수량 : 최대 9999
• 특정 필드의 범위를 넘어서는 검증
  • 가격 * 수량의 합은 10,000원 이상

✔️ 수정시 요구사항

• 등록 시에는 quantity 수량을 최대 9999까지 등록할 수 있지만 수정시에는 수량을 무제한으로 변경할 수 있다.
• 등록시에는 id 값이 없어도 되지만, 수정시에는 id 값이 필수이다.

✔️ 수정 요구사항 적용 - Item 변경

@Data
public class Item {

    @NotNull    // 수정 요구사항 추가
    private Long id;

    @NotBlank
    private String itemName;

    @NotNull
    @Range(min = 1000, max = 1000000)
    private Integer price;

    @NotNull
//    @Max(9999)    // 수정 요구사항 추가
    private Integer quantity;

    public Item() {
    }

    public Item(String itemName, Integer price, Integer quantity) {
        this.itemName = itemName;
        this.price = price;
        this.quantity = quantity;
    }
}

• id : @NotNull 추가
• quantity : @Max(9999) 제거

실행해보면 수정은 정상 작동하는데, 등록에서 문제가 발생한다😂
등록시 화면이 넘어가지 않으면서, 'id': rejected value [null]; 이런 오류가 나오는데,

➡️ 등록시에는 id 에 값이 없는데 @NotNull id 를 적용한 것 때문에 검증에 실패하고 다시 폼 화면으로 넘어온다,, 결국 등록 자체도 불가능하고, 수량 제한도 걸지 못한다🥺

이 문제를 어떻게 해결할 지는 다음 시간에 배워볼 예정이다😊

---