[ 김영한 스프링 DB 1편 - 데이터 접근 핵심 원리 #5 ] 자바 예외 이해 (2)

지난 포스팅에 이어, 이번 포스팅에서는 5) ~ 8) 까지의 내용을 정리한다.

👉 목차는 다음과 같다.

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

바로 하나씩 확인해보자.

---

5) 체크 예외 활용

그렇다면 언제 체크 예외를 사용하고 언제 언체크(런타임) 예외를 사용하면 좋을까?

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

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

 

🤔 왜 기본적으로 언체크(런타임) 예외를 사용할까?

체크 예외의 문제점

체크 예외는 컴파일러가 예외 누락을 체크해주기 때문에 개발자가 실수로 예외를 놓치는 것을 막아준다. 그래서 항상 명시적으로 예외를 잡아서 처리하거나, 처리할 수 없을 때는 예외를 던지도록 method() throws 예외 로 선언해야 한다.
지금까지 이야기를 들어보면 체크 예외가 런타임 예외보다 더 안전하고 좋아보이는데, 왜 체크 예외를 기본으로 사용하는 것이 문제가 될까?

그림과 코드로 문제점을 이해해보자.

• 체크 예외 문제점 그림 참고)
  
  • 리포지토리는 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을 수정해서 배포하기 전까지 사용자는 같은 문제를 겪게 된다.

 

👉 체크 예외 문제점을 코드로 확인해보자.

• CheckedAppTest 생성: test > java > hello > jdbc > exception > basic 패키지 내부에 CheckedAppTest 클래스를 생성하자.
  
  • 서비스: 체크 예외를 처리하지 못해서 밖으로 던지기 위해 logic() throws SQLException, ConnectException 를 선언했다.
  • 컨트롤러: 체크 예외를 처리하지 못해서 밖으로 던지기 위해 request() throws SQLException, ConnectException 를 선언했다.

• 실행해보자.
  
  • 정상적으로 실행됨을 확인할 수 있다.

 

지금까지 설명한 예시와 코드를 보면 크게 2가지 문제를 알 수 있다.

✔️ 2가지 문제

• ① 복구 불가능한 예외
• ② 의존 관계에 대한 문제

① 복구 불가능한 예외

대부분의 예외는 복구가 불가능하다. 일부 복구가 가능한 예외도 있지만 아주 적다.
SQLException 을 예를 들면 데이터베이스에 무언가 문제가 있어서 발생하는 예외이다. SQL 문법에 문제가 있을 수도 있고, 데이터베이스 자체에 뭔가 문제가 발생했을 수도 있다. 데이터베이스 서버가 중간에 다운되었을 수도 있다.
이런 문제들은 대부분 복구가 불가능하다. 특히나 대부분의 서비스나 컨트롤러는 이런 문제를 해결할 수는 없다. 따라서 이런 문제들은 일관성있게 공통으로 처리해야 한다. 오류 로그를 남기고 개발자가 해당 오류를 빠르게 인지하는 것이 필요하다. 서블릿 필터, 스프링 인터셉터, 스프링의 ControllerAdvice 를 사용하면 이런 부분을 깔끔하게 공통으로 해결할 수 있다. (시스템에서 네트워크 접근이 안되서 발생하는 문제나, DB 문제가 있거나 이런 부분들은 비즈니스적으로 복구가 불가능하다. 따라서 이런 부분은 공통으로 해결해야 한다.)

② 의존 관계에 대한 문제

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

• 체크 예외 throws 선언
  
  • 🤔 throws SQLException, ConnectException 처럼 예외를 던지는 부분을 코드에 선언하는 것이 왜 문제가 될까?
  • 바로 서비스, 컨트롤러에서 java.sql.SQLException 을 의존하기 때문에 문제가 된다. ( SQLException은 JDBC 기술이다. )
  • 이후에 리포지토리를 JDBC 기술이 아닌 다른 기술로 변경한다면, 그래서 SQLException 이 아니라 예를 들어서 JPAException 으로 예외가 변경된다면 어떻게 될까?
  • SQLException 에 의존하던 모든 서비스, 컨트롤러의 코드를 JPAException 에 의존하도록 고쳐야 한다.
  • 서비스나 컨트롤러 입장에서는, 어차피 본인이 처리할 수도 없는 예외를 의존해야 하는 큰 단점이 발생하게 된다. 결과적으로 OCP, DI를 통해 클라이언트 코드의 변경없이 대상 구현체를 변경할 수 있다는 장점이 체크 예외 때문에 발목이 잡히게 된다.

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

 

✔️ 정리

• 처리할 수 있는 체크 예외라면 서비스나 컨트롤러에서 처리하겠지만, 지금처럼 데이터베이스나 네트워크 통신처럼 시스템 레벨에서 올라온 예외들은 대부분 복구가 불가능하다. 그리고 실무에서 발생하는 대부분의 예외들은 이런 시스템 예외들이다.

• 문제는 이런 경우에 체크 예외를 사용하면 아래에서 올라온 복구 불가능한 예외를 서비스, 컨트롤러 같은 각각의 클래스가 모두 알고 있어야 한다. 그래서 불필요한 의존관계 문제가 발생하게 된다.

• throws Exception

  • SQLException , ConnectException 같은 시스템 예외는 컨트롤러나 서비스에서는 대부분 복구가 불가능하고 처리할 수 없는 체크 예외이다. 따라서 다음과 같이 처리해주어야 한다.
  • void method() throws SQLException, ConnectException {..}
  • 그런데 다음과 같이 최상위 예외인 Exception 을 던져도 문제를 해결할 수 있다. (그러면 SQLException, ConnectException 에 의존하지 않아도 되므로, 의존관계 문제는 해결된다.)
    • void method() throws Exception {..}
    • 이렇게 하면 Exception 은 물론이고 그 하위 타입인 SQLException , ConnectException 도 함께 던지게 된다. 코드가 깔끔해지는 것 같지만, Exception 은 최상위 타입이므로 모든 체크 예외를 다 밖으로 던지는 문제가 발생한다.
    • 결과적으로 체크 예외의 최상위 타입인 Exception 을 던지게 되면 다른 체크 예외를 체크할 수 있는 기능이 무효화 되고, 중요한 체크 예외를 다 놓치게 된다. 중간에 중요한 체크 예외가 발생해도 컴파일러는 Exception 을 던지기 때문에 문법에 맞다고 판단해서 컴파일 오류가 발생하지 않는다.
    • 이렇게 하면 모든 예외를 다 던지기 때문에 체크 예외를 의도한 대로 사용하는 것이 아니다. 따라서 꼭 필요한 경우가 아니면 이렇게 Exception 자체를 밖으로 던지는 것은 좋지 않은 방법이다. (안티 패턴이다.)
    • 그러면 뭐가 대안일까? 바로 언체크 예외를 활용하는 것이 대안이다.

 

다음 내용에서는 이런 부분들을 언체크 예외로 바꿔서 문제를 해결해보자.

---

6) 언체크 예외 활용

이번에는 런타임 예외를 사용해보자.

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

 

👉 코드로 확인해보자.

• UncheckedAppTest 생성: test > java > hello > jdbc > exception > basic 패키지 내부에 UncheckedAppTest 클래스를 생성하자.
  

• 각 내부 코드는 다음과 같다.
  

• 실행해보자.
  
  • 정상적으로 실행됨을 확인할 수 있다.

 

✔️ 코드 설명

예외 전환

• 리포지토리에서 체크 예외인 SQLException 이 발생하면 런타임 예외인 RuntimeSQLException 으로 전환해서 예외를 던진다.
  • 참고로 이때 기존 예외를 포함해주어야 예외 출력시 스택 트레이스에서 기존 예외도 함께 확인할 수 있다. 예외 포함에 대한 부분은 조금 뒤에 더 자세히 설명한다.
• NetworkClient 는 단순히 기존 체크 예외를 RuntimeConnectException 이라는 런타임 예외가 발생하도록 코드를 바꾸었다.

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

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

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

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

런타임 예외 throws 생략

• 참고)
  
  • 런타임 예외이기 때문에 컨트롤러나 서비스가 예외를 처리할 수 없다면 다음 부분을 생략할 수 있다. ( 따라서 컨트롤러와 서비스에서 해당 예외에 대한 의존 관계가 발생하지 않는다. )
    • method() throws RuntimeSQLException, RuntimeConnectException

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

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

 

✔️ 정리

• 처음 자바를 설계할 당시에는 체크 예외가 더 나은 선택이라 생각했다. 그래서 자바가 기본으로 제공하는 기능들에는 체크 예외가 많다.
• 그런데 시간이 흐르면서 복구할 수 없는 예외가 너무 많아졌다. 특히 라이브러리를 점점 더 많이 사용하면서 처리해야 하는 예외도 더 늘어났다. 체크 예외는 해당 라이브러리들이 제공하는 모든 예외를 처리할 수 없을 때마다 throws 에 예외를 덕지덕지 붙어야 했다. 그래서 개발자들은 throws Exception 이라는 극단적?인 방법도 자주 사용하게 되었다.
• 물론 이 방법은 사용하면 안된다. 모든 예외를 던진다고 선언하는 것인데, 결과적으로 어떤 예외를 잡고 어떤 예외를 던지는지 알 수 없기 때문이다. 체크 예외를 사용한다면 잡을 건 잡고 던질 예외는 명확하게 던지도록 선언해야 한다.
• 체크 예외의 이런 문제점 때문에 최근 라이브러리들은 대부분 런타임 예외를 기본으로 제공한다. 사실 위에서 예시로 설명한 JPA 기술도 런타임 예외를 사용한다. 스프링도 대부분 런타임 예외를 제공한다.
• 런타임 예외도 필요하면 잡을 수 있기 때문에 필요한 경우에는 잡아서 처리하고, 그렇지 않으면 자연스럽게 던지도록 둔다. 그리고 예외를 공통으로 처리하는 부분을 앞에 만들어서 처리하면 된다.

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

런타임 예외는 문서화

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

---

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

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

👉 코드로 확인해보자.

• UncheckedAppTest 추가: 다음과 같이 추가해보자.
  
  • (참고) @Slf4j 추가
  • 로그를 출력할 때 마지막 파라미터에 예외를 넣어주면 로그에 스택 트레이스를 출력할 수 있다.
    • 예) log.info("message={}", "message", ex) 여기에서 마지막에 ex 를 전달하는 것을 확인할 수 있다. 이렇게 하면 로그에 스택 트레이스를 출력할 수 있다.
    • 예) log.info("ex", ex) 지금 예에서는 파라미터가 없기 때문에, 예외만 파라미터에 전달하면 스택 트레이스를 로그에 출력할 수 있다.
  • System.out 에 스택 트레이스를 출력하려면 e.printStackTrace() 를 사용하면 된다. ( e.printStackTrace()를 사용하게 되면 System.out에 출력된다. )
    • 실무에서는 항상 로그를 사용해야 한다는 점을 기억하자.

 

기존 예외를 포함하는 경우

• 참고)
  
• 실행해보자. ( printEx() )
  
  • 예외를 포함해서 기존에 발생한 java.sql.SQLException 과 스택 트레이스를 확인할 수 있다.

 

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

• 참고)
  
  • (참고) RuntimeSQLException에 기본 생성자를 하나 추가하였다.
• 실행해보자. ( printEx() )
  
  • 예외를 포함하지 않아서 기존에 발생한 java.sql.SQLException 과 스택 트레이스를 확인할 수 없다. 변환한 RuntimeSQLException 부터 예외를 확인할 수 있다. (뭐 때문에 RuntimeSQLException이 발생했는지 알 수 없다.) 만약 실제 DB에 연동했다면 DB에서 발생한 예외를 확인할 수 없는 심각한 문제가 발생한다.
  • 예외를 전환할 때는 꼭! 기존 예외를 포함하자.

---

8) 정리

• 예외 계층
  • 예외 계층을 그림을 통해서 알아보았다.
    • 최상위 예외로 Throwable이 있고, Exception과 Error로 나뉜다. ( Error 부분은 애플리케이션 개발시 예외를 잡으려고 해서는 안 된다. )
    • Exception의 하위는 체크 예외와 언체크 예외(런타임 예외)로 나뉜다.
• 예외 기본 규칙
  • 예외의 기본 규칙은 잡아서 처리하거나, 처리할 수 없으면 밖으로 던져야한다.
• 체크 예외 기본 이해
• 언체크 예외 기본 이해
  • 체크 예외와 언체크 예외에 대해서 알아보았다.
  • 결국 둘의 차이는
    • 체크 예외는 예외를 잡아서 처리하거나 또는 항상 throw에 던지는 예외를 선언해야 한다.
    • 언체크 예외는 예외를 잡아서 처리하지 않아도 throws를 생략할 수 있다.
• 체크 예외 활용
  • 체크 예외와 언체크 예외를 언제 사용하면 좋을지 알아보았다.
    • 기본 원칙은 다음 2가지를 기억하자.
      • 기본적으로 언체크(런타임) 예외를 사용하자. (최근 트렌드)
      • 체크 예외는 비즈니스 로직상 의도적으로 던지는 예외에만 사용하자.
  • 체크 예외의 문제점에 대해서 알아보았다.
    • 복구 불가능한 예외, 의존 관계에 대한 문제
• 언체크 예외 활용
  • 런타임 예외이기 때문에 서비스, 컨트롤러는 해당 예외들을 처리할 수 없다면 별도의 선언 없이 그냥 두면 된다. (공통 처리하는 곳에서 처리)
• 예외 포함과 스택 트레이스
  • 예외를 전환할 때는 반드시 기존 예외를 포함하자. (그렇지 않으면 장애 발생시 왜 문제가 발생했는지 찾기 어렵다.)

---

강의를 듣고 정리한 글입니다. 코드와 그림 등의 출처는 김영한 강사님께 있습니다.