[Spring]@ExceptionHandler

스프링에서 에러 핸들링을 할 수 있는 방법인 @ExceptionHandler에 대해서 알아보자.

💡 @ExceptionHandler

@ExceptionHandler는 Exception 클래스들을 속성으로 받아 처리할 예외를 지정할 수 있다.

@RestController
public class SimpleController {

    // ...

    @ExceptionHandler(value = IllegalArgumentException.class)
    public ResponseEntity<String> invokeError(IllegalArgumentException e) {
         ...
				return new ResponseEntity<>("error Message", HttpStatus.BAD_REQUEST);
    }
}

여러개의 Exception을 잡아야한다면, @ExceptionHandler(IOException.class)처럼 포괄적인게 아닌 @ExceptionHandler(FileSystemException.class, RemoteException.class)로 구체적으로 명시해주는 것을 권장한다고 한다.

@ExceptionHandler는 코드를 작성한 컨트롤러에서만 발생하는 예외만 처리된다.

💡 @ControllerAdvice, @RestControllerAdvice

전역적으로 @ExceptionHandler를 적용할 수 있는 어노테이션이다. 두 개의 차이는 @Controller와 RestController와 같이 @ResponseBody가 붙어 있어 응답을 Json으로 내려준다는 점이 차이점이다.

🌸 장점

1. 하나의 클래스로 모든 컨트롤러에 대해 전역적으로 예외 처리가 가능함

2. 직접 정의한 에러 응답을 일관성있게 클라이언트에게 내려줄 수 있음

3. 별도의 try-catch문이 없어 코드의 가독성이 높아짐

🧨 주의사항

1. 한 프로젝트당 하나의 ControllerAdvice만 관리하는 것이 좋다.

2. 만약 여러 ControllerAdvice가 필요하다면 basePackages나 annotations 등을 지정해야 한다.

3. 직접 구현한 Exception 클래스들은 한 공간에서 관리한다.

🪄 적용

💎 1. 에러코드 정의

@JsonFormat(shape = Shape.OBJECT) //직렬화할때 어떤 값의 모습으로 직렬화될지
@RequiredArgsConstructor // 필수(final)변수 파라미터로 가지는 생성자 생성
@Getter
public enum ErrorCode {// enum 클래스

    //Common -> http 요청시 발생할만한 예외
    INVALID_INPUT_VALUE(HttpStatus.BAD_REQUEST, "Common-001", " Invalid Input Value"),
    METHOD_NOT_ALLOWED(HttpStatus.METHOD_NOT_ALLOWED, "Common-002", " Invalid Http Method"),
    ENTITY_NOT_FOUND(HttpStatus.BAD_REQUEST,"Common-003", " Entity Not Found"),
    INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "Common-004", "Server Error"),
    INVALID_TYPE_VALUE(HttpStatus.BAD_REQUEST,"Common-005", " Invalid Type Value"),
    HANDLE_ACCESS_DENIED(HttpStatus.FORBIDDEN, "Common-006", "Access is Denied"),

    //Member Validation
    EMAIL_DUPLICATION(HttpStatus.BAD_REQUEST, "Member-001", "Email is Duplication"),
    LOGIN_INPUT_INVALID(HttpStatus.BAD_REQUEST, "Member-002", "Login input is invalid"),

    //room Validation


    //...등
    ;

    private final HttpStatus status; // http 상태코드
    private final String code;//에러코드
    private final String message;//에러메시지

}

💎 2. 커스텀 예외

• 비즈니스 로직안에서 예외를 발생시켜야할때 에러코드를 이용하여 만들기 위해서 만든 예외

@Getter
public class BusinessException extends RuntimeException{ //api 내부동작할때(비즈니스 로직에서) 발생하는 일반적인 예외들

    private final ErrorCode errorCode;

    public BusinessException(String message, ErrorCode errorCode) {
        super(message);
        this.errorCode = errorCode;
    }

    public BusinessException(ErrorCode errorCode) {
        super(errorCode.getMessage());
        this.errorCode = errorCode;
    }
}

💎 3. 전역 예외처리

@RestControllerAdvice
@Slf4j
public class ExceptionHandlerAdvice {

    /*
    @Valid 또는 @Validated로 binding error 발생시 발생하는 예외
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    protected ResponseEntity<Object> handleMethodArgumentNotValid(
        MethodArgumentNotValidException e) {
        log.warn("handleMethodArgumentNotValidException", e);
        final ErrorResponse response = ErrorResponse.of(ErrorCode.INVALID_INPUT_VALUE,
            e.getBindingResult());
        return new ResponseEntity<>(response, HttpStatus.valueOf(response.getStatus()));
    }
    /*
    enum type이 일치하지 않아 binding 못할경우 발생
     */
    @ExceptionHandler(MethodArgumentTypeMismatchException.class)
    protected ResponseEntity<ErrorResponse> handleMethodArgumentTypeMismatchException(
        MethodArgumentTypeMismatchException e) {
        log.error("handleMethodArgumentTypeMismatchException", e);
        final ErrorResponse response = ErrorResponse.of(e);
        return new ResponseEntity<>(response, HttpStatus.valueOf(response.getStatus()));
    }
    /*
    지원하지 않은 Http Method방식으로 호출할 경우 발생
     */
    @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
    protected ResponseEntity<Object> handleHttpRequestMethodNotSupported(
        HttpRequestMethodNotSupportedException e) {
        log.error("handleHttpRequestMethodNotSupportedException", e);
        final ErrorResponse response = ErrorResponse.of(ErrorCode.METHOD_NOT_ALLOWED);
        return new ResponseEntity<>(response, HttpStatus.valueOf(response.getStatus()));
    }

    @ExceptionHandler(BusinessException.class) //비즈니스로직에서 던져지는,발생되는 예외들에 대한 처리 (validation오류들과 같은)
    protected ResponseEntity<ErrorResponse> handleBusinessException(BusinessException e) {
        log.error("handle내부로직에러(BusinessException)", e);
        final ErrorCode code = e.getErrorCode();
        final ErrorResponse response = ErrorResponse.of(code);
        return new ResponseEntity<>(response, HttpStatus.valueOf(response.getStatus()));
    }

    @ExceptionHandler(Exception.class) // 위의 예외들에서 걸러지지않은 나머지 예외들에 대한 처리
    protected ResponseEntity<ErrorResponse> handleException(Exception e) {
        log.error("handleAllException", e);
        final ErrorResponse response = ErrorResponse.of(ErrorCode.INTERNAL_SERVER_ERROR);
        return new ResponseEntity<>(response, HttpStatus.valueOf(response.getStatus()));
    }
}

---

마무리

에러 처리할 때 try catch 문을 많이 작성해서 소스가 복잡하고 가독성이 떨어졌지만 @ExceptionHandler을 사용함으로 전역적인 에러 관리를 할 수 있어 굉장히 편리했다. 자주 이용해야겠다.

---

출처: https://mangkyu.tistory.com/204 [MangKyu's Diary:티스토리]

출처: https://keeeeeepgoing.tistory.com/175 [Spring] 예외처리 (@ExceptionHandler , @ControllerAdvice,@RestControllerAdvice), 에러코드,실제 적용 [미완]