[SpringBoot] @Valid에 의한 Validation Errors 발생 시 예외 처리 및 반환

📌 SpringBoot RestController에서 Validation Errors 발생 시 처리

@Valid에 의해 발생한 Validation Error는 기본적으로 Errors 인터페이스 타입의 객체에 담긴다.

따라서 메서드의 인자로 Errors 타입의 객체를 받는지 or 안받는지에 따라 처리가 달라진다.

 

해당 내용은 아래와 같다.

//상황1) Errors 타입 객체를 포함하지 않았을 때 (400 Bad Request 자동 반환)
@PostMapping("/user/sign-up")
public ResponseEntity<SingleResult<UserDto.UserSignUpResDto>> userSignUp(
            @RequestBody @Valid UserDto.UserSignUpReqDto userSignUpReqDto) {
				...
}

//상황2) Errors 타입 객체를 포함했을 때 (if문으로 추가 처리해줘야 함)
@PostMapping("/user/sign-up")
public ResponseEntity<SingleResult<UserDto.UserSignUpResDto>> userSignUp(
            @RequestBody @Valid UserDto.UserSignUpReqDto userSignUpReqDto, Errors errors) {
				...
	if (errors.hasErrors()) { ... }
    			...
}

 

위의 상황1)처럼 Errors errors 가 포함되어 있지 않으면, 아래와 같이 Spring Boot가 자동으로 400 Bad Request를 반환해준다. 이렇게 처리되는 경우 구체적인 에러 내용을 확인할 수 없다.

{
    "timestamp": "2022-04-04T08:38:40.322+00:00",
    "status": 400,
    "error": "Bad Request",
    "path": "/v3/user/sign-up"
}

구체적인 에러 내용을 확인하려면, @RestControllerAdvice와 @ExceptionHandler를 사용해 @Valid 유효성을 통과하지 못했을 때 기본으로 발생하는 MethodArgumentValidException 예외에 대한 반환 값 처리를 해줘야 한다.

 

반면, 위의 상황2)처럼 Errors errors가 포함되어 있다면, 반드시 if문으로 처리를 해줘야 한다.

처리를 따로 해주지 않으면 자동으로 예외 반환이 되지 않고, 그냥 200 OK로 나온다.

 

📌 @RestControllerAdvice & @ExceptionHandler로 예외 처리하기

위에서 언급했듯이 @Valid의 유효성을 통과하지 못하면, 기본으로 MethodArgumentValidException이 발생한다.

만약 해당 예외말고 Custom Exception을 발생시키려면, 아래와 같이 Errors가 존재하는지 확인한 뒤 throw를 해줘야 한다.

public ResponseEntity<SingleResult<UserDto.UserSignUpResDto>> userSignUp(
            @RequestBody @Valid UserDto.UserSignUpReqDto userSignUpReqDto, Errors errors) {
				...

        if(errors.hasErrors()) {
            throw new ApiParamNotValidException(errors);
        }

        ...
}

 

Custom Exception에 대한 처리는 아래와 같이 @RestControllerAdvice와 @ExceptionHandler를 사용해 직접 예외 처리 구성을 해줘야 한다. 그렇지 않으면, 500 Internal Server 에러가 발생한다.

@RestControllerAdvice
public class ExceptionAdvice {

    /**
     * @valid 유효성 검사 통과하지 못하면 발생하는 커스텀 예외에 대한 처리
     */
    @ExceptionHandler(ApiParamNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    protected SingleResult<Errors> apiParamNotValid(HttpServletRequest httpServletRequest, ApiParamNotValidException e) {

        return new SingleResult<>(e.getErrors());
    }
}

 

📌 API 응답으로 구체적인 에러 내용 반환하기

▶️ 상황

@RestControllerAdvice
public class ExceptionAdvice {

	@ExceptionHandler(ApiParamNotValidException.class)
  	@ResponseStatus(HttpStatus.BAD_REQUEST)
  	protected SingleResult<Errors> apiParamNotValid(HttpServletRequest httpServletRequest, ApiParamNotValidException e) { 
            return new SingleResult<>(e.getErrors());
  	}
}

위와 같이 전달받은 Errors 객체를 응답으로 바로 반환하려 하였다.

Caused by: com.fasterxml.jackson.databind.exc.InvalidDefinitionException: No serializer found for class org.springframework.validation.DefaultMessageCodesResolver and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS)

위와 같은 오류가 발생하게 된다.

 

▶️ 원인

• 기본적인 도메인들은 Java Bean 스펙을 따르기 때문에 BeanSerializer에 의해 JSON Serialization이 가능하다. Spring이 사용하는 ObjectMapper에는 여러 Serializer가 등록되어 있다.
• Errors 인터페이스의 경우 Java Bean 스펙을 따르지 않기 때문에 정의되어 있는 Seriazlier가 없어 Serialization 할 수 없다. 따라서 위와 같이 'No serializer found for class' 에러가 발생한 것이다.

 

▶️ 해결

@JsonComponent와 JsonSerializer의 serialize() 메서드를 오버라이딩한 클래스를 정의하여 Errors에 대한 Serializer를 만들어 해결이 가능하다.

@JsonComponent
public class ErrorsSerializer extends JsonSerializer<Errors> {

    @Override
    public void serialize(Errors errors, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeStartArray();

        errors.getFieldErrors().forEach(e -> {  //field
            try {
                gen.writeStartObject();

                gen.writeStringField("field", e.getField());
                gen.writeStringField("defaultMessage", e.getDefaultMessage());

                Object rejectedValue = e.getRejectedValue();
                if(rejectedValue != null) {
                    gen.writeStringField("rejectedValue", rejectedValue.toString());
                }

                gen.writeEndObject();
            } catch (IOException ioException) {
                ioException.printStackTrace();
            }
        });

        errors.getGlobalErrors().forEach(e -> { //global
            try {
                gen.writeStartObject();

                gen.writeStringField("defaultMessage", e.getDefaultMessage());

                gen.writeEndObject();
            } catch (IOException ioException) {
                ioException.printStackTrace();
            }
        });

        gen.writeEndArray();
    }
}

• @JsonComponent - ObjectMapper에 해당 Serializer를 등록해준다.
• JsonGenerator의 writeArray()를 통해 여러 에러 내용을 담는다.
• 발생한 fieldErrors들의 field, defaultMessage, rejectedValue 값만 반환하도록 구성하였다.

 

👩🏻‍💻 전체 코드 확인 → spring-validation-practice

 

📌 위와 같이 구성한 이유

처음에는 위와 같이 ErrorsSerializer를 구성하지 않고, Errors 타입 객체에서 필요한 값들만 뽑아서 반환하는 메서드를 생성해서 사용했다. 하지만 Errors 타입 객체가 생성되는 모든 상황에서 코드를 추가하지 않고 동일한 형태로 에러를 반환해주기 위해서는 Serializer를 구성하는게 더 용이하다는 생각이 들어 해당 방안으로 수정하였다.

 

 

 

🎈참고

• https://cchoimin.tistory.com/entry/Valid-와-ControllerAdvice로-DTO-예외처리하기

• https://100100e.tistory.com/383
• https://sas-study.tistory.com/344
• https://bepoz-study-diary.tistory.com/191