[Spring] Bean Validation - 어노테이션을 통해 검증 진행하기

김영한 님의 '스프링 MVC 2편 - 백엔드 웹 개발 활용 기술'을 보고 정리한 글입니다 😊

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의

---

- 지난 포스팅과 이어집니다 :D

[Spring] BindingResult를 활용해서 검증 로직 추가하기, MessageCodesResolver 알아보기

---

 

| Bean Validation

- 어노테이션을 통해 검증 로직을 설정해보자.

- 우선, build.gradle에 다음을 추가해주자.

 

[SItem.java] - 수정

@Getter
@NoArgsConstructor
@Setter
public class SItem {
    private Long id;

    @NotBlank
    private String itemName;

    @NotNull
    @Range(min=1000, max=1000000)
    private Integer price;

    @NotNull
    @Max(9999)
    private Integer quantity;
    
    ...

- @Range의 경우 하이버네이트 validation인데 실무에서 많이 사용하기 때문에 크게 신경쓰지 않고 사용해도 된다.

- 그외 나머지는 javax.validation이라 특정 구현에 관계없이 제공된다.

 

[SItemController.java] 

@Controller
@RequestMapping("/basic/items")
@RequiredArgsConstructor
public class SItemController {
    private final SItemService service;

    @GetMapping
    public String items(Model model) {
        List<SItem> items = service.findAllItem();
        model.addAttribute("items", items);
        model.addAttribute("userName", "Spring");
        return "basic/items";
    }

    @GetMapping("/{itemId}")
    public String item(@PathVariable Long itemId, Model model) {
        SItem item = service.findByItemId(itemId);
        model.addAttribute("item", item);
        return "basic/item";
    }

    @GetMapping("/add")
    public String addForm(Model model) {
        model.addAttribute("item", new SItem());
        return "basic/addForm";
    }

    @PostMapping("/add")
    public String addItem (@Validated @ModelAttribute("item") SItem item, BindingResult bindingResult,
                           RedirectAttributes redirectAttributes) {
        if (bindingResult.hasErrors()) {
            return "basic/addForm";
        }

        SItem savedItem = service.saveItem(item);
        redirectAttributes.addAttribute("itemId", savedItem.getId());
        redirectAttributes.addAttribute("status", true);
        return "redirect:/basic/items/{itemId}";
    }

    @GetMapping("/{itemId}/edit")
    public String editForm(@PathVariable Long itemId, Model model) {
        SItem item = service.findByItemId(itemId);
        model.addAttribute("item", item);
        return "basic/editForm";
    }

    @PostMapping("/{itemId}/edit")
    public String edit(@PathVariable Long itemId, SItem item, Model model) {
        service.updateItem(itemId, item);
        model.addAttribute("item", item);
        return "redirect:/basic/items/{itemId}";
    }


    @ModelAttribute("regions")
    public Map<String, String> regions() {
        Map<String, String> regions = new LinkedHashMap<>();
        regions.put("SEOUL", "서울");
        regions.put("BUSAN", "부산");
        regions.put("JEJU", "제주");
        return regions;
    }

    @ModelAttribute("itemTypes")
    public SItemType[] itemTypes() {
        return SItemType.values();
    }

    @ModelAttribute("deliveryCodes")
    public List<DeliveryCode> deliveryCodes() {
        return CreateDeliveryCode.getCodes();
    }

    @NoArgsConstructor
    static class CreateDeliveryCode {
        private static final List<DeliveryCode> deliveryCodes
                = Arrays.asList(new DeliveryCode("FAST", "빠른 배송"),
                new DeliveryCode("NORMAL", "일반 배송"),
                new DeliveryCode("SLOW", "느린 배송"));


        public static List<DeliveryCode> getCodes() {
            return deliveryCodes;
        }
    }

    // 테스트 데이터 추가 (의존관계 주입 이후 실행)
    @PostConstruct
    public void init() {
        service.saveItem(new SItem("itemA", 10000, 10));
        service.saveItem(new SItem("itemB", 20000, 20));
    }
}

- 지난 포스팅에서 작성하였던 WebBinder를 이용한 validation 추가 코드를 삭제하였다.

- 이렇게 해도 실제로는 잘 동작한다. 어떻게 이러는 것일까? (단, 아직은 우리가 지정한 메시지대로 동작하지는 않는다.)

 

- 기본적으로, 스프링 부트는 build.gradle에 있는 spring-boot-starter-validation 라이브러리를 확인하면 Bean Validator를 자동으로 인지한다.

- 스프링 부트는 ValidationAutoConfiguration 클래스를 통해서 LocalValidatorFactoryBean을 글로벌 Validator로 등록한다.

- 또한, 메서드 파라미터나 리턴 값 검증을 위해 MethodValidationPostProcessor 역시 자동으로 설정한다.

@AutoConfiguration
@ConditionalOnClass(ExecutableValidator.class)
@ConditionalOnResource(resources = "classpath:META-INF/services/javax.validation.spi.ValidationProvider")
@Import(PrimaryDefaultValidatorPostProcessor.class)
public class ValidationAutoConfiguration {

    @Bean
    @Role(BeanDefinition.ROLE_INFRASTRUCTURE)
    @ConditionalOnMissingBean(Validator.class)
    public static LocalValidatorFactoryBean defaultValidator(ApplicationContext applicationContext) {
        LocalValidatorFactoryBean factoryBean = new LocalValidatorFactoryBean();
        MessageInterpolatorFactory interpolatorFactory = new MessageInterpolatorFactory(applicationContext);
        factoryBean.setMessageInterpolator(interpolatorFactory.getObject());
        return factoryBean;
    }

    @Bean
    @ConditionalOnMissingBean(search = SearchStrategy.CURRENT)
    public static MethodValidationPostProcessor methodValidationPostProcessor(Environment environment,
                                                                              @Lazy Validator validator, ObjectProvider<MethodValidationExcludeFilter> excludeFilters) {
        FilteredMethodValidationPostProcessor processor = new FilteredMethodValidationPostProcessor(
                excludeFilters.orderedStream());
        boolean proxyTargetClass = environment.getProperty("spring.aop.proxy-target-class", Boolean.class, true);
        processor.setProxyTargetClass(proxyTargetClass);
        processor.setValidator(validator);
        return processor;
    }

}

- 실제 코드를 보면 다음과 같이 @Bean을 통해 2가지를 설정하는 것을 볼 수 있다.

 

🚩 컨트롤러 클래스에 @Validated를 붙이고 각 메서드의 @RequestParam에 @Min 같은 검증 어노테이션을 설정하면,

MethodValidationPostProcessor에 의해서 validation이 가능하도록 프록시 객체가 생성된다!

 

 

✔ 검증 순서

- 1차적으로 @ModelAttribute의 각각의 필드에 파라미터로 넘어온 값을 넣어 타입 변환을 시도한다.

- 실패 시 typeMismatch로 FieldError를 추가하고, 성공하면 다음 로직으로 넘어간다.

- ⭐ 이때, 바인딩에 성공한 필드만 Bean Validation을 적용한다.

- @Validated, @Valid가 있다면 글로벌 검증기를 활용해서 Validator를 찾고 검증을 실행한다. (Bean Validation)

 

- 그렇다면, 우리가 설정한 메시지로 오류 메시지가 나오도록 해보자.

- 기본적으로, 메시지 코드의 경우 애노테이션 이름 + 규칙을 통해 설정된다.

@Range

- Range.item.price

- Range.price

- Range.java.lang.Integer

- Range

 

- 그렇기 때문에, 우리가 따로 이와 관련해서 프로퍼티를 작성해주면 된다.

[errors.properties]

NotBlank=Please enter the {0} as required.
Range={0} range from KRW {1} to KRW {2}.
Max=Up to {1}, {0} are allowed.

[errors_ja.properties]

NotBlank=必要に応じて{0}を入力してください。
Range={0}の範囲は{1}ウォンから{2}ウォンです。
Max=最大{1}、{0}が許可されます。

- 이렇게 되면, 만들어진 메시지 코드에 대해 순서대로 messageSource에서 찾는다.

- 만약 없으면 어노테이션의 message 속성 값을 이용하게 된다. (@Range(message=""))

- 그래도 없으면 그냥 라이브러리가 제공하는 기본 값이 나온다.

- 다음과 같이 잘 동작하는 걸 확인할 수 있다.

 

- 그럼, 특정 필드에 대한 오류가 아닌 오브젝트 오류(ObjectError)의 경우 어떻게 처리할 수 있을까?

@ScriptAssert라는 어노테이션을 사용할 수 있지만, 상당히 복잡하기 때문에 웬만하면 이 부분은 자바 코드로 작성하는 것이 낫다.

 

[SItemController.java] - 수정

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

    if (item.getPrice() != null && item.getQuantity() != null) {
        int resultPrice = item.getPrice() * item.getQuantity();
        if (resultPrice < 10000) {
            bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
        }
    }
    ...

---

| Bean Validation - 전부 적용하기

- 지금까지는 등록 폼에만 적용했지만, 이번에는 수정 폼에도 적용해주자!

[SItemController.java]

@PostMapping("/{itemId}/edit")
public String edit(@PathVariable Long itemId,
                   @Validated @ModelAttribute("item") SItem item,
                   BindingResult bindingResult) {

    if (item.getPrice() != null && item.getQuantity() != null) {
        int resultPrice = item.getPrice() * item.getQuantity();
        if (resultPrice < 10000) {
            bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
        }
    }

    if (bindingResult.hasErrors()) {
        return "basic/editForm";
    }

    service.updateItem(itemId, item);
    return "redirect:/basic/items/{itemId}";
}

 

[editForm.html]

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <link href="../css/bootstrap.min.css"
          th:href="@{/css/bootstrap.min.css}"
          rel="stylesheet">
    <title>Item Edit Form</title>
    <style>
        .field-error{
            border-color:#dc3545;
            color:#dc3545;
        }
    </style>
</head>
<body>
<div class="container">
    <div class="py-5 text-center">
        <h2 class="font-monospace fw-bold"
            th:text="#{page.updateItem}">Item Edit Form</h2>
    </div>

    <form action="item.html" th:action th:object="${item}" method="post">
        <div th:if="${#fields.hasGlobalErrors()}">
            <p class="field-error text-center fw-bold"
               th:each="err: ${#fields.globalErrors()}"
               th:text="${err}">
                전체 오류 메시지</p>
        </div>

        <div class="row fw-bold font-monospace">
            <div class="col text-center">
                <label for="id"
                       th:text="#{label.item.id}">Id</label>
                <input type="text"
                       th:field="*{id}"
                       class="form-control text-center"
                       readonly>
            </div>
            <div class="col text-center">
                <label for="itemName"
                       th:text="#{label.item.itemName}">Name</label>
                <input type="text"
                       th:field="*{itemName}"
                       th:errorclass="field-error"
                       class="form-control text-center"
                       placeholder="Please Enter an Item Name."
                >
                <div class="field-error"
                     th:errors="*{itemName}">
                    상품명 오류
                </div>
            </div>
        </div>

        <div class="row mt-2 fw-bold font-monospace">
            <div class="col text-center">
                <label for="price"
                       th:text="#{label.item.price}">Price</label>
                <input type="text"
                       th:field="*{price}"
                       th:errorclass="field-error"
                       class="form-control text-center"
                       placeholder="Please Enter an Item Price."
                >
                <div class="field-error"
                     th:errors="*{price}">
                    가격 오류
                </div>
            </div>
            <div class="col text-center">
                <label for="quantity"
                       th:text="#{label.item.quantity}">Quantity</label>
                <input type="text"
                       th:field="*{quantity}"
                       th:errorclass ="field-error"
                       class="form-control text-center"
                       placeholder="Please Enter an Item Quantity."
                >
                <div class="field-error"
                     th:errors="*{quantity}">
                    수량 오류
                </div>
            </div>
        </div>
        ...
    </form>
</div>
</body>
</html>

 

---

| Bean Validation - 한계점

- 데이터를 등록할 때와 수정할 때의 요구사항이 다르다면 어떻게 처리해야 할까?

- 수정할 때는 수량을 무제한으로 체크할 수 있도록 변경해보자.

- 또한, 수정 시에는 id 값이 필수로 들어간다.

 

이를 위해 Bean Validation의 groups 기능을 사용할 수 있다.

등록용 인터페이스와 수정용 인터페이스를 따로 생성하여 검증 어노테이션의 그룹 옵션을 사용하는 것이다.

ex)

도메인 필드 - @NotNull(groups=UpdateChecking.class)

컨트롤러 - @Validated(UpdateChecking.class)

cf) 이때, @Valid는 groups 기능이 없고 @Validated만 사용 가능하다!

 

그러나, 이 방법보다는 데이터 전달을 위한 별도의 객체를 사용하는 방법을 많이 사용한다.

왜냐면, 보통은 도메인 객체를 그대로 사용하면 생성/수정 시 검증도 groups를 사용해야 하고, 간단한 경우만 가능하게 된다.

보통, DTO를 통해서 이러한 정보를 많이 관리하며, 이름은 각 역할을 나타낼 수 있도록 '의미있게' 사용하면 된다.

 

- 우리의 코드를 수정해보자. 우선, 기존의 SItem에서 적용하였던 검증 어노테이션들은 다 삭제한다.

[SItem.java]

@Getter
@NoArgsConstructor
@Setter
public class SItem {
    private Long id;
    private String itemName;
    private Integer price;
    private Integer quantity;

    private Boolean open;
    private List<String> regions;
    private SItemType itemType;
    private String deliveryCode;

    public SItem(String itemName, Integer price, Integer quantity, Boolean open, List<String> regions, SItemType itemType, String deliveryCode) {
        this.itemName = itemName;
        this.price = price;
        this.quantity = quantity;
        this.open = open;
        this.regions = regions;
        this.itemType = itemType;
        this.deliveryCode = deliveryCode;
    }

    public void changeId(Long id) {
        this.id = id;
    }

    public void changeItemInfo(String itemName, Integer price, Integer quantity,
                               Boolean open, List<String> regions, SItemType itemType,
                               String deliveryCode) {
        this.itemName = itemName;
        this.price = price;
        this.quantity = quantity;
        this.open = open;
        this.regions = regions;
        this.itemType = itemType;
        this.deliveryCode = deliveryCode;
    }

}

- 등록, 수정용도 DTO 객체를 새롭게 만든다.

- Setter를 삭제하였으며, 생성자 파라미터를 수정하였다.

 

[SItemSaveRequest.java]

@Data
@AllArgsConstructor
public class SItemSaveRequest {
    @NotBlank
    private String itemName;

    @NotNull
    @Range(min = 1000, max = 1000000)
    private Integer price;

    @NotNull
    @Max(value = 9999)
    private Integer quantity;

    @NotNull
    private Boolean open;
    @NotNull
    private List<String> regions;
    @NotNull
    private SItemType itemType;
    @NotNull
    private String deliveryCode;

}

[SItemUpdateRequest.java]

@Data
public class SItemUpdateRequest {
    @NotNull
    private Long id;

    @NotBlank
    private String itemName;

    @NotNull
    @Range(min = 1000, max = 1000000)
    private Integer price;

    private Integer quantity;

    @NotNull
    private Boolean open;
    @NotNull
    private List<String> regions;
    @NotNull
    private SItemType itemType;
    @NotNull
    private String deliveryCode;
}

[SItemRepository.java] - 일부 수정

public void update(Long itemId, String itemName, Integer price, Integer quantity,
                   Boolean open, String deliveryCode, List<String> regions, SItemType itemType) {
    SItem findItem = store.get(itemId);
    findItem.changeItemInfo(itemName, price, quantity, open, regions, itemType, deliveryCode);
}

- Dto가 레파지토리 단계까지 내려가는 건 별로 좋지 않기 때문에 이런 식으로 바꿔주었다.

 

[SItemService.java] - 일부 수정

public SItem saveItem(SItemSaveRequest itemDto) {
    SItem item = new SItem(itemDto.getItemName(), itemDto.getPrice(), itemDto.getPrice(), itemDto.getOpen(),
            itemDto.getRegions(), itemDto.getItemType(), itemDto.getDeliveryCode());
    return repository.save(item);
}

public void updateItem(Long itemId, SItemUpdateRequest item) {
    repository.update(itemId, item.getItemName(), item.getPrice(), item.getQuantity(),
            item.getOpen(), item.getDeliveryCode(), item.getRegions(), item.getItemType());
}

 

[SItemController.java]

@Controller
@RequestMapping("/basic/items")
@RequiredArgsConstructor
public class SItemController {
    private final SItemService service;

    ...

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

        if (item.getPrice() != null && item.getQuantity() != null) {
            int resultPrice = item.getPrice() * item.getQuantity();
            if (resultPrice < 10000) {
                bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
            }
        }

        if (bindingResult.hasErrors()) {
            return "basic/addForm";
        }

        SItem savedItem = service.saveItem(item);
        redirectAttributes.addAttribute("itemId", savedItem.getId());
        redirectAttributes.addAttribute("status", true);
        return "redirect:/basic/items/{itemId}";
    }

    ...

    @PostMapping("/{itemId}/edit")
    public String edit(@PathVariable Long itemId,
                       @Validated @ModelAttribute("item") SItemUpdateRequest item,
                       BindingResult bindingResult) {

        if (item.getPrice() != null && item.getQuantity() != null) {
            int resultPrice = item.getPrice() * item.getQuantity();
            if (resultPrice < 10000) {
                bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
            }
        }

        if (bindingResult.hasErrors()) {
            return "basic/editForm";
        }

        service.updateItem(itemId, item);
        return "redirect:/basic/items/{itemId}";
    }

    ...
    // 테스트 데이터 추가 (의존관계 주입 이후 실행)
    @PostConstruct
    public void init() {
        service.saveItem(new SItemSaveRequest("itemA", 10000, 10, true, null, SItemType.BOOK, null));
        service.saveItem(new SItemSaveRequest("itemB", 20000, 20, false, null, SItemType.FOOD, null));
    }
}

- 등록에 대해서는 ItemSaveRequest를, 수정에 대해서는 ItemUpdateRequest를 사용해주었다.

- 모두 매우 잘 동작하는 것을 확인할 수 있다!

 

---

| Bean Validation - HTTP Message Converter

- @Valid, @Validated는 @RequestBody에도 적용이 가능하다.

cf) @RequestBody는 HTTP  Body의 데이터를 객체로 변환할 때 사용.

- 이 경우, 타입 오류 발생 시 애초부터 'SItemSaveRequest 객체로 변환'하는 것 자체가 실패하기 때문에, 컨트롤러 자체가 호출되지 않는다.

- 검증 오류라면 (수량이 9999개 이상 같은 오류) 컨트롤러가 실행되며 검증 오류 자체가 잘 실행된다.

 

 

✔ @ModelAttribute vs @RequestBody

- HttpMessageConverter의 경우 전체 객체 단위로 적용되기 때문에, 객체 생성이 되어야 @Valid, @Validated가 적용된다.

- @ModelAttribute는 각각의 필드 단위로 바인딩이 적용된다. 그래서 특정 필드가 바인딩 안 되어도 다른 필드는 잘 바인딩된다.

 

🚩 여러 가지 차이점

@ModelAttribute : Http 파라미터, Http Body 내용을 Setter를 통해 1:1로 객체에 바인딩 

- 바인딩 시 검증 작업 진행 

- Http Body는 multipart/form-data 형태이다.

 

@RequestBody : Http Body에 application/json 형태로 데이터를 전송하면 해당 내용을 객체로 변환해주는 역할 수행

- 객체 변환은 MappingJackson2HttpMessageConverter 이용

- Body 내용을 사용하기 때문에 객체에 @Setter 없어도 무관, POST에서만 사용 가능 (GET은 header 값 사용)

 

@RequestParam : HTTP 요청 파라미터를 @RequestParam이 쓰인 변수로 mapping

 

- 다음 포스팅부터는 로그인 처리 방법에 대해서 알아보자!