Spring Boot 예외 처리

Java에서의 예외 처리 → try-catch 문

Spring Boot 에서의 에러 처리 

 

@ControllerAdvice

컨트롤러에 대해 전역적으로 ExceptionHandler를 적용해줌

-> 전역적으로 에러를 다루는 클래스로 에러 처리를 위임

@RestControllerAdvice -> @ResponseBody가 붙어있어 응답을 JSON으로 내려줌

• 하나의 클래스로 모든 컨트롤러에 예외 처리가 가능
• 직접 정의한 에러 응답을 클라이언트에게 줄 수 있음
• 별도의 try-catch 문이 없어 코드의 가독성이 높아짐

 

 

@RestControllerAdvice를 이용한 Spring 예외 처리

1. 에러 코드 정의

@Getter
@RequiredArgsConstructor
public interface ErrorCode {

	INTERVAL_SERVER_ERROR(INTERNAL_SERVER_ERROR, false, "요청을 처리하는 과정에서 서버가 예상하지 못한 오류가 발생하였습니다."),
    USER_NOT_FOUND(NOT_FOUND, false, "해당 회원을 찾을 수 없습니다."),

   	private final int code;
	private final boolean isSuccess;
    private final String message;
    
    ErrorCode(HttpStatus code, boolean isSuccess, String message) {
        this.code = code.value();
        this.isSuccess = isSuccess;
        this.message = message;
    }
}

 

2. 예외 클래스(Exception Class) 추가

• 발생한 예외를 처리
• RuntimeException을 상속받는 예외 클래스 추가

 

@Getter
public class BusinessException extends RuntimeException{
    private final ErrorCode errorCode;

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

 

3. 에러 응답 클래스 정의

BaseResponseDto에 요청 실패 응답 추가

    // 요청에 실패한 경우
    public BaseResponseDto(BaseResponseStatus status) {
        this.code = status.getCode();
        this.isSuccess = status.isSuccess();
        this.message = status.getMessage();
    }

 

4. @RestControllerAdvice 구현

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(BusinessException.class)
    public BaseResponseDto<BaseResponseStatus> businessExceptionHandle(BusinessException e) {
        log.warn("businessException : {}", e);
        return new BaseResponseDto(e.getStatus());
    }

 

 

 

참고 자료 : https://mangkyu.tistory.com/205