API 예외 처리 - HandlerExceptionResolver(2) : ResponseStatusExceptionResolver, DefaultHandlerExceptionResolver, ExceptionHandlerExceptionResolver

 

 

https://mong-dev.tistory.com/43

API 예외 처리 - HandlerExceptionResolver(1)

 

 

스프링 부트가 기본으로 제공하는 ExceptionResolver 는 다음과 같다.

HandlerExceptionResolverComposite 에 다음 순서로 등록되어 있다.

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

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

3. DefaultHandlerExceptionResolver 우선 순위가 가장 낮다.
스프링 내부 기본 예외를 처리한다.

 

 

 

 

ResponseStatusExceptionResolver

---

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

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

 

다음과 같이 코드를 작성해서 테스트를 해볼 수 있다.

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

 @GetMapping("/api/response-status-ex1")
    public String responseStatusEx1() {
        throw new BadRequestException();
    }

 

원래는 500에러가 떴지만, 이제 400에러로 바껴있을 것이다.

{
    "status": 400,
    "error": "Bad Request",
    "exception": "hello.exception.exception.BadRequestException", "message": "잘못된 요청 오류",
    "path": "/api/response-status-ex1"'
}

 

reason 을 MessageSource 에서 찾는 기능도 제공한다. reason = "error.bad" 

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

 

messages.properties

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

 

결과

{
	"status": 400,
	"error": "Bad Request",
	"exception": "hello.exception.exception.BadRequestException", 
	"message": "잘못된 요청 오류입니다. 메시지 사용",
	"path": "/api/response-status-ex1"
}

 

 

단점

@ResponseStatus 는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다. (애노테이션을 직접 넣어야 하는데, 내가 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에는 적용할 수 없다.) 추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵다. 이때는 ResponseStatusException 예외를 사용하면 된다.

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

  {
      "status": 404,
      "error": "Not Found",
      "exception": "org.springframework.web.server.ResponseStatusException", 
      "message": "잘못된 요청 오류입니다. 메시지 사용",
       "path": "/api/response-status-ex2"
  }

 

 

 

 

DefaultHandlerExceptionResolver

---

DefaultHandlerExceptionResolver 는 스프링 내부에서 발생하는 스프링 예외를 해결한다. 대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException 이 발생하는데, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로 500 오류가 발생한다.

그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다. HTTP 에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어 있다. DefaultHandlerExceptionResolver 는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로변경한다. 스프링 내부 오류를 어떻게 처리할지 수 많은 내용이 정의되어 있다.

 

DefaultHandlerExceptionResolver.handleTypeMismatch 를 보면 다음과 같은 코드를 확인할 수 있다.

response.sendError(HttpServletResponse.SC_BAD_REQUEST) (400)

 

결국 response.sendError() 를 통해서 문제를 해결한다.

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

 

.

.

. 

 

지금까지 HTTP 상태 코드를 변경하고, 스프링 내부 예외의 상태코드를 변경하는 기능도 알아보았다.

그런데 HandlerExceptionResolver 를 직접 사용하기는 복잡하다. API 오류 응답의 경우 response 에 직접 데이터를 넣어야 해서 매우 불편하고 번거롭다. ModelAndView 를 반환해야 하는 것도 API에는 잘 맞지 않는다.

 

스프링은 이 문제를 해결하기 위해 @ExceptionHandler 라는 매우 혁신적인 예외 처리 기능을 제공한다.

그것이 ExceptionHandlerExceptionResolver 이다.

 

 

 

ExceptionHandlerExceptionResolver

---

스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler 라는 애노테이션을 사용하는 매우 편리한 예외 처리 기능을 제공하는데, 이것이 바로 ExceptionHandlerExceptionResolver 이다. 스프링은 ExceptionHandlerExceptionResolver 를 기본으로 제공하고, 기본으로 제공하는 ExceptionResolver 중에 우선순위도 가장 높다. 실무에서 API 예외 처리는 대부분 이 기능을 사용한다.

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

 

@Data
@AllArgsConstructor
public class ErrorResult {
    private String code;
    private String message;
}

@Slf4j
@RestController
public class ApiExceptionV2Controller {

    //상태코드도 변경하고 싶으면 이걸 붙여준다.
    @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 exExHandler(Exception e) {
        log.error("[exceptionHandler] 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;
    }

}

 

Controller에서 예외가 발생하면, ExceptionHandlerExceptionResolver 가 먼저 Controller에 @ExceptionHandler가 있는 지 찾고, 있으면 호출해준다. 그리고 오류해결을 시도하고, 정상흐름으로 변경된다. (200코드로 나오게 된다.) 그런데, 만약에 상태코드도 변경하고 싶으면 @ResponseStatus를 붙여준다. 혹은 두번째 처럼 ReponseEntity를 사용해준다.

 

다음과 같이 다양한 예외를 한번에 처리할 수 있다.

  @ExceptionHandler({AException.class, BException.class})
  public String ex(Exception e) {
        log.info("exception e", e);
  }

 

 

@ExceptionHandler 에는 마치 스프링의 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다.

자세한 파라미터와 응답은 다음 공식 메뉴얼을 참고하자.

https://docs.spring.io/springframework/docs/current/reference/html/web.html#mvc-ann-exceptionhandler-args 

 

 

 

 

이번 주제의 마지막 글인 @ControllerAdvice에 대해서 다음 글에서 알아보겠다 :)