[API 예외 처리] 스프링이 제공하는 ExceptionResolver (ResponseStatus, DefaultHandler)

 

스프링 부트가 기본으로 제공하는 ExceptionResolver는 다음과 같습니다.

HandlerExceptionResolverComposite 에 다음 순서로 등록됩니다.

1. ExceptionHandlerExceptionResolver

2. ResponseStatusExceptionResolver

3. DefaultHandlerExceptionResolver 우선순위가 가장 낮습니다.

 

ExceptionHandlerExceptionResolver

@ExceptionHandler을 처리한다. API 예외 처리는 대부분 이 기능으로 해결한다. 다음 글에서 다루겠습니다.

 

ResponseStatusExceptionResolver

HTTP 상태 코드를 지정해준다.

예) @ResponseStatus(value = HttpStatus.NOT_FOUND)

 

DefaultHandlerExceptionResolver

스프링 내부 기본 예외를 처리합니다.

 

이번에는 ResponseStatusExceptionResolver과DefaultHandlerExceptionResolver을 알아보겠습니다.

 

ResponseStatusExceptionResolver

ResponseStatusExceptionResolver는 예외에 따라서 HTTP 상태 코드를 지정해주는 역할을 합니다.

다음 두 가지 경우를 처리합니다.

 

• @ResponseStatus 가 달려있는 예외
• ResponseStatusException 예외

 

예외에 다음과 같이 @ResponseStatus 애노테이션을 적용하면 HTTP 상태 코드를 변경해줍니다.

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "error.bad")
public class BadRequestException extends RuntimeException {
}

 

Controller

@GetMapping("/api/response-status-ex1")
public String responseStatusEx1() {
        throw new BadRequestException();
}

BadRequestException 예외가 컨트롤러 밖으로 넘어가면 ResponseStatusExceptionResolver 예외가 해당 애노테이션을 확인해서, 오류 코드를 HttpStatus.BAD_REQUEST(400)으로 변경하고, 메시지도 담습니다.

ResponseStatusExceptionResolver 코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason)를 호출하는 것을 확인할 수 있습니다.

sendError(400)를 호출했기 때문에 WAS에서 다시 오류 페이지( /error )를 내부 요청합니다.

 

실행

http://localhost:8080/api/response-status-ex1

{
    "status": 400,
    "error": "Bad Request",
    "exception": "hello.exception.exception.BadRequestException",
    "message": "잘못된 요청 오류",
    "path": "/api/response-status-ex1"
}

 

메시지 기능

reason 을 MessageSource 에서 찾는 기능도 제공합니다. reason = "error.bad"

messages.properties

error.bad=잘못된 요청 오류입니다. 메시지 사용

메시지 사용 결과

{
    "status": 400,
    "error": "Bad Request",
    "exception": "hello.exception.exception.BadRequestException",
    "message": "잘못된 요청 오류입니다. 메시지 사용",
    "path": "/api/response-status-ex1"

}

 

 

@ResponseStatus는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없습니다. (애노테이션을 직접 넣어야 하는데, 내가 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에는 적용할 수 없습니다.)

추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵습니다. 이때는 ResponseStatusException 예외를 사용하면 됩니다.

@GetMapping("/api/response-status-ex2")
public String responseStatusEx2() {
        throw new ResponseStatusException(HttpStatus.NOT_FOUND, "error.bad", new IllegalArgumentException());
}

 

DefaultHandlerExceptionResolver

DefaultHandlerExceptionResolver는 스프링 내부에서 발생하는 스프링 예외를 해결합니다.

대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException이 발생하는데, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로 500 오류가 발생합니다.

그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제입니다.

HTTP에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어 있습니다.

DefaultHandlerExceptionResolver는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로 변경합니다.

스프링 내부 오류를 어떻게 처리할지 수많은 내용이 정의되어 있습니다.

 

코드 확인

DefaultHandlerExceptionResolver.handleTypeMismatch 를 보면 다음과 같은 코드를 확인할 수 있습니다.

response.sendError(HttpServletResponse.SC_BAD_REQUEST) (400)

결국 response.sendError()를 통해서 문제를 해결합니다.

sendError(400)를 호출했기 때문에 WAS에서 다시 오류 페이지( /error )를 내부 요청합니다.

 

@GetMapping("/api/default-handler-ex")
public String defaultException(@RequestParam Integer data) {
        return "ok";
}

Integer data 에 문자를 입력하면 내부에서 TypeMismatchException 이 발생합니다.

 

실행

http://localhost:8080/api/default-handler-ex?data=hello&message=

{
    "status": 400,
    "error": "Bad Request",
    "exception": "org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
    "message": "Failed to convert value of type 'java.lang.String' to required type 'java.lang.Integer'; nested exception is java.lang.NumberFormatException: For input string: \"hello\"",
    "path": "/api/default-handler-ex"
}

실행 결과를 보면 HTTP 상태 코드가 400인 것을 확인할 수 있습니다.