스프링 MVC 2 - 스프링 부트 기본 오류 처리

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

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

BasicErrorController 코드

@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {

}
@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {

}

/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를 사용하도록 WebServerCustomizer의 @Component를 주석처리 하자.

• GET : http://localhost:8080/api/members/ex

{
    "timestamp": "2022-08-30T15:19:35.648+00:00",
    "status": 500,
    "error": "Internal Server Error",
    "exception": "java.lang.RuntimeException",
    "trace": "java.lang.RuntimeException: 잘못된 사용자\n\tat hello.exception.api.ApiExceptionController.getMember(ApiExceptionController.java:17)\n\tat ...........
    "message": "잘못된 사용자",
    "path": "/api/members/ex"
}

스프링 부트는 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를 사용하자.

출처 : 인프런 김영한 지식공유자님 강의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술