[Spring] API 예외 처리

hi·2022년 12월 16일
Spring
0

HTML 페이지의 경우 오류 페이지만 있으면 대부분의 문제 해결 가능
하지만 API는 각 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 한다

서블릿 오류 페이지 방식

@RequestMapping(produces = MediaType.APPLICATION_JSON_VALUE)

  • 요청 HTTP Header의 Accept 값이 application/json일 때 해당 메서드 호출
ex)

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

스프링 부트 기본 오류 처리

스프링 부트가 제공하는 BasicErrorController를 보면
동일한 경로 /error 를 처리하는 두 메서드가 있다

@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse 
response) {}

@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {}

errorHtml()

  • produces = MediaType.TEXT_HTML_VALUE
  • 클라이언트 요청의 Accept 헤더 값이 text/html 이면 errorHtml() 을 호출하여 view 제공

error()

  • 그 외 경우 호출
  • ResponseEntity 로 HTTP Body에 JSON 데이터를 반환

but , 복잡한 API 오류 처리에는 적합하지 않음


HandlerExceptionResolver

  • 컨트롤러(핸들러) 밖으로 예외가 던져진 경우, 예외를 해결하고 동작을 새로 정의할 수 있다
  • 스프링 MVC 제공

발생하는 예외에 따라 다른 상태코드로 처리할 수 있다

HandlerExceptionResolver 인터페이스

public interface HandlerExceptionResolver {

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

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

  • ModelAndView 를 반환하는 이유 : Exception 을 처리하여 정상 흐름처럼 변경

ex) IllegalArgumentException 발생시 HTTP 상태코드를 400으로 지정

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

반환 값에 따른 동작 방식

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

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

null
다음 ExceptionResolver를 찾아서 실행.
없으면 예외 처리가 안 되고, 기존 예외를 서블릿 밖으로 던진다

활용

  • 예외 상태 코드 변환 response.sendError(xxx)
  • 뷰 템플릿 처리
  • API 응답 처리
    : response.getWriter().println("hello"); 처럼 HTTP 응답 바디에 직접 데이터를 넣을 수 있다. JSON으로 응답하면 API 처리 가능

등록

@Configuration
public class WebConfig implements WebMvcConfigurer {

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

주의)
extendHandlerExceptionResolvers 대신 configureHandlerExceptionResolvers 를 사용하면 스프링이 기본으로 등록하는 ExceptionResolver가 제거된다


HandlerExceptionResolver - API 활용

@Slf4j
public class UserHandlerExceptionResolver implements HandlerExceptionResolver {

    //JSON 변환 라이브러리
    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); //상태코드 변경 400

                //acceptHeader가 JSON인 경우
                if ("application/json".equals(acceptHeader)) { 
                    Map<String, Object> errorResult = new HashMap<>(); //JSON 형태로 만들어 정보 넣음
                    errorResult.put("ex", ex.getClass());
                    errorResult.put("message", ex.getMessage());
                    String result = objectMapper.writeValueAsString(errorResult);//JSON -> String

                    response.setContentType("application/json");
                    response.setCharacterEncoding("utf-8");
                    response.getWriter().write(result); 
                    return new ModelAndView();

                } else {
                    // text/html인 경우
                    return new ModelAndView("error/500"); //view 지정
                }
            }

        } catch (IOException e) {
            log.error("resolver ex", e);
        }

        return null;
    }
}

ExceptionResolver 사용 전 후 비교


스프링 제공 ExceptionResolver

스프링 부트가 기본으로 제공하는 ExceptionResolver (우선순위별)
(HandlerExceptionResolverComposite 에 다음 순서로 등록)

1. ExceptionHandlerExceptionResolver
2. ResponseStatusExceptionResolver
3. DefaultHandlerExceptionResolver


① ExceptionHandlerExceptionResolver

@ExceptionHandler

ex)

@ResponseStatus(HttpStatus.BAD_REQUEST) 
@ExceptionHandler(IllegalArgumentException.class) 
public ErrorResult illegalArgumentException(IllegalArgumentException e) {
	log.error("[exceptionHandler] ex", e);
    return new ErrorResult("BAD", e.getMessage());
}
  • @ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리할 예외 지정
  • 해당 컨트롤러에서 예외 발생시 이 메서드 호출
  • 자식 클래스도 함께 처리
  • 다양한 예외 함께 처리 가능
    @ExceptionHandler({AException.class, BException.class})

우선순위

스프링은 항상 자세한 것이 우선권을 가진다
따라서 아래의 경우 자식예외가 발생하면 자식예외처리()가 호출

@ExceptionHandler(부모예외.class)
public String 부모예외처리()(부모예외 e) {}

@ExceptionHandler(자식예외.class)
public String 자식예외처리()(자식예외 e) {}

예외 생략

@ExceptionHandler 에 예외를 생략하면 메서드 파라미터의 예외가 지정된다

ex)

@ExceptionHandler // 생략시 UserException 예외 지정
public ResponseEntity<ErrorResult> userExHandle(UserException e) {}

실행 흐름

  1. 예외가 터지면
  2. 해당 컨트롤러에 예외를 처리할 수 있는 @ExceptionHandler가 있는지 확인
  3. 해당 메서드 실행
    이때 정상 흐름으로 반환된다
  4. 상태 코드를 변경하는 경우 @ResponseStatus 함께 사용
  • @ResponseStatus는 응답 코드를 동적으로 변경할 수 없기에 ResponseEntity를 사용 가능
  • ModelAndView 를 반환하여 오류 화면을 응답하는데 사용할 수도 있다

@ControllerAdvice

@ExceptionHandler는 정상 코드와 예외처리 코드가 하나의 컨트롤러에 섞여 있는데
애노테이션을 사용해 분리할 수 있다

@ControllerAdvice

  • 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler, @InitBinder 기능
    부여
  • @ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용 (글로벌 적용)

@RestControllerAdvice

  • @ControllerAdvice + @ResponseBody
    @Controller - @RestController 의 차이와 같다.

대상 컨트롤러 지정 방법

// Target all Controllers annotated with @RestController
@ControllerAdvice(annotations = RestController.class)
public class ExampleAdvice1 {}

// Target all Controllers within specific packages
@ControllerAdvice("org.example.controllers")
public class ExampleAdvice2 {}

// Target all Controllers assignable to specific classes
@ControllerAdvice(assignableTypes = {ControllerInterface.class,
									AbstractController.class})
public class ExampleAdvice3 {}

스프링 공식 문서
https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-anncontroller-advice

@ControllerAdvice(annotations = RestController.class) : 특정 애노테이션이 있는 컨트롤러 지정
@ControllerAdvice("org.example.controllers") : 패키지와 그 하위 컨트롤러에 적용
@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class} : 직접 컨트롤러 지정


② ResponseStatusExceptionResolver

예외에 따라 HTTP 상태 코드를 지정하며, 다음 두 가지 경우를 처리

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

1) @ResponseStatus

500 -> 400 변경

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류")
public class BadRequestException extends RuntimeException {
}

  • BadRequestException 예외가 컨트롤러 밖으로 넘어가면
    ResponseStatusExceptionResolver 예외가 애노테이션을 확인 -> 오류 코드 변경 , 메시지를 담는다

  • ResponseStatusExceptionResolver 를 확인해보면 결국 response.sendError(statusCode,resolvedReason)를 호출한다.
    따라서 WAS 에서 다시 오류 페이지 /error 를 내부 요청


메시지 기능

  • reason 을 MessageSource 에서 찾는 기능도 제공
@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "error.bad") 
public class BadRequestException extends RuntimeException {
}

//messages.properties
error.bad=잘못된 요청 오류입니다. 메시지 사용

2) ResponseStatusException

  • @ResponseStatus는 개발자가 직접 변경할 수 없는 예외에는 적용 불가
    ex) 라이브러리
  • 조건에 따라 동적으로 변경하기 어려움

이때는 ResponseStatusException 예외를 사용

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

③ DefaultHandlerExceptionResolver

  • 스프링 내부에서 발생하는 스프링 예외를 해결
  • 내부 오류를 어떻게 처리할지 수 많은 내용이 정의되어 있다

ex) 대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException 발생 👉 서블릿 컨테이너까지 오류가 올라가면 결과적으로 500 오류 발생

DefaultHandlerExceptionResolver는 이것을 HTTP 상태 코드 400 오류로 변경한다


내부 코드 확인

DefaultHandlerExceptionResolver.handleTypeMismatch 를 보면 아래 코드를 확인할 수 있다. 결국 response.sendError( ) 를 통해 문제를 해결한다.

  • sendError(400)를 호출했기 때문에 WAS에서 다시 오류 페이지 /error를 내부 요청

ex) 

@GetMapping("/api/default-handler-ex")
public String defaultException(@RequestParam Integer data) {
	return "ok";
}
  • Integer data에 문자를 입력하면 내부에서 TypeMismatchException 발생
  • 실행 결과 HTTP 상태 코드가 400 이다
profile
hi
이전 포스트

[Servlet] 예외 처리, 오류 페이지

다음 포스트

[Spring] 스프링 타입 컨버터

0개의 댓글