18) API 예외처리 (3)

API 예외 처리 - @ExceptionHandler

HTML 화면 오류 vs API 오류

 

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

 

이때는

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

 

 

그런데 API는 각 시스템 마다 응답의 모양도 다르고, 스펙도 모두 다르다.

 

예외 상황에 단순히 오류 화면을 보여주는 것이 아니라, 예외에 따라서 각각 다른 데이터를 출력해야 할 수도 있다.

 

그리고 같은 예외라고 해도 어떤 컨트롤러에서 발생했는가에 따라서 다른 예외 응답을 내려주어야 할 수 있다.

 

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

 

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

 

 

결국

지금까지 살펴본 BasicErrorController 를 사용하거나 HandlerExceptionResolver 를 직접 구현하는 방식으로

 

API 예외를 다루기는 쉽지 않다.

 

 

API 예외처리의 어려운 점

 

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

 

API 응답을 위해서 HttpServletResponse에 직접 응답 데이터를 넣어주었다. 이것은 매우 불편하다.

스프링 컨트롤러에 비유하면 마치 과거 서블릿을 사용하던 시절로 돌아간 것 같다.

 

특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다.

예를 들어서 회원을 처리하는 컨트롤러에서 발생하는 RuntimeException 예외와 상품을 관리하는 컨트롤러에서

발생하는 동일한 RuntimeException 예외를 서로 다른 방식으로 처리하고 싶다면 어떻게 해야할까?

(HandlerExceptionResolver를 직접만들고 구현하려면 지저분한 코드가 생성될것이다.)

 

@ExceptionHandler

 

스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler라는 애노테이션을 사용하는

매우 편리한 예외 처리 기능을 제공하는데, 이것이 바로 ExceptionHandlerExceptionResolver이다

 

스프링은 ExceptionHandlerExceptionResolver를 기본으로 제공하고, 기본으로 제공하는 ExceptionResolver 중

우선순위도 가장 높다.

 

실무에서 API 예외 처리는 대부분 이 기능을 사용한다

 

먼저 예제로 알아보자

 

 

ErrorResult (예외 응답 객체)

@Data
@AllArgsConstructor
public class ErrorResult {

    private String code;
    private String message;

}

 

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

 

 

ApiExceptionV2Controller

예외를 처리하는 메소드 , 예외를 발생시키는 API가 있는 컨트롤러

@Slf4j
@RestController
public class ApiExceptionV2Controller {


    @ExceptionHandler(IllegalArgumentException.class) //IllegalArgumentException를 처리한다는뜻
    public ErrorResult illegalExHandler(IllegalArgumentException e) {  //파라미터로 발생한 예외를 받는다.
        log.error("[exceptionHandler] ex ", e);

        //직접만든 에러 응답 객체 ErrorResult를 반환한다.
        return new ErrorResult("BAD", e.getMessage());
    }

    @GetMapping("/api2/members/{id}")  //예외를 발생시키기 위한 API
    public MemberDto getMember(@PathVariable String id) {

        if (id.equals("ex")) { // ex라는 아아디가 반환되면
            throw new RuntimeException("잘못된 사용자"); // 예외를 발생시켲고
        }

        if (id.equals("bad")) { //bad라고 들어오면
            throw new IllegalArgumentException("잘못된 입력값"); //IllegalArgumentException를 발생시킨다.
        }

        if (id.equals("user-ex")) { //user-ex라고 들어오면
            throw new UserException("사용자 오류");  //UserException 발생

        }

        return new MemberDto(id, "hello" + id); // 아니라면 멤버를 반환해준다.
    }

    @Data
    @AllArgsConstructor
    static class MemberDto {

        private String memberId;
        private String name;

    }
}

getMember()는 예외를 발생시키는 API

illegalExHandler()는 IllegalArgumentException를 처리하는 메소드이다.

(illegalExHandler()는 IllegalArgumentException 또는 그 하위 자식 클래스를 모두 처리할 수 있다.)

 

@ExceptionHandler 예외 처리 방법

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

( 일반 컨트롤러 (@Controller,@RestController) 내부에서 @ExceptionHandler가 사용된다면)

 

"해당 컨트롤러에서 예외가 발생하면" 이 메서드가 호출된다.

 

참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다.

 

 

결과

동작방식

IllegalArgumentException 발생시 컨트롤러 밖으로 예외가 빠져나온다. 그렇게 되면 DisPatcher Servlet이 ExceptionResolver들을 호출하면서 예외를 처리하려고한다. 

우선순위가 가장높은 ExceptionHandlerExceptionResolver를 먼저 호출하는데

ExceptionHandlerExceptionResolver는 먼저 "예외가 발생한 컨트롤러에서" 지금 발생한 예외가 매핑된 @ExceptionHandler가 있는지 찾아본다. 존재한다면 해당 @ExceptionHandler가 매핑된 메소드를 호출한다.

@ExceptionHandler(IllegalArgumentException.class)가 있는 컨트롤러가 호출된 모습

@ExceptionHandler가 매핑된 메소드를 호출된 후 Exception이 처리됬다고 간주해서 그 후 정상흐름으로 진행된다.

WAS까지 정상응답이 가고 , 정상적으로 Http응답이 나가면서 상태코드 200으로 처리된다.

(예외가 처리됬으므로 , 서블릿컨테이너의 서블릿까지 예외가 올라가지않는다 그러므로 오류처리를 위해 다시 request되는 그런 복잡한 흐름을 안거쳐도된다.)

 

 

하지만 응답코드를 200이 아닌 다른상태코드로 바꾸고싶다면 이전에 배운 @ResponseStatus를 메소드에 붙여주면된다.

@ResponseStatus는 클래스레벨에도 붙일수있고, 메소드레벨에도 붙일 수 있다.

(참고는 아래링크)

https://keeeeeepgoing.tistory.com/181

 

결과확인

설정한 상태코드로 바뀐것을 확인할 수 있다.

 

 

추가 예시

@ExceptionHandler가 붙은 메소드는 그냥 일반 핸들러메소드(API메소드)라고 생각하면된다. 거의 똑같다.

 

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

 

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

(https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-exceptionhandler-args)
컨트롤러보다 넘길수있는 파라미터는 좀 적지만 엄청 다양하다  공식문서가서 참고해보자.

(@controller에서 @ExceptionHandler가 붙은 메소드가 String을 반환하면, 논리뷰이름으로 판단하고 뷰리졸버에서 뷰를 찾아 렌더링하는것도 같다. 아니면 그냥 View객체 자체를 반환할수도있다. 위의 문서에서 참고, 하지만 API예외처리에 많이 사용되므로 객체를 많이 반환하게될것이다.)

 

(ExceptionHandler를 구현할때 modelAndView를 반환하게 되어있었는데 그 이유는 예외를 처리했으므로 일반 컨트롤러처럼 modelAndView를 반환하게 하여 정상흐름으로 진행되게끔 하는것이였다. 

그것처럼 @ExceptionHandler가 붙은 메소드를 동작되면서 예외는 처리됬고, 반환값으로 인해 나머지 정상흐름이 동작하게끔하는것이므로 컨트롤러의 일반 API 메소드처럼 동작하는것 같다.) (반환이 뷰와 관련된것이라면 나머지 흐름은 뷰를 렌더링하는것일거고, 객체와 같이 JSON관련이라면 서블릿에 정상응답을 넘겨 Http응답메시지에 값을 넣는것으로 넘어갈것이다.)

@ExceptionHandler //@ExceptionHandler에 예외를 넣지않고 메소드의 파라미터로 넣어도 알아서 처리해준다.
public ResponseEntity<ErrorResult> userExHanlder(UserException e) { // 일반 핸들러메소드처럼 ResponseEntity로 반환가능하다, 일반 핸들러메소드와 거의동일함
    log.error("[exceptionHandler] ex ", e);
    ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
    return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST); //ResponseEntity를 이용하면 상태코드도 지정가능
}

@ExceptionHandler 에 예외를 지정하지 않으면 해당 메서드 파라미터 예외를 사용한다.

 

여기서는 UserException 을 사용한다.

 

결과확인

 

추가 예시

@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler
public ErrorResult exHandler(Exception e) { //모든 Exception에 대해 
    log.error("[exceptionHandler] ex ", e);
    return new ErrorResult("EX", "내부오류");
}

해당 컨트롤러에서 발생하는 모든 예외에 대한 처리를 하는 메소드이다. (Exception을 파라미터로해서)

하지만 스프링의 우선순위는 항상 자세한것이 우선권을 가진다. 

만약 IllegalArgumentException이 발생하면 위에서 만든 예외처리 메소드가 더 자세한 메소드이므로 그것이 실행될것이다.

하지만 따로 처리해놓지않은 예외가 발생하면 Exception을 처리하는 이 메소드가 실행될것이다.

(Exception은 최상위 인터페이스이므로, 따로 처리하지않은 예외들은 전부 여기서 처리될것이다.)

RuntimException을 발생시켰을때, 따로 RuntimException을 처리하는 매핑된 메소드가 없으니, 위의 메소드가 실행된 모습

 

ResponseEntity 를 사용하면 HTTP 응답 코드를 프로그래밍해서 동적으로 변경할 수 있다.

 

위의 사용된 @ResponseStatus는 애노테이션이므로 HTTP 응답 코드를 동적으로 변경할 수 없다.

 

 

예외처리 우선순위

스프링의 우선순위는 항상 자세한 것이 우선권을 가진다.

 

예를 들어서 부모, 자식 클래스가 있고 다음과 같이 예외가 처리된다.

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

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

}

@ExceptionHandler에 지정한 부모 클래스는 자식 클래스까지 처리할 수 있다.

 

따라서 자식예외 가 발생하면 부모예외처리() , 자식예외처리() 둘다 호출 대상이 된다.

 

그런데 둘 중 더 자세한 것이 우선권을 가지므로 자식예외처리()가 호출된다.

 

물론 부모예외가 호출되면 부모예외처리()만 호출 대상이 되므로 부모예외처리()가 호출된다.

 

다양한 예외

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

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

 

 

한계

매번 이렇게 컨트롤러에 @ExceptionHandler 를 이용한 예외처리를 하는 메소드가 들어가면

정상코드와 예외처리코드가 하나의 컨트롤러안에 섞여있기도하고,

해당 컨트롤러에서 발생하는 예외만 처리할 수 있게된다.

그것을 해결하기위해 @ControllerAdvice 또는 @RestControllerAdvice를 사용한다.

 

 

API 예외 처리 - @ControllerAdvice

 

@ExceptionHandler 를 사용해서 예외를 깔끔하게 처리할 수 있게 되었지만,

정상 코드와 예외 처리 코드가 하나의 컨트롤러에 섞여 있다.

@ControllerAdvice 또는 @RestControllerAdvice 를 사용하면 둘을 분리할 수 있다.

 

@ControllerAdvice 는 대상으로 지정한 여러 컨트롤러에

@ExceptionHandler , @InitBinder 기능을 부여해주는 역할을 한다.

 

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

 

@RestControllerAdvice 는

@ControllerAdvice 와 같고, @ResponseBody 가 추가되어 있다. @Controller , @RestController 의 차이와 같다.

 

@RestControllerAdvice는 @ControllerAdvice에다가 @ResponseBody가 붙은 어노테이션이다.

 

ExControllerAdvice

클래스레벨에 @RestController를 붙인후 위에서 만들었던 예외처리 메소드들을 복사해온다.

 

그리고 이제 컨트롤러 내부에서 예외처리를 할 필요가 없으니 예외처리 부분은 없애도 된다.

 

@Slf4j
@RestControllerAdvice
public class ExControllerAdvice {
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(IllegalArgumentException.class) //IllegalArgumentException를 처리한다는뜻
    public ErrorResult illegalExHandler(IllegalArgumentException e) {  //파라미터로 발생한 예외를 받는다.
        log.error("[exceptionHandler] ex ", e);

        //직접만든 에러 응답 객체 ErrorResult를 반환한다.
        return new ErrorResult("BAD", e.getMessage());
    }

    @ExceptionHandler //@ExceptionHandler에 예외를 넣지않고 메소드의 파라미터로 넣어도 알아서 처리해준다.
    public ResponseEntity<ErrorResult> userExHanlder(UserException e) { // 일반 핸들러메소드처럼 ResponseEntity로 반환가능하다, 일반 핸들러메소드와 거의동일함
        log.error("[exceptionHandler] ex ", e);
        ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
        return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST); //ResponseEntity를 이용하면 상태코드도 지정가능
    }

    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler
    public ErrorResult exHandler(Exception e) { //모든 Exception에 대해
        log.error("[exceptionHandler] ex ", e);
        return new ErrorResult("EX", "내부오류");
    }

}

 

실행 결과

똑같이 동작하는것을 확인할 수 있다.

 

대상 컨트롤러 지정 방법

@ControllerAdvice는 적용할 컨트롤러를 지정할 수도 있다

 

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

 

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

위의 코드는 공식문서의 예제이다.

참고(https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-controller-advice)

 

 

스프링 공식 문서 예제에서 보는 것 처럼

 

특정 애노테이션이 있는 컨트롤러를 지정할 수 있고, ( annotation 속성을 지정해서)

(위에서는 RestController 어노테이션이 있는 컨트롤러로 지정했다.)

 

 

특정 패키지를 직접 지정할 수도 있다.

(패키지 지정의 경우 해당 패키지와 그 하위에 있는 컨트롤러가 대상이 된다.)

(이걸 응용하면, 도메인별로 다른 예외처리를 할 수 있거나 , 원하는 패키지마다 다른 예외처리를 설정 해줄수도있다)

 

 

그리고 특정 클래스를 지정할 수도 있다. 대상 컨트롤러 지정을 생략하면 모든 컨트롤러에 적용된다.

(부모클래스나 인터페이스를 지정해서 그것을 상속,구현한 컨트롤러에 대해 예외처리를 지정할수도있고,

아니면 특정 컨트롤러의 클래스를 넣어서, 해당 컨트롤러에 대한 예외처리를 지정해줄수도 있다.)