Spring Boot, ExceptionHandler, 전역 예외 처리 로직 작성하기

개요

Spring Framework 3.2부터 @ControllerAdvice가 소개되었다. 이를 통해 우리는 특정 컨트롤러에 종속되지 않은 전역 범위에서 발생하는 특정 예외에 대한 처리를 한 곳에서 작성할 수 있게 되었다. 본 글에서는 이 방법을 설명하고자 한다.

목표

• 특정 컨트롤러에 종속되지 않은 전역 예외 처리 로직을 작성한다.

사전 지식

• IntelliJ IDEA에서 Spring Boot 웹 프로젝트 생성하기

특정 예외를 처리하는 ExceptionHandler 작성

@ControllerAdvice
@Order(Ordered.HIGHEST_PRECEDENCE)
public class SomeExceptionHandler {

    @ExceptionHandler(SomeException.class)
    @ResponseBody
    public ResponseEntity<?> handleSomeException(HttpServletRequest request, SomeException ex) {

        // SomeException 예외 발생시 처리 로직 작성
        return new ResponseEntity<>(ex, HttpStatus.BAD_REQUEST);
    }

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ResponseEntity<?> handleException(HttpServletRequest request, Exception ex) {

        // Exception 예외 발생시 공통 처리 로직 작성
        return new ResponseEntity<>(ex, HttpStatus.BAD_REQUEST);
    }
}

• @ControllerAdvice를 클래스 레벨에 부여하면 @Controller 빈을 돕는 빈으로 기능할 수 있다. 예를 들어 모든 컨트롤러 제어 범위에서 특정 예외가 발생하면 공통적인 처리 로직을 작성할 수 있다.


• @Order를 클래스 레벨에 부여하면 @ControllerAdvice 빈 간의 우선순위를 조정할 수 있다. @ControllerAdvice 빈이 여러 개일 때 어떤 것을 우선할지 결정할 수 있다. Ordered.HIGHEST_PRECEDENCE는 최우선 순위를 의미한다.


• @ExceptionHandler를 메써드 레벨에 부여하면 특정 예외가 발생했을 때의 처리 로직을 작성할 수 있다.


• @ResponseBody를 메써드 레벨에 부여하면 특정 뷰가 아닌 메시지 바디를 반환할 수 있다. 즉, REST API의 응답 형태로 예외 처리 로직의 결과를 반환하겠다는 것이다.


• ResponseEntity 오브젝트는 HTTP 응답 코드, 응답 헤더, 응답 바디 모두를 담을 수 있는 만능 객체이다. 즉, REST API의 응답을 자유롭게 담을 수 있다.

특정 예외 발생 예

@Service
public class SomeService {

    public void doSomeBusinessLogic {

        // 특정 조건에 따라 SomeException 예외 발생
        throw new SomeException("SomeError Occured.");
        ...
    }
}

• @Controller에 의해 호출되는 모든 범위에서 위와 같이 SomeException 예외를 발생시키면 앞서 작성한 @ControllerAdvice 빈에 의해 해당 예외에 대한 특정 예외 응답을 수행할 수 있다.

참고 글

• https://spring.io/blog/2013/11/01/exception-handling-in-spring-mvc
• Error Handling for REST with Spring