[Spring] API 예외 처리

 

안녕하세요 이번 포스팅은 API 예외 처리에 대해서 알아보겠습니다!!

 

API 예외 처리 - 시작

 

HTML 페이지의 경우 지금까지 설명했던 것처럼 4xx, 5xx와 같은 오류 페이지만 있으면 대부분의 문제를 해결할 수 있었습니다. 그런데 API의 경우에는 생각할 내용이 더 많습니다.

오류 페이지는 단순히 고객에게 오류 화면을 보여주고 끝이지만, API는 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 합니다. 지금부터 API의 경우 어떻게 예외 처리를 하면 좋은지 알아보겠습니다.

 

WebServerCustomizer

 

import org.springframework.boot.web.server.ConfigurableWebServerFactory;
import org.springframework.boot.web.server.ErrorPage;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;

@Component
public class WebServerCustomizer implements
WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
     @Override
     public void customize(ConfigurableWebServerFactory factory) {
         ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/errorpage/404");
         ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");
         ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/errorpage/500");
         
         factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
     }
}

Customizer를 스프링 빈으로 등록하고 ErrorPage를 설정해주면 WAS에 예외가 전달되거나, resopnse.sendError()가 호출되면 위에 등록한 예외 페이지 경로가 호출됩니다.

 

ApiExceptionController

 

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@RestController
public class ApiExceptionController {

 @GetMapping("/api/members/{id}")
 public MemberDto getMember(@PathVariable("id") String id) {
     if (id.equals("ex")) {
    	 throw new RuntimeException("잘못된 사용자");
     }
     return new MemberDto(id, "hello " + id);
 }
 
 @Data
 @AllArgsConstructor
 static class MemberDto {
     private String memberId;
     private String name;
 }
}

단순히 회원을 조회하는 기능을 하나 만들었습니다. 예외 테스트를 위해 URL에 전달된 id의 값이 ex 이면 예외가 발생하도록 코드를 심어두었습니다.

 

이제 Postman으로 테스트를 해보겠습니다.

반드시 HTTP Header에 Accept가 application/json인 것을 꼭 확인해야합니다.

 

http://localhost:8080/api/members/spring으로 호출하게 되면 다음과 같은 결과를 볼 수 있습니다.

 

 

하지만 http://localhost:8080/api/members/ex를 호출해서 예외를 발생시키면 ErrorPage에 등록해 두었던 url로 다시 mapping 요청을 하면서 templates 경로에 있는 html 파일을 반환하게 됩니다.

 

이것은 저희가 기대하는 바가 아닙니다. 클라이언트는 정상 요청이든, 오류 요청이든 Accept에 application/json으로 설정했기 때문에 JSON으로 반환되기를 기대합니다.

 

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

 

ErrorPageController - API 응답 추가

 

@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() 두 메서드를 확인할 수 있습니다.

 

1. errorHtml() : produces = MediaType.TEXT_HTML_VALUE : 클라이언트 요청의 Accept 헤더 값이 text/html인 경우에는 errorHtml()을 호출해서 view를 제공합니다.

 

2. error() : 그 외 경우에 호출되고 ResponseEntity로 HTTP Body에 JSON 데이터를 반환합니다.

 

스프링 부트의 예외 처리

앞서 공부했듯이 스프링 부트의 기본 설정은 오류 발생 시 /error를 오류 페이지로 요청합니다. BasicErrorController는 이 경로를 기본으로 받습니다.

 

WebServerCustomizer의 @Component를 주석 처리하고 다음의 url을 호출해보겠습니다.

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

 

결과

 

 

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

 

 

HTML 페이지 vs API 오류

 

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

 

스프링 부트가 제공하는 BasicErrorController는 HTML 페이지를 제공하는 경우에는 매우 편리합니다. 4xx, 5xx 등등 모두 잘 처리해줍니다.

그런데 API 오류 처리는 다른 차원의 이야기입니다. API 마다, 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야 할 수도 있습니다.

예를 들어서 회원과 관련된 API에서 예외가 발생할 때 응답과, 상품과 관련된 API에서 발생하는 예외에 따라 그 결과가 달라질 수 있습니다. 결과적으로 매우 세밀하고 복잡하다. 따라서 이 방법은 HTML 화면을 처리할 때 사용하고, API는 오류 처리는 뒤에서 설명할 @ExceptionHandler를 사용하면 됩니다.

 

그렇다면 복잡한 API 오류는 어떻게 처리해야 하는지 지금부터 하나씩 알아보겠습니다.

 

 

 API 예외 처리 - HandlerExceptionResolver 시작

 

목표

예외가 발생해서 서블릿을 넘어서 WAS까지 예외가 전달되면 HTTP 상태 코드가 500으로 처리됩니다. 발생하는 예외에 따라서 400, 404 등 다른 상태로 처리하려고 합니다.

즉, 오류 메시지, 형식 등을 API마다 다르게 처리하는 것입니다.

 

상태코드 변환

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

 

ApiExceptionController - 수정

 

@GetMapping("/api/members/{id}")
public MemberDto getMember(@PathVariable("id") String id) {
     if (id.equals("ex")) {
   	  throw new RuntimeException("잘못된 사용자");
     }
     if (id.equals("bad")) {
  	   throw new IllegalArgumentException("잘못된 입력 값");
     }
     return new MemberDto(id, "hello " + id);
}

우선 bad라는 pathVariable이 오면 IllegalArgumentException이 발생하도록 합니다.

 

postman으로 실행해서 상태 코드르 보면 500인 것을 확인할 수 있습니다.

 

 

HandlerExceptionResolver

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

 

ExceptionResolver 적용 전

 

 

ExceptionResolver 적용 후

 

 

참고 : ExceptionResolver로 예외를 해결하여도 postHandle()은 호출되지 않습니다.

 

 

HandlerExceptionResolver - 인터페이스

 

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

 

1. handler : 핸들러(컨트롤러) 정보

2. Exception ex : 핸들러(컨트롤러)에서 발생한 예외

 

 

MyHandlerExceptionResolver

 

 

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException

@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", e);
         }
     return null;
 }
}

 

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

 

 

반환 값에 따른 동작 방식

HandlerExceptionResolver의 반환 값에 따른 DispatcherServlet의 동작 방식은 다음과 같습니다

 

1. 빈 ModelAndView : new ModelAndView()처럼 빈 객체를 반환하면 뷰를 렌더링 하지 않고 정상 흐름으로 서블릿이 리턴됩니다.

 

2. ModelAndVeiw 지정 : ModelAndView에 View, Model 등의 정보를 지정해서 반환하면 뷰를 렌더링 합니다.

 

3. null : null을 반환하면 다음 ExceptionResolver를 찾아서 실행합니다. 만약 처리할 수 있는 ExceptionResolver가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던집니다.

 

ExceptionResolver 활용

1. 예외 상태 코드 변환

- 예외를 response.sendError() 호출로 변경해서 서블릿에서 상태 코드에 따른 오류를 처리하도록 위임합니다.

- 이후 WAS는 서블릿 오류 페이지를 찾아서 내보 호출, 예를 들어서 스프링 부트가 기본으로 설정한 /error 가 호출됩니다.

 

2. 뷰 템플릿 처리

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

 

3. API 응답 처리

- response.getWriter(). println("hello");처럼 HTTP  응답 바디에 직접 데이터를 넣어주는 것이 가능합니다. 여기에 JSON으로 응답하면 API 응답 처리를 할 수 있습니다.

 

 

WebConfig - 수정

WebMvcConfigurer를 통해 등록

 

/**
 * 기본 설정을 유지하면서 추가
 */
@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver>
resolvers) {
     resolvers.add(new MyHandlerExceptionResolver());
}

configureHandlerExceptionResolvers()를 사용하면 스프링이 기본으로 등록하는 ExceptionResolver가 제거되므로 주의해야 합니다. 그래서 반드시 extendHandlerExceptionResolver를 사용해야 합니다.

 

이제 postman으로 http://localhost:8080/api/members/bad로 요청을 하면 HTTP 상태 코드가 400인 것을 확인할 수 있습니다.

 

API 예외 처리 - HandlerExceptionResolver 활용

 

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

 

예제로 알아보겠습니다.

 

UserException

 

 

public class UserException extends RuntimeException {
     public UserException() {
     	super();
     }
     public UserException(String message) {
     	super(message);
     }
     public UserException(String message, Throwable cause) {
     	super(message, cause);
     }
     public UserException(Throwable cause) {
     	super(cause);
     }
     protected UserException(String message, Throwable cause, boolean
    enableSuppression, boolean writableStackTrace) {
     	super(message, cause, enableSuppression, writableStackTrace);
     }
}

 

 

ApiExceptionController - 예외 추가

 

 

import hello.exception.exception.UserException;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@RestController
public class ApiExceptionController {
     @GetMapping("/api/members/{id}")
     public MemberDto getMember(@PathVariable("id") String id) {
         if (id.equals("ex")) {
        	 throw new RuntimeException("잘못된 사용자");
         }
         if (id.equals("bad")) {
        	 throw new IllegalArgumentException("잘못된 입력 값");
         }
         if (id.equals("user-ex")) {
        	 throw new UserException("사용자 오류");
         }

         return new MemberDto(id, "hello " + id);
     }
 
     @Data
     @AllArgsConstructor
     static class MemberDto {
         private String memberId;
         private String name;
 }
}

http://localhost:8080/api/members/user-ex 호출 시 UserException이 발생하도록 해두었습니다.

 

이제 이 예외를 처리하는 UserHandlerExceptionResolver르 만들어 보겠습니다.

 

UserHandlerExceptionResolver

 

import com.fasterxml.jackson.databind.ObjectMapper;
import hello.exception.exception.UserException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

@Slf4j
public class UserHandlerExceptionResolver implements HandlerExceptionResolver {
     private final ObjectMapper objectMapper = new ObjectMapper();

     @Override
     public ModelAndView resolveException(HttpServletRequest request,
    HttpServletResponse response, Object handler, Exception ex) {
         try {
             if (ex instanceof UserException) {
             	log.info("UserException resolver to 400");
             	String acceptHeader = request.getHeader("accept");
             	response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
                 if ("application/json".equals(acceptHeader)) {
                    Map<String, Object> errorResult = new HashMap<>();
                    errorResult.put("ex", ex.getClass());
                    errorResult.put("message", ex.getMessage());

                     String result = objectMapper.writeValueAsString(errorResult);
                     response.setContentType("application/json");
                     response.setCharacterEncoding("utf-8");
                     response.getWriter().write(result);
                     return new ModelAndView();
                 } else {
                 //TEXT/HTML
                 return new ModelAndView("error/500");
             	}
             }
         } catch (IOException e) {
       		log.error("resolver ex", e);
         }
         return null;
     }
}

 

HTTP 요청 헤더의 ACCEPT 값이 application/json 이면 JSON으로 오류를 내려주고, 그 외 경우에는 error/500에 있는 HTML 오류 페이지를 보여줍니다.

 

WebConfig에 UserHandlerExceptionResolver 추가

 

@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver>
resolvers) {
     resolvers.add(new MyHandlerExceptionResolver());
     resolvers.add(new UserHandlerExceptionResolver());
}

 

이제 postman으로 http://localhost:8080/api/members/user-ex에 ACCEPT를 application/json으로 설정하고 요청하면 다음과 같은 결과를 볼 수 있습니다.

 

 

정리

 

ExceptionResolver를 사용하면 컨트롤러에서 예외가 발생해도 ExceptionResolver에서 예외를 처리해버립니다. 따라서 예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, 스프링 MVC에서 예외 처리는 끝이 납니다. 결과적으로 WAS입장에서는 정상 처리가 된 것입니다. 이렇게 예외를 이곳에서 모두 처리할 수 있다는 것이 핵심입니다.

 

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

 

그런데 직접 ExceptionResolver를 구현하려고 하니 상당히 복잡합니다. 다음 포스팅에서는 스프링이 제공하는 ExcpetionResolver 들을 알아보겠습니다.