검증 기능의 정의

클라이언트로부터 받은 데이터가 비즈니스 규칙을 만족하는지 확인하거나, 데이터가 일관성 있고 안정적인 상태를 유지할 수 있도록 보장해주는 기능

오류 관리와 추적

1. BindingResult

ThymeLeaf에서 검증 오류 표현

ThymeLeaf의 검증 관련 기능 참고

Message 기능 응용

Message 기능을 사용하여 오류 메시지를 효과적으로 관리할 수 있습니다.

1. 오류 Message 설정 파일 생성과 application 설정

src/main/resources/ 경로에 errors.properties 생성

그 후 application.properties에서 errors도 추가해줌

spring.messages.basename=messages, errors

2. errors.properties 내용 추가

# 예시
required.item.itemName=상품 이름은 필수입니다.
range.item.price=가격은 {0} ~ {1} 까지 허용합니다.
max.item.quantity=수량은 최대 {0} 까지 허용합니다.
totalPriceMin=가격 * 수량의 합은 {0}원 이상이어야 합니다. 현재 값 = {1}

3. BindingResult에 메시지 code 관련 파라미터를 추가

String 타입의 배열로 메시지 code를 우선순위대로 추가함

bindingResult.rejectValue("price", "range", new Object[]{1000, 1000000}, null);
bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);

code를 range.item.price가 아닌 range만 추가한 이유

오류 Message 레벨 분류

상세적으로 단계를 나눠서 오류 문구를 관리할 수 있습니다. 예시)

#==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} 까지 허용합니다.

검증 로직 분리

Validator 인터페이스를 구현한 검증 로직을 별도로 분리하여 관리가 가능합니다.

Validator 인터페이스 구조

public interface 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) {
	    ...
	}
}

호출 예시

private final ItemValidator itemValidator;
 
@PostMapping("/add")
public String addItem(
	@ModelAttribute Item item, 
	BindingResult bindingResult, 
	...) {
 
	itemValidator.validate(item, bindingResult);
	...
}

🧑🏻‍💻뒤끝 개발자

탐색기

Spring의 검증(Validation) 기능