[SpringDB1] 자바 예외 활용

July 14, 2022 6 분 소요

체크 예외 활용

기본 원칙

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

체크 예외의 문제점

체크 예외는 컴파일러가 예외 누락을 체크해주기 때문에 실수로 예외를 놓치는 것을 막아준다.
그래서 항상 명시적으로 예외를 잡아서 처리하거나, 처리할 수 없을 때는 예외를 던지도록 method() throws 예외로 선언해야 한다.

리포지토리는 DB에 접근해서 데이터를 저장하고 관리한다.
- 여기서는 SQLException 체크 예외를 던진다.
NetworkClient는 외부 네트워크에 접속해서 어떤 기능을 처리하는 객체이다.
- 여기서는 ConnectionException 체크 예외를 던진다.
서비스는 Repository와 NetworkClient 둘 다 호출한다.
- 따라서, 두 곳에서 올라오는 SQLException과 ConnectionException을 처리해야 한다.
- 하지만, ConnectionException처럼 연결이 실패하거나 SQLException처럼 데이터베이스에서 발생하는 문제들은 대부분 애플리케이션 로직에서 처리할 방법이 없다.
서비스는 SQLException과 ConnectionException을 처리할 수 없으므로 둘 다 밖으로 던진다.
- 체크 예외이기 때문에 던질 경우 다음과 같이 선언해야 한다.
- method() throws SQLException, ConnectException
컨트롤러도 두 예외를 처리할 방법이 없기 때문에 서비스와 똑같이 두 예외를 밖으로 던진다.
웹 애플리케이션이라면 서블릿 오류 페이지나, 스프링 MVC가 제공하는 ControllerAdvice에서 이런 예외를 공통으로 처리한다.
API라면 보통 HTTP 상태코드 500을 사용해서 응답을 내려준다.
이렇게 해결이 불가능한 공통 예외는 별도의 오류 로그를 남기고, 개발자가 오류를 빨리 인지할 수 있도록 메일, 알림(문자, 슬랙)등을 통해서 전달 받아야 한다. 예를 들어서 SQLException이 잘못된 SQL을 작성해서 발생했다면, 개발자가 해당 SQL을 수정해서 배포하기 전까지 사용자는 같은 문제를 겪게 된다.

CheckedAppTest

@Slf4j
public class CheckedAppTest {

    @Test
    void checked() {
        Controller controller = new Controller();
        assertThatThrownBy(() -> controller.request())
                .isInstanceOf(Exception.class);
    }

    static class Controller {
        Service service = new Service();

        public void request() throws SQLException, ConnectException {
            service.logic();
        }
    }

    static class Service {

        Repository repository = new Repository();
        NetworkClient networkClient = new NetworkClient();

        public void logic() throws SQLException, ConnectException {
            repository.call();
            networkClient.call();
        }
    }

    static class NetworkClient {
        public void call() throws ConnectException {
            throw new ConnectException("연결 실패");
        }
    }

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

서비스
- 체크 예외를 처리하지 못하기 때문에 logic() throws SQLException, ConnectException을 선언해서 예외를 밖으로 던졌다.
컨트롤러
- 체크 예외를 처리하지 못하기 때문에 request() throws SQLException, ConnectException을 선언해서 예외를 밖으로 던졌다.

2가지 문제

1.복구 불가능한 예외
2.의존 관계에 대한 문제

복구 불가능한 예외
대부분의 예외는 복구가 불가능하며, 일부 복구가 가능한 예외도 있지만 아주 적다.
SQLException을 예로 들면 데이터베이스에 무언가 문제가 있어서 발생하는 예외이다. SQL 문법에 문제가 있을 수도 있고, 데이터베이스 자체에 뭔가 문제가 발생했을 수도 있다.
이런 문제들은 대부분 복구가 불가능하며, 특히 대부분의 서비스나 컨트롤러는 이런 문제를 해결할 수 없다. 따라서, 이런 문제들은 일관성 있게 공통으로 처리해야 한다.
오류 로그를 남기고 개발자가 해당 오류를 빠르게 인지하는 것이 필요하다. 서블릿 필터, 스프링 인터셉터, 스프링의 ControllerAdvice를 사용하면 이런 부분을 깔끔하게 공통으로 해결할 수 있다.
의존관계에 대한 문제
앞서 대부분의 예외는 복구 불가능한 예외라고 했다. 그런데 체크 예외이기 때문에 컨트롤러나 서비스 입장에서는 본인이 처리할 수 없어도 어쩔 수 없이 throws를 통해 던지는 예외를 선언해야 한다.

throws SQLException, ConnectException처럼 예외를 던지는 부분 때문에 서비스, 컨트롤러는 java.sql.SQLException을 의존하는 문제가 발생한다.

향후 리포지토리를 JDBC 기술이 아닌 다른 기술로 변경한다면 SQLException이 다른 예외로 변경될 것이다. 그렇게 되면 SQLException에 의존하던 모든 서비스, 컨트롤러의 코드를 다른 기술에 의존하도록 고쳐야 한다. 결과적으로 OCP, DI를 통해 클라이언트 코드의 변경 없이 대상 구현체를 변경할 수 있다는 장점이 체크 예외 때문에 발목이 잡히게 된다.

JDBC -> JPA 같은 기술로 변경하면 예외도 함께 변경해야한다. 그리고 해당 예외를 던지는 모든 다음 부분도 함께 변경해야 한다.
- logic() throws SQLException -> logic() throws JPAException
- (참고로 JPA 예외는 실제 이렇지는 않고, 이해하기 쉽게 예를 든 것이다.)

정리

처리할 수 있는 체크 예외라면 서비스나 컨트롤러에서 처리하겠지만, 지금처럼 데이터베이스나 네트워크 통신처럼 시스템 레벨에서 올라온 예외들은 대부분 복구가 불가능하다. 그리고 실무에서 발생하는 대부분의 예외들은 이런 시스템 예외들이다.
문제는 이런 경우에 체크 예외를 사용하면 아래에서 올라온 복구 불가능한 예외를 서비스, 컨트롤러 같은 각각의 클래스가 모두 알고 있어야 한다. 그래서 불필요한 의존관계 문제가 발생하게 된다.
최상위 예외인 Exception을 던져도 문제를 해결할 수 있지만, 모든 체크 예외를 밖으로 던지는 문제가 발생한다.
- 결과적으로 다른 체크 예외를 체크할 수 있는 기능이 무효화 되고, 중간에 중요한 체크 예외가 발생하도 컴파일러는 Exception을 던지기 때문에 문법에 맞다고 판단해서 컴파일 오류가 발생하지 않는다.
- 따라서, 꼭 필요한 경우가 아니면 Exception 자체를 밖으로 던지는 것은 좋지 않은 방법이다.

언체크 예외 활용

SQLException을 런타임 예외인 RuntimeSQLException으로 변환.
ConnectionException 대신에 RuntimeConnectionException을 사용하도록 변환.
런타임 예외이기 때문에 서비스, 컨트롤러는 해당 예외들을 처리할 수 없다면 별도의 선언 없이 그냥 두면 된다.

UncheckedAppTest

@Slf4j
public class UncheckedAppTest {

    @Test
    void unchecked() {
        Controller controller = new Controller();
        assertThatThrownBy(() -> controller.request())
                .isInstanceOf(Exception.class);
    }

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

    static class Controller {

        Service service = new Service();

        public void request() {
            service.logic();
        }
    }

    static class Service {

        Repository repository = new Repository();
        NetworkClient networkClient = new NetworkClient();

        public void logic() {
            repository.call();
            networkClient.call();
        }
    }

    static class NetworkClient {
        public void call() {
            throw new RuntimeConnectException("연결 실패");
        }
    }

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

        private void runSQL() throws SQLException {
            throw new SQLException("ex");
        }
    }

    static class RuntimeConnectException extends RuntimeException {
        public RuntimeConnectException(String message) {
            super(message);
        }
    }

    static class RuntimeSQLException extends RuntimeException {
        public RuntimeSQLException(Throwable cause) {
            super(cause);
        }
    }
}

런타임 예외이기 때문에 컨트롤러나 서비스가 예외를 처리할 수 없다면 다음 부분을 생략할 수 있다.

method() throws RuntimeSQLException, RuntimeConnectionException
따라서, 컨트롤러와 서비스에서 해당 예외에 대한 의존 관계가 발생하지 않는다.

예외 전환

Repository에서 체크 예외인 SQLException이 발생하면 런타임 예외인 RuntimeSQLException으로 전환해서 예외를 던진다.
- 이때 기존 예외(cause)를 포함해주어야 예외 출력시 스택 트레이스에서 기존 예외도 함께 확인할 수 있다.
NetworkClient는 단순히 기존 체크 예외를 RuntimeConnectionException이라는 런타임 예외가 발생하도록 코드를 바꾸었다.

런타임 예외 - 대부분 복구 불가능한 예외
시스템에서 발생한 예외는 대부분 복구 불가능한 예외이다. 런타임 예외를 사용하면 서비스나 컨트롤러가 이런 복구 불가능한 예외를 신경쓰지 않아도 된다.
물론 이렇게 복구 불가능한 예외는 일관성있게 공통으로 처리해야 한다.

런타임 예외 - 의존 관계에 대한 문제
런타임 예외는 해당 객체가 처리할 수 없는 예외는 무시하면 된다. 따라서, 체크 예외처럼 예외를 강제로 의존하지 않아도 된다.

기술 변경

런타임 예외를 사용하면 중간에 기술이 변경되어도 해당 예외를 사용하지 않는 컨트롤러, 서비스에서는 코드를 변경하지 않아도 된다.
구현 기술이 변경되는 경우, 예외를 공통으로 처리하는 곳에서는 예외에 따른 다른 처리가 필요할 수 있다.
- 하지만, 공통 처리하는 한 곳만 변경하면 되기 때문에 변경의 영향 범위는 최소화 된다.

정리

시간이 흐르면서 복구 할 수 없는 예외가 너무 많아졌고, 특히 라이브러리를 점점 더 많이 사용하면서 처리해야 하는 예외도 더 늘어났다. 체크 예외는 해당 라이브러리들이 제공하는 모든 예외를 처리할 수 없을 때 마다 throws에 예외를 다 붙여야 했다.
체크 예외의 이런 문제점 때문에 스프링과, 최근 라이브러리들은 대부분 런타임 예외를 기본으로 제공한다.(위에서 예시로 설명한 JPA기술도 런타임 예외를 사용한다.)

런타임 예외 문서화

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

예시

JPA EntityManager

/**
 * 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);

Ex) 문서에 예외 명시

스프링 JdbcTemplate

/**
 * 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;

스택 트레이스

예외를 전환할 때는 반드시 기존 예외를 포함해야한다!

@Test
void printEx() {

    Controller controller = new Controller();

    try {
        ontroller.request();
    } catch (Exception e) {
        //e.printStackTrace();
        log.info("ex", e);
    }
}

로그를 출력할 때 마지막 파라미터에 예외를 넣어주면 로그에 스택 트레이스를 출력할 수 있다.
System.out에 스택 트레이스를 출력하려면 e.printStackTrace()를 사용하면 된다.
- 실무에서는 항상 로그를 사용해야 한다.

기존 예외 포함 코드

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

기존 예외를 포함하지 않으면 기존에 발생한 java.sql.SQLException과 스택 트레이스를 확인할 수 없고, 변환한 RuntimeSQLException부터 예외를 확인할 수 있다.
만약, 실제 DB에 연동했다면 DB에서 발생한 예외를 확인할 수 없는 심각한 문제가 발생한다.

따라서, 예외를 전환할 때는 반드시 기존 예외를 포함해야한다!!

<출처 : 인프런 - 스프링 DB 1편 : 데이터 접근 핵심 원리(김영한)>

Twitter Facebook LinkedIn

[SpringDB1] 자바 예외 활용

체크 예외 활용

체크 예외의 문제점

CheckedAppTest

정리

언체크 예외 활용

UncheckedAppTest

기술 변경

정리

런타임 예외 문서화

예시

스택 트레이스

공유하기

댓글남기기

참고

[독서] 돈의속성

[독서] 부자 아빠 가난한 아빠

[독서] 부자 아빠 가난한 아빠

[취업] SKCT 후기