Chained Exception 알아보기

이월(0216tw)·2024년 5월 8일

Chained Exception Java Spring 연쇄 예외 예외 예외처리

Chained Exception이란?

한 예외가 다른 예외를 발생시키는 것을 의미한다.

사용 이유

여러 예외를 추상화하고, 구체적으로 원인 설정도 가능
추상화된 예외원인과 상세원인을 알수 있어 추적이 가능
checked 를 unchecked 로 바꿔주므로 코드 가독성 향상

만약 chained Exception을 처음 듣는다면 이 말이 잘 이해가 가지 않을것이다.
아래 코드를 보고나면 충분히 이해할 수 있을 것이며,
단, 이 자료는 Exception에 대해 기본 개념을 알고있다는 전제를 깔고 시작한다.

Chained Exception 예시

만약 우리가 계산기를 구현하고 있다고 하자.

계산기를 구현하다보니 연산 관련 예외처리 할 것이 너무 많아졌다.

[발생한 예외]

0으로 나눌 수 없으면 ArithmeticException 예외가 발생한다.
입력값(int)가 100000을 초과하면 사용자 예외(TooLargeNumberException)
입력값으로 숫자가 아닌 값이 들어온경우(NumberFormatException)

이 상태에서 예외처리를 한다면 아래 코드와 같을 것이다.

public class CalculatorService {

    //NumberFormatException은 RuntimeException 을 상속함
    //ArithmeticException은 RuntimeException을 상속함
    //TooLargeNumberException은 Exception을 상속함 
    
    public int divide(String num1 , String num2)  {

        int result = 0; 
        try {
            int number1 = Integer.parseInt(num1);
            int number2 = Integer.parseInt(num2);

            if (number1 > 100000 || number2 > 100000) {
                throw new TooLargeNumberException("숫자는 100000이하로만 입력가능합니다.");
            }
            number2 = 0; //강제 예외를 만들기 위해 임의로 넣음
            result = number1/number2 ;

        } catch(NumberFormatException numberFormatException) {
            System.out.println("숫자형이 아닙니다!!"); 
        } catch(TooLargeNumberException tooLargeNumberException) {
            System.out.println("숫자는 100000이하로만 가능합니다!!");
        } catch(ArithmeticException arithmeticException) {
            System.out.println("0으로 나누지 말라고!!"); 
        }
        return result; 
    }
}

class TooLargeNumberException extends Exception {
    public TooLargeNumberException(String msg) {
        super(msg);
    }
}

소스를 천천히 뜯어보자.

만약 입력파라미터 String num1 , num2 가 "A" 나 숫자가 아닌 값으로 들어올 경우
Integer.parseInt() 부분에서 NumberFormatException이 발생한다.

그리고 입력받은 값이 숫자이지만 100000을 초과하면
TooLargeNumberException 라는 사용자 예외가 발생한다.

마지막으로 divide 결과를 리턴할 때 나눌 값이 0이면
ArithmeticException 이 발생하게 되어있다.

그런데 나는 @Service 부분에서 이렇게 예외를 전부 처리하려니 로직이 복잡해진다는 생각이 들었다 (코드 가독성이 떨어진다.)

그래서 @Controller 부분에 이 예외를 옮기기로 했다.

[Service 부분 코드]

public class CalculatorService { 
    public int divide(String num1 , String num2) throws NumberFormatException , TooLargeNumberException , ArithmeticException {
    //throws 를 이용해서 예외를 호출한 컨트롤러에게 예외처리 책임을 전가했다.
    //Service 부분의 코드가 깔끔해졌다.

        int number1 = Integer.parseInt(num1);
        int number2 = Integer.parseInt(num2);
        if (number1 > 100000 || number2 > 100000) {
            throw new TooLargeNumberException("숫자는 100000이하로만 입력가능합니다.");
        }
        number2 = 0; //강제 예외를 만들기 위해 임의로 넣음
        return  number1/number2 ;
    }
}

[Controller 부분 코드]

public class CalculatorController {

    public static void main( String[] args) {

  CalculatorService calculatorService = new CalculatorService();

        try {
            String num1 = "aaa";
            String num2 = "12312";
            calculatorService.divide(num1 , num2) ;

        } catch(NumberFormatException numberFormatException) {
            System.out.println("숫자형이 아닙니다!!");
        } catch(TooLargeNumberException tooLargeNumberException) {
            System.out.println("숫자는 100000이하로만 가능합니다!!");
        } catch(ArithmeticException arithmeticException) {
            System.out.println("0으로 나누지 말라고!!");
        }
    }
}

"엥.. Service에서 하나 Controller에서 하나 다를게 없넹 ?

그리고 혹시모르니 Exception도 추가해야 할 거 같은데?

그러니까 이방법은 실패!!

이번에는 예외를 좀 추상화 시켜보자.

아이디어는 다음과 같다.

"어차피 세 예외 모두 연산에 관련된 오류니까 하나로 묶을 수 없을까?"

이 아이디어를 Chained Exception으로 한번 구현해보겠다.

[Service 부분 코드]

public class CalculatorService {

    //NumberFormatException은 RuntimeException 을 상속함
    //TooLargeNumberException은 Exception을 상속하기로 함
    public int divide(String num1 , String num2) throws DivideOperationException {

        int result = 0; 
        
        try {
            int number1 = Integer.parseInt(num1);
            int number2 = Integer.parseInt(num2);

            if (number1 > 100000 || number2 > 100000) {
                throw new TooLargeNumberException("");
            }
            number2 = 0; //강제 예외를 만들기 위해 임의로 넣음
            return  number1/number2 ;

        } catch(NumberFormatException numberFormatException) {

            DivideOperationException divideOperationException = new DivideOperationException("숫자만 입력가능합니다!");
            divideOperationException.initCause(numberFormatException); //여기서 중요! 원래 예외였던 원인을 initCause로 원인으로 초기화했다.
            throw divideOperationException; //그리고 새롭게 연결시킨(chain) divideOperationException 다시 던지고 있다. (즉 연쇄적으로 감싸서 던졌다.)

        } catch(TooLargeNumberException tooLargeNumberException) {

            DivideOperationException divideOperationException = new DivideOperationException("숫자는 10000만 이하로만 가능합니다!!");
            divideOperationException.initCause(tooLargeNumberException);
            throw divideOperationException;

        } catch(ArithmeticException arithmeticException) {
            DivideOperationException divideOperationException = new DivideOperationException("0으로 나누지 말라고!!");
            divideOperationException.initCause(arithmeticException);
            throw divideOperationException;
        }
    }
}

class TooLargeNumberException extends Exception {
    public TooLargeNumberException(String msg) {
        super(msg);
    }
}

class DivideOperationException extends RuntimeException {
    public DivideOperationException(String msg) {
        super(msg);
    }
}

catch(NumberFormatException numberFormatException) { ...
부분을 보면 발생한 예외 NumberFormatException 을 던지는게 아니라
새롭게 DivideOperationException 을 던지고 있다.
(이 예외는 하단에 내가 사용자 정의로 만든 것이다)

그리고 새롭게 만든 예외에 initCause() 메서드를 이용해서
"원래 예외는 이놈이에요." 라고 알려주는 것이다.

즉 요지는 이렇다.

[기존]

0으로 나눌 수 없으면 ArithmeticException 예외가 발생한다.
입력값(int)가 100000을 초과하면 사용자 예외(TooLargeNumberException)
입력값으로 숫자가 아닌 값이 들어온경우(NumberFormatException)

[chained Exception 적용]

DivideOperationException 예외 발생
- 그 안에 실제 예외가 있음 (예: NumberFormatException )

그럼 이제 Controller 쪽은??

[ControllerS 부분 코드]

public class CalculatorController {
    public static void main( String[] args) {

        CalculatorService calculatorService = new CalculatorService();

        try {
            String num1 = "aaa";
            String num2 = "12312";
            calculatorService.divide(num1, num2);
        } catch (DivideOperationException divideOperationException) {
            System.out.println("에러 메시지: " + divideOperationException.getMessage()); // 에러 메시지: 숫자만 입력가능합니다! 
            System.out.println("원인: " + divideOperationException.getCause());  // 원인: java.lang.NumberFormatException: For input string: "aaa"
        }
    }
}