Spring API 예외 처리

hoyong.eom·2023년 7월 29일
APISpringspringMVC예외처리
0

스프링

목록 보기
24/59
post-thumbnail

Spring

API 예외 처리 - 서블릿

API 서버가 아닌 웹서버는 요청에 대한 결과로서 Html 페이지를 전달한다.
따라서, 이전에 예외가 발생한 경우 특정 오류 페이지를 클라이언트에게 전달해주는 과정을 공부했다.
그렇다면 API서버라면 어떨까?
Html 페이지를 전달하는게 올바른 방법일까? 당연히아니다.

API 서버는 각 오류 상황에 맞게 오류 응답 스펙을 정하고 Json으로 데이터를 내려줘야한다.

Servlet 방식의 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);
    }
}

위 코드의 핵심은 WebServerFactoryCustomizer를 구현한 클래스에서 customize 함수의 오버라이드 이다.

그리고 위 오류 코드 요청에 대한 컨트롤러는 아래와 같다.

@Slf4j
@Controller
public class ErrorPageController {

    //RequestDispatcher 상수로 정의되어 있음
    public static final String ERROR_EXCEPTION = "javax.servlet.error.exception";
    public static final String ERROR_EXCEPTION_TYPE = "javax.servlet.error.exception_type";
    public static final String ERROR_MESSAGE = "javax.servlet.error.message";
    public static final String ERROR_REQUEST_URI = "javax.servlet.error.request_uri";
    public static final String ERROR_SERVLET_NAME = "javax.servlet.error.servlet_name";
    public static final String ERROR_STATUS_CODE = "javax.servlet.error.status_code";

    @RequestMapping("/error-page/404")
    public String errorPage404(HttpServletRequest request, HttpServletResponse response) {
        log.info("errorPage 404");
        printErrorInfo(request);
        return "error-page/404";
    }

    @RequestMapping("/error-page/500")
    public String errorPage500(HttpServletRequest request, HttpServletResponse response) {
        log.info("errorPage 500");
        printErrorInfo(request);
        return "error-page/500";
    }
  }

위 컨트롤러에서는 정상적인 경우 Json 결과를 반환해주지만 예외가 발생한 경우 오류 Html을 넘겨준다.

Servlet에서는 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일때 해당 메서드가 호출되도록 한다는 의미가 된다.

그리고 반환값으로 HttpMessageBody에 데이터를 바로 쓸 수 있는 ResponseEntity를 사용했다.

즉, 정리를 해보면 produces 값에 의해서 클라이언트가 요청한 타입에 따라서 Html을 전달할건지, Json을 전달할 건지 메서드를 선택해서 수행할 수 있게 된다.

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

API 예외 처리도 스프링 부트가 제공하는 기본 오류 방식을 사용할 수 도 있다.
스프링 부트는 기본적으로 BasicErrorCOntroller라는 컴포넌트를 스프링빈에 등록해서 사용한다.

@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {

	private final ErrorProperties errorProperties;

	/**
	 * Create a new {@link BasicErrorController} instance.
	 * @param errorAttributes the error attributes
	 * @param errorProperties configuration properties
	 */
	public BasicErrorController(ErrorAttributes errorAttributes, ErrorProperties errorProperties) {
		this(errorAttributes, errorProperties, Collections.emptyList());
	}

	/**
	 * Create a new {@link BasicErrorController} instance.
	 * @param errorAttributes the error attributes
	 * @param errorProperties configuration properties
	 * @param errorViewResolvers error view resolvers
	 */
	public BasicErrorController(ErrorAttributes errorAttributes, ErrorProperties errorProperties,
			List<ErrorViewResolver> errorViewResolvers) {
		super(errorAttributes, errorViewResolvers);
		Assert.notNull(errorProperties, "ErrorProperties must not be null");
		this.errorProperties = errorProperties;
	}

	@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
	public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
		HttpStatus status = getStatus(request);
		Map<String, Object> model = Collections
				.unmodifiableMap(getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.TEXT_HTML)));
		response.setStatus(status.value());
		ModelAndView modelAndView = resolveErrorView(request, response, status, model);
		return (modelAndView != null) ? modelAndView : new ModelAndView("error", model);
	}

	@RequestMapping
	public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
		HttpStatus status = getStatus(request);
		if (status == HttpStatus.NO_CONTENT) {
			return new ResponseEntity<>(status);
		}
		Map<String, Object> body = getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.ALL));
		return new ResponseEntity<>(body, status);
	}

위 코드는 BasicErrorController 소스의 일부분이다.

앞서 Servlet API 예외 처리에서 직접 작성했었던 코드와 매우 유사하다.

기본적으로 /error 동일한 경로를 처리하는는 errorHtml과 error 2가지 메서드를 확인할 수 있다.

정리해보면 스프링 부트는 예외처리를 할떄
/error를 오류 페이지로 요청하며 BaiscErrorController는 이 경로를 기본으로 받는다.

(server.error.path 로 수정이 가능하다.)

Servlet 방식에서 추가했던 WebServerCutomizer의 @Component 애노테이션을 주석 처리하고 실행하면 BasicErrorController가 실행되는것을 확인할 수 있다.

스프링부트에서 Html 페이지와 API 오류

BasicErrorController를 사용하면 error 뷰 경로에 에러 페이지만 넣어놓으면 매우 편리하게 Html 에러 페이지를 제공할 수 있다.
그러나, API 예외 처리는 매우 복잡하게 설정해야할 수 있다. 복잡한 API 오류는 BasicErrorController가 아닌 다른 방법을 사용해야 한다.

API 예외 처리 - handlerExceptionResolver

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

컨트롤러에서 예외가 발생한 경우 ExceptionResolver가 있으면 예외를 해결해서 WAS로 정상 응답을 보낼 수 있고, 그대로 예외를 전달도 가능하며, 예외를 바꿔서 전달할 수 도 있다.

HandlerExceptionResolver 인터페이스는 아래와 같다..

public interface HandlerExceptionResolver {

	@Nullable
	ModelAndView resolveException(
			HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex);

}

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

HandlerExceptionResolver를 구현해서 Servlet에서 지원했던 Html오류페이지와 API 예외 처리를 하는 방식을 아래와 같이 처리도 가능하다.

public class MyHandlerExceptionResolver implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {

        log.info("call resolver", 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;
    }
}

위 ExceptionHandler에서는 컨트롤러에서 WAS서버까지 에러가 전달된 경우 500에러를 발생시키지만, ExceptionHandler에서 400에러로 바꿔서 전달한다. 그리고 빈 ModelAndView()를 전달해서 마치 정상 흐름 처럼 변경한다.

ExceptionHandler의 반환값에 따른 동작 방식

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

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

null : null을 반환하면, 다음 ExceptionHandler를 찾아서 실행한다.

ExceptonResolver 활용

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

ExceptionResolver 등록

ExceptionHandler는 WebMvcConfigure를 통해서 등록할 수 있다.

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

configureHandleerExceptionResolvers를 사용하면 스프링이 기본으로 등록해주는 ExceptionResolver가 제거되므로 extendHandlerExceptionResolvers를 사용해야함.

API 예외처리 - HandlerExceptionResolver 활용

예외가 발생하면 WAS까지 예외가 던져지고, WAS에서 오류 페이지 정보를 찾아서 다시 /error를 호출하는 과정은 매우 복잡하다. ExceptionResolver를 활용하면 예외가 발생했을떄 이런 복잡한 과정없이 resolver에서 해결이 가능하다.

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

위 코드를 보면 Html 오류페이지와 API 예외처리가 WAS에서 처리되는게 아니라 ExceptionResolver에서 모두 처리되고 있다.

API 예외 처리 - 스프링이 제공하는 ExceptionResolver1

ExceptionResolver는 스프링부트가 기본적으로 제공해준다.(이래서 스프링부트를 사용해야한다!!!!)

여러가지 ExceptionResolver를 제공해주는데 아래와 같다.

  1. ExceptionHandlerExceptionResolver
  2. ResponseStatusExceptionResolver
  3. DefaultHandlerExceptionResolver
    1이 우선순위가 가장 높고, 3이 가장 낮다.

각 resolver를 간단히 설명하면 아래와 같다.

ExceptionHandlerExceptionResolver

@ExceptionHandler를 처리한다. API 예외 처리는 대부분 이 기능으로 해결한다.

ResponseStatusExceptionResolver

Http 상태 코드를 지정해준다.
예시)
@ResponseStatus(value = HttpStatus.NOT_FOUND)

DefaultHandlerExceptionResolver
스프링 내부 기본 예외를 처리한다.

ResponseStatusExceptionResolver

ResponseStatusExceptionResolver는 예외에 따라서 Http 상태 코드를 지정해주는 역할을 하다.

다음 두 가지 경우를 처리한다.

  • @ResponseStatus가 달려 있는 예외
  • ResponseStatusException 예외

ResponseStatus

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "error.bad")
public class BadRequestException extends RuntimeException {

위 코드를 보면 BadRequestException 예외가 컨트롤러 밖으로 나가면 ResponseStatusExceptionResolver가 해당 애노테이션을 확인해서 오류 코드를 HttpStatus.BAD_REQUEST(400)으로 변겨앟고 메시지도 담는다.

ResponseStatusExceptionResolver코드를 확인해보면 response.sendError() 를 호출하기 떄문에 WAS에서 다시 오류 페이지를 내부 요청한다.
그리고 reason에 오류 메시지 코드를 넣어서 사용할 수 도 있다.reasone은 MessageSource에서 찾는 기능도 제공한다.

ResponseStatus

@ResponseStatus는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 가 없다.(애노테이션을 직접 넣어야하는데 그럴 수가 없으니까..)
이떄는 ResponseStatusExcepton예외를 사용하면 된다.

    @GetMapping("/api/response-status-ex2")
    public String responseStatusEx2() {
        throw new ResponseStatusException(HttpStatus.NOT_FOUND, "error.bad", new IllegalArgumentException());
    }

DefaultHandlerExceptionResolver

DefaultHandlerExceptionResolver는 스프링 부 내부에서 발생하는 스프링 예외를 해결한다.
대표적으로 파라미터 바인딩 시점에 맞지 않으면 내부에서 TypeMismathException이 발생하는데 이 경우에 예외가 발생했기 떄문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고 결과적으로 500에러가 발생한다. 그런데 파라미터 바인딩은 대부분 클라이언트가 Http 요청 정보를 잘못 호출해서 발생하는 문제이므로 Http에서는 이런 경우 Http 상태코드 400사용하도록 되어 있다.

DefaultHandlerExceptionResolver는 500이 아니라 400으로 변경해준다.

@ExceptionHandler

API 예외 처리의 경우에는 각 상황에 따른 오류 응답을 전달해줘야하기 떄문에 세밀한 제어가 필요하다.

API 예외 처리가 어려운 이유는 다음과 같다.

  • HandlerExceptionResolver는 ModelAndView를 반환한다. 이것은 사실 API 응답에는 필요하지 않다.
  • API응답을 위해서 HttpServletResponse에 직접 응답 데이터를 넣어줘야한다. 매우 불편하다.. 아주 옜날 방식이다.
  • 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기가 어렵다.

이러한 문제를 쉽게 해결하기 위해서 스프링에서는 @ExceptionHandler라는 애노테이션을 제공한다.
이게 바로 ExceptionHandlerExceptionREesolver이다.

스프링은 ExceptionHandlerExceptionResolver를 기본으로 제공하고 우선순위도 가장 높다.

예제 코드는 아래와 같다.


@Slf4j
@RestController
public class ApiExceptionV2Controller {

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(IllegalArgumentException.class)
    public ErrorResult illegalExHandler(IllegalArgumentException e) {
        log.error("[exceptionHandler ex", e);

//        json 객체로 출력됨.
        return new ErrorResult("BAD", e.getMessage());
    }

//    UserException이 매개변수와 동일해서 생략가능
    @ExceptionHandler
    public ResponseEntity<ErrorResult> userExHandle(UserException e) {
        log.error("[exceptionHandle] ex", e);
        ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
        return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
    }



    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler
    public ErrorResult exHandle(Exception e) {
        log.error("[exceptionHandle] ex", e);
        return new ErrorResult("EX", "내부 오류");
    }

    @GetMapping("/api2/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;
    }

}

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

@ExceptionHandler는 예외 생략도 가능한데 생략하면 메서드 파라미터의 예외가 지정된다.

API 예외 처리 - @ControllerAdvice

@EXceptionHandler를 사용해서 예외를 깔끔하게 처리할 수 있지만 컨트롤러에 정상 코드와 예외 처리 코드가 섞여있다.

@ControllerAdvice 또는 @RestControllerAdvice를 사용하면 분리가 가능하다.

@Slf4j
@RestControllerAdvice(basePackages = "hello.exception.api")
public class ExControllerAdvice {

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

    @ExceptionHandler
    public ResponseEntity<ErrorResult> userExHandler(UserException e) {
        log.error("[exceptionHandler] ex", e);
        ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
        return new ResponseEntity(errorResult, HttpStatus.BAD_REQUEST);
    }

    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler
    public ErrorResult exHandler(Exception e) {
        log.error("[exceptionHandler] ex", e);
        return new ErrorResult("EX", "내부 오류");
    }

}

@ControllerAdive는 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler, @InitBinder기능을 부여해주는 역할을 하다.

@ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다.

@RestControllerAdvice는 @ControllerAdvice와 같고, @ResponseBody가 추가되어있따.

참고

아래의 강의를 공부하여 정리한 내용입니다.
김영한님의 SpringMVC2-예외처리

profile
hoyong.eom
Hello
이전 포스트

Spring에서의 API 예외 처리

다음 포스트

Spring에서의 타입 컨버터

0개의 댓글