API 예외 처리 (Spring)

예외가 발생해서 서블릿을 넘어 WAS까지 예외가 전달되면 HTTP 상태코드가 500으로 처리된다. 발생하는 예외에 따라서 400, 404 등등 다른 상태코드도 처리하고 싶다. (오류 메시지, 형식등을 API마다 다르게 처리하고 싶다.)

HandlerExceptionResolver

• ExceptionResolver로 예외를 해결해도 postHandle()은 호출되지 않는다.

public class MyHandlerExceptionResolver implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {

        try {
            if (ex instanceof IllegalArgumentException) {
log.info("IllegalArgumentException resolver to 400");
                response.sendError(HttpServletResponse.SC_BAD_REQUEST, ex.getMessage());
                return new ModelAndView();
            }
        } catch (IOException e) {
log.error("resolver ex", e);
        }
        return null;
    }
}

• HandlerExceptionResolver를 Implements한 MyHandlerExceptionresolver 구현

• ExceptionResolver가 ModelAndView를 반환하는 이유는 Exception을 처리해서 정상 흐름 처럼 변경하는 것이 목적

• IllegalArgumentException이 발생하면 response.sendError(400) 을 호출해서 HTTP 상태 코드를 400으로 지정하고, Empty ModelAndView를 반환

WebConfig 등록

@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
    resolvers.add(new MyHandlerExceptionResolver());
}

반환 값에 따른 동작 방식

• Empty ModelAndView
• 뷰를 렌더링 하지 않고, 정상 흐름으로 서블릿이 리턴된다.

• ModelAndView 지정
• ModelAndView에 View, Model 등의 정보를 지정해서 반환하면 뷰를 렌더링 한다.

• null
• null을 반환하면, 다음 ExceptionResolver를 찾아서 실행한다.
• 만약 처리할 수 있는 ExceptionResolver가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던진다.

스프링이 제공하는 ExceptionResolver

1. ExceptionHandlerExceptionResolver

• API 예외 처리는 대부분 이 기능으로 해결한다.

1. ResponseStatusExceptionResolver

• HTTP 응답 코드 변경

1. DefaultHandlerexceptionResolver

• 스프링 내부 예외 처리

ResponseStatusExceptionResolver

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류")
public class BadRequestException extends RuntimeException{
}

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

• response.sendError(statusCode, resolvedReason) 을 호출하는 것을 확인할 수 있다.

단점

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

DefaultHandlerExceptionResolver

• EX)
• 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException이 발생
• 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로 500 오류가 발생한다.
• 그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다.
• HTTP 에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어 있다.

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

내부 코드

protected ModelAndView handleTypeMismatch(TypeMismatchException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException {
    response.sendError(400);
    return new ModelAndView();
}

• response.sendError(400) 통해서 문제 해결

• HandlerExceptionResolver를 떠올려 보면 ModelAndView 를 반환해야 했다.

• API 응답을 위해서 HttpServletResponse에 직접 응답 데이터를 넣어주어야했다.

• 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다.

ExceptionHandlerExceptionResolver

• ExceptionResolver 중에 우선순위 가장 높다.

@ExceptionHandler

@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandler(IllegalArgumentException e) {
log.error("[exceptionHandler] ex", e);
    return new ErrorResult("BAD", e.getMessage());
}

• 컨트롤러를 호출한 결과 IllegalArgumentException 예외가 컨트롤러 밖으로 던져진다.

• 예외가 발생했으므로 ExceptionResolver가 작동한다. 가장 우선순위가 높은 ExceptionHandlerExceptionResolver가 실행된다.

• ExceptionHandlerExceptionResolver는 해당 컨트롤러에 IllegalArgumentException을 처리할 수 있는 @ExceptionHandler가 있는지 확인한다.

• illegalExHandle()을 실행한다. @RestController이므로 @ResponseBody 적용

• @ResponseStatus(HttpStatus.BAD_REQUEST)를 지정했으므로 HTTP 상태 코드 400으로 응답한다.

@CongtrollerAdvice

@RestControllerAdvice(basePackages = "hello.exception.api")
@Slf4j
public class ExControllerAdvice {
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(IllegalArgumentException.class)
    public ErrorResult illegalExHandler(IllegalArgumentException e) {
log.error("[exceptionHandler] ex", e);
        return new ErrorResult("BAD", e.getMessage());
    }
}

• @ControllerAdvice는 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler, @InitBinder 기능을 부여해주는 역할을 한다.

• @ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다.

• 특정 애노테이션이 있는 컨트롤러를 지정할 수 있다.

• 특정 패키지를 직접 지정할 수 있다. (패키지 하위에 있는 컨트롤러가 대상이 된다.)