오류 메세지를 체계적으로 다루어보자
FieldError 생성자
FieldError
는 두 가지 생성자를 제공한다.
public FieldError(String objectName, String field, String defaultMessage);
public FieldError(String objectName, String field, @Nullable Object rejectedValue, boolean bindingFailure, @Nullable String[] codes, @Nullable
Object[] arguments, @Nullable String defaultMessage)
파라미터 목록
objectName
: 오류가 발생한 객체 이름
field
: 오류 필드
rejectedValue
: 사용자가 입력한 값(거절된 값)
bindingFailure
: 타입 오류 같은 바인딩 실패인지, 검증 실패인지 구분 값 codes : 메시지 코드
arguments
: 메시지에서 사용하는 인자
defaultMessage
: 기본 오류 메시지
FieldError
, ObjectError
의 생성자는 codes
, arguments
를 제공한다. 이것은 오류 발생시 오류 코드로 메시지를 찾기 위해 사용된다.
messages.properties
를 사용해도 되지만, 오류 메시지를 구분하기 쉽게 errors.properties
라는 별도의 파일로 관리해보자.
먼저 스프링 부트가 해당 메시지 파일을 인식할 수 있게 다음 설정을 추가한다. 이렇게하면 messages.properties
, errors.properties
두 파일을 모두 인식한다. (생략하면 messages.properties
를 기본으로 인식한다.)
application.properties
spring.messages.basename=messages,errors
src/main/resources/errors.properties
required.item.itemName=상품 이름은 필수입니다.
range.item.price=가격은 {0} ~ {1} 까지 허용합니다.
max.item.quantity=수량은 최대 {0} 까지 허용합니다.
totalPriceMin=가격 * 수량의 합은 {0}원 이상이어야 합니다. 현재 값 = {1}
🤞 참고:
errors_en.properties 파일을 생성하면 오류 메시지도 국제화 처리를 할 수 있다.
이제 errors
에 등록한 메세지를 사용하도록 코드를 변경해보자
@PostMapping("/add")
public String addItemV3(@ModelAttribute Item item, BindingResult bindingResult,RedirectAttributes redirectAttributes) {
if (!StringUtils.hasText(item.getItemName())) {
bindingResult.addError(new FieldError("item", "itemName", item.getItemName(), false, new String[]{"required.item.itemName"}, null,null));
}
if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
bindingResult.addError(new FieldError("item", "price", item.getPrice(),false, new String[]{"range.item.price"}, new Object[]{1000,1000000}, null));
}
if (item.getQuantity() == null || item.getQuantity() > 10000) {
bindingResult.addError(new FieldError("item", "quantity",item.getQuantity(), false, new String[]{"max.item.quantity"}, new Object[] {9999}, null));
}
//특정 필드 예외가 아닌 전체 예외
if (item.getPrice() != null && item.getQuantity() != null) {
int resultPrice = item.getPrice() * item.getQuantity();
if (resultPrice < 10000) {
bindingResult.addError(new ObjectError("item", new String[] {"totalPriceMin"}, new Object[]{10000, resultPrice}, null));
}
}
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}";
}
codes
: required.item.itemName
를 사용해서 메시지 코드를 지정한다. 메시지 코드는 하나가 아니라 배열로 여러 값을 전달할 수 있는데, 순서대로 매칭해서 처음 매칭되는 메시지가 사용된다.
arguments
: Object[]{1000, 1000000}
를 사용해서 코드의 {0}
, {1}
로 치환할 값을 전달한다.
실행해보면 메시지, 국제화에서 학습한 MessageSource
를 찾아서 메시지를 조회하는 것을 확인할 수 있다.