[Spring] Custome Exception 만들기

📑 개요

이전 프로젝트에선 백엔드 도메인 별로 개발 파트를 나누고 예외처리를 각자 알아서 했다.

 

심지어 문서화도 제대로 해놓지 않아 해당 예외가 왜 발생했는지 잘 전달이 되지 않았고

왜, 어디서 발생한 예외인지 찾는 것이 굉장히 힘들었다.

 

그래서 예외 처리에서 문제가 생기면 내가 개발한 파트에서 발생한 예외가 아님에도

엉뚱한 곳에서 문제를 찾기 위해 시간을 허비한 경험이 있었다.

 

이런 경험을 통해, 다음 프로젝트에서는 기필코 예외 처리를 전역에서 관리하고 문서화도 제대로 해놓기로 다짐했다.

 

그래서 이번 프로젝트에서는 Custom Exception을 통해 예외 처리를 해보려 한다.

 

📑 우리의 프로젝트 상황

API 명세를 하며 발생할 수 있는 예외 상황들을 정리하였고,

예외들을 몇 가지 카테고리로 나눴다.

AUTH, PAYMENT, SETTLEMENT, TRAVEL, VALIDATION이라는 카테고리로 나눴고

PAYMENT, SETTLEMENT, TRAVEL 관련 예외는 서비스 정책상 발생할 수 있는 예외이다.

 

📑 Custom Exception

Custom Exception 구현 방법에 대해 찾아보니

대체로 CutomErrorCode, CustomException, CustomExceptionHandler, CustomExceptionResponse

이 네 가지를 사용하여 구현한다.

 

아래의 블로그에 이에 대한 개념이 자세히 나와있고, 해당 코드를 참고했다.

https://velog.io/@rungoat/SpringBoot-Custom-Exception-%EC%B2%98%EB%A6%AC

 

💡 CustomErrorCode

Errorcode 정보를 담아 관리하는 enum

import lombok.AllArgsConstructor;
import lombok.Getter;
import org.springframework.http.HttpStatus;

@Getter
@AllArgsConstructor
public enum ErrorCode {

	USER_NOT_FOUND(HttpStatus.NOT_FOUND, "ACCOUNT-001", "사용자를 찾을 수 없습니다."),
    HAS_EMAIL(HttpStatus.BAD_REQUEST, "ACCOUNT-002", "존재하는 이메일입니다."),
    INVALID_PASSWORD(HttpStatus.BAD_REQUEST, "ACCOUNT-003", "비밀번호가 일치하지 않습니다."),
    // ...
    
    private final HttpStatus httpStatus;	// HttpStatus
    private final String code;				// ACCOUNT-001
    private final String message;			// 설명
}

💡 CustomException

Exception이나 RuntimeException을 상속받고 CustomErrorCode를 필드로 가지고 있는 class

@Getter
@AllArgsConstructor
public class CustomException extends RuntimeException {
    ErrorCode errorCode;
}

💡 CustomExceptionHandler

CustomException이 발생했을 때 전역에서 이 예외를 잡아 핸들링해 주는 class

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class CustomExceptionHandler {

    @ExceptionHandler(CustomException.class)
    protected ResponseEntity<ErrorResponseEntity> handleCustomException(CustomException e){
        return ErrorResponseEntity.toResponseEntity(e.getErrorCode());
    }
}

💡 CustomExceptionResponse

CustomException이 발생해서 CustomExceptionHandler가 이를 감지했을 때,
응답으로 내려줄 Response Dto

@Data
@Builder
public class ErrorResponseEntity {
    private int status;
    private String name;
    private String code;
    private String message;

    public static ResponseEntity<ErrorResponseEntity> toResponseEntity(ErrorCode e){
        return ResponseEntity
                .status(e.getHttpStatus())
                .body(ErrorResponseEntity.builder()
                		.status(e.getHttpStatus().value())
                        .name(e.name())
                        .code(e.getCode())
                        .message(e.getMessage())
                        .build());
    }
}

👉 카테고리별로 ErrorCode 관리하기

보통 ErrorCode들을 CustomErrorCode라는 하나의 enum 안에서 모두 관리하는 것 같았다.

 

하지만 우리 프로젝트에서는 카테고리 별로 ErrorCode를 분류하여 관리하고 싶었다.

 

우선 ErrorCode를 카테고리 별로 분류해서 관리하기 위해선 한 가지 조건이 필요했다.

 

ErrorCode는 모두 한 가지 타입이어야 한다.

 

그 이유는 CustomExceptionResponse에서 ErrorResponseEntity class의 toResponseEntity 메서드를 확인해 보면

ErrorCode를 매개변수로 받고 있다.

 

만약 ErrorCode의 타입이 모두 제각각이면, ErrorCode 별로 toResponseEntity 메서드를 오버로딩해서 만들어줘야 한다.

 

이를 방지하기 위해 ErrorCode를 상속하는 AuthErrorCode, PaymentErrorCode ... 를 만들어 하나의 toResponseEntity 메서드로도 해결 가능하도록 할 것이다.

 

그럼 우선 ErrorCode를 만들어 보자.

 

위의 CustomErrorCode는 enum으로 만들어져 있는데

enum은 이미 java.lang.Enum 클래스를 암묵적으로 상속하고 있기 때문에,

카테고리별 ErrorCode들도 enum으로 만들면,  ErrorCode를 상속하게 하는 것은 불가능하다.

 

따라서 ErrorCode를 추상 클래스로 선언하고,

카테고리별 ErrorCode를 enum이 아닌 클래스로 만들어 ErrorCode를 상속받게 한다.

그리고 카테고리별 ErrorCode들에서 정적 상수 객체 정의를 통해 enum은 아니지만 enum 상수처럼 사용할 것이다.

 

💡 ErrorCode

package withbeetravel.exception.error;

import lombok.AllArgsConstructor;
import lombok.Getter;
import org.springframework.http.HttpStatus;

@Getter
@AllArgsConstructor
public abstract class ErrorCode {

    private final HttpStatus status;
    private final String name;
    private final String code;
    private final String message;
}

💡 AuthErrorCode

package withbeetravel.exception.error;

import lombok.Getter;
import org.springframework.http.HttpStatus;

@Getter
public class AuthErrorCode extends ErrorCode{

    // 정적 상수 객체 정의
    public static final AuthErrorCode AUTHENTICATION_FAILED = new AuthErrorCode(HttpStatus.UNAUTHORIZED, "AUTHENTICATION_FAILED", "AUTH-001", "사용자 인증 실패");
    public static final AuthErrorCode ADMIN_PRIVILEGES_REQUIRED = new AuthErrorCode(HttpStatus.FORBIDDEN, "ADMIN_PRIVILEGES_REQUIRED", "AUTH-002", "관리자 권한 없음");
    public static final AuthErrorCode INVALID_CREDENTIALS = new AuthErrorCode(HttpStatus.UNAUTHORIZED, "INVALID_CREDENTIALS", "AUTH-003", "잘못된 이메일 또는 비밀번호");
    public static final AuthErrorCode EMAIL_NOT_FOUND = new AuthErrorCode(HttpStatus.NOT_FOUND, "EMAIL_NOT_FOUND", "AUTH-004", "존재하지 않는 이메일");
    public static final AuthErrorCode TERMS_NOT_ACCEPTED = new AuthErrorCode(HttpStatus.FORBIDDEN, "TERMS_NOT_ACCEPTED", "AUTH-005", "서비스 이용 약관에 동의하지 않음");
    public static final AuthErrorCode EMAIL_ALREADY_EXISTS = new AuthErrorCode(HttpStatus.CONFLICT, "EMAIL_ALREADY_EXISTS", "AUTH-006", "이미 존재하는 이메일");
    public static final AuthErrorCode PASSWORD_POLICY_VIOLATION = new AuthErrorCode(HttpStatus.BAD_REQUEST, "AUTH-007", "PASSWORD_POLICY_VIOLATION", "비밀번호 정책 불충족");
    public static final AuthErrorCode INVALID_EMAIL_FORMAT = new AuthErrorCode(HttpStatus.BAD_REQUEST, "AUTH-008", "INVALID_EMAIL_FORMAT", "잘못된 이메일 형식");
    public static final AuthErrorCode PIN_POLICY_VIOLATION = new AuthErrorCode(HttpStatus.BAD_REQUEST, "PIN_POLICY_VIOLATION", "AUTH-009", "핀번호 정책 불충족");

    private AuthErrorCode(HttpStatus status, String name, String code, String message) {
        super(status, name, code, message);
    }
}

💡 PaymentErrorCode

package withbeetravel.exception.error;

import lombok.Getter;
import org.springframework.http.HttpStatus;

@Getter
public class PaymentErrorCode extends ErrorCode{

    // 정적 상수 객체 정의
    public static final PaymentErrorCode SHARED_PAYMENT_NOT_FOUND = new PaymentErrorCode(HttpStatus.NOT_FOUND, "SHARED_PAYMENT_NOT_FOUND", "PAYMENT-001", "SHARED PAYMENT ID에 해당하는 공동 결제 내역이 없음");
    public static final PaymentErrorCode NO_PERMISSION_TO_MODIFY_SHARED_PAYMENT = new PaymentErrorCode(HttpStatus.FORBIDDEN, "NO_PERMISSION_TO_MODIFY_SHARED_PAYMENT", "PAYMENT-002", "해당 공동 결제 내역 수정 권한 없음");

    private PaymentErrorCode(HttpStatus status, String name, String code, String message) {
        super(status, name, code, message);
    }
}

 

이렇게 구현함으로써 ErrorCode를 카테고리별로 구분하되,

한 가지 타입으로 만들었다.

 

👉 카테고리별로 Exception 관리하기 → CustomException으로 모두 관리

원래는 CustomException도 하나로 뭉뚱그리지 않고,

카테고리별로 관리하여 어느 예외가 발생한 것인지 직관적으로 확인이 가능하게 하고 싶었다.

 

이러한 생각으로 다음과 같이 카테고리별로 모든 Exception을 만들었다.

 

또한, 이렇게 생겨난 Exception들을 핸들링할 handler 메서드도 추가해 주었다.

💡 AuthException

package withbeetravel.exception;

import lombok.AllArgsConstructor;
import lombok.Getter;
import withbeetravel.exception.error.AuthErrorCode;

@Getter
@AllArgsConstructor
public class AuthException extends RuntimeException {

    AuthErrorCode errorCode;
}

💡 PaymentException

package withbeetravel.exception;

import lombok.AllArgsConstructor;
import lombok.Getter;
import withbeetravel.exception.error.PaymentErrorCode;

@Getter
@AllArgsConstructor
public class PaymentException extends RuntimeException {

    PaymentErrorCode errorCode;
}

💡 CustomExceptionHandler

package withbeetravel.exception.handler;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import withbeetravel.exception.*;
import withbeetravel.exception.dto.ErrorResponseDto;

@ControllerAdvice
public class CustomExceptionHandler {

    @ExceptionHandler(AuthException.class)
    protected ResponseEntity<ErrorResponseDto> handleAuthException(AuthException e) {
        return ErrorResponseDto.toResponseEntity(e.getErrorCode());
    }

    @ExceptionHandler(PaymentException.class)
    protected ResponseEntity<ErrorResponseDto> handlePaymentException(PaymentException e) {
        return ErrorResponseDto.toResponseEntity(e.getErrorCode());
    }

    @ExceptionHandler(SettlementException.class)
    protected ResponseEntity<ErrorResponseDto> handleSettlementException(SettlementException e) {
        return ErrorResponseDto.toResponseEntity(e.getErrorCode());
    }

    @ExceptionHandler(TravelException.class)
    protected ResponseEntity<ErrorResponseDto> handleTravelException(TravelException e) {
        return ErrorResponseDto.toResponseEntity(e.getErrorCode());
    }

    @ExceptionHandler(ValidationException.class)
    protected ResponseEntity<ErrorResponseDto> handleValidationException(ValidationException e) {
        return ErrorResponseDto.toResponseEntity(e.getErrorCode());
    }
}

 

하지만 이렇게 구현했을 때,

코드 중복만 심해지고

프로젝트를 디벨롭시키거나 유지보수 과정에서 새로운 카테고리의 예외가 생겼을 때

매번 새로운 Exception과 handler 메서드를 추가해주어야 한다.

이를 감수할 만큼의 장점이 없다고 느꼈다.

 

또한 이미 카테고리 별로 ErrorCode를 나눠놓았기 때문에,

이미 어느 부분에서 발생한 예외인지 확인이 가능했다.

 

그래서 그냥 하나의 CustomException으로 예외를 관리하기로 했다.

 

💡 CustomException

package withbeetravel.exception;

import lombok.AllArgsConstructor;
import lombok.Getter;
import withbeetravel.exception.error.ErrorCode;

@Getter
@AllArgsConstructor
public class CustomException extends RuntimeException{

    ErrorCode errorCode;
}

💡 CustomExceptionHandler

package withbeetravel.exception.handler;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import withbeetravel.exception.CustomException;
import withbeetravel.exception.dto.ErrorResponseDto;

@ControllerAdvice
public class CustomExceptionHandler {

    @ExceptionHandler(CustomException.class)
    protected ResponseEntity<ErrorResponseDto> handleAuthException(CustomException e) {
        return ErrorResponseDto.toResponseEntity(e.getErrorCode());
    }
}

 

이렇게 함으로써 나중에 새로운 카테고리의 Error가 생겨도

ErrorCode를 상속받은 error code 관리 클래스만 생성해 주면 된다.

 

👉 CustomeException 사용하기

CustomException을 사용할 때는 다음과 같이 어떤 Error인지만 CustomException의 생성자에 넣어주면 된다.

new CustomException(AuthErrorCode.AUTHENTICATION_FAILED);