Spring - Exception Handler 처리

[스터디/12기] 단순 CRUD는 그만! 웹 백엔드 시스템 구현(Spring Boot)에 참여를 하면서, Exception 세션을 듣고 정리하면서 복습한 내용들입니다.

@ControllerAdvice

Controller 밖으로 throw 되는 예외를 처리하는 전역 Handler
(AOP 기반)

@ExceptionHandler

@Controller, @RestController가 적용된 Bean 내에서 발생한 예외를 받아서 처리할수 있는 기능을 한다.
(리턴 타입은 자유롭게 해도 됩니다.)

@ExceptionHandler({IllegalStateException.class, IllegalArgumentException.class, ...})
public ResponseEntity<?> handleBadRequestException(Exception e) {
  return new ResponseEntity<>(e, HttpStatus.BAD_REQUEST);
}

⭐️ Exception 관련!

요즘 예외 클래스 사용의 트렌드는 Unchecked Exception을 사용하는 것입니다.
여기서 Checked Exception vs Unchecked Exception 이란?
둘다 Exception 클래스를 상속하는 클래스이긴 하지만 아래와 같은 차이가 있습니다.

• Checked Exception : 해당 코드의 사용자에게 try-catch를 강제(ex IOException)하게 되며, 사용하지 않을 시, 컴파일 오류가 발생합니다.
• Unchekced Exception : 위와 반대로 try-catch를 강제하지 않는 예외 입니다.

그래서 Checked Exception을 남발하면 try-catch도 자연스럽게 남발되고, 의미없는 catch 구문을 쓰게되고 코드도 불필요 한 부분들이 많아지게 됩니다.
위의 말 처럼 트렌드를 따르면서 꼭 해야 될것은?

예외를 catch 했으면 반드시 로그를 남기고 필요한 조치를 수행해야 합니다.

⭐️ logging 단계

예외를 catch 했는데 아무것도 수행하지 않는 코드는 바람직 하지 않습니다.
결과적으로는 로그를 남겨야 하지만, 이 로그라는게 결국엔 문제가 발생 했다는 것이고, 즉슨 해결을 해야되는데 메시지만 간단하게 남긴다면 의미가 없게 됩니다.
그래서 중요한 게 stack trace를 남기는게 좋습니다!
⚡️ log4j를 사용할 경우, 따로 처리해주지 않고 마지막에 Exception 객체만 넘겨줘도 stack trace를 남길 수 있습니다.

log.error("Unexpected error occurred : {}, e.getMessage(), e);

⭐️⭐️ (정말 정말) 중요한건 예외 종류에 따라서 로깅 레벨을 분리하여 사용해야 된다는 것입니다!
로그가 너무 남발되면 사실 로그를 안보게될 수도 있는 불상사가 발생할 수도 있으므로, 단계별로 사용해야 합니다.

• DEBUG : 개발단계에서 사용되는 것으로, 프로세스의 흐름을 체크하거나 등등 으로 사용됩니다.
• INFO : 디버깅 정보 외에 필요한 정보를 기록(설정 정보 등)할때 사용됩니다.
• WARN : 오류 상황은 아니지만, 추후 확인이 필요한 정보등을 남길때 사용됩니다.
• ERROR : 가장 우선순위로 처리해야 되는 예외 상황입니다.
• FATAL : 매우 심각한 상황 (개발자가 이걸 쓸 일은 없을듯?)

사용 예제

import ...

@Slf4j
@ControllerAdvice
public class GeneralExceptionHandler {

  private ResponseEntity<ApiResponse<?>> newResponse(Throwable throwable, HttpStatus status) {
    HttpHeaders headers = new HttpHeaders();
    headers.add("Content-Type", "application/json");
    return new ResponseEntity<>(ApiResponse.ERROR(LocalDateTime.now(), throwable), status);
  }

  @ExceptionHandler({
          IllegalStateException.class, IllegalArgumentException.class,
          TypeMismatchException.class, HttpMessageNotReadableException.class,
          MissingServletRequestParameterException.class, MultipartException.class,
  })
  public ResponseEntity<?> handleBadRequestException(Exception e) {
    log.debug("Bad request exception occurred: {}", e.getMessage(), e);
    return newResponse(e, HttpStatus.BAD_REQUEST);
  }

  ...

  @ExceptionHandler(ServiceRuntimeException.class)
  public final ResponseEntity<ApiResponse<?>> handleServiceRuntimeException(ServiceRuntimeException e) {
    if (e instanceof NotFoundException)
      return newResponse(e, HttpStatus.NOT_FOUND);

    log.warn("Unexpected service exception occurred: {}", e.getMessage(), e);
    return newResponse(e, HttpStatus.INTERNAL_SERVER_ERROR);
  }

  @ExceptionHandler({Exception.class, RuntimeException.class})
  public final ResponseEntity<ApiResponse<?>> handleAllException(Exception e) {
    log.error("Unexpected exception occurred: {}", e.getMessage(), e);
    return newResponse(e, HttpStatus.INTERNAL_SERVER_ERROR);
  }
}

참고

[스터디/12기] 단순 CRUD는 그만! 웹 백엔드 시스템 구현(Spring Boot)
@ControllerAdvice, @ExceptionHandler를 이용한 예외처리 분리, 통합하기(Spring에서 예외 관리하는 방법, 실무에서는 어떻게?)