[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๋ฅผ ์ถ”๊ฐ€ํ•œ๋‹ค.

๊ฒ€์ฆ ์ˆœ์„œ

  1. @ModalAttribute ๊ฐ๊ฐ์˜ ํ•„๋“œ์— ํƒ€์ž… ๋ณ€ํ™˜์‹œ๋„
    1. ์„ฑ๊ณตํ•˜๋ฉด ๋‹ค์Œ์œผ๋กœ
    2. ์‹คํŒจํ•˜๋ฉด typeMismatch๋กœ FieldError ์ถ”๊ฐ€
  2. 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 ๋‹จ๊ณ„์—์„œ ๋ฐ”์ธ๋”ฉํ•  ๋–ˆ ์ „์ฒด ๊ฐ์ฒด ๋‹จ์œ„๋กœ ์ ์šฉ๋œ๋‹ค. ๋”ฐ๋ผ์„œ ํ•œ ํ•„๋“œ์—์„œ ๋ฐ”์ธ๋”ฉ ์˜ค๋ฅ˜๊ฐ€ ๋ฐœ์ƒํ•œ๋‹ค๋ฉด ์ „์ฒด ํ•„๋“œ๊ฐ€ ์ฒ˜๋ฆฌ๋˜์ง€ ์•Š๊ณ  ์˜ˆ์™ธ๊ฐ€ ๋ฐœ์ƒํ•œ๋‹ค.

์ถœ์ฒ˜

๊น€์˜ํ•œ์˜ ์Šคํ”„๋ง MVC 2ํŽธ