[스프링 DB 1편] #5. 자바 예외 이해

[seyxxn]

5. 자바 예외 이해

#️⃣ 목차

• 예외 계층
• 예외 기본 규칙
• 체크 예외 기본 이해
• 언체크 예외 기본 이해
• 체크 예외 활용
• 언체크 예외 활용
• 예외 포함과 스택 트레이스

예외 계층

예외 계층

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

예외 기본 규칙

예외에 대해서는 2가지 기본 규칙을 기억해야 함

1. 예외는 잡아서 처리하거나 던져야 함
2. 예외를 잡거나 던질 때, 지정한 예외 뿐만아니라 그 예외의 자식들도 함께 처리 됨

참고 - 예외를 처리하지 못하고 계속 던지면 어떻게 될까?

• 자바 main() 쓰레드의 경우 예외 로그를 출력하면서 시스템이 종료됨
• 웹 애플리케이션의 경우 여러 사용자의 요청을 처리하기 때문에 하나의 예외 때문에 시스템이 종료되면 안됨. WAS가 해당 예외를 받아서 처리하는데, 주로 사용자에게 개발자가 지정한, 오류 페이지를 보여줌

체크 예외 기본 이해

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

체크 예외 전체 코드 - CheckedTest

package hello.jdbc.exception.basic;

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

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

@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);
        }
    }
    // Exception을 상속받으면 체크예외가 됨

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

        /**
         * 예외를 잡아서 처리하는 코드
         */
        public void callCatch() {
            try {
                repository.call();
            } catch (MyCheckedException e){ // catch는 해당타입과 그 하위 타입을 모두 잡을 수 있음
                // 예외 처리 로직
                log.info("예외 처리, message={}", e.getMessage(), e);
            }
        }

        /**
         * 체크 예외를 밖으로 던지는 코드
         * 체크 예외는 예외를 잡지 않고 밖으로 던지려면 throws 예외를 메서드에 필수로 선언해야 함
         */
        public void callThrow() throws MyCheckedException {
            repository.call();
        }
    }

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

예외를 처리하는 테스트

실행순서 분석

1. test(checked_catch) -> service.callCatch() -> repository.call() (예외 발생하고, 예외를 던짐)
2. test(checked_catch) <- service.callCatch()(catch로 예외 처리) <- repository.call()
3. test(checked_catch)(정상 흐름) <- service.callCatch() <- repository.call()

실행결과

[Test worker] INFO hello.jdbc.exception.basic.CheckedTest - 예외 처리, message=ex
hello.jdbc.exception.basic.CheckedTest$MyCheckedException: ex
at hello.jdbc.exception.basic.CheckedTest$Repository.call(CheckedTest.java:64)
at hello.jdbc.exception.basic.CheckedTest$Service.callCatch(CheckedTest.java:45)
at hello.jdbc.exception.basic.CheckedTest.checked_catch(CheckedTest.java:14)

• 첫줄은 우리가 남긴 로그
• 두번째 줄 부터는 예외에 대한 스택 트래이스 출력 (e)

예외를 처리하지 않고 밖으로 던지는 테스트

실행순서 분석

1. test(checked_throw) -> service.callThrow() -> repository.call() (예외 발생하고, 예외를 던짐)
2. test(checked_throw) <- service.callThrow()(예외 던짐) <- repository.call()
3. test(checked_throw)(예외 도착) -> service.callThrow() -> repository.call()

체크 예외의 장단점

체크 예외는 예외를 잡아서 처리할 수 없을 때, 예외를 밖으로 던지는 throws 예외를 필수로 선언해야 함. 그렇지 않으면 컴파일 오류가 발생함

• 장점 : 개발자가 실수로 예외를 누락하지 않도록 컴파일러를 통해 문제를 잡아주는 훌륭한 안전 장치임
• 단점 : 하지만 실제로는 개발자가 모든 체크 예외를 반드시 잡거나 던지도록 처리해야 하기 때문에, 너무 번거로운 일임. 크게 신경쓰고 싶지 않은 예외까지 모두 챙겨야 함.

언체크 예외 기본 이해

• RuntimeException과 하위 예외는 언체크 예외
• 언체크 예외는 컴파일러가 예외를 체크하지 않음
• 언체크 예외는 체크 예외와 기본적으로 동일함
  • 차이는 예외를 던지는 throws를 선언하지 않고 생략할 수 있다는 점
  • 이 경우 자동으로 예외를 던짐

체크 예외 vs 언체크 예외

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

언체크 예외 - UncheckedTest

package hello.jdbc.exception.basic;

import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.*;


@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);
            }
        }

        /**
         * 예외를 잡지 않아도 됨. 자연스럽게 상위로 넘어감
         * 체크 예외와 다르게 throws 예외 선언을 하지 않아도 됨
         */
        // 언체크 예외를 밖으로 던지는 코드
        public void callThrow(){
            repository.call();
        }
    }

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

언체크 예외의 장단점

언체크 예외는 예외를 잡아서 처리할 수 없을 때, 예외를 밖으로 던지는 throws 예외를 생략할 수 있음

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

체크 예외 활용

언제 체크 예외를 사용하고 언제 언체크(런타임)예외를 사용하는가?

• 기본원칙 2가지

1. 기본적으로 언체크(런타임) 예외를 사용
2. 체크 예외는 비즈니스 로직상 의도적으로 던지는 예외에만 사용

• 이 경우 해당 예외를 잡아서 반드시 처리해야 하는 문제일때만 체크 예외를 사용
• 체크 예외 예)
  • 계좌이체 실패 예외
  • 결제시 포인트 부족 예외
  • 로그인 ID, PW 불일치 예외
• 물론 이 경우에도 100% 체크 예외로 만들어야 하는 것은 아님. 다만 계좌이체 실패처럼 매우 심각한 문제는 개발자가 실수로 예외를 놓치면 안된다고 판단할 수 있음. 이 경우 체크 예외로 만들어 두면 컴파일러를 통해 놓친 예외를 인지할 수 있음 !

체크 예외의 문제점

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

• 리포지토리는 DB에 접근해서 데이터를 저장하고 관리 -> SQLException 체크 예외를 던짐
• NetworkClient는 외부 네트워크에 접속해서 어떤 기능을 처리하는 객체 -> ConnectException 체크 예외를 던짐
• 서비스는 리포지토리와 NetworkClient를 둘 다 호출함
  • 따라서 두 곳에서 올라오는 체크 예외인 SQLException과 ConnectionException을 처리해야 함
  • 그런데 서비스는 이 둘을 처리할 방법을 모름
    • ConnectException 처럼 연결이 실패하거나, SQLException 처럼 데이터베이스에서 발생하는 문제처럼 심각한 문제들은 대부분 애플리케이션 로직에서 처리할 방법이 X
• 서비스는 SQLException과 ConnectException를 처리할 수 없으므로 둘 다 밖으로 던짐
  • 체크 예외이기 때문에 던질 경우 다음과 같이 선언해야 함
    • method() throws SQLException, ConnectException
• 컨트롤러도 두 예외를 처리할 방법이 없음
  • 다음을 선언해서 예외를 밖으로 던짐
    • method() throws SQLException, ConnectException
• 웹 애플리케이션이라면 서블릿의 오류 페이지나, 또는 스프링의 MVC가 제공하는 ControllerAdvice에서 이런 예외를 공통으로 처리함

체크 예외 문제점 - CheckedAppTest

package hello.jdbc.exception.basic;

import org.junit.jupiter.api.Test;

import java.net.ConnectException;
import java.sql.SQLException;
import static org.assertj.core.api.Assertions.*;

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();
        }
        // 체크예외를 처리하지 못해서 밖으로 던지기 위해 throws
    }

    // 서비스
    static class Service {
        Repository repository = new Repository();
        NetworkClient networkClient = new NetworkClient();

        public void logic() throws SQLException, ConnectException {
            repository.call();
            networkClient.call();
        }
        // 체크예외를 처리하지 못해서 밖으로 던지기 위해 throws
    }

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

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

2가지 문제 존재

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

1. 복구 불가능한 예외

• 대부분의 예외는 복구가 불가능함
• SQLException을 예로 들자면, 데이터베이스에 무언가 문제가 있어서 발생하는 예외로 복구가 불가능함
• 대부분의 서비스나 컨트롤러는 이러한 문제를 해결할 수가 없음
• 따라서 일관성있게 공통으로 처리해야 함
• 오류 로그를 남기고 개바자가 해당 오류를 빠르게 인지하는 것이 필요함
  • 서블릿 필터, 스프링 인터셉터, 스프링의 ControllerAdvice를 사용하면 이런 부분을 깔끔하게 공통으로 해결 가능함

2. 의존 관계에 대한 문제

• 체크 예외이기 때문에 컨트롤러나 서비스 입장에서는 본인이 처리할 수 없어도 어쩔 수 없이 throws를 통해 던지는 예외를 선언해야 하는 문제

체크 예외 throws 선언

    // 컨트롤러
    static class Controller {
        Service service = new Service();

        public void request() throws SQLException, ConnectException {
            service.logic();
        }
        // 체크예외를 처리하지 못해서 밖으로 던지기 위해 throws
    }

    // 서비스
    static class Service {
        Repository repository = new Repository();
        NetworkClient networkClient = new NetworkClient();

        public void logic() throws SQLException, ConnectException {
            repository.call();
            networkClient.call();
        }
        // 체크예외를 처리하지 못해서 밖으로 던지기 위해 throws
    }

• 예외를 던지는 부분을 코드에 선언하는 것이 왜 문제가 될까?
  • 서비스, 컨트롤러에서 java.sql.SQLException을 의존하기 때문에 문제가 됨
• 향후 리포지토리를 JDBC 기술이 아닌 다른 기술로 변경한다면, 그래서 SQLException이 아니라 예를 들어서 JPAException으로 예외가 변경된다면 어떻게 될까?
  • SQLException에 의존하던 모든 서비스, 컨트롤러의 코드를 JPAException에 의존하도록 고쳐야 함
• 서비스나 컨트롤러 입장에서는 어차피 본인이 처리할 수도 없는 예외를 의존해야 하는 큰 단점이 발생함

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

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

정리

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

throws Exception

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

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

그런데 최상위 예외인 Exception을 던져도 문제를 해결할 수 있음

void method() throws Exception {..}

• 이렇게하면 문제는 Exception은 최상위 타입이라 모든 체크 예외를 다 밖으로 던지데 죔
• 그러면 다른 체크 예외를 체크할 수 있는 기능이 무효화 됨
  • 따라서, 중요한 체크 예외를 다 놓치게 됨
• 꼭 필요한 경우가 아니면 좋지 않은 방법

언체크 예외 활용

런타입 예외 사용

• SQLException을 런타임 예외인 RuntimeSQLException으로 변환함
• ConnectException 대신에 RuntimeConnectException으로 변환함
  • 런타임예외라서 서비스, 컨트롤러는 해당 예외들을 처리할 수 없다면 별도의 선언 없이 그냥 두면 됨

런타임 예외 사용 변환 - UncheckedAppTest

package hello.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 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(); // System.out에 출력하는 방법
            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); // 내가만든 예외로 바꿔서 내보냄
            }
        }

        public 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);
        }
    }
}

예외 전환

• 리포지토리에서 체크 예외인 SQLException이 발생하면 런타임 예외인 RuntimeSQLException으로 전환해서 예외를 던짐
  • 참고로 이때 기존 예외를 포함해주어야 예외 출력 시 스택 트레이스에서 기존 예외도 함께 확인할 수 있음
• NetworkClient는 단순히 기존 체크 예외를 RuntimeConnectException이라는 런타임 예외가 발생하도록 코드를 바꿈

런타임 예외 - 대부분 복구 불가능한 예외

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

런타임 예외 - 의존 관계에 대한 문제

런타임 예외는 해당 객체가 처리할 수 없는 예외는 무시하면 됨

• 따라서 체크 예외 처럼 예외를 강제로 의존하지 않아도 됨

런타임 예외 throws 생략

    static class Controller {

        public void request(){ // throws 생략함
            service.logic();
        }
    }
    static class Service {

        public void logic(){ // throws 생략함
            repository.call();
            networkClient.call();
        }
    }

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

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

런타임 예외는 문서화

• 런타임 예외는 문서화를 잘해야함
• 또는 코드에 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);

• 문서에 예외를 명시한 예시

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

• method() throws DataAccessException 와 같이 문서화 + 코드에도 명시

예외 포함과 스택 트레이스

예외를 전환할 때는 꼭 기존 예외를 포함해야 함

• 그렇지 않으면 스택 트레이스를 확인할 때 심각한 문제가 발생함

    @Test
    void printEx() {
        Controller controller = new Controller();
        try {
            controller.request();
        } catch (Exception e) {
//            e.printStackTrace(); // System.out에 출력하는 방법
            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과 스택 트레이스를 확인할 수 있음

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

        public void call() {
            try {
                runSQL();
            } catch (SQLException e) { // 여기서 잡음
                throw new RuntimeSQLException();
            }
        }

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

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

🔗 출처

• 김영한 - 스프링 DB 1편 - 데이터 접근 핵심 원리