Validation
클라이언트 검증 vs 서버 검증
컨트롤러의 중요한 역할 중 하나는 HTTP 요청이 정상인지 검증하는 것이다.
검증은 클라이언트 측에서 진행할 수도 있고 서버 측에서 진행할 수도 있으며, 특징은 다음과 같다.
- 클라이언트 검증은 조작할 수 있기 때문에 보안에 취약하다
- 서버만으로 검증하면, 즉각적인 고객 사용성이 부족해진다.
- 따라서 둘을 적절히 섞어서 사용하되, 최종적으로 서버 검증은 필수이다.
- API 방식을 사용할 경우 API 스펙을 잘 정의하여 검즈 오류를 API 응답 결과에 잘 남겨줘야 한다.
예제 만들기
검증을 직접 구현해보며 검증에 대해 알아보도록 하자.
검증 요구사항
- 타입 검증
- 가격, 수량에 문자가 들어가면 검증 오류 처리
- 필드 검증
- 상품명 : 필수, 공백x
- 가격 : 1000원 이상, 1백만원 이하
- 수량 : 최대 9999
- 특정 필드의 범위를 넘어서는 검증
- 가격 * 수량의 합은 10,000원 이상
검증 처리 구상
- 상품 저장 검증 성공
- 사용자가 상품 등록 폼에서 정상적으로 데이터를 입력하면, 서버 검증 로직이 통과한다.
- 검증 로직이 통과하면 상품을 저장하고, 상품 상세 화면으로 redirect 한다.
- 상품 저장 검증 실패
- 사용자가 상품명을 입력하지 않거나, 가격 및 수량 등이 검증 범위를 넘어설 경우 서버 검증 로직이 실패한다.
- 검증에 실패하면 사용자에게 다시 상품 등록 폼을 보여주고, 어떤 값을 잘못 입력했는지 친절하게 알려줘야 한다.
이제 검증 요구사항에 맞춰 구상해본대로 검증 로직을 직접 개발해보도록 하자.
직접 검증 처리 (V1)
코드
👉🏻 상품 등록 컨트롤러
📂 ValidationItemControllerV1 - addItem
@PostMapping("/add")
public String addItem(@ModelAttribute Item item, RedirectAttributes redirectAttributes, Model model) {
//검증 오류 결과를 보관
Map<String, String> errors = new HashMap<>();
//검증 로직
if (!StringUtils.hasText((item.getItemName()))) {
errors.put("itemName", "상품 이름은 필수입니다.");
}
if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
errors.put("price", "가격은 1,000 ~ 1,000,000까지 허용합니다.");
}
if (item.getQuantity() == null || item.getQuantity() >= 9999) {
errors.put("quantity", "수량은 최대 9,999까지 허용합니다.");
}
//특정 필드가 아닌 복합 룰 검증
if (item.getPrice() != null && item.getQuantity() != null) {
int resultPrice = item.getPrice() * item.getQuantity();
if (resultPrice < 10000) {
//필드 단위의 오류가 아니기 때문에 globalError라는 key를 사용
errors.put("globalError", "가격 * 수량의 합은 10,000원 이상이어야 합니다. 현재 값 = " + resultPrice);
}
}
//검증에 실패(검증 오류 값이 있을 경우)하면 다시 입력 폼으로
if (!errors.isEmpty()) {
model.addAttribute("errors", errors);
return "validation/v1/addForm";
}
//성공 로직
Item savedItem = itemRepository.save(item);
redirectAttributes.addAttribute("itemId", savedItem.getId());
redirectAttributes.addAttribute("status", true);
return "redirect:/validation/v1/items/{itemId}";
}- Map<String, String> errors = new HashMap<>();
- 검증시 오류가 발생하면 어떤 검증에서 오류가 발생했는지 정보를 담아둔다.
- 검증 로직
- import org.springframework.util.StringUtils; 추가가 필요하다.
- 검증 시 오류가 발생하면 errors에 담아두는데, 어떤 필드에서 오류가 발생했는지 구분을 위해 오류가 발생한 필드명을 key로 사용한다.
- 뷰에서 이 데이터를 사용해 고객에게 친절한 오류 메시지를 출력할 수 있다.
- 복합 룰 검증
- 특정 필드가 아닌 오류를 처리해야하는 경우가 있다.
- 이때는 필드 이름을 key로 넣을 수 없으므로 globalError라는 key를 사용한다.
- 검증 실패
- 검증 결과 오류 메시지가 하나라도 있으면 사용자에게 해당 오류 메시지를 보여주기 위해 model에 errors를 담아, 뷰로 보낸다.
- 검증 오류 발생 시 입력 폼을 다시 보여준다.
👉🏻 상품 등록 뷰
📂 resource/templates/validation/v1/addForm.html
<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="utf-8">
<link th:href="@{/css/bootstrap.min.css}"
href="../css/bootstrap.min.css" rel="stylesheet">
<style>
.container {
max-width: 560px;
}
.field-error {
border-color: #dc3545;
color: #dc3545;
}
</style>
</head>
<body>
<div class="container">
<div class="py-5 text-center">
<h2 th:text="#{page.addItem}">상품 등록</h2>
</div>
<form action="item.html" th:action th:object="${item}" method="post">
<div th:if="${errors?.containsKey('globalError')}">
<p class="field-error" th:text="${errors['globalError']}">전체 오류 메시지</p>
</div>
<div>
<label for="itemName" th:text="#{label.item.itemName}">상품명</label>
<input type="text" id="itemName" th:field="*{itemName}"
class="form-control" placeholder="이름을 입력하세요"
th:classappend="${errors?.containsKey('itemName')} ? 'field-error' : _">
<div class="field-error" th:if="${errors?.containsKey('itemName')}" th:text="${errors['itemName']}">상품명 오류</div>
</div>
<div>
<label for="price" th:text="#{label.item.price}">가격</label>
<input type="text" id="price" th:field="*{price}"
class="form-control" placeholder="가격을 입력하세요"
th:classappend="${errors?.containsKey('price')} ? 'field-error' : _">
<div class="field-error" th:if="${errors?.containsKey('price')}" th:text="${errors['price']}">가격 오류</div>
</div>
<div>
<label for="quantity" th:text="#{label.item.quantity}">수량</label>
<input type="text" id="quantity" th:field="*{quantity}"
class="form-control" placeholder="수량을 입력하세요"
th:classappend="${errors?.containsKey('quantity')} ? 'field-error' : _">
<div class="field-error" th:if="${errors?.containsKey('quantity')}" th:text="${errors['quantity']}">수량 오류</div>
</div>
<hr class="my-4">
<div class="row">
<div class="col">
<button class="w-100 btn btn-primary btn-lg" type="submit" th:text="#{button.save}">상품 등록</button>
</div>
<div class="col">
<button class="w-100 btn btn-secondary btn-lg"
onclick="location.href='items.html'"
th:onclick="|location.href='@{/validation/v1/items}'|"
type="button" th:text="#{button.cancel}">취소</button>
</div>
</div>
</form>
</div> <!-- /container -->
</body>
</html>- 오류 메시지를 빨간색으로 강조하기 위한 css 추가
- 글로벌 오류 메시지 출력
- 타임리프의 th:if를 사용해 조건(errors에 내용이 있음)에 만족할 때만 HTML 태그를 출력
→ ?.(Safe Navigation Operator) 사용
- 타임리프의 th:if를 사용해 조건(errors에 내용이 있음)에 만족할 때만 HTML 태그를 출력
- 필드 오류 메시지 출력
- classappend를 사용해 해당 필드에 오류가 있으면 field-error라는 클래스 정보를 더해 색깔을 빨간색으로 강조하여, 오류 메시지를 출력한다.
- 만약 해당 필드에 오류가 없으면 _(No-Operation)을 사용해 아무것도 하지 않는다.
Safe Navigation Operator
등록 폼에 처음 진입한 시점에는 담긴 errors가 없다.
이 경우 errors.containskey()를 호출하는 순간 NullPointerException이 발생한다.
errors?.는 errors가 null 일때 NullPointerException이 발생하는 대신, null을 반환하는 문법이다.
SpringEl이 제공하는 문법에 대해 더 알아보고 싶다면 여기를 참고하자.
문제점
- 뷰 템플릿에 중복 처리가 많다.
- 타입 오류 처리가 안된다.
- Item의 price, quantity 같은 숫자 필드는 타입이 Integer이므로 문자로 입력될 경우 바인딩 되지 못하고 오류가 발생한다.
- 이러한 타입 오류는 컨트롤러에 진입하기도 전에 예외가 발생하기 때문에, 400 오류가 발생하면서 오류 페이지를 띄워준다.
- 타입 오류가 발생해도 고객이 입력한 문자를 화면에 남겨야 하므로 입력 값이 어딘가에 별도로 관리가 되어야 한다.
검증을 직접 처리한 V1에서는 위와 같이 문제점이 남아있다.
이러한 문제점을 해결하기 위해 지금부터는 스프링이 제공하는 검증 처리 방법을 알아보자.
BindingResult (V2)
BindingResult란 스프링이 제공하는 검증 오류를 보관하는 객체이다.
이전에는 검증 오류가 발생하면 직접 Map을 만들어 errors에 put을 해서 보관해주었다면, 이 errors를 BindingResult가 대체한다.
BindingResult가 있으면 @ModelAttribute에 데이터 바인딩 시 타입 오류가 발생해도 오류 페이지를 띄우는 것이 아니라, 오류 정보를 BindingResult에 담아 컨트롤러를 호출한다.
💡 BindingResult에 검증 오류를 적용하는 3가지 방법
- @ModelAttribute의 객체에 바인딩이 실패하는 경우 스프링이 FieldError를 생성해 BindingResult에 넣어준다.
- 개발자가 직접 넣어준다.
- Validator 사용 (이 방법은 뒤에서 이후에 알아볼 예정)
💡 BindingResult 사용시 주의할 점
- BindingResult는 검증할 대상 바로 다음에 와야 한다. (순서가 중요)
예를 들어 @ModelAttribute 바로 다음에 BindingResult가 와야 한다. - BindingResult는 Model에 자동으로 포함된다.
코드
👉🏻 상품 등록 컨트롤러
📂 ValidationItemControllerV2 - addItemV1
//BindingResult 사용(@ModelAttribute 다음에 위치해야 한다)
@PostMapping("/add")
public String addItemV1(@ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes) {
//검증 로직
if (!StringUtils.hasText((item.getItemName()))) {
bindingResult.addError(new FieldError("item", "itemName", "상품 이름은 필수입니다."));
}
if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
bindingResult.addError(new FieldError("item", "price", "가격은 1,000 ~ 1,000,000까지 허용합니다."));
}
if (item.getQuantity() == null || item.getQuantity() >= 9999) {
bindingResult.addError(new FieldError("item", "quantity", "수량은 최대 9,999까지 허용합니다."));
}
//특정 필드 예외가 아닌 전체 예외
if (item.getPrice() != null && item.getQuantity() != null) {
int resultPrice = item.getPrice() * item.getQuantity();
if (resultPrice < 10000) {
bindingResult.addError(new ObjectError("item", "가격 * 수량의 합은 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}";
}- BindingResult bindingResult
- 오류가 있으면 FieldError, ObjectError 객체를 생성해 bindingResult에 담는다.
- FieldError 생성자
- FieldError(String objectName, String field, String defaultMessage)
- objectName : @ModelAttribute 이름
- field : 오류가 발생한 필드 이름
- defaultMessage : 오류 기본 메시지
- FieldError(String objectName, String field, String defaultMessage)
- ObjectError 생성자
- ObjectError(String objectName, String defaultMessage)
- objectName : @ModelAttribute 이름
- defaultMessage : 오류 기본 메시지
- ObjectError(String objectName, String defaultMessage)
BindingResult 파라미터의 위치는 반드시 @ModelAttribute 다음에 와야 한다.
👉🏻 상품 등록 뷰
📂 resource/templates/validation/v2/addForm.html
<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="utf-8">
<link th:href="@{/css/bootstrap.min.css}"
href="../css/bootstrap.min.css" rel="stylesheet">
<style>
.container {
max-width: 560px;
}
.field-error {
border-color: #dc3545;
color: #dc3545;
}
</style>
</head>
<body>
<div class="container">
<div class="py-5 text-center">
<h2 th:text="#{page.addItem}">상품 등록</h2>
</div>
<form action="item.html" th:action th:object="${item}" method="post">
<div th:if="${#fields.hasGlobalErrors()}">
<p class="field-error" th:each="err : ${#fields.globalErrors()}" th:text="${err}">전체 오류 메시지</p>
</div>
<div>
<label for="itemName" th:text="#{label.item.itemName}">상품명</label>
<input type="text" id="itemName" th:field="*{itemName}"
class="form-control" placeholder="이름을 입력하세요"
th:errorclass="field-error">
<div class="field-error" th:errors="*{itemName}">상품명 오류</div>
</div>
<div>
<label for="price" th:text="#{label.item.price}">가격</label>
<input type="text" id="price" th:field="*{price}"
class="form-control" placeholder="가격을 입력하세요"
th:errorclass="field-error">
<div class="field-error" th:errors="*{price}">가격 오류</div>
</div>
<div>
<label for="quantity" th:text="#{label.item.quantity}">수량</label>
<input type="text" id="quantity" th:field="*{quantity}"
class="form-control" placeholder="수량을 입력하세요"
th:errorclass="field-error">
<div class="field-error" th:errors="*{quantity}">수량 오류</div>
</div>
<hr class="my-4">
<div class="row">
<div class="col">
<button class="w-100 btn btn-primary btn-lg" type="submit" th:text="#{button.save}">상품 등록</button>
</div>
<div class="col">
<button class="w-100 btn btn-secondary btn-lg"
onclick="location.href='items.html'"
th:onclick="|location.href='@{/validation/v2/items}'|"
type="button" th:text="#{button.cancel}">취소</button>
</div>
</div>
</form>
</div> <!-- /container -->
</body>
</html>- 타임리프는 스프링의 BindingResult를 활용해 편리하게 검증 오류를 표현하는 기능을 제공한다.
| #fields | • BindingResult가 제공하는 검증 오류에 접근할 수 있다. |
| th:errors | • 해당 필드에 오류가 있는 경우 태그를 출력한다. • th:if의 편의 버전 |
| th:errorclass | • th:field에서 지정한 필드에 오류가 있으면 class 정보를 추가한다. |
* 더 많은 기능을 보고 싶다면 공식 메뉴얼을 참고하자
문제점
BindingResult, FieldError, ObjectError를 사용해 오류 메시지를 처리하는 방법을 알아봤다.
하지만, 오류가 발생하는 경우 사용자가 입력한 내용이 모두 사라진다는 문제가 있다.
rejectedValue (V2)
사용자가 입력한 오류 값이 화면에 남도록 하려면 어떻게 해야할까?
이 문제를 해결하기 위해 FieldError, ObjectError에 대해 조금더 알아보도록 하자.
💡 FieldError, ObjectError의 두가지 생성자
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)public ObjectError(String objectName, String defaultMessage)
public ObjectError(String objectName, @Nullable String[] codes, @Nullable Object[] arguments, String defaultMessage)- objectName : 오류가 발생한 객체 이름 (@ModelAttribute의 이름)
- field : 오류 필드명
- rejectedValue : 사용자가 입력한 값 (거절된 값)
- bindingFailure : 타입 오류 같은 바인딩 실패인지, 검증 실패인지 구분하는 값 (바인딩 실패시 ture, 검증 실패 시 false)
- codes : 메시지 코드
- arguments : 메시지에서 사용하는 인자
- defaultMessage : 기본 오류 메시지
사용자가 입력한 데이터가 컨트롤러의 @ModelAttribute에 바인딩 되는 시점에 오류가 발생하면 모델에 사용자 입력 값을 유지하기 어렵다. 따라서 오류가 발생한 경우 사용자 입력 값을 별도로 보관해, 검증 오류 발생 시 화면에 다시 출력해줄 수 있어야한다.
FieldError는 오류 발생 시 사용자 입력 값을 저장하는 기능인 rejectedValue를 제공한다.
스프링은 바인딩 실패 오류 발생시 FieldError 객체를 생성해 사용자 입력 값을 rejectedValue에 저장해 사용한다.
코드를 통해 확인해보자.
코드
👉🏻 상품 등록 컨트롤러
📂 ValidationItemControllerV2 - addItemV2
@PostMapping("/add")
public String addItemV2(@ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes) {
//검증 로직
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 처리
- new FieldError("item", "itemName", item.getItemName(), false, null, null, "상품 이름은 필수입니다.")
- rejectedValue에 item.getItemName() 즉 사용자 입력값을 저장한다.
- 여기서는 바인딩이 실패한 것은 아니기 때문에 bindingFailure에 false를 넣어준다.
- new FieldError("item", "itemName", item.getItemName(), false, null, null, "상품 이름은 필수입니다.")
👉🏻 상품 등록 뷰
// 이전과 동일- 타임리프의 사용자 입력값 유지 기능
- th:field="*{price}"
- 정상 상황 : @ModelAttribute를 통해 담긴 모델 객체의 값을 사용해 출력
- 오류 상황 : FieldError에 보관된 값을 사용해 출력
- 스프링의 바인딩 오류 처리
- 타입 오류로 바인딩에 실패할 경우 스프링은 FieldError를 생성해 사용자가 입력한 값을 rejectedValue에 넣어둔다.
- 그리고 해당 오류를 BindingResult에 담아 컨트롤러를 호출하기 때문에 바인딩 실패 시에도 사용자의 오류 메시지를 정상 출력할 수 있도록 한다.
오류 메시지 별도 관리 (V3)
FieldError, ObjectError의 생성자에서 errorCode, arguments는 오류 발생시 오류 코드로 메시지를 찾기 위해 사용된다.
이것을 사용해 오류 메시지를 조금 더 체계적으로 관리하는 방법을 알아보자.
errors 메시지 파일 생성
구분하기 쉽도록 오류 메시지만을 관리하는 별도의 파일로 errors.properties를 생성해준다.
또한, 새로운 메시지 파일을 만들어 줬기 때문에 스프링 부트가 이를 인식할 수 있도록 설정을 추가해주도록 하자.
👉🏻 스프링 부트 메시지 설정 추가
📂 application.properties
spring.messages.basename=messages,errors👉🏻 에러 메세지 관리 파일 추가
📂 resources/errors.properties
required.item.itemName = 상품 이름은 필수입니다.
range.item.price = 가격은 {0} ~ {1} 까지 허용합니다.
max.item.quantity = 수량은 최대 {0} 까지 허용합니다.
totalPriceMin = 가격 * 수량의 합은 {0}원 이상이어야 합니다. 현재 값 = {1}
errors 메시지 파일 적용
errors에 등록한 메시지를 사용하도록 코드를 수정해주도록 하자.
👉🏻 상품 등록 컨트롤러
📂 ValidationItemControllerV2 - addItemV3
/* 에러 메시지 파일 별도로 관리 */
@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() >= 9999) {
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
- errors에서 등록해준 "required.item.itemName"을 사용해 메시지 코드를 지정한다.
- 메시지 코드는 배열로 여러 값을 전달할 수 있는데, 순서대로 매칭을 진행 해 처음 매칭되는 메시지가 사용된다.
- arguments
- Object[]{1000, 1000000}를 사용해 errors에 등록해준 메시지 코드의 {0}, {1}에 치환할 값을 전달한다.
reject, rejectValue (V4)
생성자를 이용해 FieldError와 ObjectError를 만들어주는 과정이 생각보다 번거롭다. 오류 코드를 좀 더 자동화 할 수 있을까?
컨트롤러에서 BindingResult는 검증 해야 할 객체인 @ModelAtrribute 바로 다음에 오도록 약속되어 있다.
따라서 BidingResult는 검증해야 할 객체의 대상을 이미 알고 있다.
BindingResult가 제공하는rejectValue(), reject()를 사용하면 FieldError, ObjectError를 직접 생성하지 않고, 깔끔하게 검증 오류를 다룰 수 있다!
💡 rejectValue, reject
void rejectValue(@Nullable String field, String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage);void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage);- field : 오류 필드명
- errorCode : 오류 코드 (메시지 파일에 등록된 코드가 아님, messageResolber를 위한 오류 코드이다.)
- errorArgs : 오류 메시지에서 {0}을 치환하기 위한 값
- defalutMessage : 오류 메시지를 찾을 수 없을 때 사용하는 기본 메시지
앞에서 말했듯이 BindingResult는 어떤 객체를 대상으로 검증을 하는지 이미 알고 있기 때문에 rejectValue에서는 검증 타겟(item)에 대한 정보가 없어도 된다.
그럼 이제 코드를 통해 검증 로직이 얼마나 깔끔해졌는지 확인해보자.
코드
👉🏻 상품 등록 컨트롤러
📂 ValidationItemControllerV2 - addItemV4
/* rejectValue, reject 사용 */
@PostMapping("/add")
public String addItemV4(@ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes) {
log.info("objectName={}", bindingResult.getObjectName());
log.info("target={}", bindingResult.getTarget());
//검증 로직
if (!StringUtils.hasText((item.getItemName()))) {
bindingResult.rejectValue("itemName", "required");
}
if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
bindingResult.rejectValue("price", "range", new Object[]{1000, 1000000}, null);
}
if (item.getQuantity() == null || item.getQuantity() >= 9999) {
bindingResult.rejectValue("quantity", "max", new Object[]{9999}, null);
}
//특정 필드 예외가 아닌 전체 예외
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/v2/addForm";
}
//성공 로직
Item savedItem = itemRepository.save(item);
redirectAttributes.addAttribute("itemId", savedItem.getId());
redirectAttributes.addAttribute("status", true);
return "redirect:/validation/v2/items/{itemId}";
}- rejectValue 사용시 검증 대상이 되는 객체(item)에 대한 정보가 없어도 된다.
- 오류 코드가 훨씬 단축된 것을 확인할 수 있다.
- rejectValue 사용 이전 : range.item.price
- rejectValue 사용 이후 : range
- 특정 field를 명시할 수 없는 ObjectError의 경우 reject를 사용한다.
오류 코드 전략
오류 코드
오류 코드는 오류 메시지를 찾는데 사용된다. 이러한 오류 코드는 다음과 같이 다양하게 만들 수 있다.
- 세밀
- required.item.itemName : 상품 이름은 필수 입니다.
- range.item.price : 상품의 가격 범위 오류 입니다.
- 단순
- required : 필수 값 입니다.
- range : 범위 오류 입니다.
오류 코드를 단순하게 만들면 범용성이 좋아 여러곳에서 사용할 수 있지만, 상세한 메시지 작성은 어렵다.
반대로 세밀하게 만들면 범용성이 떨어진다.
따라서 범용성으로 사용하다가, 필요 시 세밀한 내용이 적용되도록 메시지에 단계를 두는 것이 좋은 방법이다.
스프링은 MessageCodesResolver을 통해 메시지 코드를 단계적으로 사용할 수 있도록 기능을 지원한다.
MessageCodesResolver
- 검증 오류 코드로 메시지 코드들을 생성한다.
- MessageCodesResolver 인터페이스이고 DefaultMessageCodesResolver는 기본 구현체이다.
- 주로 ObjectError, FieldError와 함께 사용한다.
테스트 코드를 통해 MessageCodesResolver를 알아보도록 하자.
👉🏻 MessageCodesResolverTest
public class MessageCodeResolverTest {
MessageCodesResolver codesResolver = new DefaultMessageCodesResolver();
@Test
void messageCodesResolverObject() {
String[] messageCodes = codesResolver.resolveMessageCodes("required", "item");
assertThat(messageCodes).containsExactly("required.item", "required");
}
@Test
void messageCodesResolverField() {
String[] messageCodes = codesResolver.resolveMessageCodes("required", "item", "itemName", String.class);
assertThat(messageCodes).containsExactly(
"required.item.itemName",
"required.itemName",
"required.java.lang.String",
"required");
}
}- MessageCodesResolver를 통해 여러 오류 코드가 만들어 지는 것을 확인 할 수 있다.
이러한 오류 코드들은 어떻게 만들어지는 것일까?
MessageCodesResolver의 구현체인 DefaultMessageCodesResolver가 어떤 규칙을 통해 오류 코드를 만드는지 알아보도록 하자.
기본 메시지 생성 규칙
DefaultMessageCodesResolver는 다음과 같은 규칙으로 오류 코드를 생성한다.
구체적인 오류코드를 먼저 만들고 덜 구체적인 것을 가장 나중에 만든다.
👉🏻 ObjectError → reject("totalPriceMin")
객체 오류의 경우 다음 순서로 2가지 생성
1.: code + "." + object name
2.: code
예) 오류 코드: code-totalPriceMin, object name-item
1.: totalPriceMin.item
2.: totalPriceMin👉🏻 FieldError → rejectValue("itemName", "required")
필드 오류의 경우 다음 순서로 4가지 메시지 코드 생성
1.: code + "." + object name + "." + field
2.: code + "." + field
3.: code + "." + field type
4.: code
예) 오류 코드: code-required, object name-item, field-itemName, field type-String
1. "required.item.itemName"
2. "required.itemName"
3. "required.java.lang.String"
4. "required"
💡 rejectValue, reject의 동작방식
- rejectValue(), reject()는 내부에서 MessageCodesResolver를 사용해 메시지 코드를 생성한다.
- FieldError, ObjectError의 생성자를 보면 여러개의 오류 코드를 가질 수 있는데, MessageCodesResolver를 통해 생성된 순서대로 오류 코드를 보관한다.
- BindingResult의 로그를 통해 보관된 오류 코드를 확인해 볼 수 있다
→ codes [required.item.itemName, required.itemName, required.String, required
- BindingResult의 로그를 통해 보관된 오류 코드를 확인해 볼 수 있다
오류 메시지 출력
이렇게 생성된 여러개의 오류 코드 중 어떤 코드에 대한 메시지를 뷰에 보여주는 것일까?
타임리프 화면을 렌더링 할 때 th:errors가 실행되면, 오류가 있을 경우 생성된 오류 메시지 코드를 순서대로 돌아가며 메시지를 찾게 된다.
이때 더욱 자세한 오류 코드가 우선순위를 가지고 선택되며, 만약 오류 코드가 없다면 디폴트 메시지를 출력한다.
오류 코드 전략 도입
이제 크게 중요하지 않은 메시지는 범용성 있는 메시지를 사용하고, 정말 중요한 메시지는 필요할 때만 구체적으로 적어서 사용하는 오류 코드 전략을 앞서 만들었던 어플리케이션에 도입해보도록 하자.
👉🏻 errors.properties
#required.item.itemName=상품 이름은 필수입니다.
#range.item.price=가격은 {0} ~ {1} 까지 허용합니다.
#max.item.quantity=수량은 최대 {0} 까지 허용합니다.
#totalPriceMin=가격 * 수량의 합은 {0}원 이상이어야 합니다. 현재 값 = {1}
#==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} 까지 허용합니다.
#==추가==
typeMismatch.java.lang.Integer=숫자를 입력해주세요.
typeMismatch=타입 오류입니다.ObjectError와 FieldError로 나누고, 범용성에 따라 레벨을 나눠 오류 메시지를 등록하였다.
정리
- rejectValue()가 호출되면 스프링은 MessageCodesResolver를 사용해 검증 오류 코드로 메시지 코드들을 생성한다.
- 예) rejectValue("itemName", "required")
- required.item.itemName
- required.itemName
- required.java.lang.String
- required
- 예) rejectValue("itemName", "required")
- new FieldError()/ObjectError()를 생성하며 메시지 코드들을 BindingResult에 보관한다.
- th:errors에서 메시지 코드들로 메시지를 순서대로(구체적인 것에서 덜 구체적인 순서) 찾아 보여준다.
Validator 분리 (V5)
Validator
지금까지의 코드를 보면 컨트롤러에서 검증 로직이 차지하는 부분이 매우 많다. 이런 경우 별도의 클래스로 검증 로직을 분리하는 것이 좋다.
검증 로직을 분리해놓을 경우 검증 로직 재사용도 용이하다.
스프링은 검증을 체계적으로 제공하기 위해 Validator라는 인터페이스를 제공한다.
public interface Validator {
boolean supports(Class<?> clazz);
void validate(Object target, Errors errors);
}- supports() {} : 해당 검증기를 지원하는 여부를 확인
- validate(Object target, Errors errors)
- Object : 검증 대상 객체
- Errors : BindingResult
스프링이 제공하는 Validator를 구현해 검증로직을 분리해주도록 하자.
코드
👉🏻 검증 클래스 생성
📂 validation/ItemValidator
@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 (!StringUtils.hasText((item.getItemName()))) {
errors.rejectValue("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() >= 9999) {
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);
}
}
}
}
👉🏻 상품 등록 컨트롤러
📂 ValidationItemControllerV2 - addItemV5
private final ItemValidator itemValidator; //등록된 스프링 빈을 주입 받아 사용/* Validator 분리 */
@PostMapping("/add")
public String addItemV5(@ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes) {
log.info("objectName={}", bindingResult.getObjectName());
log.info("target={}", bindingResult.getTarget());
itemValidator.validate(item, bindingResult);
//검증에 실패(검증 오류 값이 있을 경우)하면 다시 입력 폼으로
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}";
}별도로 만들어준 검증 클래스(ItemValidator)를 스프링 빈으로 주입 받아 직접 호출해준다.
이렇게 컨트롤러에서 검증과 관련된 부분을 깔끔하게 분리해주었다.
WebDataBinder, @Validated (V6)
앞서 Validator를 구현해 검증 로직을 분리 해준뒤, 검증기를 직접 불러서 사용했다.
이때 Validator 인터페이스를 사용해 검증기를 만들면 직접 호출할 필요 없이 스프링의 추가적인 도움을 받을 수 있다.
WebDataBinder
WebDataBinder는 스프링의 파라미터 바인딩 역할을 하고, 검증 기능 또한 내부에 포함한다.
📂 ValidationItemControllerV2
@InitBinder
public void init(WebDataBinder dataBinder) {
log.info("init binder {}", dataBinder);
dataBinder.addValidators(itemValidator);
}- WebDataBinder에 검증기를 추가하면 해당 컨트롤러에서 검증기를 자동으로 적용할 수 있다
- @InitBinder
- 해당 컨트롤러에만 영향을 주는 어노테이션
- 글로벌 설정은 별도로 해야한다.
@Validated
- 검증기를 실행하라는 어노테이션이다.
- WebDataBinder에 등록한 검증기를 찾아 실행한다.
- 만약 여러 검증기를 등록한다면 어떤 검증기가 실행되어야 할 지 구분이 필요한데, 이때 supports()가 사용된다.
📂 ValidationItemControllerV2 - addItemV6
/* @Validated 사용 (validator 호출 생략) */
@PostMapping("/add")
public String addItemV6(@Validated @ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes) {
//검증에 실패(검증 오류 값이 있을 경우)하면 다시 입력 폼으로
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}";
}- 검증기를 직접 호출하지 않고, 검증 대상 앞에 @Validated가 붙는다.
- 어노테이션 확인 후 스프링은 검증기를 찾아 실행한다.
- 이때 어느 검증기가 실행되어야 할지 구분을 위해 supports()가 사용되는데,
여기서는 supprts(Item.class)의 호출 결과가 true이므로 ItemValidator의 validate()가 호출된다.
검증기 글로벌 설정
@InitBinder로 해당 컨트롤러에만 검증기를 적용하는 것이 아니라, 모든 컨트롤러가 검증기를 사용할 수 있도록 글로벌 설정을 추가해줄 수 있다.
📁 ItemServiceApplication
@SpringBootApplication
public class ItemServiceApplication implements WebMvcConfigurer {
...
@Override
public Validator getValidator() {
return new ItemValidator();
}
}이렇게 글로벌 설정을 추가해주면, 기존 컨트롤러의 @InitBinder를 제거해도 글로벌 설정으로 정상 동작하게 된다.
검증기 글로벌 설정을 해둘 경우 BeanValidator가 자동 등록되지 않는다는 점을 유의하자.
'🗺 RoadMap > Jpa' 카테고리의 다른 글
| [JPA] #7 연관관계 매핑(1) : 단방향 매핑 (0) | 2022.10.06 |
|---|---|
| [JPA] #6 데이터베이스 스키마 자동 생성 : DDL AUTO (0) | 2022.09.30 |
| [JPA] #5 엔티티 매핑(2) - 기본 키 매핑 전략 (1) | 2022.09.30 |
| [JPA] #4 엔티티 매핑(1) - 객체와 테이블, 필드와 컬럼 매핑 (0) | 2022.09.30 |
| [JPA] #3 영속성 관리 (0) | 2022.09.29 |
| [JPA] #2 JPQL : 객체 지향 쿼리 언어 (0) | 2022.09.29 |
| [JPA] #1 JPA 왜 사용할까? (0) | 2022.09.22 |
| [MVC2] #3 Bean Validation (0) | 2022.04.30 |
