<Spring> 공통 에러 핸들러 구현하기

📌 스프링 에러 처리 방법

스프링은 프로그램 작동 중 여러 에러를 발생시킨다.

이에 에러를 처리할 수 있는 방법이 존재한다.

🔹 try-catch

try {
    Jwts.parserBuilder().setSigningKey(getSecretKey()).build().parseClaimsJws(token);
    return true;
} catch (io.jsonwebtoken.security.SecurityException | MalformedJwtException e) {
    log.info("Invalid JWT Token", e);
}

단순한 try-catch를 사용한 예외처리이다.

이를 사용한다면 에러를 처리할 수 있으나, 코드의 중복이 많이 발생할 것이다.

🔹 @ControllerAdvice

위 어노테이션을 통해 @ExceptionHandler를 컨트롤러 전체에 적용시킬 수 있다.

이 방식을 사용한다면 더 편하고 깔끔하게 에러 처리가 가능하다.

아래는 @ControllerAdvice, @ExceptionHandler에 대한 설명이다.

🔺@ControllerAdvice

전역적으로 적용할 수 있는 예외처리와 바인딩 설정을 지원하는 어노테이션이다.

🔺 @ExceptionHandler

컨트롤러에서 발생하는 에러를 처리하기 위해 사용하는 어노테이션이다.

📌 스프링 에러 처리 구현

🔹Global Exception Handler

이를 만들기 위해선 에러 객체들의 hierarchy를 먼저 고려해야 한다.

세세한 에러들, 즉 null pointer exception 같은 에러는 모두 RuntimeException를 상속받고,

이 RuntimeException은 Exception을 상속받는다.

이는 Exception.class 에러에 대한 응답을 구현하면, 이 에러 객체를 상속받는 모든 에러 객체를 처리 가능하다는 말이다.

즉, global exception handler를 통해 처리하지 않은 에러들을 모두 Exception으로 처리 가능하다.

@ControllerAdvice
@ApiIgnore
@Slf4j
public class GlobalExceptionHandler {

    // @Valid 으로 binding error 시 발생
    @ExceptionHandler(MethodArgumentNotValidException.class)
    protected ResponseEntity<ErrorResponse> handleMethodArgumentNotValidException(MethodArgumentNotValidException MANVE) {
        log.error("MethodArgumentNotValidException", MANVE);
        return new ResponseEntity<>(ErrorResponse.onFailure(ErrorCode._BAD_REQUEST),
                null, ErrorCode._BAD_REQUEST.getHttpStatus());
    }

    // 지원하지 않는 http method 호출시 발생하는 에러
    @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
    protected ResponseEntity<ErrorResponse> handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {
        log.error("HttpRequestMethodNotSupportedException", e);
        return new ResponseEntity<>(ErrorResponse.onFailure(ErrorCode._METHOD_NOT_ALLOWED),
                null, ErrorCode._METHOD_NOT_ALLOWED.getHttpStatus());
    }

    // JSON parse error 일 경우에 발생합니다
    // request 값을 읽을 수 없을 때 발생합니다.
    @ExceptionHandler(HttpMessageNotReadableException.class)
    protected ResponseEntity<ErrorResponse> handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {
        log.error("HttpMessageNotReadableException", e);
        return new ResponseEntity<>(ErrorResponse.onFailure(ErrorCode._BAD_REQUEST),
                null, ErrorCode._BAD_REQUEST.getHttpStatus());
    }

    // 변수 타입이 맞지 않을 때 발생하는 에러입니다.
    @ExceptionHandler(MethodArgumentTypeMismatchException.class)
    protected ResponseEntity<ErrorResponse> handleMethodArgumentTypeMismatchException(MethodArgumentTypeMismatchException e) {
        log.error("MethodArgumentTypeMismatchException", e);
        return new ResponseEntity<>(ErrorResponse.onFailure(ErrorCode._BAD_REQUEST),
                null, ErrorCode._BAD_REQUEST.getHttpStatus());
    }

    // 변수 타입이 맞지 않을 때 발생하는 에러입니다.
    @ExceptionHandler(EmptyResultDataAccessException.class)
    protected ResponseEntity<ErrorResponse> handleEmptyResultDataAccessException(EmptyResultDataAccessException e) {
        log.error("EmptyResultDataAccessException", e);
        return new ResponseEntity<>(ErrorResponse.onFailure(ErrorCode._BAD_REQUEST),
                null, ErrorCode._BAD_REQUEST.getHttpStatus());
    }

    // The call was transmitted successfully, but Amazon S3 couldn't process it.
    @ExceptionHandler(AmazonServiceException.class)
    protected ResponseEntity<ErrorResponse> handleAmazonServiceException(AmazonServiceException e) {
        log.error("AmazonServiceException", e);
        return new ResponseEntity<>(ErrorResponse.onFailure(ErrorCode._BAD_REQUEST),
                null, ErrorCode._BAD_REQUEST.getHttpStatus());
    }

    // thrown when service could not be contacted for a response, or when client is unable to parse the response from service.
    @ExceptionHandler(SdkClientException.class)
    protected ResponseEntity<ErrorResponse> handleSdkClientException(SdkClientException e) {
        log.error("SdkClientException", e);
        return new ResponseEntity<>(ErrorResponse.onFailure(ErrorCode._BAD_REQUEST),
                null, ErrorCode._BAD_REQUEST.getHttpStatus());

    }

    // 비즈니스 로직 에러 처리
    @ExceptionHandler(BaseException.class)
    protected ResponseEntity<ErrorResponse> handleBusinessException(final BaseException baseException) {
        log.error("handleBusinessException", baseException);
        return new ResponseEntity<>(ErrorResponse.onFailure(baseException.getErrorCode()),
                null, baseException.getErrorCode().getHttpStatus());
    }

    // 위에서 따로 처리하지 않은 에러를 모두 처리해줍니다.
    @ExceptionHandler(Exception.class)
    protected ResponseEntity<ErrorResponse> handleException(Exception exception) {
        log.error("handleException", exception);
        return new ResponseEntity<>(ErrorResponse.onFailure(ErrorCode._INTERNAL_SERVER_ERROR),
                null, INTERNAL_SERVER_ERROR);
    }

}

위 코드는 Global Exception을 처리하는 코드이다. 

@ExceptionHandler를 이용해 해당 에러가 발생할 때마다 에러 리스폰스를 정의했다.

서비스 로직 진행 중, 발생시키는 에러는 BaseException이라는 커스텀 에러 객체를 만들어서 처리해줬다. 이는 나중에 설명하겠다.

위에서 설명한 바와 같이, 위 코드의 마지막 부분에 Exception.class에 대한 리스폰스를 정의한 부분이 있다. 내가 처리하지 않은 부분은 모두 500번 서버 에러를 띄우도록 구현했다.

에러 리스폰스 형식은 아래를 보자.

@Getter
public class ErrorResponse {
    private final String timestamp = LocalDateTime.now().format(DateTimeFormatter.ISO_DATE_TIME);
    private final boolean success = false;
    private String code;
    private int status;
    private String message;


    @Builder
    public ErrorResponse(int status, String message, String code) {
        this.status = status;
        this.message = message;
        this.code = code;
    }

    public static ErrorResponse onFailure(ErrorCode errorCode) {
        return ErrorResponse.builder()
                .status(errorCode.getHttpStatus().value())
                .code(errorCode.getCode())
                .message(errorCode.getMessage())
                .build();
    }
}

이는 커스텀 에러 리스폰스이다.

onFaliure 함수를 통해 ErrorCode를 받으면, 그 ErrorCode를 이용해 ErrorResponse를 만들도록 만들었다.

ErrorCode는 밑에서 설명하겠다.

그러면 이런 에러를 얻을 수 있다.

🔹비즈니스 에러 처리

비즈니스 에러는 RuntimeException을 상속받은 BaseException 에러 객체를 만들어서 처리했다.

이 커스텀 에러 객체를 상속받은 여러 객체를 만들어서 비즈니스 에러 커스텀을 진행했다.

@Getter
@RequiredArgsConstructor
public class BaseException extends RuntimeException {
    private final ErrorCode errorCode;
    private final String message;
}

위 코드에서 볼 수 있는 ErrorCode 는 아래에서 설명하겠다.

@Getter
public class BadRequestException extends BaseException {
    public BadRequestException() {
        super(ErrorCode._BAD_REQUEST, ErrorCode._BAD_REQUEST.getMessage());
    }
    public BadRequestException(String message) {
        super(ErrorCode._BAD_REQUEST, message);
    }
    public BadRequestException(ErrorCode errorCode) {
        super(errorCode, errorCode.getMessage());
    }
}

이 에러 객체는 서비스 로직 중 에러를 발생시킬 때 사용한다.

ErrorCode나 에러 메시지를 받아서 에러 리스폰스를 만들도록 구성했다.

@Getter
@AllArgsConstructor
public enum ErrorCode {

    /* Common */
    INVALID_INPUT_VALUE(BAD_REQUEST, "C001", "Invalid Input Value"),
    _INTERNAL_SERVER_ERROR(INTERNAL_SERVER_ERROR, "C000", "서버 에러, 관리자에게 문의 바랍니다."),
    _BAD_REQUEST(BAD_REQUEST, "C001", "잘못된 요청입니다."),
    _METHOD_NOT_ALLOWED(METHOD_NOT_ALLOWED, "C003", "지원하지 않는 Http Method 입니다."),

	...

    private final HttpStatus httpStatus;
    private final String code;
    private final String message;
}

이것이 바로 ErrorCode이다.

enum으로 만들어서 ErrorCode.INVALID_INPUT_VALUE. ... 이런 식으로 값에 접근하여 사용할 수 있도록 했다.

커스텀 하고 싶은 에러를 이런 식으로 하나 하나 적어서 에러를 띄울 수 있도록 했다.