API 예외 처리

지난 mvc2 필터, 인터셉터 포스팅 말미에 서블릿 컨테이너까지 예외가 올라갔다가 다시 실행되는 추가 프로세스를 ExceptionResolver를 직접 구현함으로써 나름 간단히 해줬지만 이제 스프링이 제공하는 ExceptionResolver를 사용해보려고 한다.

 

API 예외 처리 - 스프링이 제공하는 ExceptionResolver1

스프링 부트가 기본으로 제공하는 ExceptionResolver는 다음과 같다. 아래 세 개는 기본적으로 ExceptionResolver에 등록되어 있다.

 

1. ExceptionHandlerExceptionResolver

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

 

2. ResponseStatusExceptionResolver

HTTP 상태 코드를 지정해준다.

예) @ResponseStatus(value = HttpStatus.NOT_FOUND)

 

3. DefaultHandlerExceptionResolver

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

 

 

2번 먼저 정리해보자면 ResponseStatusExceptionResolver는 예외에 따라서 HTTP 상태 코드를 지정해주는 역할을 한다.

다음 두가지 경우를 처리한다.

- @ResponseStatus가 달려있는 예외

- ResponseStatusException예외

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

 

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

 

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

 

reason을 MessageSource에서 찾는 기능도 제공한다.

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "error.bad")
public class BadRequestException extends RuntimeException{
}


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

ResponseStatusException은 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다. 예를 들어 애노테이션을 직접 넣어야 하는데 내가 코드를 수정할 수 없는 라이브러리 예외코드 같은 곳.

추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵다. 이때는 ResponseStatusException을 사용하면 된다.

 

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

---

 

API 예외 처리 - 스프링이 제공하는 ExceptionResolver2

3번 DefaultHandlerExceptionResolver를 살펴보면 DefaultHandlerExceptionResolver는 스프링 내부에서 발생하는 스프링 예외를 해결한다. 대표적으로 바인딩 시점이 맞지 않으면 내부에서 TypeMismatchException이 발생하는데 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고 결과적으로 500 오류가 발생한다. 그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제로 400을 사용하는 것이 맞다.

 

DefaultHandlerExceptionResolver는 이걸 500이 아닌 400 오류로 변경한다. 스프링 내부 오류를 어떻게 처리할 지 수많은 내용이 정의되어 있다.

 

@GetMapping("/api/default-handler-ex")
public String defaultException(@RequestParam Integer data){
    return "ok";
}

다음과 같이 컨트롤러를 만들고 data=qqq 등의 타입 미스매치가 뜨게 보내면 DefaultHandlerException이 알아서 400으로 반환해준다.

 

지금까지 상태 코드를 변경하고 내부 예외의 상태 코드를 변경하는 기능들에 대해 알아봤는데 HandlerExceptionResolver를 직접 사용하기는 복잡하다. API 오류 응답의 경우 response에 직접 데이터를 넣어야 해서 매우 불편하고 번거롭다. ModelAndView를 반환해야 하는 것도 API에는 잘 맞지 않는다. 따라서 @ExceptionHandler라는 예외 처리 기능을 제공한다. 그게 첫번째 ExceptionHandlerExceptionResolver다.

 

 

---

API 예외 처리 - @ExceptionHandler

웹 브라우저에 HTML 화면을 제공하는 오류가 발생하면 BasicErrorController를 사용하는 것이 편하다. 그런데 API는 각 시스템마다 응답의 모양도 다르고, 스펙도 모두 다르다. 예외 상황에 화면을 보여주는 것이 아니라 각각 다른 데이터를 출력해야 할 수 도 있다. 한마디로 세밀한 제어가 필요하다. 결국 BasicErrorController나 HandlerExceptionResolver로 해결할 수 없다.

 

HandlerExceptionResolver는 ModelAndView를 반환해야 했고 이것은 API 응답에는 필요하지 않다. 또한 API 응답을 위해서 HttpServletResponse에 직접 응답 데이터를 넣어주었는데 이건 매우 불편하다. 

 

특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다. 예를 들어서 회원을 처리하는 컨트롤러에서 발생하는 RuntimeException과 상품 관리 컨트롤러의 RuntimeException을 다른 방식으로 처리하고 싶다면

 

@ExceptionHandler를 사용해야 한다.

스프링 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler라는 애노테이션을 사용하는 편리한 예외 처리 기능을 제공하는데 ExceptionHandlerExceptionResolver다. 스프링은 이것을 기본으로 제공하고 우선순위도 가장 높다.

 

@Slf4j
@RestController
public class ApiExceptionV2Controller {


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

    @ExceptionHandler
    public ResponseEntity<ErrorResult> userExHandler(UserException e){
        log.error("[exceptionHandler] 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 exHandler(Exception e){
        log.error("[exceptionHandler] 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 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다. 해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다. 참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다.

 

우선순위

스프링의 우선 순위는 항상 자세한 것이 우선권을 가진다. 부모, 자식 클래스가 있으면 자식 클래스가 우선적으로 처리된다.

 

실행 흐름에 대해 이야기해보면

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

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

2. 예외가 발생했기 때문에 ExceptionResolver가 작동한다. 가장 우선순위가 높은 ExceptionHandlerExceptionResolver가 실행된다. 

3. ExceptionHan..는 해당 컨트롤러에 IllegarArgs예외를 처리할 @ExceptionHandler가 있는지 확인한다.

4. 해당 핸들러를 실행한다. RestController이므로 핸들러에도 @ResponseBody가 적용된다.. HTTP 컨버터가 사용되고 JSON으로 반환한다.

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

 

@ExceptionHandler(ViewException.class)
public ModelAndView ex(ViewException e) {
     log.info("exception e", e);
     return new ModelAndView("error");
}

참고로 ModelAndView를 리턴해서 오류화면을 응답하는데 사용할 수도 있다.

 

 

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

@Slf4j
@RestControllerAdvice
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());
    }

    @ExceptionHandler
    public ResponseEntity<ErrorResult> userExHandler(UserException e){
        log.error("[exceptionHandler] 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 exHandler(Exception e){
        log.error("[exceptionHandler] ex", e);
        return new ErrorResult("EX", "내부 오류");
    }

}

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

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

- @RestControllerAdvice는 @ControllerAdvice에 @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 {}

Web on Servlet Stack (spring.io)

Web on Servlet Stack