[ 김영한 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 #9 ] API 예외 처리 (1)

이번 섹션에서는 API 예외 처리에 대해서 알아보자.

👉 목차는 다음과 같다.

1) API 예외 처리 - 시작
2) API 예외 처리 - 스프링 부트 기본 오류 처리
3) API 예외 처리 - HandlerExceptionResolver 시작
4) API 예외 처리 - HandlerExceptionResolver 활용
5) API 예외 처리 - 스프링이 제공하는 ExceptionResolver1
6) API 예외 처리 - 스프링이 제공하는 ExceptionResolver2
7) API 예외 처리 - @ExceptionHandler
8) API 예외 처리 - @ControllerAdvice
9) API 예외 처리 - 정리

이번 섹션은 1) ~ 4), 5) ~ 9) 로 나눠서 포스팅하고자 한다.

바로 하나씩 확인해보자.

---

1) API 예외 처리 - 시작

API 예외 처리는 어떻게 해야할까?

HTML 페이지의 경우 지금까지 설명했던 것 처럼 4xx, 5xx와 같은 오류 페이지만 있으면 대부분의 문제를 해결할 수 있다. 그런데 API의 경우에는 생각할 내용이 더 많다. 오류 페이지는 단순히 고객에게 오류 화면을 보여주고 끝이지만, API는 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 한다.

지금부터 API의 경우 어떻게 예외 처리를 하면 좋은지 알아보자.
API도 오류 페이지에서 설명했던 것 처럼 처음으로 돌아가서 서블릿 오류 페이지 방식으로 해결해보자.

• WebServerCustomizer 다시 동작: @Component 주석 해제
  
  • WebServerCustomizer 가 다시 사용되도록 하기 위해 @Component 애노테이션에 있는 주석을 풀자.
  • 이제 WAS에 Exception (예외)가 전달되거나, response.sendError() 가 호출되면 위에 등록한 예외 페이지 경로가 호출된다.

• ApiExceptionController - API 예외 컨트롤러 생성: src > main > java > hello > exception > api 패키지를 생성하고, 내부에 ApiExceptionController 클래스를 생성하자.
  
  • 단순히 회원을 조회하는 기능을 하나 만들었다. (참고로 예외에 대한 학습이기에, repository는 따로 만들지 않았다.)
  • 예외 테스트를 위해 URL에 전달된 id 의 값이 ex 이면 예외가 발생하고, 그렇지 않으면 MemberDto가 반환되도록 코드를 심어두었다.

• 실행해보자. (postman - 정상 요청)
  
  • 정상적으로 MemberDto가 JSON 형태로 출력됨을 확인할 수 있다.
  • (참고) 테스트시 HTTP Header에 Accept 가 application/json 인 것을 꼭 확인하자

• 실행해보자. (postman - ex 요청)
  
  • 오류 페이지 HTML이 반환된다.

❗ API를 요청했는데, 정상의 경우 API로 JSON 형식으로 데이터가 정상 반환된다.
그런데 오류가 발생하면 우리가 미리 만들어둔 오류 페이지 HTML이 반환된다. 이것은 기대하는 바가 아니다. 클라이언트는 정상 요청이든, 오류 요청이든 JSON이 반환되기를 기대한다. 웹 브라우저가 아닌 이상 HTML을 직접 받아서 할 수 있는 것은 별로 없다.

문제를 해결하려면 오류 페이지 컨트롤러도 JSON 응답을 할 수 있도록 수정해야 한다.

• ErrorPageController - API 응답 추가: 아래와 같이 적용해보자.
  
  • produces = MediaType.APPLICATION_JSON_VALUE 의 뜻은 클라이언트가 요청하는 HTTP Header의 Accept 의 값이 application/json 일 때 해당 메서드가 호출된다는 것이다. 결국 클라어인트가 받고 싶은 미디어타입이 json이면 이 컨트롤러의 메서드가 호출된다.
  • 응답 데이터를 위해서 Map 을 만들고 status , message 키에 값을 할당했다. Jackson 라이브러리는 Map 을 JSON 구조로 변환할 수 있다.
  • ResponseEntity 를 사용해서 응답하기 때문에 메시지 컨버터가 동작하면서 클라이언트에 JSON이 반환된다.

• 다시 실행해보자. (postman - ex 요청)
  
  • 정상적으로 JSON 형태로 조회됨을 확인할 수 있다.
  • (참고) HTTP Header에 Accept 가 application/json 이 아니면, 기존 오류 응답인 HTML 응답이 출력되는 것을 확인할 수 있다.

 

지금까지 서블릿 오류 처리 매커니즘을 가지고 API 오류를 어떻게 해결할 수 있는지에 대해 알아보았다. (뭔가 간단하지는 않다.)

다음 내용에서는 이제 스프링 부트가 제공하는 BasicErrorController 를 통해서, API 오류를 어떻게 해결할 수 있는지에 대해 알아보자.

---

2) API 예외 처리 - 스프링 부트 기본 오류 처리

API 예외 처리도 스프링 부트가 제공하는 기본 오류 방식을 사용할 수 있다.

BasicErrorController 를 사용하도록 WebServerCustomizer 의 @Component 를 주석처리 후 실행해보자. ( 주석처리 하게 되면, 스프링 부트가 제공하는 기본 오류 매커니즘이 동작한다. )

• 실행해보자. (postman - ex 요청, Accept: application/json)
  
  • Accept 해더의 값으로 application/json 로 요청시, BasicErrorController 가 JSON 형태 응답 결과를 내려주는 것을 확인할 수 있다.

• 실행해보자. (postman - ex 요청, Accept: text/html)
  
  • 우리가 이전에 만든 500 오류 페이지가 결과로 응답됨을 확인할 수 있다.
  • Accept 해더의 값으로 text/html로 요청시, BasicErrorController 가 html을 내려주는 것을 확인할 수 있다.

Accept 해더의 값으로 text/html 을 요청하면, html을 제공해주고, application/json 을 요청하면, JSON 형태의 오류 정보를 내려주도록 BasicErrorController 에는 이미 개발이 다 되어있다.

 

스프링 부트가 제공하는 BasicErrorController 코드를 보자.

• 참고) BasicErrorController 코드
  
  • 동일한 경로( /error )를 처리하는 errorHtml() , error() 두 메서드를 확인할 수 있다.
    • errorHtml()
      • produces = MediaType.TEXT_HTML_VALUE : 클라이언트 요청의 Accept 해더 값이 text/html 인 경우에는 errorHtml() 을 호출해서 view를 제공한다.
    • error()
      • 그외 경우에 호출되고 ResponseEntity 로 HTTP Body에 JSON 데이터를 반환한다.

스프링 부트의 예외 처리

• 앞서 학습했듯이 스프링 부트의 기본 설정은, 오류 발생시 /error 를 오류 페이지로 요청한다. 그리고 BasicErrorController 는 이 경로를 기본으로 받는다. ( server.error.path 로 수정 가능, 기본 경로 /error )

스프링 부트는 BasicErrorController 가 제공하는 기본 정보들을 활용해서 오류 API를 생성해준다.

• 참고)
  
• 다음 옵션들을 설정하면 더 자세한 오류 정보를 추가할 수 있다.
  • server.error.include-binding-errors=always
  • server.error.include-exception=true
  • server.error.include-message=always
  • server.error.include-stacktrace=always
  • (참고) 위와 같이 설정후 실행 결과
    
    • 더 많은 정보들이 노출되는 것을 확인할 수 있다.
    • 물론 오류 메시지는 이렇게 막 추가하면 보안상 위험할 수 있다. 간결한 메시지만 노출하고, 로그를 통해서 확인하자.

 

Html 페이지 vs API 오류

• BasicErrorController 를 확장하면 JSON 메시지도 변경할 수 있다. 그런데 API 오류는 조금 뒤에 설명할 @ExceptionHandler 가 제공하는 기능을 사용하는 것이 더 나은 방법이므로, 지금은 BasicErrorController 를 확장해서 JSON 오류 메시지를 변경할 수 있다 정도로만 이해해두자.

• 스프링 부트가 제공하는 BasicErrorController 는 HTML 페이지를 제공하는 경우에는 매우 편리하다. 4xx, 5xx 등등 모두 잘 처리해준다. 그런데 API 오류 처리는 다른 차원의 이야기이다. API 마다, 각각의 컨트롤러나 예외마다, 서로 다른 응답 결과를 출력해야 할 수도 있다. 예를 들어서 회원과 관련된 API에서 예외가 발생할 때 응답과, 상품과 관련된 API에서 발생하는 예외에 따라 그 결과가 달라질 수 있다. 결과적으로 매우 세밀하고 복잡하다. 따라서 이 방법은 HTML 화면을 처리할 때 사용하고, API 오류 처리는 뒤에서 설명할 @ExceptionHandler 를 사용하자.

그렇다면 복잡한 API 오류는 어떻게 처리해야하는지 지금부터 단계적으로 하나씩 알아보자.

---

3) API 예외 처리 - HandlerExceptionResolver 시작

이번 내용에서는 API 예외 처리 - HandlerExceptionResolver에 대해서 학습해보자.

목표

• 예외가 발생해서 서블릿을 넘어 WAS까지 예외가 전달되면 HTTP 상태코드가 500으로 처리된다.
• 발생하는 예외에 따라서 400, 404 등등 다른 상태코드로 처리하고 싶다.
• 오류 메시지, 형식등을 API마다 다르게 처리하고 싶다.

 

상태코드 변환

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

• ApiExceptionController - 수정: 다음과 같이 적용해보자.
  
  • (참고) id에는 "bad"라는 값은 넘길 수 없다고 클라이언트와 스펙으로 정의했다고 가정해보자.

• 일단 실행해보자. ( id=bad )
  
  • 실행해보면 상태 코드가 500인 것을 확인할 수 있다.

상태 코드를 바꾸려면 어떻게 해야할까 ? 이것을 바꿀 수 있는 좋은 방법이 있다.
그러려면 HandlerExceptionResolver 라는 것의 매커니즘을 이해해야 한다.

 

HandlerExceptionResolver

스프링 MVC는 컨트롤러(핸들러) 밖으로 예외가 던져진 경우, 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공한다. 컨트롤러 밖으로 던져진 예외를 해결하고, 동작 방식을 변경하고 싶으면 HandlerExceptionResolver 를 사용하면 된다. 줄여서 ExceptionResolver 라 한다.

• ExceptionResolver 적용 전
  
  • 컨트롤러에서 예외가 발생한 경우, 예외가 쭉 WAS까지 전달된다. (postHandle은 호출되지 않는다.)
  • WAS에 예외가 전달되면, 상태 코드를 500으로 처리한다.

• ExceptionResolver 적용 후
  
  • 컨트롤러에서 예외가 발생한 경우, 예외가 전달이 쭉 되다가 ExceptionResolver 라는 것이 있으면, 해당 ExceptionResolver 가 호출된다. 그래서 예외를 해결하도록 시도한다.
  • ExceptionResolver는 컨트롤러(핸들러)에서 발생한 예외를 잡아서, 정상적으로 처리할 수 있도록 해주는 역할로 이해하면 된다.
  • (참고) ExceptionResolver 로 예외를 해결해도 postHandle() 은 호출되지 않는다.

 

HandlerExceptionResolver - 인터페이스

• 참고)
  
  • handler : 핸들러(컨트롤러) 정보
  • Exception ex : 핸들러(컨트롤러)에서 발생한 예외
  • (참고) 반환은 ModelAndView로 하면 된다. (특정 예외( Exception ex )가 넘어왔을 때, 이를 보고, 정상적인 ModelAndView로 반환해주면 된다.)

 

👉 이제 코드로 적용해보자.

• MyHandlerExceptionResolver 생성: src > main > java > hello > exception > resolver 패키지를 생성하고, 내부에 MyHandlerExceptionResolver 클래스를 생성하자.
  
  • 적용한 코드는 설명은 실행 후 설명한다.

• WebMvcConfigurer - 등록: 다음과 같이 적용하자.
  
  • (주의) configureHandlerExceptionResolvers(..) 를 사용하면 스프링이 기본으로 등록하는 ExceptionResolver 가 제거되므로 주의, extendHandlerExceptionResolvers 를 사용하자.

• 실행해보자.
  
  • HTTP 상태 코드가 400으로 변환된 것을 확인할 수 있다.
  • 참고)
    • http://localhost:8080/api/members/ex -> HTTP 상태 코드 500
    • http://localhost:8080/api/members/bad -> HTTP 상태 코드 400

 

로직 분석

• ExceptionResolver 가 ModelAndView 를 반환하는 이유는 마치 try, catch를 하듯이, Exception 을 처리해서 정상 흐름처럼 변경하는 것이 목적이다. 이름 그대로 Exception 을 Resolver(해결)하는 것이 목적이다.
• 여기서는 IllegalArgumentException 이 발생하면 response.sendError(400) 를 호출해서 HTTP 상태 코드를 400으로 지정하고, 빈 ModelAndView 를 반환한다.

반환 값에 따른 동작 방식

• HandlerExceptionResolver 의 반환 값에 따른 DispatcherServlet 의 동작 방식은 다음과 같다.
  • 빈 ModelAndView
    • new ModelAndView() 처럼 빈 ModelAndView 를 반환하면 뷰를 렌더링 하지 않고, 정상 흐름으로 서블릿이 리턴된다. (예외는 이제 더 이상 사용되지 않고 없어진다.)
  • ModelAndView 지정
    • ModelAndView 에 View , Model 등의 정보를 지정해서 반환하면 뷰를 렌더링 한다. (예외는 이제 더 이상 사용되지 않고 없어진다.)
  • null
    • null 을 반환하면, 다음 ExceptionResolver 를 찾아서 실행한다. 만약 처리할 수 있는 ExceptionResolver 가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던진다.
• (참고) 학습시 DispatcherServlet 코드를 확인해보자.

ExceptionResolver 활용

• 예외 상태 코드 변환
  • 예외를 response.sendError(xxx) 호출로 변경해서 서블릿에서 상태 코드에 따른 오류를 처리하도록 위임.
  • 이후 WAS는 서블릿 오류 페이지를 찾아서 내부 호출, 예를 들어서 스프링 부트가 기본으로 설정한 /error 가 호출됨.
• 뷰 템플릿 처리
  • ModelAndView 에 값을 채워서 예외에 따른 새로운 오류 화면 뷰를 렌더링해서 고객에게 제공.
• API 응답 처리
  • response.getWriter().println("hello"); 처럼 HTTP 응답 바디에 직접 데이터를 넣어주는 것도 가능하다. 여기에 JSON 으로 응답하면 API 응답 처리를 할 수 있다.

다음 내용에서는 HandlerExceptionResolver에 대해서 조금 더 깊이있게 알아보자.

---

4) API 예외 처리 - HandlerExceptionResolver 활용

이번에는 이전에 학습한 HandlerExceptionResolver를 API 예외가 발생했을 때 어떤식으로 활용할 수 있는지에 대해서 알아보자.

예외를 여기서 마무리하기

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

👉 코드로 확인해보자.

• UserException 생성: src > main > java > hello > exception 패키지 내부에 exception 패키지를 생성하자. 그리고 그 내부에 UserException 클래스를 생성하자. (사용자 정의 예외를 하나 추가하자.)
  
  • (참고) RuntimeException을 상속 받고, 전부 오버라이드 하였다.

• ApiExceptionController - 예외 추가: 다음과 같이 추가해보자.
  
  • (참고) http://localhost:8080/api/members/user-ex 호출시 UserException 이 발생하도록 해두었다.
  • 이제 이 예외를 처리하는 UserHandlerExceptionResolver 를 만들어보자.

• UserHandlerExceptionResolver 생성: src > main > java > hello > resolver 패키지 내부에 UserHandlerExceptionResolver 클래스를 생성하자.
  
  • HTTP 요청 헤더의 ACCEPT 값이 application/json 이면 JSON으로 오류를 내려주고, 그 외 경우에는 error/500에 있는 HTML 오류 페이지를 보여준다.

• WebMvcConfigurer - 등록: 다음과 같이 적용하자.
  

• 실행해보자. (postman 실행 - Accept: application/json)
  
  • response에 담은 정보가 JSON 형태로 노출됨을 확인할 수 있다.

• 실행해보자. (postman 실행 - Accept: text/html)
  
  • error/500에 있는 HTML 오류 페이지가 보여지는 것을 확인할 수 있다.

✔️ 정리

• ExceptionResolver 를 사용하면 컨트롤러에서 예외가 발생해도 ExceptionResolver 에서 예외를 처리해버린다. (물론 처리를 안할수도 있다. response.sendError 로 상태 코드 변환을 할수도 있다.) 따라서 예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, 스프링 MVC에서 예외 처리는 끝이 난다. 결과적으로 WAS 입장에서는 정상 처리가 된 것이다. 이렇게 예외를 이곳에서 모두 처리할 수 있다는 것이 핵심이다.

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

 

그런데 직접 ExceptionResolver 를 구현하려고 하니 상당히 복잡하다.

지금부터 스프링이 제공하는 ExceptionResolver 들을 알아보자.

---

강의를 듣고 정리한 글입니다. 코드와 그림 등의 출처는 김영한 강사님께 있습니다.