[Spring] 예외 처리

예외(Exception) 

 

• 프로그래밍에서 예외(Exception)란 입력값의 처리가 불가능하거나 참조된 값이 잘못된 경우 등 애플리케이션이 정상적으로 동작하지 못하는 상황
• 코드 설계를 통해 개발자가 직접 처리 가능하다.

 

에러(Error)

 

• 주로 자바의 가상머신에서 발생시키는 것이므로 예외와 달리 애플리케이션 코드에서 처리할 수 있는 것이 거의 없다.
• ex) 메모리 부족(OutOfMemory), 스택 오버플로(StackOverFlow)
• 발생 시점에 처리하는 것이 아니라 미리 애플리케이션의 코드를 살펴보면서 문제가 발생하지 않도록 예방해서 차단해야한다.

 

 

예외 클래스

 

• 모든 예외 클래스는 Throwable 클래스를 상속받는다.
• Exception클래스는 다양한 자식 클래스를 가지고 있는데 크게 두가지가 있다.
  • Checked Exception
    • 컴파일 단계에서 확인 가능한 예외 상황
    • IDE에서 캐치해서 반드시 예외 처리를 할 수 있게 표시해준다.
    • 대표적인 예외 클래스
      • IOException
      • SQLException
  • Unchecked Exception
    • 런타임 단계에서 확인되는 예외 상황
    • 문법상 문제는 없지만 프로그램이 동작하는 도중 발생하는 예외를 의미한다.
    • 대표적인 예외 클래스
      • RuntimeException
      • NullPointerException
      • IllegalArgumentException
      • IndexOutOfBoundException
      • SystemException

 

예외 처리 방법

 

• 예외가 발생했을때 처리하는 방법
  
  • 예외 복구
    • 예외 상황을 파악해서 문제 해결 방식
    • 대표적인 방법
      • try/catch
  • 예외 처리 회피
    • 예외가 발생한 시점에서 바로 처리하는것이 아니라 예외가 발생한 메서드를 호출한 곳에서 에러 처리를 할 수 있게 전가하는 방식
    • 대표적인 방법
      • throw
  • 예외 전환
    • 앞의 두 방식을 적절하게 섞은 방식(try/catch + throw)
    • 예외가 발생했을 때 어떤 예외가 발생했는냐에 따라 호출부로 예외 내용을 전달하면서 좀 더 적합한 예외 타입으로 전달 할 필요가 있을때 활용.

 

 

스프링 부트에서 예외 처리 방식

 

• 예외가 발생했을때 클라이언트에 오류 메시지를 전달하려면 각 레이어에서 발생한 예외를 엔드포인트 레벨인 컨트롤러로 전달해야 한다.
• 이렇게 전달받은 예외를 스프링 부트에서 처리하는 방식으로 크게 두가지가 있다.
  • @(Rest)ControllerAdvice와 @ExceptionHandler를 통해 모든 컨트롤러의 예외를 처리
  • @ControllerAdvice 대신 @RestControllerAdvice를 사용하면 결과값을 JSON 형태로 반환할 수 있다.
  • @ExceptionHandler 를 통해 특정 컨트롤러의 예외를 처리
  • 만약 컨트롤러 또는 @controllerAdvice 클래스내에서 동일한 핸들러 메서드가 선언된 상태에서 @ExceptionHandler(Exception.class) 와@ExceptionHandler(NullPointerException.class)가 실행된 경우 구체적인 클래스가 지정된 쪽(NullPointerException)이 우선순위를 갖게된다. 
  • 또한 @ControllerAdvice의 글로벌 예외 처리와 @Controller 내의 컨트롤러 예외 처리에 동일한 타입의 예외 처리를 하게 되면 범위가 좁은 컨트롤러의 핸들러 메서드가 우선순위를 갖게된다.

 

 

사용자 정의 예외(커스텀 예외)

 

• 표준 예외를 사용할 때는 예외 메시지를 상세히 작성해야 하는 번거로움 존재.
• 사용자 정의 예외는 클래스의 이름만 봐도 직관적으로 어떤 오류가 발생했는지 짐작 가능하다.
• 애플리케이션에서 발생하는 예외를 개발자가 직접 관리하기가 수월해진다.
  
• 또한 예외 상황에 대한 처리도 용이한데 표준 예외가 아닌 다른 에러들도 어디에서 문제가 발생했는지 확인하기 쉽다.

 

 

커스텀 에외 클래스 생성하기

 

• 커스텀 예외는 예외가 발생하는 상황에 해당하는 상위 예외 클래스를 상속받는다.
• 예외 클래스를 생성하는데 필요한 내용
  • 에러 타입(Error Type) : HttpStatus의 reasonPhrase
  • 에러 코드(Error Code) : HttpStatus의 value
  • 메시지(Message) : 상황별 상세 메시지

 

예제 코드

 

먼저 어플리케이션에서 발생할 수 있는 오류 상황별 ErrorCode를 정의한 Enum 클래스를 만든다.

그 다음, 예외 클래스임을 알려주는 Exception 또는 RuntimeException 을 상속받아 AppException 클래스를 정의한다. 예외를 강제 하고 싶은 경우 Exception,  느슨하게 정보만 제공하고 싶은 경우 RuntimeException을 상속한다.

 

@AllArgsConstructor
@Getter
public enum ErrorCode {
    USERMAIL_DUPLICATED(HttpStatus.CONFLICT, ""),
    USERMAIL_NOT_FOUND(HttpStatus.NOT_FOUND, ""),
    INVALID_PASSWORD(HttpStatus.UNAUTHORIZED, ""),
    CART_NOT_FOUND(HttpStatus.NOT_FOUND, ""),
    PRODUCT_NOT_FOUND(HttpStatus.NOT_FOUND, ""),
    PAGE_INDEX_ZERO(HttpStatus.BAD_REQUEST, ""),
    ORDER_NOT_FOUND(HttpStatus.NOT_FOUND, "");


    private HttpStatus httpStatus;
    private String message;
}

HttpStatus를 커스텀 예외 클래스에 포함시키면 핸들러 안에서 선언해서 사용하는 것이 아닌 예외 클래스만 전달받으면 그 안에 내용이 포함돼 있는 구조로 설계할 수 있다. 

@AllArgsConstructor
@Getter
public class AppException extends RuntimeException{
    private ErrorCode errorCode;
    private String message;
}

package com.example.creditmarket.exception;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class ExceptionManager {

    @ExceptionHandler(AppException.class)
    public ResponseEntity<?> appExceptionHandler(AppException e){
        return ResponseEntity.status(e.getErrorCode().getHttpStatus())
                .body(e.getErrorCode().name() + " " + e.getMessage());
    }

    @ExceptionHandler(RuntimeException.class)
    public ResponseEntity<?> runtimeExceptionHandler(RuntimeException e){
        return ResponseEntity.status(HttpStatus.CONFLICT)
                .body(e.getMessage());
    }
}

 

•  @RestControllerAdvice
  • @Controller나 @RestController에서 발생하는 예외를 한 곳에서 관리하고 처리할 수 있게 하는 기능 수행
  • basePackagesClasses, basePackages를 별도로 설정하여 예외를 관제하는 범위를 지정할 수 도 있다.
    • basePackageClasses: 적용 클래스에만 적용
    • basePackages:  하위 클래스에 모두 적용
    • @RestControllerAdvice(basePackageClasses =  ProductController.class) // 해당 클래스
    • @RestControllerAdvice(basePackages = "com.example") // 지정 패키지내에 모두 적용 
• @ExceptionHandler
  • @Controller나 @RestController가 적용된 빈에서 발생하는 예외를 잡아 처리하는 메서드를 정의할 때 사용한다.
  • 어떤 예외 클래스를 처리할지는 value 속성으로 등록하며 여러 예외 클래스를 등록 할 수도 있다.

 

 

 

 

 

참고

스프링 부트 핵심가이드 - 장정우