체크 예외 활용
그렇다면 언제 체크 예외를 사용하고 언제 언체크(런타임) 예외를 사용하면 좋을까?
기본 원칙은 다음 2가지를 기억하자
1. 기본적으로 언체크(런타임) 예외를 사용하자.
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 (코드)
public class CheckedAppTest {
@Test
void checked() {
Controller controller = new Controller();
Assertions.assertThatThrownBy(() -> controller.request())
.isInstanceOf(Exception.class);
}
static class Controller {
Service service = new Service();
public void request() throws SQLException, ConnectException { // 체크예외이므로 throws로 예외를 던짐을 선언해준다.
service.logic();
}
}
static class Service {
Repository repository = new Repository();
NetWorkClient netWorkClient = new NetWorkClient();
public void logic() throws SQLException, ConnectException {// 체크예외이므로 throws로 예외를 던짐을 선언해준다.
repository.call();
netWorkClient.call();
}
}
static class NetWorkClient {
public void call() throws ConnectException { // 체크예외이므로 throws로 예외를 던짐을 선언해준다.
throw new ConnectException("ex");
}
}
static class Repository {
public void call() throws SQLException{ // 체크예외이므로 throws로 예외를 던짐을 선언해준다.
throw new SQLException("ex");
}
}
}서비스
체크 예외를 처리하지 못해서 밖으로 던지기 위해 logic() throws SQLException, ConnectException 를 선언했다.
컨트롤러
체크 예외를 처리하지 못해서 밖으로 던지기 위해 request() throws SQLException, ConnectException 를 선언했다.
2가지 문제
지금까지 설명한 예시와 코드를 보면 크게 2가지 문제를 알 수 있다.
1. 복구 불가능한 예외
2. 의존 관계에 대한 문제
1. 복구 불가능한 예외
대부분의 예외는 복구가 불가능하다.
일부 복구가 가능한 예외도 있지만 아주 적다.
SQLException 을 예를 들면 데이터베이스에 무언가 문제가 있어서 발생하는 예외이다.
SQL 문법에 문제가 있을 수도 있고, 데이터베이스 자체에 뭔가 문제가 발생했을 수도 있다.
데이터베이스 서버가 중간에 다운 되었을 수도 있다.
이런 문제들은 대부분 복구가 불가능하다. 특히나 대부분의 서비스나 컨트롤러는 이런 문제를 해결할 수는 없다.
따라서 이런 문제들은 일관성 있게 공통으로 처리해야 한다.
오류 로그를 남기고 개발자가 해당 오류를 빠르게 인지하는 것이 필요하다.
서블릿 필터, 스프링 인터셉터, 스프링의 ControllerAdvice 를 사용하면 이런 부분을 깔끔하게 공통으로 해결할 수 있다.
2. 의존 관계에 대한 문제
체크 예외의 또 다른 심각한 문제는 예외에 대한 의존 관계 문제이다.
앞서 대부분의 예외는 복구 불가능한 예외라고 했다.
그런데 체크 예외이기 때문에 컨트롤러나 서비스 입장에서는
본인이 처리할 수 없어도 어쩔 수 없이 throws 를 통해 던지는 예외를 선언해야 한다.
public void request() throws SQLException, ConnectException { // 체크예외이므로 throws로 예외를 던짐을 선언해준다.
service.logic();
}이런식으로 체크예외니까 throws를 사용해야만한다.
( 결국 체크예외를 이용한다고 해도 컨트롤러,서비스에서 처리할 수 없는게 대부분이다.
컨트롤러 서비스에서 throws라는 예외를 던지는 코드만 증가시킬뿐이다. 어차피 컨트롤러 밖으로 예외가 던져질것이므로
서블릿 필터, 스프링 인터셉터, 스프링 기본 에러처리 , 스프링의 ControllerAdvice 등등 다양한 방법으로 처리될것이다.)
throws SQLException, ConnectException 처럼
예외를 던지는 부분을 코드에 선언하는 것이 왜 문제가 될까?
바로 서비스, 컨트롤러에서 java.sql.SQLException 을 의존하기 때문에 문제가 된다.
향후 리포지토리를 JDBC 기술이 아닌 다른 기술로 변경한다면, 그래서 SQLException 이 아니라
예를 들어서 JPAException 으로 예외가 변경된다면 어떻게 될까?
SQLException에 의존하던 모든 서비스, 컨트롤러의 코드를 JPAException 에 의존하도록 고쳐야 한다.
서비스나 컨트롤러 입장에서는 어차피 본인이 처리할 수 도 없는 예외를 의존해야 하는 큰 단점이 발생하게 된다.
결과적으로 OCP, DI를 통해 클라이언트 코드의 변경 없이
대상 구현체를 변경할 수 있다는 장점이 체크 예외 때문에 발목을 잡게 된다.
체크 예외 구현 기술 변경시 파급 효과
JDBC --> JPA 같은 기술로 변경하면 예외도 함께 변경해야한다. (기술을 바꾸면 예외도 바꿔야한다.)
그리고 해당 예외를 던지는 모든 다음 부분도 함께 변경해야 한다.
(참고로 JPA 예외는 실제 이렇지는 않고, 이해하기 쉽게 예를 든 것이다.)
정리
처리할 수 있는 체크 예외라면 서비스나 컨트롤러에서 처리하겠지만,
지금처럼 데이터베이스나 네트워크 통신처럼 시스템 레벨에서 올라온 예외들은 대부분 복구가 불가능하다.
그리고 실무에서 발생하는 대부분의 예외들은 이런 시스템 예외들이다.
문제는 이런 경우에 체크 예외를 사용하면
아래에서 올라온 복구 불가능한 예외를 서비스, 컨트롤러 같은 각각의 클래스가 모두 알고 있어야 한다.
그래서 불필요한 의존관계 문제가 발생하게 된다
throws Exception
SQLException , ConnectException 같은 시스템 예외는
컨트롤러나 서비스에서는 대부분 복구가 불가능하고 처리할 수 없는 체크 예외이다.
따라서 다음과 같이 처리해주어야 한다.
void method() throws SQLException, ConnectException {..}그런데 다음과 같이 최상위 예외인 Exception 을 던져도 문제를 해결할 수 있다.
void method() throws Exception {..}이렇게 하면 Exception 은 물론이고 그 하위 타입인 SQLException , ConnectException 도 함께 던지게 된다.
코드가 깔끔해지는 것 같지만, Exception은 최상위 타입이므로 모든 체크 예외를 다 밖으로 던지는 문제가 발생한다.
(Exception를 이용해서 throws, try catch()를 하면 언체크 예외도 같이 잡히지만, 체크예외도 함께 잡히기때문에
예외를 잡아 처리하거나, throws를 이용해서 예외를 던짐을 선언해줘야한다. 즉 언체크예외의 장점을 잃는다)
결과적으로 체크 예외의 최상위 타입인 Exception 을 던지게 되면 다른 체크 예외를 체크할 수 있는 기능이 무효화 되고,
중요한 체크 예외를 다 놓치게 된다. ( 만약 어떤 체크예외 , 예를 들어 SQLException가 올라온경우 내부적으로 코드로 처리할게 있다고할때, throws Exception을 메소드에 붙여버리면 컴파일러가 따로 알려주는게 없기에 내부적으로 코드를 처리해야하는부분을 까먹을 수도있다. 즉 체크예외의 장점을 없애버리는것이다.)
중간에 중요한 체크 예외가 발생해도 컴파일러는 Exception 을 던지기 때문에
문법에 맞다고 판단해서 컴파일 오류가 발생하지 않는다.
이렇게 하면 모든 예외를 다 던지기 때문에 체크 예외를 의도한 대로 사용하는 것이 아니다.
따라서 꼭 필요한 경우가 아니면 이렇게 Exception 자체를 밖으로 던지는 것은 좋지 않은 방법이다
언체크 예외 활용
이번에는 런타임 예외(== 언체크 예외)를 사용해보자.
런타임 예외 사용 (그림)
SQLException 을 런타임 예외인 RuntimeSQLException 으로 변환했다.
ConnectException 대신에 RuntimeConnectException 을 사용하도록 바꾸었다.
런타임 예외이기 때문에 서비스, 컨트롤러는 해당 예외들을 처리할 수 없다면 별도의 선언 없이 그냥 두면 된다
런타임 예외 사용 변환 UncheckedAppTest ( 코드 )
public class UnCheckedAppTest {
@Test
void unchecked() {
Controller controller = new Controller();
Assertions.assertThatThrownBy(() -> controller.request())
.isInstanceOf(Exception.class);
}
static class Controller {
Service service = new Service();
public void request() { // 언체크예외이므로 throws 생략가능
service.logic();
}
}
static class Service {
Repository repository = new Repository();
NetWorkClient netWorkClient = new NetWorkClient();
public void logic() { // 언체크예외이므로 throws 생략가능
repository.call();
netWorkClient.call();
}
}
static class NetWorkClient {
public void call() { // 언체크예외이므로 throws 생략가능
throw new RuntimeConnectException("ex");
}
}
static class Repository {
public void call() { // call()에서 SQLException (체크예외)를 잡아서 언체크예외로 바꿔서 던져준다.
try {
runSQL();
} catch (SQLException e) {
throw new RuntimeSQLException(e); // 예외를 넣어서그 예외의 스택 트레이스를 확인할 수 있다.
}
}
public void runSQL() throws SQLException { // runSQL()은 체크예외인 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) { // 예외는 Throwable 객체를 넣을 수 있는 생성자도 존재한다.
// Throwable는 모든 예외의 부모클래스이므로 파라미터로 예외를 넣으면 그 예외의 스택 트레이스를 확인할 수 있다.
super(cause);
}
}
}예외 전환
리포지토리에서 체크 예외인 SQLException 이 발생하면
런타임 예외인 RuntimeSQLException 으로 전환해서 예외를 던진다
(리포지토리에서 발생하는 체크예외를 내부의 try catch()로 잡아서 언체크예외로 전환해서 던져준다.
그렇게하면 리포지토리의 메소드를 호출하는 서비스, 그 서비스 메소드를 호출하는 컨트롤러 둘다 throws를 생략해도 된다. 따라서 컨트롤러와 서비스에서 해당 예외에 대한 의존 관계가 발생하지 않는다.)
참고로 이때 기존 예외를 포함해주어야 예외 출력시 스택 트레이스에서 기존 예외도 함께 확인할 수 있다.
예외 포함에 대한 부분은 조금 뒤에 더 자세히 설명한다.
NetworkClient 는 단순히 기존 체크 예외를 RuntimeConnectException 이라는
런타임 예외가 발생하도록 코드를 바꾸었다
런타임 예외 - 대부분 복구 불가능한 예외
시스템에서 발생한 예외는 대부분 복구 불가능 예외이다.
런타임 예외를 사용하면 서비스나 컨트롤러가 이런 복구 불가능한 예외를 신경쓰지 않아도 된다.
물론 이렇게 복구 불가능한 예외는 일관성 있게 공통으로 처리해야 한다.
런타임 예외 - 의존 관계에 대한 문제
런타임 예외는 해당 객체가 처리할 수 없는 예외는 무시하면 된다.
따라서 체크 예외 처럼 예외를 강제로 의존하지 않아도 된다.
(throws를 사용하지않아도 되므로)
런타임 예외 구현 기술 변경시 파급 효과
런타임 예외를 사용하면 중간에 기술이 변경되어도
해당 예외를 사용하지 않는 컨트롤러, 서비스에서는 코드를 변경하지 않아도 된다
(try catch()를 안쓴다는 가정하에 throws를 안쓰니까)
구현 기술이 변경되는 경우, 예외를 공통으로 처리하는 곳에서는 예외에 따른 다른 처리가 필요할 수 있다.
하지만 공통 처리하는 한곳만 변경하면 되기 때문에 변경의 영향 범위는 최소화 된다
(ControllerAdvice에서 해당 예외를 처리하던 @ExceptionHandler 부분을 수정하면 될거같다.)
정리
처음 자바를 설계할 당시에는 체크 예외가 더 나은 선택이라 생각했다.
(그래서 자바가 기본으로 제공하는 기능들에는 체크 예외가 많다.)
그런데 시간이 흐르면서 복구 할 수 없는 예외가 너무 많아졌다.
특히 라이브러리를 점점 더 많이 사용하면서 처리해야 하는 예외도 더 늘어났다.
체크 예외는 해당 라이브러리들이 제공하는 모든 예외를 처리할 수 없을 때마다 throws 에 예외를 덕지덕지 붙어야 했다.
그래서 개발자들은 throws Exception 이라는 극단적?인 방법도 자주 사용하게 되었다.
물론 이 방법은 사용하면 안된다.
모든 예외를 던진다고 선언하는 것인데, 결과적으로 어떤 예외를 잡고 어떤 예외를 던지는지 알 수 없기 때문이다.
체크 예외를 사용한다면 잡을 건 잡고 던질 예외는 명확하게 던지도록 선언해야 한다.
체크 예외의 이런 문제점 때문에 최근 라이브러리들은 대부분 런타임 예외를 기본으로 제공한다.
사실 위에서 예시로 설명한 JPA 기술도 런타임 예외를 사용한다.
스프링도 대부분 런타임 예외를 제공한다.
런타임 예외도 필요하면 잡을 수 있기 때문에 필요한 경우에는 잡아서 처리하고,
그렇지 않으면 자연스럽게 던지도록 둔다.
그리고 예외를 공통으로 처리하는 부분을 앞에 만들어서 처리하면 된다.
추가로 런타임 예외는 놓칠 수 있기 때문에 문서화가 중요하다.
런타임 예외(언체크예외)는 문서화
런타임 예외는 문서화를 잘해야 한다.
또는 코드에 throws 런타임예외 을 남겨서 중요한 예외를 인지할 수 있게 해준다.
jpa의 경우 이런식으로 코드안에 문서를 남기는 방식으로 어떤 런타임예외가 있는지 알려준다
/**
* 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;스프링의 jdbcTemplate을 보면 다음과 같이 문서로도 알려주고, throws ~ 를 이용해서 코드로도 명시하고있다.
(언체크예외라서 throws가 생략가능하지만 중요한 예외이므로 개발자가 눈으로 확인하게끔 해놓았다)
런타임 예외도 throws 에 선언할 수 있다. 물론 생략해도 된다.
던지는 예외가 명확하고 중요하다면, 코드에 어떤 예외를 던지는지 명시되어 있기 때문에
개발자가 IDE를 통해서 예외를 확인하가 편리하다.
물론 컨트롤러나 서비스에서 DataAccessException 을 사용하지 않는다면 런타임 예외이기 때문에 무시해도 된다.
예외 포함과 스택 트레이스
예외를 전환할 때는 꼭! 기존 예외를 포함해야 한다. ( ex) 체크예외에서 언체크예외로 전환할때)
그렇지 않으면 스택 트레이스를 확인할 때 심각한 문제가 발생한다.
( 실제발생한 Exception에 대한 정보가 나오지않는다 , 즉 예외가 발생한 위치, 요인을 알 수 없게된다.)
예외를 전환할때 기존예외를 파라미터로 전달하는 경우
@Test
void printEX() {
Controller controller = new Controller();
try {
controller.request();
} catch (Exception e) {
// e.printStackTrace(); 이렇게 에러에 대한 스택 트레이스를 출력해도 되지만 좋지않다. (실무에서는 항상 로그를 사용해야하므로)
log.info("ex",e);
}
}log.info("ex",e);로그를 출력할 때 마지막 파라미터에 예외를 넣어주면 로그에 스택 트레이스를 출력할 수 있다
예)
log.info("message={}", "message", ex)여기에서 마지막에 ex 를 전달하는 것을 확인할 수 있다.
이렇게 하면 스택 트레이스에 로그를 출력할 수 있다.
예)
log.info("ex",e);지금 예에서는 파라미터가 없기 때문에, 예외만 파라미터에 전달하면 스택 트레이스를 로그에 출력할 수 있다
System.out 에 스택 트레이스를 출력하려면
e.printStackTrace();e.printStackTrace() 를 사용하면 된다.
실무에서는 항상 로그를 사용해야 한다는 점을 기억하자.
예외를 포함해서 기존에 발생한 java.sql.SQLException 과 스택 트레이스를 확인할 수 있다.
(스택트레이스는 프로그램이 시작된 시점부터 현재 위치 까지의 메서드 호출 목록입니다. 이는 예외가 어디서 발생했는지 알려주기 위해 JVM이 자동으로 생성합니다.)
( 부모클래스에서 Throwable 객체를 받아 스택 트레이스를 구성해주는 코드가 이미 들어가있다)
예외를 전환할때 기존예외를 파라미터로 전달하지 않는 경우
public void call() {
try {
runSQL();
} catch (SQLException e) {
throw new RuntimeSQLException();
// 체크예외 --> 언체크 예외로 전환했지만 전환전 예외를 파라미터로 전달해주지않는다면?
}
}log.info("ex",e);로그의 결과는?
무엇때문에 RuntimeException이 발생했는지 정보가 없다.
예외를 포함하지 않아서 기존에 발생한 java.sql.SQLException 과 스택 트레이스를 확인할 수 없다.
변환한 RuntimeSQLException 부터 예외를 확인할 수 있다.
만약 실제 DB에 연동했다면 DB에서 발생한 예외를 확인할 수 없는 심각한 문제가 발생한다.
예외를 전환할 때는 꼭! 기존 예외를 포함하자
'인프런 > 스프링 DB 1편' 카테고리의 다른 글
| 끝) 자바 예외 + 스프링의 문제해결 (0) | 2023.02.27 |
|---|---|
| 7) 자바 예외 (Exception) , 체크예외, 언체크예외 (0) | 2023.02.26 |
| 6)트랜잭션 + 스프링 (2) (0) | 2023.02.25 |
| 5) 트랜잭션 + 스프링 (0) | 2023.02.21 |
| 4) 트랜잭션 적용(2) (0) | 2023.02.20 |
댓글