[spring] ํ๋ผ๋ฏธํฐ validation
BindingResult
HTTP ๋ฉ์ธ์ง ์ปจ๋ฒํฐ์์ ๋ฐ์ํ ๋ฐ์ดํฐ ๋ฐ์ธ๋ฉ ์ค๋ฅ๋ฅผ ๋ด์ ์ปจํธ๋กค๋ฌ์์ ์ด์ฉํ ์ ์๋ ๊ฐ์ฒด. ๋ค์๊ณผ ๊ฐ์ด ๋ฐ์ธ๋ฉ ์ค๋ฅ๊ฐ ๋ฐ์ํ ์ ์๋ ํ๋ผ๋ฏธํฐ ๋ฐ๋ก ๋ค์์ ํ๋ผ๋ฏธํฐ๋ก์ ์ถ๊ฐํ๋ค.
@PostMapping("/add")
public String addItemV1(@ModelAttribute Item item, BindingResult bindingResult)์ปจํธ๋กค๋ฌ์์ ๋ฐ์ดํฐ ๋ฐ์ธ๋ฉ ์ค๋ฅ๊ฐ ๋ฐ์ํ๋ฉด 400 ์ค๋ฅ๋ฅผ ํด๋ผ์ด์ธํธ๋ก ์ ๋ฌํ๋ค. ํ์ง๋ง ์์ ๊ฐ์ด BindingResult๋ฅผ ํ๋ผ๋ฏธํฐ์ ์ถ๊ฐํ๋ฉด, 400 ์ค๋ฅ๋ฅผ ๋ฐ๋ก ๋ณด๋ด์ง ์๊ณ ์ปจํธ๋กค๋ฌ๋ฅผ ํธ์ถํ์ฌ ๊ฐ๋ฐ์์๊ฒ ์ค๋ฅ๋ฅผ ํด๊ฒฐํ๋๋ก ํ๋ค.
@PostMapping("/add")
public String addItemV1(@ModelAttribute Item item, BindingResult bindingResult) {
// ์์ผ๋ฉด ๋ฐ๋ก 400 ์ค๋ฅ๋ฅผ ๋ณด๋
if (bindingResult.hasErrors()) {
log.info("errors={}", bindingResult);
return "validation/v2/addForm";
}
...
}BindingResult ๊ฐ์ฒด๋ thymeleaf ๋ฑ์์ ์ฌ์ฉํ ์ ์๋ค. th:errors="*{itemName}" ๊ณผ ๊ฐ์ด ์ ๊ทผํ ์ ์๋๋ฐ, ์ด๋ฅผ ์ํด์ ๊ฐ๋ฐ์๊ฐ ์์๋ก BindingResult์ ์ค๋ฅ๋ฅผ ์ถ๊ฐํด ์ค ์ ์๋ค.
// FieldError : ํ๋์ ํ๋์ ์ค๋ฅ๊ฐ ์์ ๋ ์ถ๊ฐํ๋ ๊ฐ์ฒด. ์คํ๋ง์์ ๋ฐ์ธ๋ฉ ์ค๋ฅ์ ๋ฃ์ด์ค
bindingResult.addError(new FieldError("item", "itemName", "์ํ ์ด๋ฆ์ ํ์์
๋๋ค."));
// ObjectError : ํน์ ํ๋๊ฐ ์๋ ์ฌ๋ฌ ํํธ์ ๊ฑธ์ณ ๋ฐ์ํ๊ฑฐ๋, ๊ธ๋ก๋ฒ ์ค๋ฅ์ผ ๋ ์ถ๊ฐ
bindingResult.addError(new ObjectError("item", "๊ฐ๊ฒฉ * ์๋์ ํฉ์ 10,000์ ์ด์์ด์ด์ผ ํฉ๋๋ค. ํ์ฌ ๊ฐ = " + resultPrice));๊ฐ๊ฐ ํ์๋ฆฌํ์์ ์ ๊ทผ์ ๋ค์๊ณผ ๊ฐ์ด ํ๋ค.
<!-- FieldError -->
<div class="field-error" th:errors="*{itemName}">
์ํ๋ช
์ค๋ฅ
</div>
<!-- ObjectError -->
<div th:if="${#fields.hasGlobalErrors()}">
<p class="field-error" th:each="err : ${#fields.globalErrors()}" th:text="${err}">
์ ์ฒด ์ค๋ฅ ๋ฉ์์ง
</p>
</div>Errors
BindingResult์ ์ธํฐํ์ด์ค์ด๊ณ , Errors ์ธํฐํ์ด์ค๋ฅผ ์์๋ฐ๊ณ ์๋ค. ์คํ๋ง์์๋ BeanPropertyBindingResult๋ผ๋ ๊ตฌํ์ฒด๋ก ๋ ๋ค ๊ตฌํํ์ฌ ๋๊ฒจ์ฃผ๋๋ฐ, ๋ฐ๋ผ์ BindingResult ๋์ Errors ์ธํฐํ์ด์ค๋ฅผ ์ฌ์ฉํด๋ ๋๋ค.
ํ์ง๋ง Errors๋ ๋จ์ ์ค๋ฅ ์ ์ฅ, ์กฐํ๋ง์ ํฌํจํ๊ณ BindingResult๋ ์ข ๋ ๋ค์ํ ๊ธฐ๋ฅ์ ์ ๊ณตํ๋ค. ๋ํ ๊ด๋ก์ ์ผ๋ก BindingResult๋ฅผ ์ฌ์ฉํ๋ BindingResult๋ฅผ ์ฌ์ฉํ๋ ๊ฒ์ด ์ข๋ค.
Validator
์คํ๋ง์ ๊ฒ์ฆ์ ์ฒด๊ณ์ ์ผ๋ก ์ ๊ณตํ๊ธฐ ์ํด ๋ค์ ์ธํฐํ์ด์ค๋ฅผ ์ ๊ณตํ๋ค
public interface Validator {
// ์ด validator์์ ์ง์ํ๋ ํด๋์ค์ธ์ง ํ์ธ
boolean supports(Class<?> clazz);
// ๊ฒ์ฆ ๋ก์ง
void validate(Object target, Errors errors);
}์ด ์ธํฐํ์ด์ค๋ฅผ ์ฌ์ฉํด์ ๋ค์๊ณผ ๊ฐ์ด ๊ตฌํํ์๋ค๊ณ ํด๋ณด์.
@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;
if (item.getPrice() != null && item.getQuantity() != null) {
int resultPrice = item.getPrice() * item.getQuantity();
if (resultPrice < 10000) {
errors.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
}
}
}
}์ด๋ ๊ฒ ๊ตฌํํ validator๋ ์คํ๋ง์ WebDataBinder๋ฅผ ํตํด ์คํ๋ง์ ๋์์ ๋ฐ์ ์ ์๋ค. ์ปจํธ๋กค๋ฌ์ ๋ค์๊ณผ ๊ฐ์ด @InitBinder ์ค์ ์ ํ ๋ฉ์๋๋ฅผ ์ถ๊ฐํ๋ฉด, ํด๋น ์ปจํธ๋กค๋ฌ์์๋ validator๋ฅผ ์๋์ผ๋ก ์ ์ฉํ ์ ์๋ค.
@InitBinder
public void init(WebDataBinder dataBinder) {
dataBinder.addValidators(itemValidator);
}์ด๋ ๊ฒ ๋ฑ๋ก๋ ๊ฒ์ฆ๊ธฐ๋ฅผ ์ฌ์ฉํ๋ ค๋ฉด ์ปจํธ๋กค๋ฌ ๋ฉ์๋ ํ๋ผ๋ฏธํฐ์ @Validated ๋๋ @Valid ์ ๋
ธํ
์ด์
์ ์ถ๊ฐํ๋ฉด ๋๋ค,
@PostMapping("/add")
public String addItemV6(@Validated @ModelAttribute Item item, BindingResult bindingResult)๊ธ๋ก๋ฒ๋ก ๋ชจ๋ ์ปจํธ๋กค๋ฌ์ ๋ฑ๋กํ ์๋ ์๋ค. @SpringBootApplication ์ ๋
ธํ
์ด์
์ด ๋ถ์ ๋ฃจํธ ํด๋์ค์์ validator๋ฅผ ์ถ๊ฐํด์ฃผ๋ฉด ๋๋ค.
@SpringBootApplication
public class ItemServiceApplication implements WebMvcConfigurer {
public static void main(String[] args) {
SpringApplication.run(ItemServiceApplication.class, args);
}
// ๊ธ๋ก๋ฒ ์ ์ฉ
@Override
public Validator getValidator() {
return new ItemValidator();
}
}Bean Validation
์ ๋ ธํ ์ด์ ์ผ๋ก ์ฝ๊ฒ ๊ฒ์ฆ ๋ก์ง์ ์ ์ฉํ ์ ์๋ Bean Validation 2.0(JSR-380) ๊ธฐ์ ํ์ค์ด๋ค. ๊ฒ์ฆ ์ ๋ ธํ ์ด์ ๊ณผ ์ฌ๋ฌ ์ธํฐํ์ด์ค์ ๋ชจ์์ด๋ค.
์คํ๋ง์์ Bean Validation์ ์ฌ์ฉํ๊ธฐ ์ํด์ spring-boot-starter-validation๋ผ์ด๋ธ๋ฌ๋ฆฌ๋ฅผ ์์กด์ฑ์ ์ถ๊ฐํด์ผํ๋ค. ์ถ๊ฐ ํ ์ฌ์ฉํ ๋, ๊ฒ์ฆํ๊ณ ์ํ๋ ํ๋ ์์ ๊ฒ์ฆํ ์ ๋
ธํ
์ด์
์ ์ถ๊ฐํ๋ฉด ๋๋ค.
@Data
public class Item {
private Long id;
@NotBlank
private String itemName;
@NotNull
@Range(min = 1000, max = 1000000)
private Integer price;
}๊ทธ๋ฆฌ๊ณ ์ปจํธ๋กค๋ฌ์ @Validated ๋๋ @Valid๋ฅผ ์ถ๊ฐํด์ฃผ๋ฉด ๋๋ค.
@PostMapping("/add")
public String addItem(@Validated @ModelAttribute Item item, BindingResult bindingResult)javax.validation.constraints.NotNull
org.hibernate.validator.constraints.Range
javax.validation ์ผ๋ก ์์ํ๋ฉด ํน์ ๊ตฌํ์ ๊ด๊ณ์์ด ์ ๊ณต๋๋ ํ์ค ์ธํฐํ์ด์ค์ด๊ณ , org.hibernate.validator ๋ก ์์ํ๋ฉด ํ์ด๋ฒ๋ค์ดํธ validator ๊ตฌํ์ฒด๋ฅผ ์ฌ์ฉํ ๋๋ง ์ ๊ณต๋๋ ๊ฒ์ฆ ๊ธฐ๋ฅ์ด๋ค. ์ค๋ฌด์์ ๋๋ถ๋ถ ํ์ด๋ฒ๋ค์ดํธ validator๋ฅผ ์ฌ์ฉํ๋ฏ๋ก ์์ ๋กญ๊ฒ ์ฌ์ฉํด๋ ๋๋ค.
์คํ๋ง์ Bean Validator๋ฅผ ์ด๋ฏธ ์คํ๋ง์ ์์ ํ ํตํฉํด๋์๋ค. ์คํ๋ง๋ถํธ๋ spring-boot-starter-validation ๋ผ์ด๋ธ๋ฌ๋ฆฌ๋ฅผ ๋ฃ์ผ๋ฉด ์๋์ผ๋ก Bean Validator๋ฅผ ์ธ์งํ๊ณ ์คํ๋ง์ ํตํฉํ๋ค. ์ด๋ ์คํ๋ง๋ถํธ๋ ์๋์ผ๋ก Bean Validator๋ฅผ ๊ธ๋ก๋ฒ Validator๋ก ๋ฑ๋กํ๋ค.
์ด๋ ๊ฐ๋ฐ์๊ฐ ์ง์ ๊ธ๋ก๋ฒ Validator๋ฅผ ๋ฑ๋กํ๋ฉด ์คํ๋ง๋ถํธ๊ฐ ์ถ๊ฐํ๋ Bean Validator๋ฅผ ์ ์ฉ๋์ง ์๋๋ค. ๋ฐ๋ผ์ Bean Validator๋ฅผ ์ฌ์ฉํ ๋๋ ์ง์ ๋ฑ๋กํ ๊ธ๋ก๋ฒ Validator๋ฅผ ์ง์์ฃผ์.
๊ฒ์ฆ ์์
Bean Validator๋ ๋ฐ์ธ๋ฉ ๋ ๋ฐ์ดํฐ๋ค์ ๊ฒ์ฆํ๋ค. ๋ฐ๋ผ์ ์ ์ด์ ๋ฐ์ธ๋ฉ์์ ์คํจํ๋ค๋ฉด Bean Validator๋ ์คํ๋์ง ์๊ณ FieldError๋ฅผ ์ถ๊ฐํ๋ค.
๊ฒ์ฆ ์์
- @ModalAttribute ๊ฐ๊ฐ์ ํ๋์ ํ์ ๋ณํ์๋
- ์ฑ๊ณตํ๋ฉด ๋ค์์ผ๋ก
- ์คํจํ๋ฉด typeMismatch๋ก FieldError ์ถ๊ฐ
- Validator ์ ์ฉ
์ค๋ธ์ ํธ ์ค๋ฅ
Bean Validator์์ ํน์ ํ๋๊ฐ ์๋ ObjectError๋ฅผ ์ฒ๋ฆฌํ๊ธฐ ์ํด์ @ScriptAssert()๋ฅผ ์ฌ์ฉํ๋ฉด ๋๋ค.
@Data
@ScriptAssert(lang = "javascript", script = "_this.price * _this.quantity >= 10000")
public class Item {
//...
}ํ์ง๋ง ์ด ๋ฐฉ๋ฒ์ ์ ์ฝ์ด ๋ง๊ณ ๋ณต์กํ๋ค. ๊ทธ๋ฆฌ๊ณ ์ค๋ฌด์์๋ ๊ฒ์ฆ๊ธฐ๋ฅ์ด ํด๋น ๊ฐ์ฒด ๋ฒ์๋ฅผ ๋์ด์๋ ๊ฒฝ์ฐ๋ ์ข ์ข ๋ฑ์ฅํ๋ค(DB ์กฐํ ๋ฑ). ๋ฐ๋ผ์ Bean Validator์์ ObjectError๋ @ScriptAssert()๋ฅผ ์ฌ์ฉํ๊ธฐ ๋ณด๋จ ์ปจํธ๋กค๋ฌ์์ ์ง์ ์๋ฐ์ฝ๋๋ก ์์ฑํ๋ ๊ฒ์ ๊ถ์ฅํ๋ค.
groups
๋ค์๊ณผ ๊ฐ์ด ๊ฒ์ฆ ์ ๋ ธํ ์ด์ ์ ๊ทธ๋ฃน์ง์ด ๊ฒฝ์ฐ์ ๋ฐ๋ผ ๋ค๋ฅธ ๊ฒ์ฆ ์ ๋ ธํ ์ด์ ์ด ๋์ํ๋๋ก ์ค์ ํ ์ ์๋ค
@Data
public class Item {
@NotNull(groups = UpdateCheck.class)
private String itemName;
@NotNull(groups = {SaveCheck.class, UpdateCheck.class})
@Range(min = 1000, max = 1000000, groups = {SaveCheck.class, UpdateCheck.class})
private Integer price;
}// SaveCheck ๊ทธ๋ฃน์ ์ ๋
ธํ
์ด์
๋ง validation ์ ์ฉ
@PostMapping("/add")
public String addItemV2(@Validated(SaveCheck.class) @ModelAttribute Item item, BindingResult bindingResult)์ด๋ @Valid ์ ๋
ธํ
์ด์
์๋ groups ๊ธฐ๋ฅ์ด ์๋ค. ๋ฐ๋ผ์ ์ด๋๋ @Validated๋ฅผ ์ฌ์ฉํด์ผํ๋ค.
ํ์ง๋ง groups ๊ธฐ๋ฅ์ ์ฌ์ฉํ๋ฉด ์ฝ๋์ ๋ณต์ก๋๊ฐ ์ฆ๊ฐํด์ ๋ณดํต groups ๊ธฐ๋ฅ์ ์ฌ์ฉํ๊ธฐ๋ณด๋ค๋ ๊ฒ์ฆ์ ๋ฌ๋ฆฌํด์ผํ๋ ๊ทธ๋ฃน๋ง๋ค ๋ฐ๋ก ๊ฐ์ฒด๋ฅผ ์์ฑํด์ ์ฒ๋ฆฌํ๋ ํธ์ด๋ค.
@ModelAttribute vs @RequestBody
Bean Validation์ @RequestBody๋ฅผ ์ ์ฉํ์ฌ ํ๋ผ๋ฏธํฐ๋ฅผ ๋ฐ์์ฌ ๋๋ ๋์ํ๋ค. ํ์ง๋ง ๊ฐ์ฒด๋ฅผ ๋ฐ์ธ๋ฉํ ๋์ ๋์์ ๋ค์ ๋ค๋ฅด๋ค.
@ModelAttribute์์๋ ํ๋ ๋จ์๋ก ๋ฐ์ธ๋ฉ์ด ์ ์ฉ๋๋ค. ๋ฐ๋ผ์ ํ ํ๋์์ ๋ฐ์ธ๋ฉ ์คํจ๊ฐ ๋ฐ์ํ์ ๊ฒฝ์ฐ์ ๋๋จธ์ง ํ๋๋ ์ ์ ์ฒ๋ฆฌํ๊ณ validation์ ์ํํ๋ค.
ํ์ง๋ง @RequestBody์ HttpMessageConver ๋จ๊ณ์์ ๋ฐ์ธ๋ฉํ ๋ ์ ์ฒด ๊ฐ์ฒด ๋จ์๋ก ์ ์ฉ๋๋ค. ๋ฐ๋ผ์ ํ ํ๋์์ ๋ฐ์ธ๋ฉ ์ค๋ฅ๊ฐ ๋ฐ์ํ๋ค๋ฉด ์ ์ฒด ํ๋๊ฐ ์ฒ๋ฆฌ๋์ง ์๊ณ ์์ธ๊ฐ ๋ฐ์ํ๋ค.