[ Spring ] API Exception Handling

API Exception Handling - start

이전 포스팅에서 Servlet Exception Handling 하는 방법에 대한 포스팅을 작성했는데,

API 예외 처리는 어떻게 해야 할까?

HTML 페이지의 경우 4xx, 5xx와 같은 오류 페이지만 있으면 대부분의 문제를 해결할 수 있다.

그런데 API의 경우에는 생각할 내용이 더 많다.

오류 페이지는 단순히 고객에게 오류 화면을 보여주고 끝이지만,

API는 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 한다.

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

API도 오류 페이지에서 설명했던 것처럼 처음으로 돌아가서 서블릿 오류 페이지 방식을 사용해 보자.

예제 코드로는 이전 소스를 활용하겠다.

( 예외 처리를 알아보시는 분들은 아래 글 참고해 보시면 도움이 될 거 같습니다. )

[ Spring ] 예외 처리와 오류 페이지 - Servlet Exception Handling(오류 페이지 작동 원리)

오늘부터 예외 처리와 오류 페이지 적용 및 작동 원리에 대해 포스팅을 진행해 보겠습니다. 예외를 처리하거나 핸들링하는 방법은 실무에서는 꼭 필요한 챕터입니다. 그래서 서블릿부터 시작해

drg2524.tistory.com

[ Spring ] 예외 처리와 오류 페이지 - Servlet Exception Handling(Filter , Interceptor)

이어서 Servlet Exception Handling 포스팅 진행하겠습니다. 이번 포스팅의 목표는 예외 처리에 따른 필터와 인터셉터 그리고 서블릿이 제공하는 DispatchType에 대해 이해하는 부분을 중점으로 글을 작성

drg2524.tistory.com

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

WebServerCustomizer가 다시 사용되도록 하기 위해 @Component 애노테이션에 있는 주석을 풀자

이제 WAS에 예외가 전달되거나, response.sendError()가 호출되면 위에 등록한 예외 페이지 경로가 호출된다.

ApiExceptionController - API 예외 컨트롤러

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인 것을 꼭 확인하자.

정상 호출

{
 "memberId": "spring",
 "name": "hello spring"
}

예외 발생 호출

<!DOCTYPE HTML>
<html>
<head>
</head>
<body>
	...
</body>

API를 요청했는데,

정상의 경우 API로 JSON 형식으로 데이터가 정상 반환된다.

그런데 오류가 발생하면 미리 만들어둔 오류 페이지 HTML이 반환된다.

이것은 기대하는 바가 아니다.

클라이언트는 정상 요청이든, 오류 요청이든 JSON이 반환되기를 기대한다.

웹 브라우저가 아닌 이상 HTML을 직접 받아서 할 수 있는 것은 별로 없다.

문제를 해결하려면 오류 페이지 컨트롤러도 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이 반환된다.

포스트맨을 통해서 다시 테스트해보자.

{
 "message": "잘못된 사용자",
 "status": 500
}

HTTP Header에 Accept가 application/json이 아니면,

기존 오류 응답인 HTML 응답이 출력되는 것을 확인할 수 있다.

API Exception Handling - Spring Boot Basic Exception Handling

API 예외 처리도 Spring Boot가 제공하는 기본 오류 방식을 사용할 수 있다.

Spring Boot가 제공하는 BasicErrorController 코드를 보자.

BasicErrorController Code

@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를 주석처리 하자.

{

     "timestamp": "2021-04-28T00:00:00.000+00:00",
     "status": 500,
     "error": "Internal Server Error",
     "exception": "java.lang.RuntimeException",
     "trace": "java.lang.RuntimeException: 잘못된 사용자\n\tat 
    hello.exception.web.api.ApiExceptionController.getMember(ApiExceptionController
    .java:19...,
     "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 오류 메시지를 변경할 수 있다 정도로만 이해해 두자.

Spring Boot가 제공하는 BasicErrorController는 HTML 페이지를 제공하는 경우에는 매우 편리하다.

4xx,5xx 등등 모두 잘 처리해 준다.

그런데 API 오류 처리는 다른 차원의 이야기이다.

API 마다, 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야 할 수도 있다.

예를 들어서 회원과 관련된 API에서 예외가 발생할 때 응답과, 상품과 관련된 API에서 발생하는 예외에 따라 그 결과가 달라질 수 있다.

결과적으로 매우 세밀하고 복잡하다.

따라서 이 방법은 HTML 화면을 처리할 때 사용하고, API 오류 처리는 뒤에서 설명할 @ExceptionHandler를 사용하자.

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

API Exception Handling - HandlerExceptionResolver start

목표를 잡아보자.

예외가 발생해서 서블릿을 넘어 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);
}

위 코드에서 {id} 경로에 bad라고 호출하면 IllegalArgumentException이 발생하도록 했다.

실행해 보면 상태 코드가 500인 것을 확인할 수 있다.

{
     "status": 500,
     "error": "Internal Server Error",
     "exception": "java.lang.IllegalArgumentException",
     "path": "/api/members/bad"
}

HandlerExceptionResolver
- Spring MVC는 Controller(Handler) 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공한다.
- Controller 밖으로 던져진 예외를 해결하고, 동작 방식을 변경하고 싶으면 HandlerExceptionResolver를 사용하면 된다.
- 줄여서 ExceptionResolver라 한다.

ExceotuibResolver 적용 전

ExceotuibResolver 적용 후

참고로 ExceptionResolver로 예외를 해결해도 postHandle()은 호출되지 않는다.

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

public interface HandlerExceptionResolver {
     
     ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response,
     Object handler, 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의 동작 방식은 다음과 같다.

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

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

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

■ ExceptionResolver 활용

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

■ WebConfig - 수정

webMvcConfigurer를 통해 등록한다.

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

}

configureHandlerExceptionResolvers(..)를 사용하면 스프링이 기본으로 등록하는

ExceptionResolver가 제거되므로 주의하자, extendHandlerExceptionResolvers를 사용하자.

포스트맨으로 실행해 보면

ex 경로는 HTTP 상태 코드 500

bad 경로는 HTTP 상태 코드 400

값을 확인할 수 있다.

API Exception Handling - 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;
         
     }
     
}

해당 경로에서 /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());

}

포스트맨으로 http://localhost:8080/api/members/user-ex 해당 경로를 실행하면 다음과 같은 결과를 볼 수 있다.

ACCEPT : application/json

{
     "ex": "hello.exception.exception.UserException",
     "message": "사용자 오류"
}

ACCEPT : text/html

<!DOCTYPE HTML>
<html>
...
</html>

마치며

정리해 보면

ExceptionResolver를 사용하면 컨트롤러에서 예외가 발생해도 ExceptionResolver에서 예외를 처리해 버린다.

따라서 예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, Spring MVC에서 예외 처리는 끝이 난다.

결과적으로 WAS 입장에서는 정상 처리가 된 것이다.

이렇게 예외를 이곳에서 모두 처리할 수 있다는 것이 핵심이다.

서블릿 컨테이너까지 예외가 올라가면 복잡하고 지저분하게 추가 프로세스가 실행된다.

반면에 ExceptionResolver를 사용하면 예외처리가 상당히 깔끔해진다.

그런데 직접 ExceptionResolver를 구현하려고 하니 상당히 복잡하다.

다음 포스팅에서 Spring이 제공하는 ExceptionResolver들을 알아보자.

위 포스팅은 김영한님의 Spring MVC 2편 - 백엔드 웹 개발 활용 강의를 참고했습니다

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 강의 - 인프런

웹 애플리케이션 개발에 필요한 모든 웹 기술을 기초부터 이해하고, 완성할 수 있습니다. MVC 2편에서는 MVC 1편의 핵심 원리와 구조 위에 실무 웹 개발에 필요한 모든 활용 기술들을 학습할 수 있

www.inflearn.com

728x90

저작자표시

'[ JAVA ] > JAVA Spring' 카테고리의 다른 글

[ Spring ] Spring Type Converter (3)	2024.01.29
[ Spring ] API Exception Handling - ExceptionResolver (3)	2024.01.25
[ Spring ] 예외 처리와 오류 페이지 - Servlet Exception Handling(Filter , Interceptor) (3)	2024.01.17
[ Spring ] 예외 처리와 오류 페이지 - Servlet Exception Handling(오류 페이지 작동 원리) (77)	2024.01.16
[ Spring ] Spring Interceptor - 인증 체크 / ArgumentResolver 활용 (4)	2024.01.15

환이의 개발일지

[ Spring ] API Exception Handling

■ 반환 값에 따른 동작 방식

■ ExceptionResolver 활용

■ WebConfig - 수정

마치며

'[ JAVA ] > JAVA Spring' 카테고리의 다른 글

티스토리툴바

[ Spring ] API Exception Handling

■ 반환 값에 따른 동작 방식

■ ExceptionResolver 활용

■ WebConfig - 수정

마치며

'[ JAVA ] > JAVA Spring' 카테고리의 다른 글

관련글

티스토리툴바