본 프로젝트 자료는 김영한님의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술을 참고 제작됐음을 알립니다.
API 예외 처리
오류 페이지는 4xx, 5xx와 같은 오류 페이지만 있으면 대부분의 문제를 해결할 수 있지만, API의 경우에는 생각할 내용이 더 많다.
오류 페이지는 단순히 사용자에게 오류 화면을 보여주고 끝이지만, API는 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 한다.
그래서 API의 경우 어떻게 예외 처리를 하는지 어떻게 돌아가는지 알아볼려고 한다.
WebServerCustomizer - @Compenent 주석 해제
아까 스프링부트 를 사용하기 위해 주석 처리한 @Compenent 다시 해제 해주자.
이제 WAS에 예외가 전달되거나, response.sendError() 가 호출되면 위에 등록한 예외 페이지 경로가 호출된다.
ApiExceptionController - API 예외 컨트롤러
단순 회원 조회 기능을 추가.
- 예외테스트를위해URL에전달된 id의값이 ex이면 예외가 발생하도록 코드를 심어두었다.
이제 제대로 동작하는지 PostMan 으로 확인해봤다.
PostMan
정상 호출
예외 발생 호출
정상 호출했을 때는 원하는 모습으로 출력이 되는데, 오류를 발생시킬 때는 설정한 JSON 형식의 메시지가 아닌 등록된 HTML 로 출력됐다.
웹브라우저가 아닌 이상 HTML 로 받아봐야 할 수 있는게 없어, JSON 형식으로 출력될 수 있게 수정해야 한다.
ErrorPageController - API 응답 추가
이제 포스트맨으로 JSON 으로 제대로 변환됐는지 확인해본다.
PostMan
API 예외 처리 - 스프링 부트 기본 오류 처리
API 예외 처리도 스프링 부트가 제공하는 기본 오류 방식을 사용할 수 있다.
BasicErrorController 코드
- errorHtml() , error() : 동일한 error 을 처리한다.
- errorHtml() : produces = MediaType.TEXT_HTML_VALUE : 클라이언트 요청의 Accept 해더 값이 text/html 인 경우에는 errorHtml() 을 호출해서 view를 제공한다.
- error() : 그외 경우에 호출되고 ResponseEntity 로 HTTP Body에 JSON 데이터를 반환한다.
스프링 부트의 예외 처리
스프링 부트의 기본 설정은 오류 발생시 /error 를 오류 페이지로 요청한다.
BasicErrorController 는 이 경로를 기본으로 받는다. ( server.error.path 로 수정 가능, 기본 경로 / error )
Postman
스프링 부트는 BasicErrorController 가 제공하는 기본 정보들을 활용해서 오류 API를 생성해준다.
더 자세한 오류 정보를 확인하고 싶다면,
server.error.include-binding-errors=always
server.error.include-exception=true
server.error.include-message=always
server.error.include-stacktrace=always
위의 방식을 사용해도 되지만, 너무 자세한 정보를 출력해주기에 보안상 추천하지 않는다. 간결한 메시지만 노출하고, 로그를 통해서 확인하자.
API 예외 처리 - HandlerExceptionResolver 시작
WAS 에 예외가 전달되면 HTTP 상태 코드가 500으로 처리된다.
하지만 발생하는 예외에 따라 4xx,500 으로 처리하고 싶다.
이때 상태코드 변환을 사용하면 된다.
상태코드 변환
예를 들어 IllegalArgumentException 을 처리하지 못해 컨트롤러가 밖으로 넘어가면 400으로 처리싶다.
아래와 같이 변경하면 된다.
ApiExceptionController - 수정
코드를 수정하고 PostMan 에 매핑에 등록된 bad 로 출력하면,
실행해보면 500으로 상태 코드가 표시된다.
여기부터 HandlerExceptionResolver 을 사용해 400으로 변경이 가능하다.
HandlerExceptionResolver
스프링 MVC는 컨트롤러(핸들러) 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공한다.
컨트롤러 밖으로 던져진 예외를 해결하고, 동작 방식을 변경하고 싶으면 HandlerExceptionResolver 를 사용하면 된다. 줄여서 ExceptionResolver 라 한다.
ExceptionResolver 적용 전
ExceptionResolver 적용 후
참고: ExceptionResolver 로 예외를 해결해도 postHandle() 은 호출되지 않는다.
HandlerExceptionResolver - 신규 인터페이스 생성
반환 값에 따른 동작 방식
HandlerExceptionResolver 의 반환 값에 따른 DispatcherServlet 의 동작 방식은 다음과 같다.
- 빈 ModelAndView: new ModelAndView() 처럼 빈 ModelAndView 를 반환하면 뷰를 렌더링 하지 않고, 정상 흐름으로 서블릿이 리턴된다.
- ModelAndView 지정: ModelAndView 에 View , Model 등의 정보를 지정해서 반환하면 뷰를 렌더링 한다.
- null: null 을 반환하면, 다음 ExceptionResolver 를 찾아서 실행한다. 만약 처리할 수 있는 ExceptionResolver 가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던진다.
ExceptionResolver 활용
- 예외 상태 코드 변환
- 예외를 response.sendError(xxx) 호출로 변경해서 서블릿에서 상태 코드에 따른 오류를 처리하도록 위임
- 이후 WAS는 서블릿 오류 페이지를 찾아서 내부 호출, 예를 들어서 스프링 부트가 기본으로 설정한 / error 가 호출됨
- 뷰 템플릿 처리
- ModelAndView 에 값을 채워서 예외에 따른 새로운 오류 화면 뷰 렌더링 해서 고객에게 제공
- API 응답 처리
- response.getWriter().println("hello"); 처럼 HTTP 응답 바디에 직접 데이터를 넣어주는 것도 가능하다. 여기에 JSON 으로 응답하면 API 응답 처리를 할 수 있다.
이제 PostMan 으로 정상적으로 등록됐는지 확인해보자.
PostMan
500 -> 400 으로 변경된 것을 확인할 수 있다.
API 예외 처리 - HandlerExceptionResolver 활용
예외가 발생하면 WAS까지 예외가 던져지고,WAS에서 오류 페이지 정보를 찾아서 다시 /error 를 호출하는 과정은 생각해보면 너무 복잡하다.
ExceptionResolver 를 활용하면 예외가 발생했을 때 이런 복잡한 과정 없이 여기에서 문제를 깔끔하게 해결할 수 있다.
예제를 통해 어떻게 바뀌는지 알아볼려고 한다.
UserException - 신규 클래스 생성
먼저 사용자 정의 예외를 하나 추가하자.
ApiExceptionController - 예외 추가
PostMan 호출 시 UserException 이 발생하도록 만들었다.
이제 이 예외를 처리하는 UserHandlerExceptionResolver 를 만들어야 한다.
UserHandlerExceptionResolver - 신규 클래스 생성
HTTP 요청 해더의 ACCEPT 값이 application/json 이면 JSON으로 오류를 내려주고, 그 외 경우에는 error/500에 있는 HTML 오류 페이지를 보여준다.
WebConfig - UserHandlerExceptionResolver 추가
실행 결과
정상적으로 출력된다.
정리
- ExceptionResolver 를 사용하면 컨트롤러에서 예외가 발생해도 ExceptionResolver 에서 예외를 처리해버린다.
- 예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, 스프링 MVC에서 예외 처리는 끝이난다.
- 결과적으로 WAS 입장에서는 정상 처리가 된 것이다. 이렇게 예외를 이곳에서 모두 처리할 수 있다는 것이 핵심이다.
- 서블릿 컨테이너까지 예외가 올라가면 복잡하고 지저분하게 추가 프로세스가 실행된다. 반면에 ExceptionResolver 를 사용하면 예외처리가 상당히 깔끔해진다.
그런데 직접 ExceptionResolver 를 구현하려고 하니 상당히 복잡하다.
조금 더 편리하게 만들 수 있게 스프링이 제공하는ExceptionResolver 를 활용해보자.
