[SPRING] Bean Validation

11 분 소요

소개

검증 기능을 지금처럼 매번 코드로 작성하는 것은 상당히 번거롭다.
특히 특정 필드에 대한 검증 로직은 대부분 빈 값인지 아닌지, 특정 크기를 넘는지 아닌지와 같이 매우 일반적인 로직이다.

이런 검증 로직을 모든 프로젝트에 적용할 수 있게 공통화하고, 표준화 한 것이 바로 Bean Validation 이다.
Bean Validation을 잘 활용하면, 애노테이션 하나로 검증 로직을 매우 편리하게 적용할 수 있다.

Bean Validation 이란?
먼저 Bean Validation은 검증 애노테이션과 여러 인터페이스의 모음이다.
Bean Validation을 구현한 기술중에 일반적으로 사용하는 구현체는 하이버네이트 Validator이다. (이름이 하이버네이트가 붙어서 그렇지 ORM과는 관련이 없다.)

하이버네이트 Validator 관련 링크

공식 사이트: http://hibernate.org/validator/

공식 메뉴얼: https://docs.jboss.org/hibernate/validator/6.2/reference/en-US/html_single/

🌟 검증 애노테이션 모음: https://docs.jboss.org/hibernate/validator/6.2/reference/en-US/html_single/#validator-defineconstraints-spec
(@Email, @CreditCardNumber 등등 웬만한 애노테이션은 모두 존재! - 읽어보기)

준비

Bean Validation 의존관계 추가

Bean Validation을 사용하려면 build.gradle에서 다음 의존관계를 추가해야 한다.

implementation 'org.springframework.boot:spring-boot-starter-validation'

spring-boot-starter-validation 의존관계를 추가하면 라이브러리가 추가 된다.

Item - Bean Validation 애노테이션 적용

src/main/java/hello/itemservice/domain/item/Item

import org.hibernate.validator.constraints.Range;

import javax.validation.constraints.Max;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

@Data
public class Item {

    private Long id;

    @NotBlank(message = "공백X")
    private String itemName;

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

    @NotNull
    @Max(9999)
    private Integer quantity;

    public Item() {
    }

    public Item(String itemName, Integer price, Integer quantity) {
        this.itemName = itemName;
        this.price = price;
        this.quantity = quantity;
    }
}

검증 애노테이션

@NotBlank : 빈값 + 공백만 있는 경우를 허용하지 않는다.
@NotNull : null 을 허용하지 않는다.
@Range(min = 1000, max = 1000000) : 범위 안의 값이어야 한다.
@Max(9999) : 최대 9999까지만 허용한다.

🥜 Bean Validation - 스프링 적용

컨트롤러 - `ValidationItemControllerV3`

`addItem()`

@Slf4j
@Controller
@RequestMapping("/validation/v3/items")
@RequiredArgsConstructor
public class ValidationItemControllerV3 {
    ...
    @PostMapping("/add")
    public String addItem(@Validated @ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes, Model model) {

        // 검증에 실패하면 다시 입력 폼으로
        if (bindingResult.hasErrors()){
            log.info("errors={}", bindingResult);
            return "validation/v3/addForm";
        }

        // 성공 로직
        Item savedItem = itemRepository.save(item);
        redirectAttributes.addAttribute("itemId", savedItem.getId());
        redirectAttributes.addAttribute("status", true);
        return "redirect:/validation/v3/items/{itemId}";
    }
...
}

실행해보면 애노테이션 기반의 Bean Validation이 정상 동작하는 것을 확인할 수 있다.

참고
특정 필드의 범위를 넘어서는 검증(가격 * 수량의 합은 10,000원 이상) 기능이 빠졌는데, 이 부분은 조금 뒤에 설명한다.

스프링 MVC는 어떻게 Bean Validator를 사용?

스프링 부트가 spring-boot-starter-validation 라이브러리를 넣으면 자동으로 Bean Validator를 인지하고 스프링에 통합한다.

스프링 부트는 자동으로 글로벌 Validator로 등록한다.

LocalValidatorFactoryBean 을 글로벌 Validator로 등록한다.
이 Validator는 @NotNull 같은 애노테이션을 보고 검증을 수행한다. 이렇게 글로벌 Validator가 적용되어 있기 때문에, @Valid , @Validated 만 적용하면 된다.
검증 오류가 발생하면, FieldError , ObjectError 를 생성해서 BindingResult 에 담아준다.

검증 순서

@ModelAttribute 각각의 필드에 타입 변환 시도
1-1. 성공하면 다음으로
1-2. 실패하면 typeMismatch 로 FieldError 추가
Validator 적용

바인딩에 성공한 필드만 Bean Validation 적용

BeanValidator는 바인딩에 실패한 필드는 BeanValidation을 적용하지 않는다.
생각해보면 타입 변환에 성공해서 바인딩에 성공한 필드여야 BeanValidation 적용이 의미 있다.
(일단 모델 객체에 바인딩 받는 값이 정상으로 들어와야 검증도 의미가 있다.)

@ModelAttribute 각각의 필드 타입 변환시도 -> 변환에 성공한 필드만 BeanValidation 적용

예)

itemName 에 문자 “A” 입력 타입 변환 성공 itemName 필드에 BeanValidation 적용
price 에 문자 “A” 입력 -> “A”를 숫자 타입 변환 시도 실패 -> typeMismatch FieldError 추가 -> price 필드는 BeanValidation 적용 X

🥜 Bean Validation - 에러 코드

Bean Validation이 기본으로 제공하는 오류 메시지를 좀 더 자세히 변경하고 싶으면 어떻게 하면 될까?

@NotBlank

NotBlank.item.itemName
NotBlank.itemName
NotBlank.java.lang.String
NotBlank

@Range

Range.item.price
Range.price
Range.java.lang.Integer
Range

`errors.properties` - 메시지 등록

이제 메시지를 등록해보자.

#Bean Validation 추가

NotBlank.item.itemName=상품 이름을 적어주세요.

NotBlank={0} 공백X
Range={0}, {2} ~ {1} 허용
Max={0}, 최대 {1}

NotBlank.item.itemName처럼 세세하게 적으면 우선순위(Level)가 높아진다.
{0} 은 필드명이고, {1} , {2} …은 각 애노테이션 마다 다르다.

BeanValidation 메시지 찾는 순서

생성된 메시지 코드 순서대로 messageSource 에서 메시지 찾기
애노테이션의 message 속성 사용 -> @NotBlank(message = "공백! {0}")
라이브러리가 제공하는 기본 값 사용 -> 공백일 수 없습니다.

🥜 Bean Validation - 오브젝트 오류

Bean Validation에서 특정 필드( FieldError )가 아닌 해당 오브젝트 관련 오류( ObjectError )는 어떻게 처리할 수 있을까?
두 가지 방법이 존재한다.

1) `@ScriptAssert`

src/main/java/hello/itemservice/domain/item/Item

@Data
@ScriptAssert(lang = "javascript", script = "_this.price * _this.quantity >= 10000", message = "총 금액이 10000원이 넘도록 주문해주세요.") // 🌟 추가
public class Item {

    private Long id;

    @NotBlank(message = "공백X")
    private String itemName;

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

    @NotNull
    @Max(9999)
    private Integer quantity;

    public Item() {
    }

    public Item(String itemName, Integer price, Integer quantity) {
        this.itemName = itemName;
        this.price = price;
        this.quantity = quantity;
    }
}

그런데 실제 사용해보면 제약이 많고 복잡하다. 그리고 실무에서는 검증 기능이 해당 객체의 범위를 넘어서는 경우들도 종종 등장하는데, 그런 경우 대응이 어렵다.
따라서 오브젝트 오류(글로벌 오류)의 경우 @ScriptAssert 을 억지로 사용하는 것 보다는 아래과 같이 오브젝트 오류 관련 부분만 직접 자바 코드로 작성하는 것을 권장한다.

2) 자바 코드로 직접 작성

컨트롤러 - `ValidationItemControllerV3`

`addItem()` - 오브젝트 오류 추가

@Slf4j
@Controller
@RequestMapping("/validation/v3/items")
@RequiredArgsConstructor
public class ValidationItemControllerV3 {
    ...
    @PostMapping("/add")
    public String addItem(@Validated @ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes, Model model) {
         
        // 오브젝트 오류 (글로벌 오류) 검증 🌟
        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()){
            log.info("errors={}", bindingResult);
            return "validation/v3/addForm";
        }

        // 성공 로직
        Item savedItem = itemRepository.save(item);
        redirectAttributes.addAttribute("itemId", savedItem.getId());
        redirectAttributes.addAttribute("status", true);
        return "redirect:/validation/v3/items/{itemId}";
    }
...
}

🥜 Bean Validation - 한계

데이터를 등록할 때와 수정할 때는 요구사항이 다를 수 있다.

등록시 기존 요구사항

타입 검증
• 가격, 수량에 문자가 들어가면 검증 오류 처리
필드 검증
• 상품명: 필수, 공백X
• 가격: 1000원 이상, 1백만원 이하
• 수량: 최대 9999
특정 필드의 범위를 넘어서는 검증
• 가격 * 수량의 합은 10,000원 이상

수정시 요구사항

등록시에는 quantity 수량을 최대 9999까지 등록할 수 있지만 수정시에는 수량을 무제한으로 변경할 수 있다.
등록시에는 id 에 값이 없어도 되지만, 수정시에는 id 값이 필수이다.

item에 수정 요구사항을 적용하면, 수정은 잘 동작하지만 등록에서 문제가 발생한다.
등록시에는 id 에 값이 없다. 따라서 @NotNull id 를 적용한 것 때문에 검증에 실패하고 다시 폼 화면으로 넘어온다.
또한 quantity 수량 제한 최대 값인 9999도 적용되지 않는 문제가 발생한다.
결국 등록 자체도 불가능하고, 수량 제한도 걸지 못한다.

결과적으로 item 은 등록과 수정에서 검증 조건의 충돌이 발생하고, 등록과 수정은 같은 BeanValidation 을 적용할 수 없다.
이 문제를 어떻게 해결할 수 있을까?

🥜 Bean Validation - groups

동일한 모델 객체를 등록할 때와 수정할 때 각각 다르게 검증하는 방법을 알아보자.
두 가지 방법이 존재한다.

1) BeanValidation groups 기능 사용

이런 문제를 해결하기 위해 Bean Validation은 groups라는 기능을 제공한다.
예를 들어서 등록시에 검증할 기능과 수정시에 검증할 기능을 각각 그룹으로 나누어 적용할 수 있다.

저장용 groups 생성 (인터페이스)

src/main/java/hello/itemservice/domain/item/SaveCheck

public interface SaveCheck {
}

수정용 groups 생성 (인터페이스)

src/main/java/hello/itemservice/domain/item/UpdateCheck

public interface UpdateCheck {
}

`Item` - groups 적용

src/main/java/hello/itemservice/domain/item/Item

@Data
public class Item {

    @NotNull(groups = UpdateCheck.class) // 🌟 groups 적용
    private Long id;

    @NotBlank(groups = {SaveCheck.class, UpdateCheck.class}) // 🌟 groups 적용
    private String itemName;

    @NotNull(groups = {SaveCheck.class, UpdateCheck.class}) // 🌟 groups 적용
    @Range(min = 1000, max = 1000000, groups = {SaveCheck.class, UpdateCheck.class}) // 🌟 groups 적용
    private Integer price;

    @NotNull(groups = {SaveCheck.class, UpdateCheck.class}) // 🌟 groups 적용
    @Max(value = 9999, groups = SaveCheck.class) // 🌟 groups 적용
    private Integer quantity;

    public Item() {
    }

    public Item(String itemName, Integer price, Integer quantity) {
        this.itemName = itemName;
        this.price = price;
        this.quantity = quantity;
    }
}

컨트롤러 - `ValidationItemControllerV3`

`addItemV2()` - groups 적용

@Slf4j
@Controller
@RequestMapping("/validation/v3/items")
@RequiredArgsConstructor
public class ValidationItemControllerV3 {
    ...
     @PostMapping("/add")
    public String addItemV2(@Validated(SaveCheck.class) @ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes) { // 🌟 groups 적용

        // 오브젝트 오류 (글로벌 오류) 검증
        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()){
            log.info("errors={}", bindingResult);
            return "validation/v3/addForm";
        }

        // 성공 로직
        Item savedItem = itemRepository.save(item);
        redirectAttributes.addAttribute("itemId", savedItem.getId());
        redirectAttributes.addAttribute("status", true);
        return "redirect:/validation/v3/items/{itemId}";
    }
...
}

`editV2()` - groups 적용

@Slf4j
@Controller
@RequestMapping("/validation/v3/items")
@RequiredArgsConstructor
public class ValidationItemControllerV3 {
    ...
    @PostMapping("/{itemId}/edit")
    public String editV2(@PathVariable Long itemId, @Validated(UpdateCheck.class) @ModelAttribute Item item, BindingResult bindingResult) { // 🌟 groups 적용

        // 오브젝트 오류 (글로벌 오류) 검증
        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()){
            log.info("errors={}", bindingResult);
            return "validation/v3/editForm";
        }

        itemRepository.update(itemId, item);
        return "redirect:/validation/v3/items/{itemId}";
    }
...
}

참고
@Valid 에는 groups를 적용할 수 있는 기능이 없다. 따라서 groups를 사용하려면 @Validated 를 사용해야 한다.

groups 기능을 사용해서 등록과 수정시에 각각 다르게 검증을 할 수 있었다.
그런데 groups 기능을 사용하니 Item 은 물론이고, 전반적으로 복잡도가 올라갔다.
사실 groups 기능은 실제 잘 사용되지는 않는데, 그 이유는 실무에서는 주로 다음에 등장하는 등록용 폼 객체와 수정용 폼 객체를 분리해서 사용하기 때문이다.

2) Form 전송 객체 분리 🌟

소개

등록시 폼에서 전달하는 데이터가 Item 도메인 객체와 딱 맞지 않기 때문에 실무에서는 groups를 잘 사용하지 않는다.
실무에서는 회원 등록시 회원과 관련된 데이터만 전달받는 것이 아니라, 약관 정보도 추가로 받는 등 Item 과 관계없는 수 많은 부가 데이터가 넘어온다.
그래서 보통 Item 을 직접 전달받는 것이 아니라, 복잡한 폼의 데이터를 컨트롤러까지 전달할 별도의 객체를 만들어서 전달한다.

예를 들면 ItemSaveForm 이라는 폼을 전달받는 전용 객체를 만들어서 @ModelAttribute 로 사용한다.
이것을 통해 컨트롤러에서 폼 데이터를 전달 받고, 이후 컨트롤러에서 필요한 데이터를 사용해서 Item 을 생성한다.

폼 데이터 전달에 Item 도메인 객체 사용

HTML Form -> Item -> Controller -> Item -> Repository

장점: Item 도메인 객체를 컨트롤러, 리포지토리 까지 직접 전달해서 중간에 Item을 만드는 과정이 없어서 간단하다.
단점: 간단한 경우에만 적용할 수 있다. 수정시 검증이 중복될 수 있고, groups를 사용해야 한다.

폼 데이터 전달을 위한 별도의 객체 사용

HTML Form -> ItemSaveForm -> Controller -> Item 생성 -> Repository

장점: 전송하는 폼 데이터가 복잡해도 거기에 맞춘 별도의 폼 객체를 사용해서 데이터를 전달 받을 수 있다.
보통 등록과, 수정용으로 별도의 폼 객체를 만들기 때문에 검증이 중복되지 않는다.
단점: 폼 데이터를 기반으로 컨트롤러에서 Item 객체를 생성하는 변환 과정이 추가된다.

Item 도메인 객체를 폼 전달 데이터로 사용하고, 그대로 쭉 넘기면 편리하겠지만, 앞에서 설명한 것과 같이 실무에서는 Item 의 데이터만 넘어오는 것이 아니라 무수한 추가 데이터가 넘어온다.
그리고 더 나아가서 Item 을 생성하는데 필요한 추가 데이터를 데이터베이스나 다른 곳에서 찾아와야 할 수도 있다.
따라서 이렇게 폼 데이터 전달을 위한 별도의 객체를 사용하고, 등록, 수정용 폼 객체를 나누면 등록, 수정이 완전히 분리되기 때문에 groups를 적용할 일은 드물다.

Q. 이름은 어떻게 지어야 하나요?
이름은 의미있게 지으면 된다. ItemSave 라고 해도 되고, ItemSaveForm , ItemSaveRequest , ItemSaveDto 등으로 사용해도 된다.
중요한 것은 일관성이다.

개발

`Item` - 원복

src/main/java/hello/itemservice/domain/item/Item

@Data
public class Item {

    private Long id;
    private String itemName;
    private Integer price;
    private Integer quantity;

    public Item() {
    }

    public Item(String itemName, Integer price, Integer quantity) {
        this.itemName = itemName;
        this.price = price;
        this.quantity = quantity;
    }
}

`ItemSaveForm` - `item` 저장용 폼

src/main/java/hello/itemservice/web/validation/form/ItemSaveForm

@Data
public class ItemSaveForm {

    @NotBlank
    private String itemName;

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

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

`ItemUpdateForm` - `item` 수정용 폼

src/main/java/hello/itemservice/web/validation/form/ItemUpdateForm

@Data
public class ItemUpdateForm {

    @NotNull
    private Long id;

    @NotBlank
    private String itemName;

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

    // 수정 시에는 수량을 자유롭게 변경할 수 있다.
    private Integer quantity;
}

컨트롤러 - `ValidationItemControllerV4`

`addItem()`

@Slf4j
@Controller
@RequestMapping("/validation/v4/items")
@RequiredArgsConstructor
public class ValidationItemControllerV4 {
    ...
    @PostMapping("/add")
    public String addItem(@Validated @ModelAttribute("item") ItemSaveForm form, BindingResult bindingResult, RedirectAttributes redirectAttributes) { // 🌟 Item -> ItemServiceForm 변경

        // 오브젝트 오류 (글로벌 오류) 검증
        if (form.getPrice()!=null && form.getQuantity()!=null){
            int resultPrice = form.getPrice() * form.getQuantity();
            if (resultPrice<10000){
                bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
            }
        }

        // 검증에 실패하면 다시 입력 폼으로
        if (bindingResult.hasErrors()){
            log.info("errors={}", bindingResult);
            return "validation/v4/addForm";
        }

        // 성공 로직 
        // 🌟 폼 객체를 Item으로 변환
        Item item = new Item();
        item.setItemName(form.getItemName());
        item.setPrice(form.getPrice());
        item.setQuantity(form.getQuantity());

        Item savedItem = itemRepository.save(item);
        redirectAttributes.addAttribute("itemId", savedItem.getId());
        redirectAttributes.addAttribute("status", true);
        return "redirect:/validation/v4/items/{itemId}";
    }
...
}

Item 대신에 ItemSaveform 을 전달 받는다. 그리고 @Validated 로 검증도 수행하고, BindingResult로 검증 결과도 받는다.
폼 객체의 데이터를 기반으로 Item 객체를 생성한다. 이렇게 폼 객체 처럼 중간에 다른 객체가 추가되면 변환하는 과정이 추가된다.

주의 🚨
@ModelAttribute("item") 에 item 이름을 넣어준 부분을 주의하자.
이것을 넣지 않으면 ItemSaveForm 의 경우 규칙에 의해 itemSaveForm 이라는 이름으로 MVC Model에 담기게 된다.
이렇게 되면 뷰 템플릿에서 접근하는 th:object 이름도 함께 변경해주어야 한다.

`edit()`

@Slf4j
@Controller
@RequestMapping("/validation/v4/items")
@RequiredArgsConstructor
public class ValidationItemControllerV4 {
    ...
    @PostMapping("/{itemId}/edit")
    public String edit(@PathVariable Long itemId, @Validated @ModelAttribute("item") ItemUpdateForm form, BindingResult bindingResult) { // 🌟 Item -> ItemUpdateForm 변경

        // 오브젝트 오류 (글로벌 오류) 검증
        if (form.getPrice()!=null && form.getQuantity()!=null){
            int resultPrice = form.getPrice() * form.getQuantity();
            if (resultPrice<10000){
                bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
            }
        }

        // 검증에 실패하면 다시 입력 폼으로
        if (bindingResult.hasErrors()){
            log.info("errors={}", bindingResult);
            return "validation/v4/editForm";
        }

        // 성공 로직 
        // 🌟 폼 객체를 Item으로 변환
        Item itemParam = new Item();
        itemParam.setItemName(form.getItemName());
        itemParam.setPrice(form.getPrice());
        itemParam.setQuantity(form.getQuantity());

        itemRepository.update(itemId, itemParam);
        return "redirect:/validation/v4/items/{itemId}";
    }
...
}

수정의 경우도 등록과 같다. 그리고 폼 객체를 Item 객체로 변환하는 과정을 거친다.

🥜 Bean Validation - HTTP 메시지 컨버터

@Valid , @Validated 는 HttpMessageConverter ( @RequestBody )에도 적용할 수 있다.

참고

@ModelAttribute 는 HTTP 요청 파라미터(URL 쿼리 스트링, POST Form)를 다룰 때 사용한다.

@RequestBody 는 HTTP Body의 데이터를 객체로 변환할 때 사용한다. 주로 API JSON 요청을 다룰 때 사용한다.

컨트롤러 - `ValidationItemApiController`

src/main/java/hello/itemservice/web/validation/ItemSaveForm

@Slf4j
@RestController
@RequestMapping("/validation/api/items")
public class ValidationItemApiController {

    @PostMapping("/add")
    public Object addItem(@RequestBody @Validated ItemSaveForm form, BindingResult bindingResult){
        log.info("API 컨트롤러 호출");

        if(bindingResult.hasErrors()){
            log.info("검증 오류 발생 errors={}", bindingResult);
            return bindingResult.getAllErrors();
        }

        log.info("성공 로직 실행");
        return form;
    }
}

return bindingResult.getAllErrors(); 는 ObjectError 와 FieldError 를 반환한다.
스프링이 이 객체를 JSON으로 변환해서 클라이언트에 전달했다.
여기서는 예시로 보여주기 위해서 검증 오류 객체들을 그대로 반환했다.
실제 개발할 때는 이 객체들을 그대로 사용하지 말고, 필요한 데이터만 뽑아서 별도의 API 스펙을 정의하고 그에 맞는 객체를 만들어서 반환해야 한다.

포스트맨 테스트

POST http://localhost:8080/validation/api/items/add
{"itemName":"hello", "price":1000, "quantity": 10}

Postman에서 Body -> raw -> JSON을 선택해야 한다.

API 3가지 경우 - 성공 요청, 실패 요청, 검증 오류 요청

API의 경우 3가지 경우를 나누어 생각해야 한다.

성공 요청: 성공
실패 요청: JSON을 객체로 생성하는 것 자체가 실패함 (ex. price 값에 숫자가 아닌 문자를 전달한 경우)
검증 오류 요청: JSON을 객체로 생성하는 것은 성공했고, 검증에서 실패함 (ex. quantity 값에 100000을 전달한 경우)

실패 요청

HttpMessageConverter 에서 요청 JSON을 ItemSaveForm 객체로 생성하는데 실패한다.
이 경우는 ItemSaveForm 객체를 만들지 못하기 때문에 컨트롤러 자체가 호출되지 않고 그 전에 예외가 발생한다.
물론 Validator도 실행되지 않는다.

검증 오류 요청

HttpMessageConverter 는 성공하지만 검증(Validator)에서 오류가 발생하는 경우이다.

`@ModelAttribute` vs `@RequestBody`

HTTP 요청 파리미터를 처리하는 @ModelAttribute 는 각각의 필드 단위로 세밀하게 적용된다.
그래서 특정 필드에 타입이 맞지 않는 오류가 발생해도 나머지 필드는 정상 처리할 수 있었다.

HttpMessageConverter 는 @ModelAttribute 와 다르게 각각의 필드 단위로 적용되는 것이 아니라, 전체 객체 단위로 적용된다.
따라서 메시지 컨버터의 작동이 성공해서 ItemSaveForm 객체를 만들어야 @Valid , @Validated 가 적용된다.

@ModelAttribute 는 필드 단위로 정교하게 바인딩이 적용된다.
특정 필드가 바인딩 되지 않아도 나머지 필드는 정상 바인딩 되고, Validator를 사용한 검증도 적용할 수 있다.
@RequestBody 는 HttpMessageConverter 단계에서 JSON 데이터를 객체로 변경하지 못하면 이후 단계 자체가 진행되지 않고 예외가 발생한다.
컨트롤러도 호출되지 않고, Validator도 적용할 수 없다.

참고
HttpMessageConverter 단계에서 실패하면 예외가 발생한다. 예외 발생시 원하는 모양으로 예외를 처리하는 방법은 예외 처리 부분에서 다룬다.

💛 개인 공부 기록용 블로그입니다. 👻

맨 위로 이동하기

Twitter Facebook LinkedIn

Minju412

소개

준비

Bean Validation 의존관계 추가

Item - Bean Validation 애노테이션 적용

검증 애노테이션

🥜 Bean Validation - 스프링 적용

컨트롤러 - ValidationItemControllerV3

addItem()

스프링 MVC는 어떻게 Bean Validator를 사용?

스프링 부트는 자동으로 글로벌 Validator로 등록한다.

검증 순서

바인딩에 성공한 필드만 Bean Validation 적용

🥜 Bean Validation - 에러 코드

@NotBlank

@Range

errors.properties - 메시지 등록

BeanValidation 메시지 찾는 순서

🥜 Bean Validation - 오브젝트 오류

1) @ScriptAssert

2) 자바 코드로 직접 작성

컨트롤러 - ValidationItemControllerV3

addItem() - 오브젝트 오류 추가

🥜 Bean Validation - 한계

🥜 Bean Validation - groups

1) BeanValidation groups 기능 사용

저장용 groups 생성 (인터페이스)

수정용 groups 생성 (인터페이스)

Item - groups 적용

컨트롤러 - ValidationItemControllerV3

addItemV2() - groups 적용

editV2() - groups 적용

2) Form 전송 객체 분리 🌟

소개

폼 데이터 전달에 Item 도메인 객체 사용

폼 데이터 전달을 위한 별도의 객체 사용

개발

Item - 원복

ItemSaveForm - item 저장용 폼

ItemUpdateForm - item 수정용 폼

컨트롤러 - ValidationItemControllerV4

addItem()

edit()

🥜 Bean Validation - HTTP 메시지 컨버터

컨트롤러 - ValidationItemApiController

포스트맨 테스트

API 3가지 경우 - 성공 요청, 실패 요청, 검증 오류 요청

실패 요청

검증 오류 요청

@ModelAttribute vs @RequestBody

공유하기

참고

누군가 나의 EC2를 해킹하여 사용하는 경우

[Trouble Shooting] AWS EC2 멈춤 현상 (CPU Utilization)

EC2, Docker Compose를 이용한 애플리케이션 배포 (with. Docker Hub)

[BOJ] 10448 - 유레카 이론 (🥉 브론즈 1티어)

컨트롤러 - `ValidationItemControllerV3`

`addItem()`

`errors.properties` - 메시지 등록

1) `@ScriptAssert`

컨트롤러 - `ValidationItemControllerV3`

`addItem()` - 오브젝트 오류 추가

`Item` - groups 적용

컨트롤러 - `ValidationItemControllerV3`

`addItemV2()` - groups 적용

`editV2()` - groups 적용

`Item` - 원복

`ItemSaveForm` - `item` 저장용 폼

`ItemUpdateForm` - `item` 수정용 폼

컨트롤러 - `ValidationItemControllerV4`

`addItem()`

`edit()`

컨트롤러 - `ValidationItemApiController`

`@ModelAttribute` vs `@RequestBody`