[Spring] API 예외 처리 - 스프링이 제공하는 ExceptionResolver

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

1. ExceptionHandlerExceptionResolver
2. ResponseStatusExceptionResolver
3. DefaultHandlerExceptionResolver -> 우선순위 가장 낮음

ExceptionHandlerExceptionResolver
: @ExceptionHandler 을 처리한다. API 예외 처리는 대부분 이 기능으로 해결한다.

ResponseStatusExceptionResolver
: HTTP 상태 코드를 지정해준다 (ex. @ResponseStatus(value = HttpStatus.NOT_FOUND))

DefaultHandlerExceptionResolver
: 스프링 내부 기본 예외를 처리한다.

 

ResponseStatusExceptionResolver

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

다음 두 가지 경우를 처리한다.
- @ResponseStatus가 달려있는 예외
- ResponseStatusException 예외

 

@ResponseStatus

 

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

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

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

 

ResponseStatusExceptionResolver 코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason)를 호출하는 것을 확인할 수 있다. sendError(400)를 호출했기 때문에 WAS에서 다시 오류 페이지(/error)를 내부 요청한다.

 

 

ApiExceptionController - 컨트롤러

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

 

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

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

메시지 기능
: @ResponseStatus 애노테이션의 reason 을 MessageSource에서 찾는 기능도 제공한다 (ex. reason = "error.bad")

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

 

ResponseStatusException

@ResponseStatus의 한계
: @ResponseStatus는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다. (라이브러리 예외코드...etc) 추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵다 이때는 ResponseStatusException 예외를 사용하면 된다.

 

ApiExceptionController - 컨트롤러

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

---

DefaultHandlerExceptionResolver

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

 

ApiExceptionController - 컨트롤러

@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 - 실행

{
 "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"
}

 

중간 정리

지금까지 2개의 ExceptionResolver 들에 대해 알아보았다.

1. ResponseStatusExceptionResolver -> HTTP 응답 코드 변경
2. DefaultHandlerExceptionResolver -> 스프링 내부 예외 처리

지금까지 HTTP 상태 코드를 변경하고, 스프링 내부 예외의 상태코드를 변경하는 기능도 알아보았다. 그런데 HandlerExceptionResolver를 직접 사용하기는 복잡하다. API 오류 응답의 경우 response에 직접 데이터를 넣어야 해서 매우 불편하고 번거롭고 ModelAndView를 반환해야 하는 것도 API에는 잘 맞지 않는다. (지난 포스팅 참고) 

스프링은 이런 문제를 해결하기 위해 @ExceptionHandler 라는 매우 혁신적인 예외 처리 기능을 제공한다. 이것이 바로 다음에 알아볼 ExceptionHandlerExceptionResolver 이다.

---

@ExceptionHandler

 

HTML 화면 오류 vs API 오류
: 웹 브라우저에 HTML 화면을 제공할 때는 오류가 발생하면 BasicErrorController를 사용하는게 편하다. 이 때는 단순히 5xx, 4xx 관련 오류 화면을 보여주면 되는데 BasicErrorController는 이런 메커니즘을 모두 구현해두었다. 그런데 API는 각 시스템 마다 응답의 모양도 다르고 스펙도 모두 다르다. 예외 상황에 단순히 오류 화면을 보여주는 것이 아니라 예외에 따라서 각각 다른 데이터를 출력해야 할 수도 있다. 그리고 같은 예외라고 해도 어떤 컨트롤러에서 발생했는가에 따라서 다른 예외 응답을 내려주어야 할 수 있다. 한마디로 매우 세밀한 제어가 필요하다. 예를 들어 상품 API와 주문 API는 오류가 발생했을 때 응답의 모양이 완전히 다를 수 있다. 결국 지금까지 살펴본 BasicErrorController를 사용하거나 HandlerExceptionResolver를 직접 구현하는 방식으로 API 예외를 다루기는 쉽지 않다.

 

API 예외처리의 어려운 점

• HandlerExceptionResolver를 떠올려보면 ModelAndView를 반환해야 하는데 이것은 API응답에 필요하지 않다.
• API응답을 위해 HttpServletResponse에 직접 응답 데이터를 넣어주는 것은 매우 불편하다.
• 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다.

 

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

 

ErrorResult

@Data
@AllArgsConstructor
public class ErrorResult{
    private String code;
    private String message;
}

예외가 발생했을 때 API응답으로 사용하는 객체 

 

 

ApiExceptionV2Controller - 컨트롤러

@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> userHandle(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 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다. 해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출되며 참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다.

ex) IllegalArgumentException 부분은 IllegalArgumentException 또는 그 하위 자식 클래스를 모두 처리할 수 있다.

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

@ExceptionHandler(부모예외.class) 
public String 부모예외처리() (부모 예외 e) {}

@ExceptionHandler(자식예외.class) 
public String 자식예외처리() (자식 예외 e) {}

자식 예외가 발생하면 부모예외처리(), 자식예외처리() 둘다 호출 대상이되며 자식예외처리()가 우선권을 가지므로 호출된다.

 

다양한 예외

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

한번에 다양한 예외를 처리할 수 있다.

 

 

@ExceptionHandler에는 마치 스프링의 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다.

자세한 파라미터 응답은 공식 메뉴얼을 참고하자.

https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-exceptionhandler-args

Web on Servlet Stack

 

실행 흐름 (IllegalArgumentException)

• 컨트롤러 호출 결과 IllegalArgumentException 예외가 컨트롤러 밖으로 던져진다.
• 예외가 발생했으므로 ExceptionResolver가 작동하고 가장 우선순위가 높은 ExceptionHandlerExceptionResolver가 실행된다.
• ExceptionHandlerExceptionResolver는 해당 컨트롤러에 IllegalArgumentResolver을 처리할 수 있는 @ExceptionHandler가 있는지 확인한다.
• illegalExHandle()을 실행한다. @RestController이므로 illegalExHandle()에도 @ResponseBody가 적용된다. 따라서 HTTP 컨버터가 사용되고 응답이 다음과 같은 JSON으로 반환된다.
• @ResponseStatus(HttpStatus.BAD_REQUEST)를 지정했으므로 HTTP 상태 코드 400으로 응답한다.

 

 

실행 흐름(UserException)

• @ExceptionHandler에 예외를 지정하지 않으면 해당 메서드 파라미터 예외를 사용한다. 여기서는 UserException을 사용한다.
• ResponseEntity를 사용해 HTTP 메시지 바디에 직접 응답한다. 물론 HTTP 컨버터가 사용된다.
• ResponseEntity를 사용하면 HTTP 응답 코드를 프로그래밍해서 동적으로 변경할 수 있다. 앞서 살펴본 @ResponseStatus는 애노테이션이므로 HTTP 응답 코드를 동적으로 변경할 수 없다.

 

 

실행 흐름 (Exception)

• throw new RuntimeException("잘못된 사용자") 코드가 실행되면서 컨트롤러 밖으로 RuntimeException이 던져진다.
• RuntimeException은 Exception의 자식 클래스이고 따라서 해당 메서드가 호출된다.
• @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)로 HTTP 상태 코드를 500으로 응답한다.

---

@ControllerAdvice

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

 

ExControllerAdivce

@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", "내부 오류");
	}
}

• 예외처리 코드를 분리하였다. (ApiExceptionV2Controller에 @ExceptionHandler를 모두 제거해주자.)
• 이후 실행해보면 이전과 동일한 결과를 얻을 수 있다.

 

@ControllerAdvice
- @ControllerAdvice는 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler , @InitBinder 기능을 부여해주는 역할을 한다.
- @ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다(글로벌).
- @RestControllerAdvice는 @ControllerAdivce와 같고, @ResponseBody가 추가되어 있다. 

 

대상 컨트롤러 지정 방법

// 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 {}

• 특정 애노테이션이 있는 컨트롤러 지정
• 특정 패키지를 지정 (해당 패키지 하위에 있는 컨트롤러가 대상이 된다.)
• 특정 클래스를 지정
• 생략시 모든 컨트롤러에 지정

 

정리

• API 예외처리에는 @ExceptionHandler 를 실무에서 가장 많이 사용한다.
• @ExceptionHandler와 @ControllerAdvice를 조합하면 예외를 깔끔하게 해결할 수 있다.

---

참고 자료

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의