[Spring] errors 오류 코드 관리 전략과 타입 오류 처리 + ValidationUtils 사용

오류 코드 관리 전략의 핵심은

구체적인 것에서 덜 구체적인 것으로 정의하는 것이다.

MessageCodesResolver 는 required.item.itemName 처럼 구체적인 것을 먼저 만들어주고,

required 처럼 덜 구체적인 것을 가장 나중에 만든다.

이렇게 하면 앞서 말한 것 처럼 메시지와 관련된 공통 전략을 편리하게 도입할 수 있다.

 

모든 오류 코드에 대해서 메시지를 각각 다 정의하기가 힘들다

크게 중요하지 않은 메시지는 범용성 있는 required 같은 메시지로 끝내고,

정말 중요한 메시지는 꼭 필요할 때 구체적으로 적어서 사용하는 방식이 더 효과적이다.

 

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

 

크게 객체 오류와 필드 오류를 나누고, 범용성에 따라 레벨을 나눈 설정이다.

 

itemName의 경우, required 검증 오류 메시지가 발생하면 다음 코드 순서대로 메시지가 생성된다.

1. required.item.itemName

2. required.itemName

3. required.java.lang.String

4. required

 

그리고 이렇게 생성된 메시지 코드를 기반으로 순서대로 MessageSource 에서 메시지에서 찾는다.

구체적인 것에서 덜 구체적인 순서대로 찾는다.

메시지에 1번이 없으면 2번을 찾고, 2번이 없으면 3번을 찾는다.

이렇게 되면 만약에 크게 중요하지 않은 오류 메시지는 기존에 정의된 것을 그냥 재활용 하면 된다!

 

오류 코드를 메시지로 관리하는 가장 큰 핵심은 바로 소스코드로 관리하지 않고,

메시지 정의 파일로 오류코드를 관리하는 것이 가장 큰 핵심이다.

 

불필요한 소스코드 수정이 필요하지 않고, 메시지 파일만 수정해주면 오류 내용을 손쉽게 반영할 수 있다.

 

실행

 - Level1 전부 주석 처리

 - Level2,3 전부 주석 처리

 - Level4 전부 주석 처리 → 못찾으면 코드에 작성한 디폴트 메시지를 사용한다.

 - Object 오류도 Level1, Level2로 재활용 가능하다.

 

Level 4 디폴트 메시지 반환

 

ValidationUtils

 

ValidationUtils 사용 전

if (!StringUtils.hasText(item.getItemName())) {
	bindingResult.rejectValue("itemName", "required", "기본: 상품 이름은 필수입니다.");
}

 

ValidationUtils 사용 후

다음과 같이 한줄로 가능, 제공하는 기능은 Empty , 공백 같은 단순한 기능만 제공

ValidationUtils.rejectIfEmptyOrWhitespace(bindingResult, "itemName", "required");

 

ValidationUtils 동작 방식

(1) rejectValue() 호출

(2) MessageCodeResolver를 사용해서 검증 오류 코드로 메시지 코드들을 생성

(3) new FieldError()를 생성하면서 메시지 코드들을 보관

(4) th:errors에서 메시지 코드들로 메시지를 순서대로 메시지에서 찾고, 노출

 

스프링이 직접 만든 오류 메시지 처리 - 타입 오류

 

검증 오류 코드는 다음과 같이 2가지로 나눌 수 있다.

 - 개발자가 직접 설정한 오류 코드 rejectValue() 를 직접 호출

 - 스프링이 직접 검증 오류에 추가한 경우(주로 타입 정보가 맞지 않음)

 

price 필드에 문자 "A" 를 입력해보면 

price 필드에 A 입력 후 결과

 

콘솔 에러

로그를 확인해보면 BindingResult에 FieldError가 담겨있고, 다음과 같은 메시지 코드들이 생성된 것을 확인할 수 있다.

TypeMisMatch

다음과 같이 4가지 메시지 코드가 입력되어 있다.

- typeMismatch.item.price

- typeMismatch.price

- typeMismatch.java.lang.Integer

- typeMismatch

 

그렇다. 스프링은 타입 오류가 발생하면 typeMismatch 라는 오류 코드를 사용한다.

이 오류 코드가 MessageCodesResolver 를 통하면서 4가지 메시지 코드가 생성된 것이다.

 

실행해보면,

아직 errors.properties 에 메시지 코드가 없기 때문에 스프링이 생성한 기본 메시지가 출력된다.

Failed to convert property value of type java.lang.String to required type java.lang.Integer for property price;

nested exception is java.lang.NumberFormatException: For input string: "A"

 

error.properties 에 다음 내용을 추가하자

#추가
typeMismatch.java.lang.Integer=숫자를 입력해주세요.
typeMismatch=타입 오류입니다.

 

다시 실행해보자

결과적으로 소스코드를 하나도 건들지 않고, 원하는 메시지를 단계별로 설정할 수 있다.

 

TypeMismatch 적용 결과

 

정리

메시지 코드 생성 전략은 그냥 만들어진 것이 아니다.

조금 뒤에서 Bean Validation을 학습하면 그 진가를 더 확인할 수 있다.