스프링 DB 데이터접근 원리 - 6. 스프링과 문제해결-예외 처리, 반복

체크 예외와 인터페이스

- 서비스 계층은 가급적 특정 구현 기술에 의존하지 않고 순수하게 유지하는 것이 좋다.

   이렇게 하려면 예외에 대한 의존도 함께 해결해야한다

- 예를 들어서 서비스가 처리할 수 없는 'SQLException' 에 대한 의존을 제거하려면 어떻게 해야할까?

- 서비스가 처리할 수 없으므로 리포지토리가 던지는 'SQLException' 체크 예외를 런타임 예외로 전환해서 서비스 계층에 던지자

- 이렇게 하면 서비스 계층이 해당 예외를 무시할 수 있기 때문에, 특정 구현 기술에 의존하는 부분을 제거하고, 서비스 계층을 순수하게 유지할 수 있다.

 

인터페이스 도입

- 이렇게 인터페이스를 도입하면 'MemberSevice'는 'MemberRepository' 인터페이스에만 의존하면 된다

- 이제 구현 기술을 변경하고 싶으면 DI를 사용해서 'MemberService' 코드의 변경 없이 구현 기술을 변경할 수 있다.

 

* 체크 예외와 인터페이스 *

- 잠깐? 기존에는 왜 이런 인터페이스를 만들지 않았을까?

- 왜냐하면 'SQLException'이 체크 예외이기 때문이다. 여기서 체크 예외가 또 발목을 잡는다.

- 체크 예외를 사용하려면 인터페이스에도 해당 체크 예외가 선언되어 있어야한다.

 

* 체크 예외 코드에 인터페이스 도입시 문제점 - 인터페이스 *

public interface MemberRepositoryEx {
	Member save(Member member) throws SQLException;
}

- 인터페이스의 메서드에 `throws SQLException`이 있는 것을 확인할 수 있다.

 

* 체크 예외 코드에 인터페이스 도입시 문제점 - 구현 클래스 *

@Slf4j
public class MemberRepositoryV3 implements MemberRepositoryEx {
	public Member save(Member member) throws SQLException {
        String sql = ""
    }
}

- 인터페이스의 구현체가 체크 예외를 던지려면, 인터페이스 메서드에 먼저 체크 예외를 던지는 부분이 선언되어 있어야 한다.

- 그래야 구현 클래스의 메서드도 체크 예외를 던질 수 있다.

    ㆍ쉽게 이야기해서 `MemberRepositoryV3`가 `throws SQLException`를 하려면 `MemberRepositoryEx` 인터페이스도

         `throws SQLException`이 필요하다

- 참고로 구현 클래스의 메서드에 선언할 수 있는 예외는 부모 타입에서 던진 예외와 같거나 하위 타입이어야 한다

    ㆍ예를 들어서 인터페이스 메서드에 `throws Exception`를 선언하면, 구현 클래스 메서드에 `throws SQLException`는 

        가능하다. `SQLException`은 'Exception`의 하위 타입이기 때문

 

* 특정 기술에 종속되는 인터페이스 *

- 구현 기술을 쉽게 변경하기 위해서 인터페이스를 도입하더라도 `SQLException` 과 같은 특정 구현 기술에 종속적인 체크 예외를 사용하게 되면 인터페이스에도 해당 예외를 포함해야한다

- 하지만 이것은 우리가 원하던 순수한 인터페이스가 아니다.

- JDBC 기술에 종속적인 인터페이스일 뿐이다.

- 인터페이스를 만드는 목적은 구현체를 쉽게 변경하기 위함인데, 이미 인터페이스가 특정 구현기술에 오염되어 버렸다

- 향후 JDBC가 아닌 다른 기술로 변경한다면 인터페이스 자체를 변경해야 한다

 

* 런타임 예외와 인터페이스 *

- 런타임 예외는 이런 부분에서 자유롭다. 인터페이스에 런타임 예외를 따로 선언하지 않아도 된다.

- 따라서 인터페이스가 특정 기술에 종속적일 필요가 없다.

---

런타임 예외 적용

* 예외 변환 *

catch (SQLException e) {
    throw new MyDbException(e);
}

- 기존 예외 포함할 것

- `MyDbException`이 내부에 `SQLException`을 포함하고 있다고 이해하면 된다.

- 예외를 출력했을 때 스택 트레이스를 통해 둘다 확인 할 수 있다

 

* 주의! *

- 예외를 변환할 때는 기존 예외를 꼭! 포함하자. 장애가 발생하고 로그에서 진짜 원인이 남지 않는 심각한 문제가 발생할 수 있다.

 

* 정리 *

- 체크 예외를 런타임 예외로 변환하면서 인터페이스와 서비스 계층의 순수성을 유지할 수 있게 되었다

- 덕분에 향후 JDBC에서 다른 구현 기술로 변경하더라도 서비스 계층의 코드를 변경하지 않고 유지

 

* 남은 문제 *

- 리포지토리에서 넘어오는 특정한 예외의 경우 복구를 시도할 수 있다

- 그런데 지금 방식은 항상 `MyDbException`이라는 예외만 넘어오기 때문에 예외를 구분할 수 없는 단점이 있다

- 만약 특정 상황에는 예외를 잡아서 복구하고 싶으면 예외를 어떻게 구분해서 처리할 수 있을까?

---

데이터 접근 예외 직접 만들기

- 데이터베이스 오류에 따라서 특정 예외는 복구하고 싶을 수 있다

- 데이터를 DB에 저장할 때 같은 ID가 이미 데이터베이스에 저장되어 있다면, 데이터베이스는 오류 코드를 반환하고, 이 오류 코드를 받은 JDBC 드라이버는 `SQLException`을 던진다. 그리고 `SQLException`에는 데이터베이스가 제공하는 `errorCode`라는 것이 들어있다.

 

* H2 데이터베이스의 키 중복 오류 코드 *

e.getErrorCode() == 23505

- `SQLException` 내부에 들어있는 `errorCode`를 활용하면 데이터베이스에서 어떤 문제가 발생했는지 확인

* H2 데이터베이스 예*

- 23505 : 키 중복 오류

- 42000 : SQL 문법 오류

 

- 참고로 같은 오류여도 각각의 데이터베이스마다 정의된 오류 코드가 다르다.

- 따라서 오류 코드를 사용할 때는 데이터베이스 메뉴얼을 확인해야 한다.

- 서비스 계층에서 예외 복구를 위해 키 중복 오류를 확인할 수 있어야 한다.

 

* 정리 *

- SQL ErrorCode로 데이터베이스에 어떤 오류가 있는지 확인

- 예외 변환을 통해 `SQLException`을 특정 기술에 의존하지 않는 직접 만든 예외인 `MyDuplicateKeyException`로 변환할 수 있었다

- 리포지토리 계층이 예외를 변환해준 덕분에 서비스 계층은 특정 기술에 의존하지 않는 `MyDuplicateKeyException`을 사용해서 문제를 복구하고, 서비스 계층의 순수성도 유지

 

* 남은 문제 *

- SQL ErrorCode는 각각의 데이터베이스 마다 다르다. 결과적으로 데이터베이스가 변경될 때마다 ErrorCode도 모두 변경

    ㆍ예) 키 중복 오류 코드

        ㆍH2 : 23505

        ㆍMySQL : 1062

- 데이터베이스가 전달하는 오류는 키 중복 뿐만 아니라 락이 걸린 경우, SQL 문법에 오류 있는 경우 등등 수십 수백가지 오류코드가 있다

- 이 모든 상황에 맞는 예외를 지금처럼 다 만들어야 할까?

---

스프링 예외 추상화 이해

- 스프링은 앞서 설명한 문제들을 해결하기 위해 데이터 접근과 관련된 예외를 추상화해서 제공

- 스프링은 데이터 접근 계층에 대한 수십 가지 예외를 정리해서 일관된 예외 계층을 제공한다

- 각각의 예외는 특정 기술에 종속적이지 않게 설계되었다.

- 따라서 서비스 계층에서도 스프링이 제공하는 예외를 사용하면 된다.

  예를 들어 JDBC 기술을 사용하든, JPA 기술을 사용하든 스프링이 제공하는 예외를 사용

- JDBC나 JPA를 사용할 때 발생하는 예외를 스프링이 제공하는 예외로 변환해주는 역할도 스프링이 제공

 

- 예외의 최고 상위는 `org.springframework.dao.DataAccessException`이다. 그림에서 보는 것처럼 런타임 예외를 상속 받았기 때문에 스프링이 제공하는 데이터 접근 계층의 모든 예외는 런타임 예외이다.

- `DataAccessException`은 크게 2가지로 구분하는데 `NonTransient` 예외와 `Transient` 예외이다

1. `Transient`는 일시적이라는 뜻이다. `Transient` 하위 예외는 동일한 SQL을 다시 시도했을 때 성공할 가능성이 있다

    ㆍ예를 들어서 쿼리 타임아웃, 락과 관련된 오류들이다. 이런 오류들은 데이터베이스 상태가 좋아지거나,

        락이 풀렸을 때 다시 시도하면 성공할 수 도 있다

2. `NonTransient`는 일시적이지 않다는 뜻이다. 같은 SQL을 그대로 반복해서 실행하면 실패한다.

    ㆍSQL 문법 오류, 데이터베이스 제약조건 위배 등이 있다.

 

스프링이 제공하는 예외 변환기

- 스프링은 데이터베이스에서 발생하는 오류 코드를 스프링이 정의한 예외로 자동으로 변환해주는 변환기를 제공

 

- 이전에는 SQL ErrorCode를 직접 확인하는 방법이다. 이렇게 직접 예외를 확인하고 하나하나 스프링이 만들어준 예외로 변환하는 것은 현실성이 없다. 이렇게 하려면 해당 오류 코드를 확인하고 스프링의 예외 체계에 맞추어 예외를 직접 변환해야 할 것이다. 그리고 데이터베이스마다 오류 코드가 다르다는 점도 해결해야 한다

- 그래서 스프링은 예외 변환기를 제공

 

SQLErrorCodeSQLExceptionTranslator exTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);
DataAccessException resultEx = exTranslator.translate("select", sql, e);

- `translator()` 메서드의 첫번째 파라미터는 읽을 수 있는 설명이고, 두번째는 실행한 sql, 마지막은 발생된 SQLException을 전달하면된다. 이렇게 하면 적절한 스프링 데이터 접근 계층의 예외로 변환해서 반환한다

- 예제에서 SQL 문법이 잘못되었으므로 `BadSqlGrammarException`을 반환하는 것을 확인

    ㆍ참고로 `BadSqlGrammarException`은 최상위 타입인 `DataAccessException`를 상속받아서 만들어진다.

 

* 각각의 DB마다 SQL ErrorCode는 다르다. 그런데 스프링은 어떻게 각각의 DB가 제공하는 SQL ErrorCode까지 고려해서 예외를 변환할 수 있을까?

- 비밀은 *sql-error-codes.xml*에 있다

- `org.springframework.jdbc.support.sql-error-codes.xml`

- 스프링 SQL 예외 변환기는 SQL ErrorCode를 이 파일에 대입해서 어떤 스프링 데이터 접근 예외로 전환해야 할지 찾아낸다.

 

* 정리 *

- 스프링은 데이터  접근 계층에 대한 일관된 예외 추상화를 제공한다

- 스프링은 예외 변환기를 통해서 `SQLException`의 `ErrorCode`에 맞는 적절한 스프링 데이터 접근 예외로 변환해준다.

- 만약 서비스, 컨트롤러 계층에서 예외 처리가 필요하면 특정 기술에 종속적인 `SQLException` 같은 예외를 직접 사용하는 것이 아니라, 스프링이 제공하는 데이터 접근 예외를 사용하면 된다.

- 스프링 예외 추상화 덕분에 특정 기술에 종속적이지 않게 되었다. 이제 JDBC에서 JPA같은 기술로 변경되어도 예외로 인한 변경을 최소화 할 수 있다. 

향후 JDBC에서 JPA로 구현 기술을 변경하더라도, 스프링은 JPA 예외를 적절한 스프링 데이터 접근 예외로 변환해준다.

- 물론 스프링이 제공하는 예외를 사용하기 때문에 스프링에 대한 기술 종속성은 발생한다.

    ㆍ스프링에 대한 기술 종속성까지 완전히 제거하려면 예외를 모두 직접 정의하고 예외변환도 직접하면 되지만,

        실용적인 방법은 아니다.

---

스프링 예외 추상화 적용

* 정리 *

- 예외에 대한 부분을 깔끔하게 정리

- 스프링이 예외를 추상화해준 덕분에, 서비스 계층은 특정 리포지토리의 구현 기술과 예외에 종속적이지 않게 되었다.

따라서 서비스 계층은 특정 구현 기술이 변경되어도 그대로 유지할 수 있게 되었다

다시 DI를 제대로 활용할 수 있게 된 것이다

- 추가로 서비스 계층에서 예외를 잡아서 복구해야 하는 경우, 예외가 스프링이 제공하는 데이터 접근 예외로 변경되어서 서비스 계층에 넘어오기 떄문에 필요한 경우 예외를 잡아서 복구하면 된다.

---

JDBC 반복 문제 해결 - JdbcTemplate

* JDBC 반복 문제 *

- 커넥션 조회, 커넥션 동기화

- `PreparedStatement` 생성 및 파라미터 바인딩

- 쿼리 실행

- 결과 바인딩

- 예외 발생시 스프링 예외 변환기 실행

- 리소스 종료

 

 

- 리포지토리의 각각의 메서드를 살펴보면 상당히 많은 부분이 반복된다.

- 이런 반복을 효과적으로 처리하는 방법이 바로 템플릿 콜백 패턴이다

- 스프링은 JDBC의 반복 문제를 해결하기 위해 `JdbcTemplate`이라는 템플릿을 제공

- `JdbcTemplate`은 JDBC로 개발할 때 발생하는 반복을 대부분 해결해준다. 그 뿐만 아니라 지금까지 학습했던, *트랜잭션을 위한 커넥션 동기화*는 물론이고, 예외 발생시 *스프링 예외 변환기*도 자동으로 실행해준다.

---

정리

- 서비스 계층의 순수성

    ㆍ트랜잭션 추상화 + 트랜잭션AOP 덕분에 서비스 계층의 순수성을 최대한 유지하면서 서비스 계층에서

        트랜잭션을 사용할 수 있다

    ㆍ스프링이 제공하는 예외 추상화와 예외 변환기 덕분에, 데이터 접근 기술이 변경되어도 서비스 계층의 순수성을

        유지하면서 예외도 사용할 수 있다

    ㆍ서비스 계층이 리포지토리 인터페이스에 의존한 덕분에 향후 리포지토리가 다른 구현 기술로 변경되어도 

         서비스 계층을 순수하게 유지할수 있다

- 리포지토리에서 JDBC를 사용하는 반복코드가 `JdbcTemplate`으로 대부분 제거되었다.