[Spring] 검증(Validation) - BindingResult, FieldError, ObjectError

  이번 글을 통해 BindingResult를 활용한 검증(Validation)을 알아보고자 한다. 

글의 순서는

1. 서버에서 검증이 필요한 이유
   왜 서버에서 검증을 추가적으로 해야 하는가?
2. BindingResult
   BindingResult를 활용하여 검증을 수행하는 방법
3. 사용자의 입력 값 유지 방법
   바인딩을 하지 못한 상황에서도 사용자의 입력 값을 저장하는 방법

으로 진행하겠다.

 

1. 서버에서 검증이 필요한 이유 🧲

  컨트롤러의 중요한 역할 중 하나는 HTTP 요청이 정상인지 검증하는 것이다.

  그러나 클라이언트에서 검증을 하고 서버에서는 검증된 값을 그냥 쓰면 되는 거 아닌가라고 생각할 수 있다. 하지만 아래와 같은 이유로 인해서 서버에서도 검증을 수행해야 한다.

• 클라이언트 검증은 조작할 수 있으므로 보안에 취약하다
• 서버만으로 검증하면, 즉각적인 고객 사용성이 부족해진다.
• 클라이언트 검증과 서버 검증을 섞어서 사용하되, 최종적으로 서버 검증은 필수이다.
• API 방식을 사용하면 API 스펙을 잘 정의해서 검증 오류로 API 응답 결과에 잘 남겨줘야 한다.

 

2. BindingResult 🔗

📕 1. 개념

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

@PostMapping("/add")
public String addItem(@ModelAttribute Item item, BindingResult bindingResult) {
    ...
}

  BindingResult는 스프링이 제공하는 검증 오류를 보관하는 객체이다. 검증 오류가 발생하면 BindingResult에 보관하면 된다. 그리고 BindingResult는 Model에 자동으로 포함되기 때문에 그 값을 응답을 받는 쪽에서 사용하면 된다.

  주의할 점 한 가지는 BindingResult의 위치는 항상 바인딩되는 객체 뒤에 와야 한다는 것이다.

📕 2. 사용

  BindingResult의 유무에 따라서 바인딩 시 타입 오류가 발생했을 때의 진행이 달라진다.

• BindingResult가 없는 경우
  400 오류가 발생하면서 컨트롤러가 호출되지 않고, 오류 페이지로 이동한다.
• BindingResult가 있는 경우
  오류 정보(FieldError)를 BindingResult에 담아서 컨트롤러를 정상 호출한다.

  BindingResult에 검증 오류를 적용하는 것에는 3가지 방법이 있다.

1. 위에서 설명한 것처럼 바인딩 자체가 실패하는 경우에는 스프링이 FieldError를 생성해서 BindingResult에 넣어준다.
2. Validator를 사용한다. (뒤에서 다룰 주제인 Bean Validation에서 확인하자.)
3. 개발자가 직접 넣어준다.

bindingResult.addError(new FieldError("item", "itemName", "상품 이름은 필수입니다."));

📕 3. 실제 적용

  지금까지의 내용을 가지고 Item 예시를 이용한 코드를 확인해 보자. Item class가 다음과 같이 존재하고, 아래와 같은 오류를 확인할 것이다.

@Data
public class Item {

    private Long id;
    private String itemName;
    private Integer price;
    private Integer quantity;
}

1. 아이템 이름(itemName)이 없는 경우
2. 가격(itemPrice)의 범위가 1,000 ~ 1,000,000이 아닌 경우
3. 개수(quantity)가 최대 9,999개가 아닌 경우
4. 최종 값(가격(itemPrice) * 개수(quantity))이 10,000원 미만인 경우

  이를 검증을 활용한 코드로 표현하면 아래와 같다.

@Slf4j
@Controller
@RequiredArgsConstructor
public class ValidationController {

    private final ItemRepository itemRepository;

    @PostMapping("/add")
    public String addItem(@ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes) {
        // 1. 아이템 이름(itemName)이 없는 경우
        if(!StringUtils.hasText(item.getItemName())){
            bindingResult.addError(new FieldError("item", "itemName", "상품 이름은 필수입니다."));
        }
        
        // 2. 가격(itemPrice)의 범위가 1,000 ~ 1,000,000이 아닌 경우
        if(item.getPrice() == null || item.getPrice() < 1000 | item.getPrice() > 1_000_000){
            bindingResult.addError(new FieldError("item", "price", "가격은 1,000 ~ 1,000,000까지 허용합니다."));
        }

        // 3. 개수(quantity)가 최대 9,999개가 아닌 경우
        if(item.getQuantity() == null || item.getQuantity() > 10_000) {
            bindingResult.addError(new FieldError("item", "quantity", "수량은 최대 9,999까지 허용합니다."));
        }

        // 특정 필드 예외가 아닌 전체 예외
        // 4. 최종 값(가격(itemPrice) * 개수(quantity))이 10,000원 미만인 경우
        if(item.getPrice() != null && item.getQuantity() != null){
            int resultPrice = item.getPrice() * item.getQuantity();

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

        if(bindingResult.hasErrors()){
            return "item/addForm"; // 다시 상품 등록페이지로 이동
        }

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

 

3. 오류 발생 시 사용자 입력 값 유지 방법 🧰

  바인딩이 되는 시점에 오류가 발생하면 모델 객체에 사용자 입력 값을 유지하기 어렵다는 문제가 있다. 예를 들어 Integer 타입인 price에 문자가 들어온다면 값을 보관할 수 없기 때문이다.

  이런 경우 FieldError와 ObjectError의 생성자를 이용하여 해결할 수 있다. 기존에 사용한 생성자가 아닌 rejectedValue를 사용할 수 있는 생성자를 사용하여 rejectedValue에 값을 저장하면 된다. 아래는 FieldError와 ObjectError의 생성자를 나타낸 것이다.

// rejectedValue X
public FieldError(String objectName, 
                  String field, 
                  String defaultMessage)

// rejectedValue O
public FieldError(String objectName, 
                  String field, 
                  @Nullable Object rejectedValue, 
                  boolean bindingFailure, 
                  @Nullable String[] codes, 
                  @Nullable Object[] arguments, 
                  @Nullable String defaultMessage) 

// rejectedValue X
public ObjectError(String objectName, 
                   @Nullable String defaultMessage) 
    
// rejectedValue O
public ObjectError(String objectName, 
                   @Nullable String[] codes, 
                   @Nullable Object[] arguments, 
                   @Nullable String defaultMessage)

  각각의 파라미터는 다음과 같은 의미를 가진다.

• objectName
  오류가 발생한 객체 이름
• field
  오류 필드
• rejectedValue
  사용자가 입력한 값(거절된 값)
• bindingFailure
  타입 오류 같은 바인딩 실패인지, 검증 실패인지 구분 값
• codes
  메시지 코드
• arguments
  메시지에서 사용하는 인자
• defaultMessage
  기본 오류 메시지

  rejectedValue를 사용하는 생성자를 이용한다면 아래와 같이 코드를 작성할 수 있다.

@Slf4j
@Controller
@RequiredArgsConstructor
public class ValidationController {

    private final ItemRepository itemRepository;

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

        // 1. 아이템 이름(itemName)이 없는 경우
        if(!StringUtils.hasText(item.getItemName())){
            bindingResult.addError(
                    new FieldError("item",
                            "itemName",
                            item.getItemName(),
                            false,
                            null,
                            null,
                            "상품 이름은 필수입니다."));
        }

        // 2. 가격(itemPrice)의 범위가 1,000 ~ 1,000,000이 아닌 경우
        if(item.getPrice() == null || item.getPrice() < 1000 | item.getPrice() > 1_000_000){
            bindingResult.addError(new FieldError("item",
                    "price",
                    item.getPrice(),
                    false,
                    null,
                    null,
                    "가격은 1,000 ~ 1,000,000 까지 허용합니다."));
        }

        // 3. 개수(quantity)가 최대 9,999개가 아닌 경우
        if(item.getQuantity() == null || item.getQuantity() > 10_000) {
            bindingResult.addError(new FieldError("item",
                    "quantity",
                    item.getQuantity(),
                    false,
                    null,
                    null,
                    "수량은 최대 9,999 까지 허용합니다."));
        }

        // 특정 필드 예외가 아닌 전체 예외
        // 4. 최종 값(가격(itemPrice) * 개수(quantity))이 10,000원 미만인 경우
        if(item.getPrice() != null && item.getQuantity() != null){
            int resultPrice = item.getPrice() * item.getQuantity();

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

        if(bindingResult.hasErrors()){
            return "item/addForm"; // 다시 상품 등록페이지로 이동
        }

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

 

해당 글은 김영한 님의 '스프링 MVC 2탄 - 백엔드 웹 개발 활용 기술'을 참고하였습니다.