[Spring] 검증(Validation) - Validator

1. Validator 🍩

  이전까지 검증 기능들은 컨트롤러 안에 있었다. 당연히 이런 경우에는 별도의 클래스를 만들어서 역할을 분리하는 것이 좋다. 

  기존 코드를 먼저 살펴보고, ItemValidator라는 클래스를 만들어서 어떻게 별도의 클래스로 검증 기능을 분리하였는지 알아보자.

// 기존 코드
@Slf4j
@Controller
@RequiredArgsConstructor
public class ValidationController3 {

    private final ItemRepository itemRepository;

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

        // 1. 아이템 이름(itemName)이 없는 경우
        ValidationUtils.rejectIfEmptyOrWhitespace(bindingResult, "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}";
    }
}

// 검증기능 분리
@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;

        // 1. 아이템 이름(itemName)이 없는 경우
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "itemName", "required");

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

        // 3. 개수(quantity)가 최대 9,999개가 아닌 경우
        if(item.getQuantity() == null || item.getQuantity() > 10_000) {
            errors.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) {
                errors.reject("totalPriceMin", new Object[]{10_000, resultPrice}, null);
            }
        }
    }
}

  스프링은 Validator라는 인터페이스를 제공한다. 파라미터와 메서드의 설명은 주석을 통해서 확인하자.

public interface Validator {
    // 객체 타입이 어떤 검증기를 사용해야하는지 알려준다.
    boolean supports(Class<?> clazz);
    
    // target = 검증 대상 객체, errors = BindingResult
    void validate(Object target, Errors errors);
}

Validator는 하나의 클래스에 적용할 수도 있고 글로벌 설정으로 적용할 수도 있다. 두 가지 설정 방법들을 각각 알아보자.

 

2. Validator 적용 방법 - 하나의 컨트롤러에 적용 🍪

  WebDataBinder를 사용하면 스프링의 파라미터 바인딩의 역할을 해주고 검증 기능도 내부에 포함한다.

  사용방법은 @InitBinder를 이용한 코드를 해당 컨트롤러에 추가하고, 검증을 할 객체 앞에 @Validated를 적어주면 된다.

@Slf4j
@Controller
@RequiredArgsConstructor
public class ValidationController4 {

    private final ItemRepository itemRepository;
    private final ItemValidator itemValidator;

    @InitBinder
    public void init(WebDataBinder dataBinder) {
        dataBinder.addValidators(itemValidator);
    }

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

        // 기존에 검증 기능이 있던 코드들이 없어졌다. (ItemValidator로 이동)

        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. Validator 적용 방법 - 글로벌 설정 🍰

  아래와 같이 설정하면 글로벌 설정이 된다. 컨트롤러에 있는 @InitBinder을 부분은 삭제해도 글로벌 설정으로 인해서 코드가 동작한다.

@SpringBootApplication
public class DemoApplication implements WebMvcConfigurer {

	public static void main(String[] args) {
		SpringApplication.run(DemoApplication.class, args);
	}

	@Override
	public Validator getValidator() {
		return new ItemValidator();
	}
}

하지만, 이렇게 하면 BeanValidator가 자동 등록되지 않는다는 것을 염두에 두자.

 

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