지금부터 API의 경우 어떻게 예외 처리를 하면 좋은지 알아보겠습니다.
먼저 API 예외 상황 서블릿 오류 페이지 방식을 사용해보겠습니다.
서블릿 오류 페이지로 방식
@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");
factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
}
}@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이면 예외가 발생하도록 했습니다.
HTTP Header에 Accept 가 application/json을 넣어줍니다.
정상 호출
http://localhost:8080/api/members/spring
{
"memberId": "spring",
"name": "hello spring"
}예외 발생 호출
<!DOCTYPE HTML>
<html>
<head>
</head>
<body>
...
</body>API를 요청했는데, 정상의 경우 API로 JSON 형식으로 데이터가 정상 반환됩니다. 그런데 오류가 발생하면 우리가 미리 만들어둔 오류 페이지 HTML이 반환됩니다. 우리가 원하는 방식으로 동작하는게 아닙니다.
문제를 해결하려면 오류 페이지 컨트롤러도 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이 반환됩니다.
{
"message": "잘못된 사용자",
"status": 500
}
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를 주석처리 하자.
{
"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는 HTML 페이지를 제공하는 경우에는 매우 편리합니다.
4xx, 5xx 등등 모두 잘 처리해줍니다. 그런데 API 오류 처리는 다른 차원의 이야기입니다. API 마다, 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야 할 수도 있다. 예를 들어서 회원과 관련된 API에서 예외가 발생할 때 응답과, 상품과 관련된 API에서 발생하는 예외에 따라 그 결과가 달라질 수 있습니다.
API는 오류 처리는 @ExceptionHandler를 사용하는 것이 좋습니다.
'스프링 > Spring MVC' 카테고리의 다른 글
| [API 예외 처리] 스프링이 제공하는 ExceptionResolver (ResponseStatus, DefaultHandler) (0) | 2021.11.01 |
|---|---|
| [API 예외 처리] - HandlerExceptionResolver 사용하기 (0) | 2021.11.01 |
| 스프링 부트를 사용해 예외 처리 페이지 제공하기 (0) | 2021.10.31 |
| 서블릿으로 예외처리하기 - 필터, 인터셉터 그리고 DispatchType (0) | 2021.10.31 |
| 서블릿으로 예외 처리하기 (0) | 2021.10.31 |
