[Spring] 어노테이션 @ExceptionHandler

안녕하세요 이번 포스팅은 ExceptionHandler 어노테이션에 대해서 알아보겠습니다.

 

 

 HTML 화면 오류 vs API 오류

 

웹 브라우저에서 HTML 화면을 제공할 때는 오류가 발생하면 BasicErrorController를 사용하는 게 편합니다.

이때는 단순히 5xx, 4xx 관련된 오류 화면을 보여주면 됩니다. BasicErrorController는 이런 메커니즘을 모두 구현해두었습니다.

 

그런데 API는 각 시스템 마다 응답의 모양도 다르고, 스펙도 모두 다릅니다. 예외 상황에 단순히 오류 화면을 보여주는 것이 아니라, 예외에 따라서 각각 다른 데이터를 출력해야 할 수도 있습니다. 그리고 같은 예외라고 해도 어떤 컨트롤러에서 발생했는가에 따라서 다른 예외 응답을 내려주어야 할 수 있습니다.

한마디로 매우 세밀한 제어가 필요합니다.

예를 들어서 상품 API와 주문 API는 오류가 발생했을 때 응답의 모양이 완전히 다를 수 있습니다.

 

결국 지금 까지 살펴본 BasicErrorController를 사용하거나 HandlerExceptionResolver를 직접 구현하는 방식으로 API 예외를 다루기는 쉽지 않습니다.

 

API 예외처리의 어려운 점

1. HandlerExceptionResolver를 떠올려 보면 ModelAndView를 반환해야 했습니다. 이것은 API 응답에는 필요하지 않습니다.

 

2. API 응답을 위해서 HttpServeltResponse에 직접 응답 데이터를 넣어주었습니다. 이것은 매우 불편하고 마치 과거 서블릿을 사용하던 시절로 돌아간 것 같습니다

 

3. 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵습니다. 예를 들어서 회원을 처리하는 컨트롤러에서 발생하는 RuntimeException 예외와 상품을 관리하는 컨트롤러에서 발생하는 동일한 RuntimeException 예외를 서로 다른 방식으로 처리하고 싶다면 어떻게 해야 할까요?

 

 

@ExceptionHandler

 

스프링은 API 예외 처리문제를 해결하기 위해 @ExceptionHandler라는 애노테이션을 사용하는 매우 편리한 예외 처리 기능을 제공하는데, 이것이 바로 ExceptionHandlerExceptionResolver입니다. 스프링은 ExceptionHandlerExceptionResolver를 기본으로 제공하고, 기본으로 제공하는 ExceptionResolver 중에 우선순위도 가장 높습니다. 실무에서는 API 예외 처리는 대부분 이 기능을 사양한다고 합니다.

 

예제로 알아 보겠습니다.

 

ErrorResult

 

 

import lombok.AllArgsCon
structor;
import lombok.Data;
@Data
@AllArgsConstructor
public class ErrorResult {
     private String code;
     private String message;
}

예외가 발생했을 때 API 응답으로 사용하는 객체를 정의했습니다.

 

ApiExceptionV2 Controller

 

import hello.exception.exception.UserException;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

@Slf4j
@RestController
public class ApiExceptionV2Controller {

     @ResponseStatus(HttpStatus.BAD_REQUEST)
     @ExceptionHandler(IllegalArgumentException.class)
     public ErrorResult illegalExHandle(IllegalArgumentException e) {
         log.error("[exceptionHandle] ex", e);
         return new ErrorResult("BAD", e.getMessage());
     }
     
     @ExceptionHandler
     public ResponseEntity<ErrorResult> userExHandle(UserException e) {
         log.error("[exceptionHandle] ex", e);
         ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
         
         return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
     }
     
     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
     @ExceptionHandler
     public ErrorResult exHandle(Exception e) {
         log.error("[exceptionHandle] ex", e);
         
         return new ErrorResult("EX", "내부 오류");
     }
     
     @GetMapping("/api2/members/{id}")
     public MemberDto getMember(@PathVariable("id") String id) {
         if (id.equals("ex")) {
     	    throw new RuntimeException("잘못된 사용자");
         }
         if (id.equals("bad")) {
         	throw new IllegalArgumentException("잘못된 입력 값");
         }
         if (id.equals("user-ex")) {
        	 throw new UserException("사용자 오류");
         }
        return new MemberDto(id, "hello " + id);
     }

     @Data
     @AllArgsConstructor
     static class MemberDto {
         private String memberId;
         private String name;
     }
}

 

@ExceptionHandler 예외 처리 방법

@ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 됩니다.

해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출됩니다. 참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있습니다.

 

다음 예제는 IllegalArgumentException 또는 그 하위 자식 클래스를 모두 처리할 수 있습니다.

 

@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandle(IllegalArgumentException e) {
     log.error("[exceptionHandle] ex", e);
     return new ErrorResult("BAD", e.getMessage());
}

 

우선순위

스프링의 우선순위는 항상 자세한 것이 우선권을 가집니다. 예를 들어서 부모, 자식 클래스가 있고 다음과 같이 예외가 처리됩니다.

 

 

@ExceptionHandler에 지정한 부모 클래스는 자식 클래스까지 처리할 수 있습니다. 따라서 자식 예외가 발생하면 부모 예외처리(), 자식 예외처리() 둘 다 호출 대상이 됩니다. 그런데 둘 중 더 자세한 것이 우선권을 가지므로 자식 예외처리()가 호출됩니다. 물론 부모 예외가 호출되면 부모 예외처리()만 호출 대상이 되므로 부모 예외처리()가 호출됩니다.

 

다양한 예외

다음과 같이 다양한 예외를 한 번에 처리할 수 있습니다.

 

@ExceptionHandler({AException.class, BException.class})
public String ex(Exception e) {
 log.info("exception e", e);
}

 

예외 생략

@ExceptionHandler에 예외를 생략할 수 있습니다. 생략하면 메서드 파라미터의 예외가 지정됩니다.

 

@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandle(UserException e) {}

 

Postman으로 실행하면서 테스트해보겠습니다.

 

http://localhost:8080/api2/members/bad를 호출하게 되면 IllegalArgumentException이 발생하고 예외를 처리할 수 있습니다.

 

IllegalArgumentException 처리

 

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

 

실행 흐름

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

 

2. 예외가 발생했기 때문에 ExceptionResolver가 작동하는데 가장 우선순위가 높은 ExceptionHandlerExceptionResolver가 실행됩니다.

 

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

 

4. illegalExHandle()를 실행합니다. @RestController 이므로 illgalExHandle() 에도 @ResponseBody가 적용됩니다. 따라서 HTTP 컨버터가 사용되고, 응답은 다음과 같은 JSON으로 반환됩니다.

 

5. @ResponseStatus(HttpStatus.BAD_REQUEST)를 지정했으므로 HTT 상태 코드 400으로 응답합니다.

 

결과

 

{
 "code": "BAD",
 "message": "잘못된 입력 값"
}

 

이번에는 http://localhost:8080/api2/members/user-ex로 요청해보겠습니다.

 

UserException 처리

 

@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandle(UserException e) {
 log.error("[exceptionHandle] ex", e);
 ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
 return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
}

1. @ExceptionHandler에 예외를 지정하지 않으면 해당 메서드 파라미터 예외를 사용합니다. 여기서는 UserException을 사용합니다.

 

2. ResponseEntity를 사용해서 HTTP 메시지 바디에 직접 응답합니다. 물론 HTTP 컨버터가 사용됩니다.

ResponseEntity를 사용하면 HTTP 응답 코드를 프로그래밍해서 동적으로 변경할 수 있습니다. 앞서 살펴본 @ResponseStatus는 애노테이션이므로 HTTP 응답 코드를 동적으로 변경할 수 없습니다.

 

 

이번에는 http://localhost:8080/api2/members/ex를 호출해서 테스트해보겠습니다.

 

Exception

 

@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler
public ErrorResult exHandle(Exception e) {
 log.error("[exceptionHandle] ex", e);
 return new ErrorResult("EX", "내부 오류");
}

 

1. throw new RuntimeException("잘못된 사용자") 이 코드가 실행되면서, 컨트롤러 밖으로 RuntimeException이 던져집니다.

 

2. RuntimeException은 Exception의 자식 클래스입니다. 따라서 위의 메서드가 호출됩니다.

 

3.ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)로 HTTP 상태 코드를 500으로 응답합니다.

 

 

 

@ControllerAdvice

 

@ExceptionHandler를 사용해서 예외를 깔끔하게 처리할 수 있게 되었지만, 정상 코드와 예외 처리 코드가 하나의 컨트롤러에 섞여있습니다. @ControllerAdvice 또는 @RestControllerAdvice를 사용하면 둘을 분리할 수 있습니다.

 

ExControllerAdvice

 

import hello.exception.exception.UserException;
import hello.exception.exhandler.ErrorResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@Slf4j
@RestControllerAdvice
public class ExControllerAdvice {
     @ResponseStatus(HttpStatus.BAD_REQUEST)
     @ExceptionHandler(IllegalArgumentException.class)
     public ErrorResult illegalExHandle(IllegalArgumentException e) {
         log.error("[exceptionHandle] ex", e);
         
         return new ErrorResult("BAD", e.getMessage());
     }
     
     @ExceptionHandler
     public ResponseEntity<ErrorResult> userExHandle(UserException e) {
         log.error("[exceptionHandle] ex", e);
         ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
         
         return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
     }
     
     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
     @ExceptionHandler
     public ErrorResult exHandle(Exception e) {
         log.error("[exceptionHandle] ex", e);
         
         return new ErrorResult("EX", "내부 오류");
     }
}

 

그리고 ApiExceptionV2 Controller 코드에 있는 @ExceptionHandler를 모두 제거합니다.

 

그다음 포스트맨으로 요청해보면 같은 예외처리 응답을 확인할 수 있습니다.

 

@ControllerAdvice

 

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

 

2. @ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용됩니다. (글로벌 적용)

 

3. @RestControllerAdvice는 @ControllerAdvice와 같고 @ResponseBody가 추가되어 있습니다.

 

4. @Controller, @RestController의 차이와 같습니다.

 

대상 컨트롤러 지정 방법

// Target all Controllers annotated with @RestController
@ControllerAdvice(annotations = RestController.class)
public class ExampleAdvice1 {}

// Target all Controllers within specific packages
@ControllerAdvice("org.example.controllers")
public class ExampleAdvice2 {}

// Target all Controllers assignable to specific classes
@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})
public class ExampleAdvice3 {}

 

스프링 공식 문서 예제에서 보는 것처럼 특정 어노테이션이 있는 컨트롤러를 지정할 수 있고, 특정 패키지를 직접 지정할 수도 있습니다. 패키지 지정의 경우 해당 패키지와 그 하위에 있는 컨트롤러가 대상이 됩니다. 그리고 특정 클래스를 지정할 수도 있습니다.