API 예외 처리 (1) - MediaType, ExceptionResolver

API 예외 처리 (1) - MediaType, ExceptionResolver

2022. 4. 9. 00:02ㆍSpring 기초

HTML을 응답으로 보내주는 경우에는 예외처리를 4xx, 5xx 등의 오류 페이지만 있다면 대부분의 문제를 해결 가능했다.
이에 대한 포스팅은 https://mr-popo.tistory.com/53?category=1004552

스프링 예외 처리와 오류 페이지

서블릿은 크게 두가지 방식으로 예외 처리를 지원한다. Exception (예외) response.sendError(HTTP 상태 코드, 오류 메시지) Exception(예외) 자바의 메인 메서드를 실행하면 main이라는 이름의 쓰레드가 실행

mr-popo.tistory.com

지금부터 API의 경우 어떻게 예외 처리를 하면 좋은지 알아보자!

@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면 RuntimeException을 발생시킨다.
그리고, 기존의 WebServerCustomizer(아래 코드)를 재사용하였다.

@Component
public class WebServerCustomizer implements
WebServerFactoryCustomizer<ConfigurableWebServerFactory> {

@Override
 public void customize(ConfigurableWebServerFactory factory) {
 ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/404");
 
 ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");
 
 ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500");
 //ex로 호출하면 RuntimeException이 발생하므로 /error-page/500이 호출된다.
 factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
 }
}

id값으로 ex가 호출되면, RuntimeException이 WAS까지 전달된다. 그러면 WAS는 /error-page/500을 호출한다.

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

정상 호출
{
 "memberId": "spring",
 "name": "hello spring"
}

예외 발생호출
http://localhost:8080/api/members/ex
<!DOCTYPE HTML>
<html>
<head>
</head>
<body>
...
</body>

문제를 해결하려면 오류 페이지 컨트롤러도 JSON 응답을 할 수 있도록 수정해야 한다. 예외가 발생해도, HTML이 아닌 JSON을 전송하도록 해보자.

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

@RequestMapping를 보면

produces = MediaType.APPLICATION_JSON_VALUE

로 설정하였다. 이는, 클라이언트가 요청하는 HTTP Header의 Accept 의 값이 application/json 일 때 해당 메서드가 호출된다는 것이다. 결국 클라어인트가 받고 싶은 미디어타입이 json이면 이 컨트롤러의 메서드가 호출된다.

응답 데이터를 위해서 Map 을 만들고 status , message 키에 값을 할당했다. Jackson 라이브러리는 Map 을 JSON 구조로 변환할 수 있다. 이 Map을 ResponseEntity 에 담아서 응답하기 때문에 메시지 컨버터가 동작하여 클라이언트에 JSON이 반환된다.

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

기본 HTML뿐만 아니라 API 예외처리도 스프링 부트가 제공하는 기본 오류 방식을 사용할 수 있다. 기본 오류 방식은 위에 링크 걸어둔 이전 포스팅을 참고하자!(간략히 설명하자면, 스프링부트는 오류 발생시 /error를 오류 페이지로 요청하며, 이 요청을 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 데이터를 반환한다.

이 BasicErrorController를 사용하기 위해 위의 WebServerCustomizer는 주석처리하였다.

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

HandlerExceptionResolver

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

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

ExceptionResolver를 사용하기 전에는, 컨트롤러에서 예외가 발생하였을 경우, 처리하지 못하고 WAS로 전달되면 상태코드 500 서버에러가 발생했다.

ExceptionResolver를 사용하면, WAS로 가기 전, 예외 해결 시도가 가능하다. 참고로 인터셉터의 postHandle()메서드는 ExceptionResolver를 적용해도 실행되지 않는다(이미 예외는 발생했으니까)

그럼 ExceptionResolver를 사용해보자.
먼저, HandlerExceptionResolver 인터페이스를 구현해야 한다.

public interface HandlerExceptionResolver {
 ModelAndView resolveException(
     HttpServletRequest request, HttpServletResponse response,
     Object 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", e);
         }
         
     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 가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던진다.

HandlerExceptionResolver 를 활용하는 방식은,

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

HandlerExceptionResolver 는 WebMvcConfigurer를 통해 등록해야한다.

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

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

HandlerExceptionResolver 활용- 예외를 여기서 마무리하기

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

먼저 사용자 정의 예외를 하나 추가하였다.

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);
     }
}

@Slf4j
@RestController
public class ApiExceptionController {

 @GetMapping("/api/members/{id}")
 public MemberDto getMember(@PathVariable("id") String id) {
	 if (id.equals("user-ex")) {
		 throw new UserException("사용자 오류");
 }

예외를 발생할 컨트롤러도 등록하였다. url로 user-ex 호출 시 UserException이 발생하도록 해두었다.
이제 이 예외를 WAS까지 보내지도 않고 처리해버리는 UserHandlerExceptionResolver 를 만들어보자.

@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) {

             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 {
         //Header가 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 오류 페이지를 보여준다.

예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, 스프링 MVC에서 예외 처리는 끝이 난다.
결과적으로 WAS 입장에서는 정상 처리가 된 것이다. 이렇게 예외를 이곳에서 모두 처리할 수 있다는 것이 핵심이다.
서블릿 컨테이너까지 예외가 올라가면 복잡하고 지저분하게 추가 프로세스가 실행된다.
반면에 ExceptionResolver 를 사용하면 예외처리가 상당히 깔끔해진다. 그런데 직접 ExceptionResolver 를 구현하려고 하니 상당히 복잡하다. 다음 포스팅부터, 스프링이 제공하는 ExceptionResolver 들을 알아보자

++참고로 마지막의 UserHandlerExceptionResolver도 WebConfig에 추가해주어야 한다.

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

저작자표시

'Spring 기초' 카테고리의 다른 글

스프링 타입 컨버터(1) - converter, conversionService (0)	2022.04.11
API 예외 처리 (2) - 스프링이 제공하는 ExceptionResolver (0)	2022.04.09
스프링 예외 처리와 오류 페이지 (0)	2022.04.06
로그인 처리 - 필터, 인터셉터(2) (0)	2022.04.05
로그인 처리 - 필터, 인터셉터 (1) (0)	2022.04.05

미스터포포

태그

최근글

댓글

공지사항

아카이브

지금부터 API의 경우 어떻게 예외 처리를 하면 좋은지 알아보자!

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

HandlerExceptionResolver

HandlerExceptionResolver 활용- 예외를 여기서 마무리하기

'Spring 기초' 카테고리의 다른 글

관련글

티스토리툴바