Spring DB - 자바 예외 이해

Kwon Yongho·2023년 5월 16일
Spring DB
0

Spring-DB

목록 보기
5/16
post-thumbnail

자바 예외 이해

  1. 예외 계층
  2. 예외 기본 규칙
  3. 체크 예외 기본 이해
  4. 언체크 예외 기본 이해
  5. 체크 예외 활용
  6. 언체크 예외 활용
  7. 예외 포함과 스택 트레이스

1. 예외 계층

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

예외 계층

  • Object: 예외도 객체이다. 모든 객체의 최상위 부모는 Object 이므로 예외의 최상위 부모도 Object이다.
  • Throwable: 최상위 예외이다. 하위에 Exception과 Error가 있다.
  • Error: 메모리 부족이나 심각한 시스템 오류와 같이 애플리케이션에서 복구 불가능한 시스템 예외이다. 애플리케이션 개발자는 이 예외를 잡으려고 해서는 안된다.
    • 상위 예외를 catch로 잡으면 그 하위 예외까지 함께 잡는다. 따라서 애플리케이션 로직에서는 Throwable예외도 잡으면 안되는데, 앞서 이야기한 Error예외도 함께 잡을 수 있기 때문이다. 애플리케이션 로직은 이런 이유로 Exception부터 필요한 예외로 생각하고 잡으면 된다.
  • Exception: 체크 예외
    • 애플리케이션 로직에서 사용할 수 있는 실질적인 최상위 예외이다.
    • Exception과 그 하위 예외는 모두 컴파일러가 체크하는 체크 예외이다. 단 RuntimeException은 예외로 한다.
  • RuntimeException: 언체크 예외, 런타임 예외
    • 컴파일러가 체크 하지 않는 언체크 예외이다.
    • RuntimeException과 그 자식 예외는 모두 언체크 예외이다.
    • RuntimeException의 이름을 따라서 RuntimeException과 그 하위 언체크 예외를 런타임 예외라고 많이 부른다. 여기서도 앞으로는 런타임 예외로 종종 부르겠다.

2. 예외Exception : 체크 예외 기본 규칙

예외 처리

  • 5번에서 예외를 잡으면 애플리케이션 로직은 정상적으로 동작한다.
  • 예외를 처리하지 못하면 호출한 곳으로 예외를 계속 던진다.

예외에 대해서는 2가지 기본 규칙을 기억하자.

  • 예외는 잡아서 처리하거나 던져야 한다.
  • 예외를 잡거나 던질 때 지정한 예외뿐만 아니라 그 예외의 자식들도 함께 처리된다.
    • 예를 들어서 Exception을 catch로 잡으면 그 하위 예외들도 모두 잡을 수 있다.
    • 예를 들어서 Exception을 throws로 던지면 그 하위 예외들도 모두 던질 수 있다.

3. 체크 예외 기본 이해

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

CheckedTest

package com.example.jdbc.exception.basic;

import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThatThrownBy;

@Slf4j
public class CheckedTest {

    @Test
    void checked_catch() {
        Service service = new Service();
        service.callCatch();
    }

    @Test
    void checked_throw() {
        Service service = new Service();
        assertThatThrownBy(() -> service.callThrow()).isInstanceOf(MyCheckedException.class);
    }

    // Exception을 상속받은 예외는 체크 예외가 된다.
    static class MyCheckedException extends Exception {
        public MyCheckedException(String message) {
            super(message);
        }
    }

    // Checked 예외는 예외를 잡아서 처리하거나, 던지거나 둘중 하나를 필수로 선택해야 한다.
    static class Service {
        Repository repository = new Repository();

        // 예외를 잡아서 처리하는 코드
        public void callCatch() {
            try {
                repository.call();
            } catch (MyCheckedException e) {
                //예외 처리 로직
                log.info("예외 처리, message={}", e.getMessage(), e);
            }
        }

        // 체크 예외를 밖으로 던지는 코드
        public void callThrow() throws MyCheckedException {
            repository.call();
        }

    }

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

실행 순서
실행 순서를 분석해보자.
1. test -> service.callCatch() -> repository.call() (예외 발생, 던짐)
2. test <- service.callCatch() (예외처리) <- repository.call()
3. test (정상 흐름) <- service.callCatch() <- repository.call()

  • MyCheckedException는 Exception을 상속받았다. Exception을 상속받으면 체크 예외가 된다.
  • 예외가 제공하는 여러가지 기본 기능이 있는데, 그 중에 오류 메시지를 보관하는 기능도 있다. 예제에서 보는 것 처럼 생성자를 통해서 해당 기능을 그대로 사용하면 편리하다.
  • Repository.call()에서 MyUncheckedException예외가 발생하고, 그 예외를
    Service.callCatch()에서 잡는 것을 확인할 수 있다.

체크 예외의 장단점

  • 체크 예외는 예외를 잡아서 처리할 수 없을 때, 예외를 밖으로 던지는 throws예외 를 필수로 선언해야 한다. 그렇지 않으면 컴파일 오류가 발생한다. 이것 때문에 장점과 단점이 동시에 존재한다.
  • 장점: 개발자가 실수로 예외를 누락하지 않도록 컴파일러를 통해 문제를 잡아주는 훌륭한 안전 장치이다.
  • 단점: 개발자가 모든 체크 예외를 반드시 잡거나 던지도록 처리해야 하기 때문에, 너무 번거로운 일이 된다. 크게 신경쓰고 싶지 않은 예외까지 모두 챙겨야 한다.

4. 언체크 예외 기본 이해

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

체크 예외 VS 언체크 예외

  • 체크 예외: 예외를 잡아서 처리하지 않으면 항상 throws에 던지는 예외를 선언해야 한다.
  • 언체크 예외: 예외를 잡아서 처리하지 않아도 throws를 생략할 수 있다.

UncheckedTest

package com.example.jdbc.exception.basic;

import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThatThrownBy;

@Slf4j
public class UncheckedTest {

    @Test
    void unchecked_catch() {
        Service service = new Service();
        service.callCatch();
    }

    @Test
    void unchecked_throw() {
        Service service = new Service();
        assertThatThrownBy(() -> service.callThrow()).isInstanceOf(MyUncheckedException.class);
    }

    // RuntimeException을 상속받은 예외는 언체크 예외가 된다.
    static class MyUncheckedException extends RuntimeException {
        public MyUncheckedException(String message) {
            super(message);
        }
    }

    // UnChecked 예외는 예외를 잡거나, 던지지 않아도 된다.
    static class Service {
        Repository repository = new Repository();

        // 필요한 경우 예외를 잡아서 처리하면 됨
        public void callCatch() {
            try {
                repository.call();
            } catch (MyUncheckedException e) {
                //예외 처리 로직
                log.info("예외 처리, message={}", e.getMessage(), e);
            }
        }

        // 예외를 잡지 않아도 된다. 자연스럽게 상위로 넘어간다.
        public void callThrow() {
            repository.call();
        }

    }

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

  • 언체크 예외는 체크 예외와 다르게 throws예외 를 선언하지 않아도 된다.
  • 말 그대로 컴파일러가 이런 부분을 체크하지 않기 때문에 언체크 예외이다.
  • 언체크 예외도 throws예외 를 선언해도 된다. 물론 생략할 수 있다.

언체크 예외의 장단점

  • 장점: 신경쓰고 싶지 않은 언체크 예외를 무시할 수 있다. 체크 예외의 경우 처리할 수 없는 예외를 밖으로 던지려면 항상 throws예외 를 선언해야 하지만, 언체크 예외는 이 부분을 생략할 수 있다.
  • 단점: 언체크 예외는 개발자가 실수로 예외를 누락할 수 있다. 반면에 체크 예외는 컴파일러를 통해 예외 누락을 잡아준다.

5. 체크 예외 활용

기본 원칙은 다음 2가지를 기억하자.

  • 기본적으로 언체크(런타임) 예외를 사용하자.
  • 체크 예외는 비즈니스 로직상 의도적으로 던지는 예외에만 사용하자
  • 체크 예외 Ex
    • 계좌 이체 실패 예외
    • 결제시 포인트 부족 예외
    • 로그인 ID, PW 불일치 예외

체크 예외가 좋아 보이는데 무엇이 문제가 될까?

  • SQLException 체크 예외 ConnectException 체크 예외를 던지면
  • 서비스는 두 곳에서 올라오는 체크 예외인 SQLException과 ConnectException을 처리해야 한다.
  • 서비스는 SQLException과 ConnectException를 처리할 수 없으므로 둘다 밖으로 던진다.
  • 컨트롤러도 두 예외를 처리할 방법이 없다.
  • 웹 애플리케이션이라면 서블릿의 오류 페이지나, 또는 스프링 MVC가 제공하는 ControllerAdvice에서 이런 예외를 공통으로 처리한다.
  1. 복구 불가능한 예외
  2. 의존 관계에 대한 문제

CheckedAppTest

package com.example.jdbc.exception.basic;

import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;

import java.net.ConnectException;
import java.sql.SQLException;

import static org.assertj.core.api.Assertions.assertThatThrownBy;

@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를 선언했다.

1. 복구 불가능한 예외

  • 대부분의 예외는 복구가 불가능하다. 일부 복구가 가능한 예외도 있지만 아주 적다.
  • 오류 로그를 남기고 개발자가 해당 오류를 빠르게 인지하는 것이 필요하다. 서블릿 필터, 스프링 인터셉터, 스프링의ControllerAdvice를 사용하면 이런 부분을 깔끔하게 공통으로 해결할 수 있다.

2. 의존 관계에 대한 문제

  • 체크 예외의 또 다른 심각한 문제는 예외에 대한 의존 관계 문제이다.
  • 앞서 대부분의 예외는 복구 불가능한 예외라고 했다. 그런데 체크 예외이기 때문에 컨트롤러나 서비스 입장에서는 본인이 처리할 수 없어도 어쩔 수 없이 throws를 통해 던지는 예외를 선언해야 한다.

체크 예외 구현 기술 변경시 파급 효과

JDBC -> JPA 같은 기술로 변경하면 예외도 함께 변경해야한다. 그리고 해당 예외를 던지는 모든 다음 부분도 함께 변경해야 한다.

6. 언체크 예외 활용

런타임 예외 사용

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

UncheckedAppTest

package com.example.jdbc.exception.basic;

import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;

import java.sql.SQLException;

import static org.assertj.core.api.Assertions.assertThatThrownBy;

@Slf4j
public class UncheckedAppTest {

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

    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() {
        }
        public RuntimeSQLException(Throwable cause) {
            super(cause);
        }
    }
}

  • 위 설명대로 언체크 예외를 활용하여 런타임 예외가 언체크 예외가 발생하도록 변경하였고 코드가 줄고 강제로 의존하지 않도록 변경 되었다.

런타임 예외 구현 기술 변경시 파급 효과

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

런타임 예외는 문서화

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

JPA EntityManager Ex

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

스프링 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;

7. 예외 포함과 스택 트레이스

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

UncheckedAppTest(추가)

    @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() 를 사용하면 된다.

실무에서는 항상 로그를 사용해야 한다는 점을 기억

기존 예외를 포함하지 않는 경우

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

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

예외를 전환할 때는 꼭! 기존 예외를 포함하자

참고
김영한: 스프링 DB 1편 - 데이터 접근 핵심 원리(인프런)
Github - https://github.com/b2b2004/Spring_DB

profile
Kwon Yongho
공책
이전 포스트

Spring DB - 스프링과 문제 해결 - 트랜잭션

다음 포스트

Spring DB - 스프링 문제 해결 - 예외 처리, 반복

0개의 댓글