스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - (19) 검증 Validation - FieldError, ObjectError

 인프런 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술편을 학습하고 정리한 내용 입니다.

FieldError, ObjectError

지난번 내용에

이런 내용이 있었다.

목표

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

ValidationItemControllerV2 - addItemV2

@PostMapping("/add")  
public String addItemV2(@ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes, Model model) {  
  
    // 검증 로직  
    if (!StringUtils.hasText(item.getItemName())) {  
        bindingResult.addError(new FieldError("item", "itemName", item.getItemName(), false, null, null, "상품 이름은 필수 입니다."));  
    }  
    if (item.getPrice()==null || item.getPrice() < 1000 || item.getPrice() > 1000000) {  
        bindingResult.addError(new FieldError("item", "price", item.getPrice(), false, null, null, "가격은 1,000 ~ 1,000,000 까지 허용됩니다."));  
    }  
    if (item.getQuantity()==null || item.getQuantity() >= 9999) {  
        bindingResult.addError(new FieldError("item", "quantity", item.getQuantity(), false, null, null, "수량은 최대 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 (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}";  
}

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

// 신규 addItemV2
bindingResult.addError(new FieldError("item", "itemName", item.getItemName(), false, null, null, "상품 이름은 필수 입니다."));

이렇게 FieldError에 생성자가 2개인데 아래 생성자를 사용하면 더 많은 정보를 넣을 수 있다.

다 아래 생성자로 바꾸면 이렇게 잘 유지가 된다.

이제 FieldError를 좀 더 알아보자.

FieldError 생성자

FieldError는 두 가지 생성자를 제공한다.

public FieldError(String objectName, String field, String defaultMessage) {  
    this(objectName, field, (Object)null, false, (String[])null, (Object[])null, defaultMessage);  
}  
  
public FieldError(String objectName, String field, @Nullable Object rejectedValue, boolean bindingFailure, @Nullable String[] codes, @Nullable Object[] arguments, @Nullable String defaultMessage) {  
    super(objectName, codes, arguments, defaultMessage);  
    Assert.notNull(field, "Field must not be null");  
    this.field = field;  
    this.rejectedValue = rejectedValue;  
    this.bindingFailure = bindingFailure;  
}

파라미터 목록

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

ObjectError 도 유사하게 두 가지 생성자를 제공한다.

오류 발생 시 사용자 입력 값 유지

new FieldError("item", "price", item.getPrice(), false, null, null, "가격은 1,000 ~ 1,000,000 까지 허용됩니다.")

사용자의 입력 데이터가 컨트롤러의 @ModelAttribute에 바인딩 되는 시점에 오류가 발생하면 모델 객체에 사용자 입력 값을 유지하기 쉽지 않다.

가격에 숫자가 아닌 문자가 들어오면 컨트롤러단을 타기도 전에 오류가 발생하기 때문에 사용자 입력 값을 유지할 수가 없다.

그래서 오류가 발생한 오류가 발생한 경우 사용자 입력 값을 보관하는 다른 방법이 필요하다.

FieldError는 오류 발생 시 사용자 입력 값을 저장하는 기능을 제공한다.

여기서 rejectedValue가 바로 오류가 발생 시 사용자 입력 값을 저장하는 필드다.

bindingFailure는 타입 오류 같은 바인딩이 실패했는지 여부를 적어주면 된다.

여기서는 타입 오류가 아니라 1000 < 입력 값 > 100000 이 조건이 만족하지 못한 것 이기 때문에 false를 사용.

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

th:field=*{price}

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

스프링의 바인딩 오류 처리

타입 오류로 바인딩에 실패하면 스프링은 FieldError를 생성하면서 사용자가 입력한 값을 넣어둔다.

그리고 해당 오류를 BindingResult에 담아서 컨트롤러를 호출한다.

따라서 타입 오류 같은 바인딩 실패 시에도 사용자의 오류 메시지를 정상 출력할 수 있다.