[spring 데이터 접근 핵심 원리 6] 자바 예외의 이해

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-db-1/dashboard

스프링 DB 1편 - 데이터 접근 핵심 원리 - 인프런 | 강의

김영한님의 위 강의를 바탕으로 작성하였습니다.

예외 계층

스프링이 제공하는 예외 추상화를 이해하기 위해서는 먼저 자바 기본 예외에 대한 이해가 필요하다. 예외는 자바 언어의 기본 문법에 들어가기 때문에 대부분 아는 내용일 것이다. 예외의 기본 내용을 간단히 복습하고, 실무에 필요한 체크 예외와 언체크 예외의 차이와 활용 방안에 대해서도 알아보자.

Object : 예외도 객체이다. 모든 객체의 최상위 부모는 Object 이므로 예외의 최상위 부모도 Object 이다.

 

(자바에선 모든 객체의 최상위 부모는 Object)

 

Throwable : 최상위 예외이다. 하위에 Exception 과 Error 가 있다.

Error : 메모리 부족이나 심각한 시스템 오류와 같이 애플리케이션에서 복구 불가능한 시스템 예외이다. 애플리케이션 개발자는 이 예외를 잡으려고 해서는 안된다.( 애플리케이션에서 복구가 불가한 심각한 에러)

- 상위 예외를 catch 로 잡으면 그 하위 예외까지 함께 잡는다. 따라서 애플리케이션 로직에서는 Throwable 예외도 잡으면 안되는데, 앞서 이야기한 Error 예외도 함께 잡을 수 있기 때문이다. 애플리케이션 로직은 이런 이유로 Exception 부터 필요한 예외로 생각하고 잡으면 된다.
- 참고로 Error 도 언체크 예외이다.

Exception : 체크 예외
- 애플리케이션 로직에서 사용할 수 있는 실질적인 최상위 예외이다.
- Exception 과 그 하위 예외는 모두 컴파일러가 체크하는 체크 예외이다. 단 RuntimeException 은 예외로 한다.

RuntimeException : 언체크 예외, 런타임 예외 컴파일러가 체크 하지 않는 언체크 예외이다.
- RuntimeException 과 그 자식 예외는 모두 언체크 예외이다.
- RuntimeException 의 이름을 따라서 RuntimeException 과 그 하위 언체크 예외를 런타임 예외라고 많이 부른다. 여기서도 앞으로는 런타임 예외로 종종 부르겠다.

 

예외에 대해서는 2가지 기본 규칙을 기억하자.
1. 예외는 잡아서 처리하거나 던져야 한다.
2. 예외를 잡거나 던질 때 지정한 예외뿐만 아니라 그 예외의 자식들도 함께 처리된다.
- 예를 들어서 Exception 을 catch 로 잡으면 그 하위 예외들도 모두 잡을 수 있다.

- 예를 들어서 Exception 을 throws 로 던지면 그 하위 예외들도 모두 던질 수 있다.

 

예외가 발생하면, 자신이 처리하거나, 자신을 호출한 곳에서 처리하도록 예외를 throw한다.

 

참고: 예외를 처리하지 못하고 계속 던지면 어떻게 될까?
- 자바 main() 쓰레드의 경우 예외 로그를 출력하면서 시스템이 종료된다.
- 웹 애플리케이션의 경우 여러 사용자의 요청을 처리하기 때문에 하나의 예외 때문에 시스템이 종료되면 안된다. WAS가 해당 예외를 받아서 처리하는데, 주로 사용자에게 개발자가 지정한, 오류 페이지를 보여준다.

 

다음으로 체크 예외와 언체크 예외의 차이에 대해서 코드로 알아보자.

체크 예외 기본 이해
Exception 과 그 하위 예외는 모두 컴파일러가 체크하는 체크 예외이다( 단 RuntimeException 은 컴파일러가 체크하지 않는다)
체크 예외는 잡아서 처리하거나, 또는 밖으로 던지도록 선언해야한다. 그렇지 않으면 컴파일 오류가 발생한다.

 

 

체크 예외

위와 같이 에러를 던질 경우, 아래와 같이 꼭 에러를 던진다고 "선언" 해줘야한다. (아니면 unhandled exception 에러 발생 )

 

체크 예외를 밖으로(자신의 호출자로) 던질 경우 

static class Repository {
        public void call() throws MyCheckedException {
            throw new MyCheckedException("ex");
        }
    }

 

 

체크 예외를 자신이 잡아서 처리할 경우

public void callCatch() {
            try {
                repository.call();
            } catch (MyCheckedException e) {
                //예외 처리 로직
                log.info("예외 처리, message={}", e.getMessage(), e);
            }
        }

  

 

만약 커스텀 Exception을 만들경우, RuntimException을 상속받으면 unchecked 에러가 되고,

Exception을 상속받으면 Check 에러가 된다.

 

예시

@Getter
public class RestApiException extends RuntimeException {
    private final ErrorResponseCode errorCode;
    private final String message;

    public RestApiException(ErrorResponseCode errorCode) {

        this(errorCode, errorCode.getMessage());
    }

    public RestApiException(ErrorResponseCode errorCode, String message) {
        this.errorCode = errorCode;
        this.message = message;
    }
}

위 코드는 RuntimeException을 상속받아 unchecked 에러가 된다.

위와 같은 커스텀 exception은 컨트롤러 advisor 에서 처리하는 exception 들인데, 이를 unchecked 로 처리한 이유는 뭘까?

-> checked exception 사용 시, 컨트롤러 어드바이스까지 가는 모든 경로에 Throws를 해야한다, 어차피 ControllerAdvice에서 처리함에도.

 

ex) DB connection 에러 -> catch 해봤자 handle할 수 없다.

 

 

 

 

unchekced error vs checked error

checked 예외: 잡아서 처리하거나, 또는 밖으로 던지도록 선언해야한다. 그렇지 않으면 컴파일 오류가 발생한다.

unchecked 예외: 에러를 잡지 않아도, 컴파일러가 체크하지 않아 컴파일 오류가 발생하지 않는다.

 

 

checked 예외 장단점

체크예외는예외를잡아서처리할수없을때,예외를밖으로던지는throws 예외를필수로선언해야 한다. 그렇지 않으면 컴파일 오류가 발생한다. 이것 때문에 장점과 단점이 동시에 존재한다.

장점: 개발자가 실수로 예외를 누락하지 않도록 컴파일러를 통해 문제를 잡아주는 훌륭한 안전 장치이다.

단점: 하지만 실제로는 개발자가 모든 체크 예외를 반드시 잡거나 던지도록 처리해야 하기 때문에, 너무 번거로운 일이 된다. 크게 신경쓰고 싶지 않은 예외까지 모두 챙겨야 한다. 추가로 의존관계에 따른 단점도 있는데 이 부분은 뒤에서 설명하겠다.

 

언체크 예외 기본 이해

RuntimeException 과 그 하위 예외는 언체크 예외로 분류된다.
언체크 예외는 말 그대로 컴파일러가 예외를 체크하지 않는다는 뜻이다.
언체크 예외는 체크 예외와 기본적으로 동일하다. 차이가 있다면 예외를 던지는 throws 를 선언하지 않고, 생략할 수 있다. 이 경우 자동으로 예외를 던진다.

 

체크 예외 VS 언체크 예외
체크 예외: 예외를 잡아서 처리하지 않으면 항상 throws 에 던지는 예외를 선언해야 한다.

언체크 예외: 예외를 잡아서 처리하지 않아도 throws 를 생략할 수 있다. + 언체크 예외는 필요한 경우, 잡아서 처리할 수 있다.

 

따라서, 언체크 예외는 자신이 처리할 경우 try catch로 잡아서 처리하고, 자신이 처리하지 않을 것이라면,

throw new ~~~, 메소드명 throws~~~~() 와 같이 throw할 필요 없이 생략할 수 있다.(양날의 검, 편하지만, 안전하지 않다.)

 

 

* 언체크 에러도 throws 를 사용가능하다(의미는 없음) 다만, 이런 예외가 중요하다, 하는 가독성 적 측면에서 사용

 

 

언체크 예외의 장단점
언체크예외는 예외를잡아서처리할수없을때,예외를밖으로던지는throws 예외를생략할수있다. 

이것 때문에 장점과 단점이 동시에 존재한다.

장점: 신경쓰고 싶지 않은 언체크 예외를 무시할 수 있다. 체크 예외의 경우 처리할 수 없는 예외를 밖으로 던지려면 항상 throws 예외 를 선언해야 하지만, 언체크 예외는 이 부분을 생략할 수 있다. 이후에 설명하겠지만, 신경쓰고 싶지 않은 예외의 의존관계를 참조하지 않아도 되는 장점이 있다.
단점: 언체크 예외는 개발자가 실수로 예외를 누락할 수 있다. 반면에 체크 예외는 컴파일러를 통해 예외 누락을 잡아준다.
정리
체크 예외와 언체크 예외의 차이는 사실 예외를 처리할 수 없을 때 예외를 밖으로 던지는 부분에 있다. 이 부분을 필수로 선언해야 하는가 생략할 수 있는가의 차이다.

 

 

체크 예외 활용
그렇다면 언제 체크 예외를 사용하고 언제 언체크(런타임) 예외를 사용하면 좋을까?
기본 원칙은 다음 2가지를 기억하자.
기본적으로 언체크(런타임) 예외를 사용하자. ( 체크 예외는 잘 사용하지 않는 추세)
체크 예외는 비즈니스 로직상 의도적으로 던지는 예외 중, 매우 중요한 예외에만 사용하자.
이 경우 해당 예외를 잡아서 반드시 처리해야 하는 문제일 때만 체크 예외를 사용해야 한다. 예를 들어서 다음과 같은 경우가 있다.
체크 예외 예)
계좌 이체 실패 예외
결제시 포인트 부족 예외 로그인 ID, PW 불일치 예외
물론 이 경우에도 100% 체크 예외로 만들어야 하는 것은 아니다. 다만 계좌 이체 실패처럼 매우 심각한 문제는 개발자가 실수로 예외를 놓치면 안된다고 판단할 수 있다. 이 경우 체크 예외로 만들어 두면 컴파일러를 통해 놓친 예외를 인지할 수 있다.

 

 

체크예외의 문제점 
 왜 안전해보이는 체크 예외를 잘 사용하지 않는 추세일까?

리포지토리는 DB에 접근해서 데이터를 저장하고 관리한다. 여기서는 SQLException 체크 예외를 던진다. NetworkClient 는 외부 네트워크에 접속해서 어떤 기능을 처리하는 객체이다. 여기서는

ConnectException 체크 예외를 던진다.
서비스는 리포지토리와 NetworkClient 를 둘다 호출한다.

따라서 두 곳에서 올라오는 체크 예외인 SQLException 과 ConnectException 을 처리해야 한다.

그런데 서비스는 이 둘을 처리할 방법을 모른다. ConnectException 처럼 연결이 실패하거나, SQLException 처럼 데이터베이스에서 발생하는 문제처럼 심각한 문제들은 대부분 애플리케이션 로직에서 처리할 방법이 없다.

서비스는 SQLException 과 ConnectException 를 처리할 수 없으므로 둘다 밖으로 던진다. 체크 예외이기 때문에 던질 경우 다음과 같이 선언해야 한다.

     method() throws SQLException, ConnectException

컨트롤러도 두 예외를 처리할 방법이 없다. 다음을 선언해서 예외를 밖으로 던진다.

method() throws SQLException, ConnectException
웹 애플리케이션이라면 서블릿의 오류 페이지나, 또는 스프링 MVC가 제공하는 ControllerAdvice 에서 이런 예외를 공통으로 처리한다.

이런 문제들은 보통 사용자에게 어떤 문제가 발생했는지 자세히 설명하기가 어렵다. 그래서 사용자에게는 "서비스에 문제가 있습니다." 라는 일반적인 메시지를 보여준다. ("데이터베이스에 어떤 오류가 발생했어요" 라고 알려주어도 일반 사용자가 이해할 수 없다. 그리고 보안에도 문제가 될 수 있다.)

API라면 보통 HTTP 상태코드 500(내부 서버 오류)을 사용해서 응답을 내려준다.
이렇게 해결이 불가능한 공통 예외는 별도의 오류 로그를 남기고, 개발자가 오류를 빨리 인지할 수 있도록 메일, 알림(문자, 슬랙)등을 통해서 전달 받아야 한다. 예를 들어서 SQLException 이 잘못된 SQL을 작성해서 발생했다면, 개발자가 해당 SQL을 수정해서 배포하기 전까지 사용자는 같은 문제를 겪게 된다.

 

 

위와 같은 예제에서 볼 수 있는 체크 예외의 큰 문제 2가지

 

복구 불가능한 예외

대부분은 복구가 불가능한 예외가 많다.

서비스, 컨트롤러가 대부분의 오류를 복구할 수 없기에, 이러한 문제들을 서블릿 필터, 스프링 인터셉터, ControllerAdvice등을 사용하여 공통적으로 처리해야한다.

 

의존 관계 문제

서비스가 본인이 처리하지 못하는 exception 을 의존한다.

ex) JPAException인 SQLException을 던지면 서비스 코드는 JPA에 의존한다. -> Service 영역은 기술에 의존이 적어야한다.( 기술이변한다고 변하지 않도록)

결과적으로 OCP, DI를 통해 클라이언트 코드의 변경 없이 대상 구현체를 변경할 수 있다는 장점이 체크 예외 때문에 약해진다

 

 

정리

처리할 수 있는 체크 예외라면 서비스나 컨트롤러에서 처리하겠지만, 지금처럼 데이터베이스나 네트워크 통신처럼 시스템 레벨에서 올라온 예외들은 대부분 복구가 불가능하다. 그리고 실무에서 발생하는 대부분의 예외들은 이런 시스템 예외들이다.
문제는 이런 경우에 체크 예외를 사용하면 아래에서 올라온 복구 불가능한 예외를 서비스, 컨트롤러 같은 각각의 클래스가 모두 알고 있어야 한다. 그래서 불필요한 의존관계 문제가 발생하게 된다.

 

Bad Solution 

throws Exception

SQLException , ConnectException 같은 시스템 예외는 컨트롤러나 서비스에서는 대부분 복구가 불가능하고 처리할 수 없는 체크 예외이다. 따라서 다음과 같이 처리해주어야 한다.

  void method() throws SQLException, ConnectException {..}

 

그런데 다음과 같이 최상위 예외인 Exception 을 던져도 문제를 해결할 수 있다. void method() throws Exception {..}

이렇게 하면 Exception 은 물론이고 그 하위 타입인 SQLException , ConnectException 도 함께 던지게 된다. 코드가 깔끔해지는 것 같지만, Exception 은 최상위 타입이므로 모든 체크 예외를 다 밖으로 던지는 문제가 발생한다.

 

결과적으로 체크 예외의 최상위 타입인 Exception 을 던지게 되면 다른 체크 예외를 체크할 수 있는 기능이 무효화 되고, 중요한 체크 예외를 다 놓치게 된다. 중간에 중요한 체크 예외가 발생해도 컴파일러는 Exception 을 던지기 때문에 문법에 맞다고 판단해서 컴파일 오류가 발생하지 않는다.
이렇게 하면 모든 예외를 다 던지기 때문에 체크 예외를 의도한 대로 사용하는 것이 아니다. 따라서 꼭 필요한 경우가 아니면 이렇게 Exception 자체를 밖으로 던지는 것은 좋지 않은 방법이다.

 

 

그럼 SQLException, ConnectException, IOException 등 체크 예외는 어떻게 처리하면 좋을까?

 

언체크 에러 활용

 

SQLException 을 런타임 예외인 RuntimeSQLException 으로 변환했다.

ConnectException 대신에 RuntimeConnectException 을 사용하도록 바꾸었다.
런타임 예외이기 때문에 서비스, 컨트롤러는 해당 예외들을 처리할 수 없다면 별도의 선언 없이 그냥 두면 된다.

 

 public void call() {
              try {
                  runSQL();
              } catch (SQLException e) {
                  throw new RuntimeSQLException(e);
} }

 

정리

처음 자바를 설계할 당시에는 체크 예외가 더 나은 선택이라 생각했다.

그래서 자바가 기본으로 제공하는 기능들에는 체크 예외가 많다.

그런데 시간이 흐르면서 복구 할 수 없는 예외가 너무 많아졌다.

특히 라이브러리를 점점 더 많이 사용하면서 처리해야 하는 예외도 더 늘어났다. 체크 예외는 해당 라이브러리들이 제공하는 모든 예외를 처리할 수 없을 때마다 throws 에 예외를 덕지덕지 붙어야 했다.

그래서 개발자들은 throws Exception 이라는 극단적?인 방법도 자주 사용하게 되었다. 물론 이 방법은 사용하면 안된다.

모든 예외를 던진다고 선언하는 것인데, 결과적으로 어떤 예외를 잡고 어떤 예외를 던지는지 알 수 없기 때문이다.

체크 예외를 사용한다면 잡을 건 잡고 던질 예외는 명확하게 던지도록 선언해야 한다.

체크 예외의 이런 문제점 때문에 최근 라이브러리들은 대부분 런타임 예외를 기본으로 제공한다.

사실 위에서 예시로 설명한 JPA 기술도 런타임 예외를 사용한다. 스프링도 대부분 런타임 예외를 제공한다.

런타임 예외도 필요하면 잡을 수 있기 때문에 필요한 경우에는 잡아서 처리하고, 그렇지 않으면 자연스럽게 던지도록 둔다.

그리고 예외를 공통으로 처리하는 부분을 앞에 만들어서 처리하면 된다.

추가로 런타임 예외는 놓칠 수 있기 때문에 문서화가 중요하다.

 

런타임 예외는 문서화

런타임 예외는 문서화를 잘해야 한다.
또는 코드에 throws 런타임예외 을 남겨서 중요한 예외를 인지할 수 있게 해준다.

 

예시

 /**
    * Make an instance managed and persistent.
   * @param entity  entity instance
   * @throws EntityExistsException if the entity already exists.
   * @throws IllegalArgumentException if the instance is not an
   *         entity
   * @throws TransactionRequiredException if there is no transaction when
   *         invoked on a container-managed entity manager of that is of type
   *         <code>PersistenceContextType.TRANSACTION</code>
   */
public void persist(Object entity);

throws 가 안되있다 -> runtimeError로 처리된다

 

 

 

 /**
   * Issue a single SQL execute, typically a DDL statement.
   * @param sql static SQL to execute
   * @throws DataAccessException if there is any problem
   */
  void execute(String sql) throws DataAccessException;

 method() throws DataAccessException 와 같이 문서화 + 중요한 에러는 코드에도 명시(throws DataAccessException) 
런타임 예외도 throws 에 선언할 수 있다. 물론 생략해도 된다.
던지는 예외가 명확하고 중요하다면, 코드에 어떤 예외를 던지는지 명시되어 있기 때문에 개발자가 IDE를 통해서 예외를 확인하가 편리하다.
물론 컨트롤러나 서비스에서 DataAccessException 을 사용하지 않는다면 런타임 예외이기 때문에 무시해도 된다.

 

 

예외 포함과 스택 트레이스

예외를 전환할 때는 꼭! 기존 예외를 포함해야 한다. 그렇지 않으면 스택 트레이스를 확인할 때 심각한 문제가 발생한다.

  @Test
  void printEx() {
     Controller controller = new Controller();
      try {
          controller.request();
      } catch (Exception e) {
          //e.printStackTrace();
          log.info("ex", e);
      }
}

로그를 출력할 때 마지막 파라미터에 예외를 넣어주면 로그에 스택 트레이스를 출력할 수 있다.
예) log.info("message={}", "message", ex) , 여기에서 마지막에 ex 를 전달하는 것을 확인할 수 있다. 이렇게 하면 스택 트레이스에 로그를 출력할 수 있다.
예) log.info("ex", ex) 지금 예에서는 파라미터가 없기 때문에, 예외만 파라미터에 전달하면 스택 트레이스를 로그에 출력할 수 있다.

System.out 에 스택 트레이스를 출력하려면 e.printStackTrace() 를 사용하면 된다. 실무에서는 항상 로그를 사용해야 한다는 점을 기억하자.

 

e.printStackTrace() -> x

 

log.info("message={}", "message", ex)   -> o

 

public void call() {
      try {
          runSQL();
      } catch (SQLException e) {
throw new RuntimeSQLException(e); //기존 예외(e) 포함 }
//throw new RuntimeSQLException(); //기존 예외(e) 제외 
}

위와같이, 예외를 변경하여 throw 시, 기존예외를 반드시 포함해야한다.

 

public void call() {
      try {
          runSQL();
      } catch (SQLException e) {
throw new RuntimeSQLException(); //기존 예외(e) 제외 
}

이렇게 수행 시, SQLException 에 대한 스택 트레이스를 확인 할 수 없다.

 

정리

Throwable이 최상위 예외 객체. Error는 우리가 handle하면 안되고, Exception이 실제로 처리할 예외들이다.

예외처리

- Throw 하거나, Handle 하거나.

기본적으로 unchecked(런타임 에러) 사용, 의도적으로 던지는 매우 중요한 예외( 계좌이체 예외 등) 만 checked 에러 사용.

SQLException, IOException 과 같은 check예외는 catch하여 unchecked 예외로 throw하자.( checked 예외는

의존성 문제, 처리 불가 예외 문제가 존재 )