seon99il

Spring

RestControllerAdvice, ExceptionHandler로 예외 처리하기

2분 소요

Java: 1.8 Spring Boot: 2.7.5

개요

예외 처리는 애플리케이션 개발에서 매우 중요한 부분입니다. 이 글에서는 RestControllerAdvice와 ExceptionHandler를 사용해 예외를 처리하는 방법을 소개합니다.

Spring의 기본 예외 처리

기본적으로 예외가 발생하면 오류 처리는 접근한 환경에 따라 달라집니다.

웹 페이지에 접근했다면 Whitelabel 에러 페이지를 받게 됩니다.

SampleController

Exception

Spring Boot에는 오류 처리를 위한 BasicErrorController가 구현되어 있으며, 기본적으로 예외가 발생하면 WAS가 오류 요청을 다시 /error로 전달하도록 설정되어 있습니다.

요청 흐름

WAS -> Filter -> DispatcherServlet -> Interceptor -> Controller

Controller (Service, DB…) 에서 예외가 발생하면 /error를 한 번 더 호출합니다.

WAS -> Filter -> DispatcherServlet -> Interceptor -> Controller
-> (throw Exception) -> Interceptor -> DispatcherServlet -> Filter
-> WAS -> Filter -> DispatcherServlet -> Interceptor -> Controller(/error)

REST API에서는 다음과 같은 메시지를 받게 되는데, 클라이언트 입장에서는 유용하지 않습니다.

Exception Body

이를 해결하기 위해 직접 만든 예외 (message, errorCode) 를 반환하도록 구현해 보겠습니다.

방법은 여러 가지가 있지만 여기서는 ExceptionHandler와 RestControllerAdvice만 설명합니다.

ExceptionHandler

사용 가능한 위치: Controller, RestControllerAdvice

던져진 예외는 ExceptionHandlerExceptionResolver를 통해 ExceptionHandler가 처리합니다.

이를 사용하면 Controller에서 발생하는 오류를 쉽게 처리할 수 있습니다.

SampleController

Exception Result

RestControllerAdvice

RestControllerAdvice는 Spring 빈으로 등록되며, ExceptionHandler를 전역적으로 적용할 수 있습니다.

ServiceExceptionHandler

ControllerAdvice Annotation

RestControllerAdvice Annotation

예외 처리 흐름

Exception handling flow

  1. ExceptionHandlerExceptionResolver가 동작합니다
    • 예외를 던진 컨트롤러에 적절한 ExceptionHandler가 있는지 확인합니다
    • 적절한 ExceptionHandler가 없으면 ControllerAdvice로 넘어갑니다
    • ControllerAdvice에 적절한 ExceptionHandler가 있는지 확인하고, 없으면 다음 핸들러로 넘어갑니다
  2. ResponseStatusExceptionResolver가 동작합니다
    • ResponseStatus가 존재하는지, 또는 ResponseStatusException인지 확인합니다
    • 그렇다면 ServletResponse의 sendError()로 예외를 서블릿에 전달하고, 서블릿은 요청을 BasicErrorController에 전달합니다.
  3. DefaultHandlerExceptionResolver가 동작합니다
    • Spring 내부 예외인지 확인하여, 맞다면 오류를 처리하고 아니면 건너뜁니다
  4. 적절한 ExceptionResolver가 없으면 예외는 서블릿으로 전달되고, 서블릿은 Spring Boot의 자동 설정에 따라 요청을 다시 BasicErrorController에 전달합니다.

ExceptionHandler 구현하기

간단한 예로, 게시글 id로 게시글을 찾을 수 없을 때 직접 만든 예외를 반환하도록 구현해 보겠습니다

enum class로 예외 목록을 만듭니다.

PostErrorResult

RuntimeException을 상속하는 Exception을 만듭니다.

PostException

마지막으로 RestControllerAdvice를 만듭니다.

ServiceExceptionHandler

결과

PostService

Response Body (PostException)

서비스에 맞는 적절한 예외 형태를 구현해서 사용하세요.

이전 글

전체 글 보기 →

댓글