시작

이전 내용에서 HTML 페이지에서 예외가 발생했을 경우 어떻게 처리해야 하는지 알아봤다. 4xx, 5xx와 같은 오류 페이지만있으면 대부분의 문제를 해결할 수 있었다.

그런데 API의 경우 그러니까 기업과 기업 사이의 주고받는 데이터나, 앱에서 API를 호출하는 경우 등등 이러한 상황에서 발생하는 예외는 더욱 신경써서 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려줘야 한다.

글로벌하게 정해진 약속은 없기 때문에 상황마다 약속을 서로 정해서 만들어야 한다.

이전 강의에서 사용했던 에러 등록 웹서버팩토리를 다시 살려준다.

먼저 간단하게 API를 통해 데이터를 서로 주고받는 컨트롤러를 하나 만들어준다.

정상적인 결과는 위와 같이 나온다.

ex로 예외를 보내게 되면, 이렇게 예외 페이지가 나오게 되는데, 데이터를 주고받을때 이와 같은 페이지를 보내면 안된다.
json 형식을 이용해 예외가 발생했음을 알려줘야한다.

produces : @RequestMapping에서 해당 속성값을 설정할 경우, 헤더의 Accept가 Application/join으로 들어왔을때, 이 메서드가 우선순위를 가지고 실행된다.

만약 Accept가 Application/json이 아닌 다른 것이 들어오면 html 오류 페이지가 보이고, Application/json인 경우에는 이 메서드가 실행된다.

이렇게 하면 된다.

스프링 부트 기본 오류 처리

스프링 부트에서 이전에 예외처리를 했을때 BasicController를 통해 자동으로 예외처리를 하는 것을 확인했는데,

이 컨트롤러는 api도 자동으로 처리를 도와준다.

먼저 스프링의 BasicController를 사용하기 위해 이전에 등록한 WebServerCustomizer를 주석처리 해준다.

그 후에 그냥, 포스트맨에서 Application/json 형식으로 보내면,

이렇게 json 형식으로 잘 출력된다.
만약 Accept를 text/html로 넣으면,

이렇게 된다.

html을 요청하면 html을 찾아주고, json으로 요청하면 json형식으로 출력하도록 설정이 되어있다.

이렇게 text/html이 왔을 시에는 errorHtml이 호출되고, application/json의 경우 error이 호출된다.

여기서도 옵션을 추가할 수 있다.

하지만, 이런 데이터는 노출하지 않는 것이 좋다.

BasicErrorController를 오버라이딩을 이용해서 확장하면, JSON 메시지도 변경할 수 있다. 그런데 뒤에서 설명할 @ExceptionHandler가 제공하는 기능이 매우 편리하므로 그냥 확장해서 변경할 수 있다는 정도만 알아두자.

API마다 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야 하는 경우가 많다.

예를 들어서 회원과 관련된 API에서 예외가 발생했을 때의 응답과,
상품과 관련된 API에서 예외가 발생했을 때의 응답은 다르게 해야하고

회사도 서로 다른 기업에서 데이터를 주고받는다면, 응답을 다르게 해야한다.

이제 단계적으로 이 예외처리를 해보자.

HandlerExceptionResolver

예외가 발생해서 서블릿을 넘어 WAS까지 예외가 전달되면 HTTP 상태코드가 500으로 처리된다.

하지만, 발생하는 예외에 따라서 400, 404 등등 다른 상태코드도 처리하고 싶다.

상태코드 변환

IllegalArgumentException을 처리하지 못해서 컨트롤러 밖으로 넘어가는 일이 발생하면 HTTP 상태코드를 400으로 처리하고 싶다.

간단하게 코드로 표현해보자.

이렇게 bad라는 단어가 들어오지 못하게 IllegalArgumentException 처리를 하고 확인하면,

500 처리가 된다.

스픨ㅇ MVC는 컨트롤러(핸들러) 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공한다. 말 그대로 HandlerExceptionResolver 줄여서 ExceptionResolver라고 한다.

ExceptionResolver 적용 전

적용 후

이제 HandlerExceptionResolver를 받아와서 구현해보자.

ex에 예외 정보가 들어있다.
sendError를 통해 상태코드를 새로 넣어버린다.
ExceptionResolver가 ModelAndView를 반환하는 이유는 마치 try, catch를 하듯이 Exception을 처리해서 정상 흐름처럼 변경하는 것이 목적이다.

반환 값에 따른 동작 방식

빈 MAV : 뷰를 랜더링 하지 않고, 정상 프름으로 서블릿이 리턴.
MAV 지정 : ModelAndView 에 View, Model 등의 정보를 지정해서 반환하면 뷰를 랜더링한다.
null : null을 반환하면, 다음 ExceptionResolver를 찾아서 실행한다. 만약 처리할 수 있는 ExceptionResoler가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던진다.

configureHandlerExceptionResolvers(...)를 사용하면 스프링이 기본으로 등록하는 ExceptionResolver가 제거되므로 주의하자.

그리고 만든 MyHandlerExceptionResolver를 WebConfig에 등록한다.

예외 상태 코드 변환

• 예외를 response.sendError(xxx) 호출로 변경해서 서블릿에서 상태 코드에 따른 오류를 처리하도록 할 수 있다.

뷰 템플릿 처리

• ModelAndView에 값을 채워서 예외에 따른 새로운 오류 화면 뷰 렌더링해서 고객에게 제공

API 응답 처리

• response.getWriter().println("hello") 처럼 HTTP 응답 바디에 직접 데이터를 넣어주는 것도 가능하다.

HandlerExceptionResolver 활용

예외를 여기서 마무리하기
예외가 발생하면 WAS까지 예외가 던져지고, WAS에서 오류 페이지 정보를 찾아서 다시 /error를 호출하는 과정은 생각해보면 너무 복잡하다.
ExceptionResolver를 활용하면, 깔끔하게 해결할 수 있다.

이를 위해서 먼저 예외를 하나 만들어주자.

RuntimeException을 받아서 예외를 하나 만들어줬다.
이제 이 예외를 컨트롤러에 넣자.

이제 이 예외처리해줄 리졸버를 만들자.

여기를 보면, 예외가 발생했을시 응답을 다 만들어서 보냈다.
이렇게 되면, MVC에서 예외 처리가 끝나게 되고,
WAS에서는 정상처리가 된다.

출력도 이렇게 정상처리가 된다.

서블릿 컨테이너까지 예외가 올라가면 복잡하고 지저분하게 프로세스가 추가로 실행된다. 하지만, ExceptionResolver를 사용하면 예외처리가 깔끔하게 처리된다.

근데 직접 구현하려니 좀 복잡하다. 이걸 좀 간단히 해보자.

스프링이 제공하는 ExceptionResolver

스프링 부트가 기본으로 제공하는 ExceptionResolver는 다음과 같다.
HandlerExceptionResolverComposite에 다음 순서로 등록.
1. ExceptionHandlerExceptionResolver
2. ResponseStatusExceptionResolver
3. DefaultHandlerExceptionResolver

우선순위가 위처럼 된다.

**ExceptionHandlerExceptionResolver`

• API 대부분을 여기서 처리한다. 우리가 자주 사용하는 기능이 여기에서 등장하기 때문에 좀 뒤에서 설명한다.

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

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

1번에서 예외가 처리되면 그냥 그렇게 끝난다. 1번에서 처리가 안되면 2번으로 넘어가는 방식

ResponseStatusExceptionResolver

1. ExceptionHandlerExceptionResolver
2. ResponseStatusExceptionResolver <-
3. DefaultHandlerExceptionResolver

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

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

• @ResponseStatus가 달려있는 예외
• ResponseStatusException 예외

먼저 @ResponseStatus 부터 보자.

@ResponseStatus

만약 상태코드를 404로 바꾸면,

이렇게 결과도 바뀌는 것을 확인할 수 있다.

ResponseStatusExceptionResolver 코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason)을 호출하는 것을 볼 수 있다.

sendError(400)을 호출했기 때문에 WAS에서 다시 오류 페이지(/error)를 내부요청한다.

여기서 message 속성에 재미있는 기능이 있는데,
코드화할 수 있는 기능이 있다. 예를 들어서,

먼저 메세지가 출력되도록 설정해주고,

메세지를 error.bad로 설정해준 다음,

messages.properties 파일을 만들어서 해당 오류코드를 제공하면,

이렇게 오류 코드가 출력되는 것을 확인할 수 있다.

ResponseStatusException

이건 이전에 살펴봤던, @ResponseStatus 어노테이션을 파라미터로 그냥 받아서 처리해주는 예외라고 생각하면 된다.

그냥 해당 예외에 파라미터값으로 상태코드, 메세지, 발생시키려는 예외 를 받는다.

그럼 이렇게 잘 출력된다.

두개다 ResponseStatusExceptionResolver가 처리를 해준다.

DefaultHandlerExceptionResolver

1. ExceptionHandlerExceptionResolver
2. ResponseStatusExceptionResolver
3. DefaultHandlerExceptionResolver <-

만약 이와같이 데이터를 받는다고 했을때, Integer 타입에 qqq같은 다른 타입의 값을 넣으면, TypeMismatchException가 발생한다.

이 경우 예외가 발생했기 때문에 서블릿 컨테이너까지 올라가 500 오류가 발생해야한다.

하지만, 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청을 잘못 호출해서 발생하는 문제이다.
HTTP는 이런 경우 상태코드를 400으로 사용하도록 되어 있다.
DefaultHandlerExceptionResolver는 이 상태코드를 400으로 변경한다.

코드 진행은 reponse.sendError(400) 를 통해서 문제를 해결한다.

그 외에도 스프링 내부 오류를 어떻게 처리할지 수 많은 내용이 정의되어 있다.

지금까지 HTTP 상태 코드를 변경하고, 스프링 내부 예외의 상태코드를 변경하는 기능도 알아봤다. 그런데, HandlerExceptionResolver를 직접 사용하기에는 복잡하다.
ModelAndView를 반환해야 하는게 API에 좀 맞지 않다.

스프링은 이를 해겨랗기 위해 @ExceptionHandler라는 매우 혁신적인 예외 처리 기능을 제공한다.

그게 이
1. ExceptionHandlerExceptionResolver <-
2. ResponseStatusExceptionResolver
3. DefaultHandlerExceptionResolver

ExceptionHandlerExceptionResolver 이다.

@ExceptionHandler

HTML 화면 오류 vs API 오류
웹 브라우저에 HTML 화면을 제공할 때는 오류가 발생하면 BasicErrorController를 사용하는게 편하다.
이때는 단순히 5xx, 4xx관련된 오류 화면을 보여주면 된다.

그런데 API는 각 시스템마다 응답의 모양도 다르고, 스펙도 모두 다르다. 예외에 따라서 각각 다른 데이터를 출력해야 할 수도 있다. 그리고 같은 예외라고 해도 어떤 컨트롤러에서 발생했는가에 따라서 다른 예외 응답을 내려줘야 할 수 있다.
같은 예외라고 해도 상품 API와 주문 API의 응답이 완전히 다른 모양일 수 있다.

그렇기 때문에 BasicErrorController는 사용할 수 없고,
HandlerExceptionResolver를 직접 구현하자니 다루기 쉽지 않아 보인다.

API 예외처리의 어려운 점

• HandlerExceptionResolver에서 ModelAndView를 반환하는데 API 응답에 필요하지 않다.
• 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다. 예를 들어서 회원을 처리하는 컨트롤러에서 발생하는 RuntimeException 예외와 상품을 관리하는 컨트롤러에서 발생하는 동일한 RuntimeException 예외를 서로 다른 방식으로 처리하고 싶다면?

@ExceptionHandler

@ExceptionHandler는 바로 ExceptionHandlerExceptionResolver이다. 실무에서는 대부분 이걸로 처리한다. 스프링에서 기본으로 제공하고 우선순위도 제일 높다.

먼저 결과값을 출력하기 위한 데이터 폼을 만들어준다.

그리고 이 컨트롤러에서 예외 처리를 해보자.

예외 처리 방법

@Exceptionhandler 어노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다. 위의 경우, IllegalArgumentException과 이 자식 예외까지 처리를 해준다.
@ResponseStatus의 경우 반환하고 싶은 상태코드를 지정하는 것이다.
이 어노테이션을 설정하지 않으면 200 정상 처리가 된다.

우선순위

우선순위는 더 자세한 쪽이 우선순위를 갖게 된다.
위로 예를 들어 UserException이 발생했다면, 모든 예외의 최상위인 exHandler과, userExHandler 둘다 예외를 잡지만, userExHandler가 더 가깝게 있기 때문에 이 메서드가 실행된다.

항상 디테일이 먼저

다양한 예외

아래의 경우에 다양한 예외를 한번에 처리할 수 있다.

예외를 처리할 클래스를 넣고, 그 둘의 부모 예외를 매개변수로 받으면 된다.

예외 생략

예외 클래스를 생략할수도 있다. 그 경우에는 파라미터의 예외로 지정된다.

파라미터 응답
@Exceptionhandler에는 마치 스프링의 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다.
자세한 파라미터와 응답은 여기서
https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-exceptionhandler-args

그런데 여기에는 단점이 있다.

만든 예외를 다른 컨트롤러에도 적용하고 싶은데, 적용하기 위해서는 일일이 컨트롤러마다 만들어야 한다는 불편함이 있다.
이를 처리하기 위해 @ControllerAdvice라는 것을 사용할 수 있다.

@ControllerAdvice

현재 컨트롤러에는 정상적인 컨트롤러 로직과, 예외처리가 같이 모여있다.

여기서 이 예외 처리한 부분들을

이렇게 넘겨준다. 이 클래스에는 @RestControllerAdvice 어노테이션을 넣어주고, 예외 처리들을 여기로 몰아준다.

그럼 이제 이전에 있던 컨트롤러는 다시 웹 관련 정상 작동 로직들만 남아있게 된다.

예외 처리도 알아서 된다.

@ControllerAdvice

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

// Target all Controllers annotated with @RestController
@RestControllerAdvice(annotations = RestController.class)

// Target all Controllers within specific packages
@RestControllerAdvice("hello.exception.api")

// Target all Controllers assignable to specific classes
@RestControllerAdvice(assignableTypes = {ApiExceptionController.class, ApiExceptionV2Controller.class})

공식문서
https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-controller-advice

annotations
적용할 컨트롤러를 지정해준다.
hello.exception.api
해당 경로의 패키지 내부에 적용해준다.
assignableTypes
해당하는 컨트롤러와, 컨트롤러 자식들에 모두 적용해준다.

정리

Text/html

API