Validation 분리

컨트롤러에서 검증하는 로직이 너무 많이 차지하고 실제 동작 로직은 비중이 작다. 따라서 검증하는 클래스를 따로 분리해서 만드는 것이 효율적이다.

 

 

 

 

ItemValidator 클래스

import org.springframework.stereotype.Component;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
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;
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "itemName", "required");
        if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
            errors.rejectValue("price", "range", new Object[]{1000, 1000000}, null);
        }
        if (item.getQuantity() == null || item.getQuantity() > 10000) {
            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);
            }
        }
    }
}

검증 로직들을 따로 빼서 하나의 클래스를 만들었다. 스프링에서 지원하는 supports 메서드를 사용했고, 이 클래스에서는 bindingResult말고 errors를 사용했다.

 

 

 

첫 번째 방법

private final ItemValidator itemValidator; // 코드 맨 위에 추가(스프링 빈 연결)

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

    itemValidator.validate(item, bindingResult);

    // 검증에 실패하면 다시 입력 폼으로 이동하는 로직
    if (bindingResult.hasErrors()) {
        log.info("errors = {}", bindingResult);
        // model.addAttribute("errors", 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.validate(Item, bindingReuslt);라는 한 줄로 인해서 많던 코드들이 압축되었다. 컨트롤러에서 너무 많은 기능을 구현하는 것은 효율적이지 않으므로 필요한 부분만 남기고 조건 코드는 클래스를 별도로 만들어서 최소한으로 줄여주었다.

 

 

 

 

두 번째 방법

@InitBinder
    public void init(WebDataBinder dataBinder) {
        dataBinder.addValidators(itemValidator);
    }
// 클래스 맨 위에 추가


@PostMapping("/add")
public String addItemV6(@Validated @ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes) {
    // @Validated가 검증을 알아서 해주고 bindingResult에 결과를 담아준다.

    // 검증에 실패하면 다시 입력 폼으로 이동하는 로직
    if (bindingResult.hasErrors()) {
        log.info("errors = {}", bindingResult);
        // model.addAttribute("errors", 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}";
}

두 번째 방법은 @Validated 애노테이션을 추가해주는 방법이다.

@InitBinder를 통해 itemValidator를 넣어주고 @Validated라는 애노테이션을 파라미터에 넣어주면 검증기가 자동으로 검증을 해주고 그 결과를 bindingResult에 담아주어서 코드를 효율적으로 필요한 부분만 남기고 줄일 수 있게 된다.