스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - sec09
출처 : 스프링 MVC 2편

API 예외 처리

HTML 페이지의 경우 지금까지 설명했던 것 처럼 4xx, 5xx와 같은 오류 페이지만 있으면 대부분의 문제 해결 가능
BUT, API의 경우, 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 함

API를 요청했는데, 정상의 경우 API로 JSON 형식으로 데이터가 정상 반환되지만, 오류가 발생하면 미리 만들어둔 오류 페이지 HTML이 반환됨
이것은 우리의 예상과 어긋나는 균,,
클라이언트는 정상 요청이든, 오류 요청이든 JSON이 반환되기를 기대한다.

JSON응답이 가능하도록 수정

@RequestMapping(value = "/error-page/500", produces = MediaType.APPLICATION_JSON_VALUE)
    public ResponseEntity<Map<String, Object>> errorPage500Api(HttpServletRequest request, HttpServletResponse response){

        log.info("API errorPage 500");

        Map<String,Object> result =  new HashMap<>();
        Exception ex = (Exception) request.getAttribute(ERROR_EXCEPTION);
        result.put("status",request.getAttribute(ERROR_STATUS_CODE));
        result.put("message",ex.getMessage());

        Integer statusCode = (Integer) request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
        return new ResponseEntity<>(result, HttpStatus.valueOf(statusCode));
    }

produces = MediaType.APPLICATION_JSON_VALUE 의 뜻은 클라이언트가 요청하는 HTTP Header의 Accept 의 값이 application/json 일 때 해당 메서드가 호출 => 클라어인트가 받고 싶은 미디어타입이 json이면 이 컨트롤러의 메서드가 호출됨
응답 데이터를 위해, Map 을 만들고 status , message 키에 값을 할당
Jackson 라이브러리는 Map 을 JSON 구조로 변환 가능
ResponseEntity 를 사용해서 응답하기 때문에 메시지 컨버터가 동작하면서 클라이언트에 JSON이 반환됨

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

스프링 부트가 제공하는 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 데이터를 반환

HTML페이지 VS API 오류

BasicErrorController 를 확장하면 JSON 메시지도 변경할 수 있다. BUT! API 오류는 @ExceptionHandler 가 제공하는 기능을 사용하는 것이 더 조음!
BasicErrorController 는 HTML 페이지를 제공하는 경우에는 매우 편리 => 4xx, 5xx 등등 모두 잘 처리해주지만, API 오류 처리는 다른 차원의 이야기
WHY? API 마다, 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야 할 수도 있기 때문

HandlerExceptionResolver

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

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

+) ExceptionResolver로 예외를 해결해도 postHandle은 호출되지 않음
HandlerExceptionResolver 인터페이스

public interface HandlerExceptionResolver {
  ModelAndView resolveException(
    HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex);
}

handler : 핸들러(컨트롤러) 정보
Exception ex : 핸들러(컨트롤러)에서 발생한 발생한 예외

@Slf4j
public class MyHandlerExceptionResolver implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        try {
            if (ex instanceof IllegalArgumentException) {
                log.info("IllegalArgumentException resolver to 400");
                response.sendError(HttpServletResponse.SC_BAD_REQUEST, ex.getMessage());
                return new ModelAndView();
            }
        } catch (IOException e) {
            log.error("resolver ex",ex);
        }
        return null;
    }
}

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 가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던짐

ExceptionResolver 활용

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

WebConfig에서 추가할 때,
configureHandlerExceptionResolvers(..) 를 사용하면 스프링이 기본으로 등록하는 ExceptionResolver 가 제거되므로 주의, extendHandlerExceptionResolvers 를 사용하자.

HandlerExceptionResolver 활용

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

ExceptionResolver 를 사용하면 컨트롤러에서 예외가 발생해도 ExceptionResolver 에서 예외를 처리함
=> 예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, 스프링 MVC에서 예외 처리는 끝이 남, WAS 입장에서는 정상 처리가 된 것이고 이렇게 예외를 이곳에서 모두 처리할 수 있다는 것이 핵심
서블릿 컨테이너까지 예외가 올라가면 복잡하고 지저분하게 추가 프로세스가 실행되는 반면에 ExceptionResolver 를 사용하면 예외처리가 상당히 깔끔해짐

스프링이 제공하는 ExceptionResolver1

HandlerExceptionResolverComposite 에 다음 순서로 등록
1. ExceptionHandlerExceptionResolver
API 예외 처리는 대부분 이 기능으로 해결함
2. ResponseStatusExceptionResolver
HTTP 상태 코드 지정 가능 @ResponseStatus를 통해서
3. DefaultHandlerExceptionResolver 우선 순위가 가장 낮다.
스프링 내부 기본 예외 처리

ResponseStatusExceptionResolver

@ResponseStatus 가 달려있는 예외, ResponseStatusException 예외 이 두가지를 처리함
예외가 컨트롤러 밖으로 넘어가면 ResponseStatusExceptionResolver는 예외가 갖고 있는 애노테이션을 확인해서 오류 코드를 변경하고, 메시지도 담음(어노테이션 파라미터에 reason ="" 작성하면 됨)
ResponseStatusExceptionResolver 코드를 확인해보면 결국, response.sendError(statusCode, resolvedReason) 를 호출함
즉, sendError(오류 코드) 를 호출했기 때문에 WAS에서 다시 오류 페이지( /error )를 내부 요청

메시지 기능도 제공
reason은 MessageSource에서 찾는 기능도 제공함
즉, messages.properties에서 찾아오는게 가능하다는 뜻

@ResponseStatus 는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다. (애노테이션을 직접 넣어야 하는데, 내가 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에는 적용할 수 없다.)
추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵다. 이때는 ResponseStatusException 예외를 사용하면 된다.

DefaultHandlerExceptionResolver

DefaultHandlerExceptionResolver 는 스프링 내부에서 발생하는 스프링 예외를 해결
대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException 발생, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로 500 오류가 발생
그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제 => DefaultHandlerExceptionResolver 는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로 변경
이게 가능한 이유, DefaultHandlerExceptionResolver.handleTypeMismatch 를 보면 response.sendError(400오류 코드) 를 보냄, 즉 response.sendError()를 통해서 문제 해결

@ExceptionHandler

API 예외처리의 어려운 점
HandlerExceptionResolver 를 떠올려 보면 ModelAndView 를 반환해야 했음 => 이것은 API 응답에는 필요하지 않음
API 응답을 위해서 HttpServletResponse 에 직접 응답 데이터를 넣어주었는데, 과거로 돌아간 느낌
특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어려움

스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler 라는 애노테이션을 사용하는 매우 편리한 예외 처리 기능을 제공하는데, 이것이 바로 ExceptionHandlerExceptionResolver
스프링은 ExceptionHandlerExceptionResolver 를 기본으로 제공하고, 기본으로 제공하는 ExceptionResolver 중에 우선순위도 가장 높음! 실무에서 API 예외 처리는 대부분 이 기능 사용

에외 처리 방법
@ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 됨! 해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다. 참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있음

@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandle(IllegalArgumentException e) {
	log.error("[exceptionHandle] ex", e);
	return new ErrorResult("BAD", e.getMessage());
}

자식 VS 부모 우선 순위

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

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

@ExceptionHandler 에 지정한 부모 클래스는 자식 클래스까지 처리 가능
=> 자식예외가 발생하면 부모예외처리() , 자식예외처리() 둘 다 호출 대상이 됨 둘 중 더 자세한 것이 우선권을 가지므로 자식예외처리() 가 호출됨, 물론 부모예외 가 호출되면 부모예외처리() 만 호출 대상이 되므로 부모예외처리() 가 호출됨

예외의 다양한 적용
1. 어노테이션에 파라미터로 다양한 예외를 한 번에 줄 수 있음
2. 어노테이션에서 예외를 생략하고 메서드 파라미터로 예외를 줄 수 있음

예시

@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandle(IllegalArgumentException e) {
  log.error("[exceptionHandle] ex", e);
  return new ErrorResult("BAD", e.getMessage());
}

실행흐름
1. 컨트롤러를 호출한 결과 IllegalArgumentException 예외가 컨트롤러 밖으로 던져짐
2. 예외가 발생했으로 ExceptionResolver 작동, 가장 우선순위가 높은
ExceptionHandlerExceptionResolver 실행
3. ExceptionHandlerExceptionResolver 는 해당 컨트롤러에 IllegalArgumentException 을 처리할 수 있는 @ExceptionHandler 가 있는지 확인
4. illegalExHandle() 를 실행, @RestController 이므로 illegalExHandle() 에도 @ResponseBody 가 적용됨! 따라서 HTTP 컨버터가 사용되고, 응답이 다음과 같은 JSON으로 반환됨
5. @ResponseStatus(HttpStatus.BAD_REQUEST) 를 지정했으므로 HTTP 상태 코드 400으로 응답

@ControllerAdvice

@ExceptionHandler 를 사용해서 예외를 깔끔하게 처리할 수 있게 되었지만, 정상 코드와 예외 처리 코드가 하나의 컨트롤러에 섞여 있음
=> @ControllerAdvice 또는 @RestControllerAdvice 를 사용하면 둘을 분리할 수 있음

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

대상 컨트롤러 지정 방법

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