03.Validation

Validation

Spring Verification

컨트롤러의 중요한 역할중 하나는 HTTP 요청이 정상인지 검증하는 것

  • 클라이언트 검증은 조작할 수 있으므로 보안에 취약

  • 그렇다고 서버만으로 검증하면 즉각적인 고객 사용성이 부족

  • 서버, 클라이언트 검증을 적절히 섞어서 사용하되 서버 검증은 필수

  • API 방식 사용 시, API 스펙을 잘 정의해서 검증 오류를 API 응답 결과에 잘 남겨야 함

BindingResult

스프링이 제공하는 검증 오류를 보관하는 객체

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

    if (!StringUtils.hasText(item.getItemName())) {
        bindingResult.addError(new FieldError("item", "itemName", item.getItemName(), false, null, null, "상품 이름은 필수 입니다."));
    }
    
    if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
        bindingResult.addError(new FieldError("item", "price", item.getPrice(), false, null, null, "가격은 1,000 ~ 1,000,000 까지 허용합니다."));
    }
    
    if (item.getQuantity() == null || item.getQuantity() >= 9999) {
        bindingResult.addError(new FieldError("item", "quantity", item.getQuantity(), false, null ,null, "수량은 최대 9,999 까지 허용합니다."));
    }

    // 글로벌 예외
    if (item.getPrice() != null && item.getQuantity() != null) {
        int resultPrice = item.getPrice() * item.getQuantity();
        if (resultPrice < 10000) {
            bindingResult.addError(new ObjectError("item",null ,null, "가격 * 수량의 합은 10,000원 이상이어야 합니다. 현재 값 = " + resultPrice));
        }
    }

    // 검증 실패 시 입력 폼으로
    if (bindingResult.hasErrors()) {
        log.info("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}";
}

...

/** 
 * FieldError class
 * 필드에 오류가 있으면 FieldError 객체를 생성해서 bindingResult 에 담아두자.
 */
public FieldError(
  String objectName, // @ModelAttribute 이름
  String field, // 오류가 발생한 필드 이름
  String defaultMessage // 오류 기본 메시지 
) {}

public FieldError(
  String objectName, // 오류가 발생한 객체 이름
  String field, // 오류 필드
  @Nullable Object rejectedValue, // 사용자가 입력한 값(거절된 값)
  boolean bindingFailure, // 타입 오류 같은 바인딩 실패인지, 검증 실패인지 구분 값
  @Nullable String[] codes, // 메시지 코드
  @Nullable Object[] arguments, // 메시지에서 사용하는 인자
  @Nullable String defaultMessage // 기본 오류 메시지
)

/**
 * ObjectError
 * 특정 필드를 넘어서는 오류가 있으면 ObjectError 객체를 생성해서 bindingResult 에 담아두자.
 */
public ObjectError(
  String objectName, // @ModelAttribute 의 이름
  String defaultMessage // 오류 기본 메시지
) {}

BindingResult

  • @ModelAttribute 객체 다음 위치

  • BindingResult 가 있으면 @ModelAttribute 에 데이터 바인딩 시 오류가 발생해도 컨트롤러 호출

    • BindingResult 가 없으면 400 오류 발생 후, 오류 페이지로 이동

    • BindingResult 가 있으면 오류 정보(FieldError)를 BindingResult 에 담아서 컨트롤러 정상 호출

  • Model 에 자동으로 포함

  • 어떤 객체를 대상으로 검증하는지 타겟을 알고 있음

.

BindingResult 에 검증 오류를 적용하는 세 가지 방법

  • @ModelAttribute 객체의 타입 오류 등, 바인딩 실패 시 스프링이 FieldError 생성 후 BindingResult 에 삽입

  • 개발자가 직접 입력

  • Validator 사용

Error Message

오류 메시지 파일을 인식할 수 있도록 설정 추가

spring.messages.basename=messages,errors

errors.properties

required.item.itemName=상품 이름은 필수입니다.
range.item.price=가격은 {0} ~ {1} 까지 허용합니다.
max.item.quantity=수량은 최대 {0} 까지 허용합니다.
totalPriceMin=가격 * 수량의 합은 {0}원 이상이어야 합니다. 현재 값 = {1}
required.default=기본 오류 메시지
required=필수 값 입니다.
bindingResult.addError(
  new FieldError("item", "itemName", item.getItemName(), false, 
  new String[]{"required.item.itemName"}, null, null)
);

bindingResult.addError(
    new FieldError("item", "price", item.getPrice(), false, 
    new String[]{"range.item.price"}, // codes : 메시지 코드
    new Object[]{1000, 1000000}, // arguments : 메시지에서 사용하는 인자
    null)
);

rejectValue() , reject()

BindingResult 는 검증해야 target 객체를 알고 있음

  • BindingResult 의 rejectValue(), reject() 를 사용하면 FieldError, ObjectError 를 직접 생성하지 않고, 깔끔하게 검증 오류를 다룰 수 있음

bindingResult.rejectValue("itemName", "required");

bindingResult.rejectValue("price", "range", new Object[]{1000, 10000000}, "상품 가격 오류");

bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
...

void rejectValue(
  @Nullable String field, // 오류 필드명
  String errorCode, // 오류 코드(메시지에 등록된 코드가 아닌 messageResolver 를 위한 오류 코드)
  @Nullable Object[] errorArgs, // 메시지에서 사용하는 인자
  @Nullable String defaultMessage // 기본 메시지(오류 메시지를 찾을 수 없을 때 사용)
);

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

Apply Thymeleaf

필드 오류 처리

  • rejectedValue(): 오류 발생 시 사용자 입력 값을 저장

bindingResult.rejectValue("price", "range", new Object[]{1000, 10000000}, "상품 가격 오류");
<input
  type="text"
  id="price"
  th:field="*{price}"
  th:errorclass="field-error"
  class="form-control"
  placeholder="가격을 입력하세요"
/>
<div class="field-error" th:errors="*{price}">가격 오류</div>

  • th:field는 평소에는 모델 객체의 값을 사용하지만, 오류가 발생하면 FieldError 에서 보관한 값을 사용해서 값을 출력

글로벌 오류 처리

bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
<div th:if="${#fields.hasGlobalErrors()}">
  <p
    class="field-error"
    th:each="err : ${#fields.globalErrors()}"
    th:text="${err}"
  >
    전체 오류 메시지
  </p>
</div>

Validation and Error Messages

MessageCodesResolver

  • 검증 오류 코드로 메시지 코드들을 생성

  • MessageCodesResolver 는 인터페이스, DefaultMessageCodesResolver 는 기본 구현체

  • ObjectError, FieldError 와 주로 함께 사용

DefaultMessageCodesResolver 기본 메시지 생성 규칙

필드 오류

필드 오류의 경우 다음 순서로 4가지 메시지 코드 생성

1. code + "." + ObjectName + "." + field
2. code + "." + field
3. code + "." + field type
4. code

---

(example)
error code: required
ObjectName: item
field: itemName
field type: String

1. "required.item.itemName"
2. "required.itemName"
3. "required.java.lang.String"
4. "required"

객체 오류

객체 오류의 경우 다음 순서로 2가지 생성

1. code + "." + objectName
2. code

---

(example)
error code: totalPriceMin
ObjectName: item

1. "totalPriceMin.item"
2. "totalPriceMin"

동작 방식

  • rejectValue() , reject() 는 내부에서 MessageCodesResolver 사용 ➜ 여기서 메시지 코드 생성

    • FieldError, ObjectError 생성자를 보면 알 수 있듯이, 여러 오류 코드를 가질 수 있음

  • MessageCodesResolver 를 통해 생성된 순서대로 오류 코드 보관

1. rejectValue() 호출
2. MessageCodesResolver 를 사용해서 검증 오류 코드로 메시지 코드들을 생성
3. new FieldError() 를 생성하면서 메시지 코드들을 보관
4. th:erros 에서 메시지 코드들로 메시지를 순서대로 메시지에서 찾고 출력

오류 코드 관리 전략

구체적인 것 ➜ 덜 구체적인 것으로가 핵심

  • MessageCodesResolver 는 구체적인 것(required.item.itemName)을 먼저 생성하고, 덜 구체적인 것(required)을 나중애 생성

  • 중요하지 않은 메시지는 범용성 있는 간단한 메시지(requried)로, 중요한 메시지는 필요할 때 구체적으로 사용하는 방식이 효과적

errors.properties

#==ObjectError==
#Level1
totalPriceMin.item=상품의 가격 * 수량의 합은 {0}원 이상이어야 합니다. 현재 값 = {1}

#Level2 - 생략
totalPriceMin=전체 가격은 {0}원 이상이어야 합니다. 현재 값 = {1}



#==FieldError==
#Level1
required.item.itemName=상품 이름은 필수입니다.
range.item.price=가격은 {0} ~ {1} 까지 허용합니다.
max.item.quantity=수량은 최대 {0} 까지 허용합니다.

#Level2 - 생략

#Level3
required.java.lang.String = 필수 문자입니다.
required.java.lang.Integer = 필수 숫자입니다.
min.java.lang.String = {0} 이상의 문자를 입력해주세요.
min.java.lang.Integer = {0} 이상의 숫자를 입력해주세요.
range.java.lang.String = {0} ~ {1} 까지의 문자를 입력해주세요.
range.java.lang.Integer = {0} ~ {1} 까지의 숫자를 입력해주세요.
max.java.lang.String = {0} 까지의 숫자를 허용합니다.
max.java.lang.Integer = {0} 까지의 숫자를 허용합니다.

#Level4
required = 필수 값 입니다.
min= {0} 이상이어야 합니다.
range= {0} ~ {1} 범위를 허용합니다.
max= {0} 까지 허용합니다.

ValidationUtils

ValidationUtils 사용 전

if (!StringUtils.hasText(item.getItemName())) {
    bindingResult.rejectValue("itemName", "required", "기본: 상품 이름은 필수입니다.");
}

ValidationUtils 사용 후

ValidationUtils.rejectIfEmptyOrWhitespace(bindingResult, "itemName", "required");

Spring 검증 오류 메시지

  • Spring 은 타입 오류가 발생하면 typeMismatch 오류 코드를 사용

    • 주로 타입 정보가 맞지 않을 경우 Spring 직접 검증

  • typeMismatch 오류 코드가 MessageCodesResolver 를 통해 4가지 메시지 코드로 생성

    • typeMismatch.item.price

    • typeMismatch.price

    • typeMismatch.java.lang.Integer

    • typeMismatch

errors.properties

typeMismatch.java.lang.Integer=숫자를 입력해주세요.
typeMismatch=타입 오류입니다.

Validator

스프링은 체계적으로 검증 기능을 제공하기 위해 Validator 인터페이스 제공

public interface Validator {
    boolean supports(Class<?> clazz); // 해당 검증기를 지원하는 여부 확인
    void validate(Object target, Errors errors); // 검증 대상 객체와 BindingResult
}

검증로직 분리와 호출

@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);
            }
        }
    }
}

...

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

    ...
}

WebDataBinder

WebDataBinder 는 스프링의 파라미터 바인딩 역할을 해주고, 검증 기능도 내부에 포함

/**
 * @InitBinder
 * 특정 컨트롤러에만 적용
 */
@InitBinder
public void init(WebDataBinder dataBinder) {
    dataBinder.addValidators(itemValidator);
}

...

/**
 * Application.class
 * 글로벌 설정(모든 컨트롤러에 다 적용)
 * 직접 사용하는 경우는 드묾
 */
@Override
public Validator getValidator() {
    return new ItemValidator();
}
@PostMapping("/add")
public String addItem(@Validated @ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes) {
    ...
}

  • WebDataBinder 에 검증기 추가 시 해당 컨트롤러에서는 검증기를 자동 적용

  • WebDataBinder 를 통해 ItemValidator 호출

@Validated

  • 검증기를 실행하라는 애노테이션

  • WebDataBinder 에 등록한 검증기를 찾아서 실행

    • 여러 검증기가 등록된다면 Validator.supports() 를 통해 구분

    • 여기서는 Validator.supports(Item.class) 호출 후, 결과가 true 이므로 ItemValidator 의 validate() 호출

  • bindingResult 에 검증 결과가 담김

Bean Validation

  • 검증 로직을 모든 프로젝트에 적용할 수 있게 공통화하고, 표준화

    • 애노테이션 하나로 검증 로직을 매우 편리하게 적용

  • 특정한 구현체가 아니라 Bean Validation 2.0(JSR-380)이라는 기술 표준

    • 검증 애노테이션과 여러 인터페이스의 모음

    • 마치 JPA 가 표준 기술이고 그 구현체로 하이버네이트가 있는 것과 유사

  • 일반적으로 사용하는 구현체는 Hibernate Validator

    • ORM 과는 무관..

Hibernate Validator Reference

Hibernate Validator

Hibernate Validator Guide

Jakarta Bean Validation constraints

dependence

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

Jakarta Bean Validation

  • jakarta.validation-api: Bean Validation 인터페이스

  • hibernate-validator: 구현체

검증 애노테이션 적용

@Data
@NoArgsConstructor
public class Item {

    private Long id;

    @NotBlank // 빈값 + 공백 허용 X
    private String itemName;

    @NotNull // null 허용 X
    @Range(min = 1000, max = 1000000) // 범위 안의 값이어야 허용
    private Integer price;

    @NotNull
    @Max(9999) // 최대 9999까지만 허용
    private Integer quantity;

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

...

@Test
void beanValidation() {
    /**
     * 검증기 생성
     */
    ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
    Validator validator = factory.getValidator();

    Item item = new Item();
    item.setItemName(" ");
    item.setPrice(0);
    item.setQuantity(10000);

    /**
     * 검증 실행
     *
     * 검증 대상(item)을 검증기에 삽입
     * Set 에는 ConstraintViolation 이라는 검증 오류가 담김
     * 결과가 비어있으면 검증 오류가 없는 것
     */
    Set<ConstraintViolation<Item>> violations = validator.validate(item);
    for (ConstraintViolation<Item> violation : violations) {
        System.out.println("violation=" + violation);
        System.out.println("violation.message=" + violation.getMessage() + "\n");
    }
}
violation=ConstraintViolationImpl{interpolatedMessage='공백일 수 없습니다', propertyPath=itemName, rootBeanClass=class com.conquest.spring.validation.domain.Item, messageTemplate='{jakarta.validation.constraints.NotBlank.message}'}
violation.message=공백일 수 없습니다

violation=ConstraintViolationImpl{interpolatedMessage='9999 이하여야 합니다', propertyPath=quantity, rootBeanClass=class com.conquest.spring.validation.domain.Item, messageTemplate='{jakarta.validation.constraints.Max.message}'}
violation.message=9999 이하여야 합니다

violation=ConstraintViolationImpl{interpolatedMessage='1000에서 1000000 사이여야 합니다', propertyPath=price, rootBeanClass=class com.conquest.spring.validation.domain.Item, messageTemplate='{org.hibernate.validator.constraints.Range.message}'}
violation.message=1000에서 1000000 사이여야 합니다

Apply Bean Validation in Spring

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

  • Spring Boot 는 자동으로 LocalValidatorFactoryBean 을 Global Validator 로 등록

    • LocalValidatorFactoryBean 은 Annotation 기반 검증

  • @Valid(자바 표준), @Validated(스프링 전용) 만 적용하여 검증 사용 가능

  • 검증 오류 발생 시 FieldError, ObjectError 를 생성해서 BindingResult 에 담아 준다.

  • ItemValidator 가 등록되어 있다면 오류 검증기 중복을 막기 위해 제거가 필요

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

검증 순서

\1. @ModelAttribute 각 필드에 타입 변환 시도

  • 변환에 성공한 필드만 BeanValidation 적용

  • 실패하면 typeMismatch 로 FieldError 추가

\2. BeanValidation

  • 바인딩에 성공한 필드만 BeanValidation 적용

  • 바인딩에 실패한 필드는 적용하지 않음

에러 코드

애노테이션 오류 코드를 기반으로 MessageCodesResolver 를 통해 다양한 메시지 코드가 순서대로 생성

@NotBlank

  • NotBlank.item.itemName

  • NotBlank.itemName

  • NotBlank.java.lang.String

  • NotBlank

@Range

  • Range.item.price

  • Range.price

  • Range.java.lang.Integer

  • Range

NotBlank.item.itemName=상품 이름을 입력해주세요.
NotBlank={0} 공백X
Range={0}, {2} ~ {1} 허용
Max={0}, 최대 {1}

BeanValidation 메시지 찾는 순서

  1. 생성된 메시지 코드 순서대로 messageSource 에서 메시지 찾기

  2. 애노테이션의 message 속성 사용 ➜ @NotBlank(message = "공백은 입력할 수 없습니다.")

  3. 라이브러리가 제공하는 기본 값 사용 ➜ "공백일 수 없습니다"

글로벌 오류

@ScriptAssert() 사용은 제약이 많고 검증 기능이 해당 객체 범위를 넘어설 경우 대응이 어렵다.

  • 글로벌 오류 관련 부분만 자바 코드로 작성하는 것을 권장

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

groups

등록시에 검증할 기능과 수정시에 검증할 기능을 각각 그룹으로 나누어 적용

  • groups 기능은 실제 잘 사용되지 않음

  • 대신 실무에서는 주로 등록용 폼 객체(ItemSaveForm)와 수정용 폼 객체(ItemUpdateForm)를 분리해서 사용

참고. @Valid 에는 groups 적용 기능을 제공하지 않으므로, groups 사용 시 @Validated 를 사용하자.

groups 생성

/**
 * 저장용 groups
 */
public interface SaveCheck {
}

...

/**
 * 수정용 groups
 */
public interface UpdateCheck {
}

...

@Data
@NoArgsConstructor
public class Item {

    @NotNull(groups = UpdateCheck.class) // 수정 시에만 적용
    private Long id;

    @NotBlank(message = "{0} 공백은 입력할 수 없습니다.", groups = {SaveCheck.class, UpdateCheck.class})
    private String itemName;

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

    @NotNull(groups = {SaveCheck.class, UpdateCheck.class})
    @Max(value = 9999, groups = SaveCheck.class) // 등록 시에만 적용
    private Integer quantity;

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

validation interface 명시

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

...

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

Form 전송 객체 분리 🌞

groups 기능을 사용하면 전반적인 복잡도가 상승해서 실무에서는 주로 폼 객체를 분리해서 사용

  • 등록과 수정은 다루는 데이터 범위에 차이가 있다보니 완전히 다른 데이터가 넘어온다.

  • 따라서, Save/Update 별도의 객체로 데이터를 전달받는 것이 좋다.

  • 폼 데이터 전달을 위한 별도의 객체를 사용하면 등록, 수정이 완전히 분리되기 때문에 groups 적용이 불필요

Form 전송 객체 분리

@Data
public class Item {
    private Long id;
    private String itemName;
    private Integer price;
    private Integer quantity;
}

...

@Data
public class ItemSaveForm {

    @NotBlank(message = "{0} 공백은 입력할 수 없습니다.")
    private String itemName;

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

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

...

@Data
public class ItemUpdateForm {

    @NotNull
    private Long id;

    @NotBlank(message = "{0} 공백은 입력할 수 없습니다.")
    private String itemName;

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

    private Integer quantity;
}

분리된 전송 객체 적용

  • MVC Model 에 item 으로 담기도록 하기 위해 @ModelAttribute("item") 적용

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

    ...

    Item item = new Item();
    item.setItemName(form.getItemName());
    item.setPrice(form.getPrice());
    item.setQuantity(form.getQuantity());

    ...
}

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

    ...

    Item itemParam = new Item();
    itemParam.setItemName(form.getItemName());
    itemParam.setPrice(form.getPrice());
    itemParam.setQuantity(form.getQuantity());

    ...
}

HTTP Message Converter

@Valid, @Validated 는 HttpMessageConverter(@RequestBody)에도 적용 가능

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

@RequestBody 는 HTTP Body의 데이터를 객체로 변환할 때 사용(주로 API JSON 요청)

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

    @PostMapping("/add")
    public Object addItem(@RequestBody @Validated ItemSaveForm form, BindingResult bindingResult) {
        // ...

        if (bindingResult.hasErrors()) {
            return bindingResult.getAllErrors();
        }

        // ...
    }
}

API 요청 케이스

  • 성공 요청: 성공

  • 실패 요청: JSON 을 객체로 생성하는 것 자체가 실패

    JSON parse error: Cannot deserialize value of type `java.lang.Integer` from String "A": not a valid `java.lang.Integer` value]
    {
  "timestamp": "2023-07-07T00:00:00.000+00:00",
  "status": 400,
  "error": "Bad Request",
  "message": "",
  "path": "/validation/api/items/add"
}

  • 검증 오류 요청: JSON을 객체로 생성하는 것은 성공했지만, 검증에서 실패

    • 실무에서는 필요한 데이터만 뽑아 별도 API 스펙을 정의하고 객체를 만들어서 오류 정보 반환

    Field error in object 'itemSaveForm' on field 'quantity': rejected value [10000]; codes [Max.itemSaveForm.quantity,Max.quantity,Max.java.lang.Integer,Max]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [itemSaveForm.quantity,quantity]; arguments []; default message [quantity],9999]; default message [9999 이하여야 합니다]
    [
  {
    "codes": [
      "Max.itemSaveForm.quantity",
      "Max.quantity",
      "Max.java.lang.Integer",
      "Max"
    ],
    "arguments": [
      {
        "codes": [
          "itemSaveForm.quantity",
          "quantity"
        ],
        "arguments": null,
        "defaultMessage": "quantity",
        "code": "quantity"
      },
      9999
    ],
    "defaultMessage": "9999 이하여야 합니다",
    "objectName": "itemSaveForm",
    "field": "quantity",
    "rejectedValue": 10000,
    "bindingFailure": false,
    "code": "Max"
  }
]

@ModelAttribute VS @RequestBody

  • HttpMessageConverter 는 각 필드 단위로 적용되는 것이 아니라, 전체 객체 단위로 적용

  • 따라서, 메시지 컨버터 작동이 성공해서 객체를 생성해야 @Valid, @Validated 가 적용

@ModelAttribute

  • HTTP 요청 파리미터를 처리

    • ModelAttribute 대상 객체는 Setter 메서드 필요

  • 필드 단위로 정교하게 바인딩이 적용

  • 특정 필드가 바인딩 되지 않더라도 나머지 필드는 정상 바인딩 되고, @Validator 를 사용한 검증도 적용 가능

  • test code

@RequestBody

  • HttpMessageConverter 단계에서 JSON 데이터를 객체로 변경 실패파면 이후 단계가 진행되지 않고 400 Bad Request 예외 발생

  • 타입 오류가 발생할 경우 컨트롤러도 호출되지 않고, Validator 도 적용 불가

    {
    "timestamp": "2023-07-07T04:36:11.489+00:00",
    "status": 400,
    "error": "Bad Request",
    "path": "/validation/api/items/add"
}

  • test code

Ideal result code..

Last updated