[Spring] 검증(Validation) - bindingResult.rejectValue(), binding.reject()

  이번 글을 통해 이전 글에서 BindingResult, FieldError, ObjectError를 통해 만들어보았던 검증 기능을 조금 더 쉽게 만들어보고자 한다.

 

1. rejectValue() & reject() 🍣

  FieldError와 ObjectError는 너무 복잡하다. BindingResult의 rejectValue와 reject를 사용하면 조금 더 간결하게 검증을 진행할 수 있다.

  이전 글에서 BindingResult는 항상 검증해야 할 객체 바로 뒤에 이어서 작성해야 한다고 말한 적이 있다. 이는 BindingResult가 검증해야 할 객체를 이미 알고 있는 것이다. 이 정보를 바탕으로 아래 내용들을 계속해서 살펴보자.

  rejectValue와 reject의 생성자는 다음과 같다.

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

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

  rejectValue()와 reject()가 내부에서 MessageCodesResolver를 사용하여 적절한 오류 메시지를 정하게 된다. 

 

2. messageCodesResolver 🍜

  messageCodesResolver는 'errorCode, 객체 이름, 필드 이름, 필드 타입'을 이용해서 적절한 오류메시지를 정한다. 오류 메시지를 찾을 수 없을 경우에는 위에서 말한 것처럼 defaultMessage를 사용한다.

  MessageCodesResolve는 인터페이스이고, DefaultMessageCodesResolver는 기본 구현체이다. DefaultMessageCodesResolver의 기본 메시지 생성 규칙은 아래와 같다. 객체 오류로 나누어져 있고 번호가 낮을수록 우선순위가 높다.

📒 1. 객체 오류

1. errorCode + "." + object name
2. code

  errorCode가 required, object name이 item이면 아래와 같은 우선순위를 가진다.

1. required.item
2. required

📒 2. 필드 오류

1. errorCode + "." + object name + "." + field
2. errorCode + "." + field
3. errorCode + "." + field type
4. errorCode

  errorCode가 typeMismatch, object name이 user, field가 age, field type이 int라면 아래와 같은 우선순위를 가진다.

1. typeMismatch.user.age
2. typeMismatch.age
3. typeMismatch.int
4. typeMismatch

  MessageCodesResolver를 사용하는 이유는 다음과 같다고 할 수 있다.

  오류 코드는 자세히 만들 수도 있고 간단하게 만들 수도 있다. 단순하게 만들면 범용성이 좋아서 여러 곳에서 사용할 수 있지만, 메시지를 세밀하게 작성하기 어렵다는 문제가 있다. 반면에 너무 자세하게 만들면 범용성이 떨어진다.

  그렇기 때문에 세밀한 경우가 필요하다면 자세한 메시지를 가져오고 범용성이 중요하다면 단순한 메시지를 가져와야 한다.

 

3. 구현 🍤

  rejectValue와 reject를 사용하면 이전에 FieldError와 ObjectError로 나타냈던 것을 다음과 같이 변경할 수 있다.

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

// 변경
bindingResult.rejectValue("itemName", "required");

----------

// 기존
bindingResult.addError(new FieldError("item",
        "price",
        item.getPrice(),
        false,
        null,
        null,
        "가격은 1,000 ~ 1,000,000 까지 허용합니다."));

// 변경
bindingResult.rejectValue("price", "range", new Object[]{1_000, 1_000_000}, null);

----------

// 기존
bindingResult.addError(new FieldError("item",
        "quantity",
        item.getQuantity(),
        false,
        null,
        null,
        "수량은 최대 9,999 까지 허용합니다."));

// 변경
bindingResult.rejectValue("quantity", "max", new Object[]{9_999}, null);

----------

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

// 변경
bindingResult.reject("totalPriceMin", new Object[]{10_000, resultPrice}, null);

// application.properties
spring.messages.basename=messages, errors

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

  전체 코드는 다음과 같다.

@Slf4j
@Controller
@RequiredArgsConstructor
public class ValidationController2 {

    private final ItemRepository itemRepository;

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

        // 1. 아이템 이름(itemName)이 없는 경우
        if(!StringUtils.hasText(item.getItemName())){
            bindingResult.rejectValue("itemName", "required");
        }

        // 2. 가격(itemPrice)의 범위가 1,000 ~ 1,000,000이 아닌 경우
        if(item.getPrice() == null || item.getPrice() < 1000 | item.getPrice() > 1_000_000){
            bindingResult.rejectValue("price", "range", new Object[]{1_000, 1_000_000}, null);
        }

        // 3. 개수(quantity)가 최대 9,999개가 아닌 경우
        if(item.getQuantity() == null || item.getQuantity() > 10_000) {
            bindingResult.rejectValue("quantity", "max", new Object[]{9_999}, null);
        }

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

            if(resultPrice < 10_000) {
                bindingResult.reject("totalPriceMin", new Object[]{10_000, resultPrice}, null);
            }
        }

        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탄 - 백엔드 웹 개발 활용 기술'을 참고하였습니다.