[ 김영한 스프링 DB 1편 - 데이터 접근 핵심 원리 #6 ] 스프링과 문제 해결 - 예외 처리, 반복 (2)
지난 포스팅에 이어, 이번 포스팅에서는 4) ~ 7) 까지의 내용을 정리한다.
👉 목차는 다음과 같다.
1) 체크 예외와 인터페이스
2) 런타임 예외 적용
3) 데이터 접근 예외 직접 만들기
4) 스프링 예외 추상화 이해
5) 스프링 예외 추상화 적용
6) JDBC 반복 문제 해결 - JdbcTemplate
7) 정리
바로 하나씩 확인해보자.
4) 스프링 예외 추상화 이해
스프링은 앞서 설명한 문제들을 해결하기 위해, 데이터 접근과 관련된 예외를 추상화해서 제공한다. (이전에는 MyDbException, MyDuplicateKeyException 등을 우리가 직접 만들어서 사용했지만, 스프링은 이미 이런것들을 다 만들어서 제공한다.)
스프링 데이터 접근 예외 계층
- 참고)
- 스프링은 데이터 접근 계층에 대한 수십 가지 예외를 정리해서 일관된 예외 계층을 제공한다.
- 각각의 예외는 특정 기술에 종속적이지 않게 설계되어 있다. 따라서 서비스 계층에서도 스프링이 제공하는 예외를 사용하면 된다. 예를 들어서 JDBC 기술을 사용하든, JPA 기술을 사용하든 스프링이 제공하는 예외를 사용하면 된다.
- JDBC나 JPA를 사용할 때 발생하는 예외를 스프링이 제공하는 (위와 같은) 예외로 변환해주는 역할도 스프링이 제공한다.
- 참고로 그림을 단순화 하기 위해 일부 계층을 생략했다.
- 예외의 최고 상위는
org.springframework.dao.DataAccessException이다. 그림에서 보는 것 처럼 런타임 예외를 상속 받았기 때문에 스프링이 제공하는 데이터 접근 계층의 모든 예외는 런타임 예외이다. DataAccessException은 크게 2가지로 구분하는데NonTransient예외와Transient예외이다.Transient는 일시적이라는 뜻이다.Transient하위 예외는 동일한 SQL을 다시 시도했을 때 성공할 가능성이 있다.- 예를 들어서 쿼리 타임아웃, 락과 관련된 오류들이다. 이런 오류들은 데이터베이스 상태가 좋아지거나, 락이 풀렸을 때 다시 시도하면 성공할 수도 있다.
NonTransient는 일시적이지 않다는 뜻이다. 같은 SQL을 그대로 반복해서 실행하면 실패한다.- SQL 문법 오류, 데이터베이스 제약조건 위배 등이 있다.
- (참고) 스프링 메뉴얼에 모든 예외가 정리되어 있지는 않기 때문에 코드를 직접 열어서 확인해보는 것이 필요하다.
스프링이 제공하는 예외 변환기
스프링은 데이터베이스에서 발생하는 오류 코드를 스프링이 정의한 예외로 자동으로 변환해주는 변환기를 제공한다.
👉 코드를 통해 스프링이 제공하는 예외 변환기를 알아보자. 먼저 에러 코드를 확인하는 부분을 간단히 복습해보자.
- SpringExceptionTranslatorTest 생성: test > java > hello > jdbc > exception > translator 패키지 내부에 SpringExceptionTranslatorTest 클래스를 생성하자.
- 실행해보자.
- 정상적으로 실행됨을 확인할 수 있다.
❗ 이전에 살펴봤던 SQL ErrorCode를 직접 확인하는 방법이다. 이렇게 직접 예외를 확인하고 하나하나 스프링이 만들어준 예외로 변환하는 것은 현실성이 없다. 이렇게 하려면 해당 오류 코드를 확인하고 스프링의 예외 체계에 맞추어 예외를 직접 변환해야 할 것이다. 그리고 데이터베이스마다 오류 코드가 다르다는 점도 해결해야 한다.
그래서 스프링은 예외 변환기를 제공한다.
👉 스프링이 제공하는 예외 변환기를 확인해보자.
- SpringExceptionTranslatorTest 추가: 다음과 같이 적용해보자.
- 참고로 스프링이 제공하는 SQL 예외 변환기는 다음과 같이 사용하면 된다.
translate()메서드의 첫번째 파라미터는 읽을 수 있는 설명이고, 두번째는 실행한 sql, 마지막은 발생된SQLException을 전달하면 된다. 이렇게 하면 적절한 스프링 데이터 접근 계층의 예외로 변환해서 반환해준다.- 예제에서는 SQL 문법이 잘못되었으므로
BadSqlGrammarException을 반환하는 것을 확인할 수 있다.- 눈에 보이는 반환 타입은 최상위 타입인
DataAccessException이지만 실제로는BadSqlGrammarException예외가 반환된다. 마지막에assertThat()부분을 확인하자. - 참고로
BadSqlGrammarException은 최상위 타입인DataAccessException를 상속 받아서 만들어진다.
- 눈에 보이는 반환 타입은 최상위 타입인
- 실행해보자.
- 정상적으로 실행된 것을 확인할 수 있다.
- (참고) 따라서 리포지토리에서 예외 변환을 우리가 직접하는것이 아닌, 위 예외변환기 코드를 사용해서 변환한다. 그러면 스프링에서 제공하는 데이터 접근 계층의 예외를 사용할 수 있다.
🤔 그런데 각각의 DB마다 SQL ErrorCode는 다르다. 그런데 스프링은 어떻게 각각의 DB가 제공하는 SQL ErrorCode까지 고려해서 예외를 변환할 수 있을까?
비밀은 바로 다음 파일에 있다.
- sql-error-codes.xml (
org.springframework.jdbc.support.sql-error-codes.xml)
- 스프링 SQL 예외 변환기는 SQL ErrorCode를 이 파일에 대입해서 어떤 스프링 데이터 접근 예외로 전환해야 할지 찾아낸다. 예를 들어서 H2 데이터베이스에서
42000이 발생하면badSqlGrammarCodes이기 때문에BadSqlGrammarException을 반환한다. - 해당 파일을 확인해보면 10개 이상의 우리가 사용하는 대부분의 관계형 데이터베이스를 지원하는 것을 확인할 수 있다.
- 스프링 SQL 예외 변환기는 SQL ErrorCode를 이 파일에 대입해서 어떤 스프링 데이터 접근 예외로 전환해야 할지 찾아낸다. 예를 들어서 H2 데이터베이스에서
✔️ 정리
- 스프링은 데이터 접근 계층에 대한 일관된 예외 추상화를 제공한다.
- 스프링은 예외 변환기를 통해서
SQLException의ErrorCode에 맞는 적절한 스프링 데이터 접근 예외로 변환해준다. - 만약 서비스, 컨트롤러 계층에서 예외 처리가 필요하면 특정 기술에 종속적인
SQLException같은 예외를 직접 사용하는 것이 아니라, 스프링이 제공하는 데이터 접근 예외를 사용하면 된다. - 스프링 예외 추상화 덕분에 특정 기술에 종속적이지 않게 되었다. 이제 JDBC에서 JPA같은 기술로 변경되어도 예외로 인한 변경을 최소화 할 수 있다. 이후에 JDBC에서 JPA로 구현 기술을 변경하더라도, 스프링은 JPA 예외를 적절한 스프링 데이터 접근 예외로 변환해준다.
- 물론 스프링이 제공하는 예외를 사용하기 때문에 스프링에 대한 기술 종속성은 발생한다.
- 스프링에 대한 기술 종속성까지 완전히 제거하려면 예외를 모두 직접 정의하고 예외 변환도 직접 하면 되지만, 실용적인 방법은 아니다.
5) 스프링 예외 추상화 적용
이제 우리가 만든 애플리케이션에 스프링이 제공하는 데이터 접근 예외 추상화와 SQL 예외 변환기를 적용해보자.
- MemberRepositoryV4_2 생성: src > main > java > hello > jdbc > repository 패키지 내부에 MemberRepositoryV4_2 클래스를 생성하자. ( 기존 MemberRepositoryV4_1을 복사해서 만들자. )
- 기존 코드에서 스프링 예외 변환기를 사용하도록 변경되었다.
- (참고) findById, update, delete 메서드도 동일하게 변경하였다. (단 translate 메서드의 첫번째 파라미터(task)는 메서드명으로 작성하였다.)
👉 테스트해보자.
- MemberServiceV4Test 수정: 기존 MemberServiceV4Test 코드를 다음과 같이 수정하자.
MemberRepository인터페이스가 제공되므로 스프링 빈에 등록할 빈만MemberRepositoryV4_1에서MemberRepositoryV4_2로 교체하면 리포지토리를 변경해서 테스트를 확인할 수 있다.
- 실행해보자. ( memberRepositoryV4_2 클래스 findById 메서드의 쿼리를 비정상적으로 수정 후 실행하자. )
- 정상적으로 예외가 발생된 것을 확인할 수 있다. ( BadSqlGrammarException )
✔️ 정리
- 드디어 예외에 대한 부분을 깔끔하게 정리했다.
- 스프링이 예외를 추상화해준 덕분에, 서비스 계층은 특정 리포지토리의 구현 기술과 예외에 종속적이지 않게 되었다. 따라서 서비스 계층은 특정 구현 기술이 변경되어도 그대로 유지할 수 있게 되었다. 다시 DI를 제대로 활용할 수 있게 된 것이다.
- 추가로 서비스 계층에서 예외를 잡아서 복구해야 하는 경우, 예외가 스프링이 제공하는 데이터 접근 예외로 변경되어서 서비스 계층에 넘어오기 때문에 필요한 경우 예외를 잡아서 복구하면 된다.
이번 내용으로 예외 누수 문제까지 해결되었다.
이제 마지막으로 남은 JDBC 반복 문제를 다음 내용을 통해 해결해보자.
6) JDBC 반복 문제 해결 - JdbcTemplate
지금까지 서비스 계층의 순수함을 유지하기 위해 수 많은 노력을 했고, 덕분에 서비스 계층의 순수함을 유지하게 되었다. 이번에는 리포지토리에서 JDBC를 사용하기 때문에 발생하는 반복 문제를 해결해보자.
JDBC 반복 문제
- 커넥션 조회, 커넥션 동기화
PreparedStatement생성 및 파라미터 바인딩- 쿼리 실행
- 결과 바인딩
- 예외 발생시 스프링 예외 변환기 실행
- 리소스 종료
리포지토리의 각각의 메서드를 살펴보면 상당히 많은 부분이 반복된다. 이런 반복을 효과적으로 처리하는 방법이 바로 템플릿 콜백 패턴이다.
스프링은 JDBC의 반복 문제를 해결하기 위해 JdbcTemplate 이라는 템플릿을 제공한다. JdbcTemplate 에 대한 자세한 사용법은 뒤에서 설명하겠다. 지금은 전체 구조와, 이 기능을 사용해서 반복 코드를 제거할 수 있다는 것에 초점을 맞추자.
- MemberRepositoryV5 생성: src > main > java > hello > jdbc > repository 패키지 내부에 MemberRepositoryV5 클래스를 생성하자.
- MemberServiceV4Test 수정: 정상 동작하는지 확인해보자. (기존 MemberServiceV4Test를 아래와 같이 수정하자.)
MemberRepository인터페이스가 제공되므로 등록하는 빈만MemberRepositoryV5로 변경해서 등록하면 된다.
- 실행해보자.
- 정상적으로 실행된 것을 확인할 수 있다.
JdbcTemplate 은 JDBC로 개발할 때 발생하는 반복을 대부분 해결해준다. 그 뿐만 아니라 지금까지 학습했던, 트랜잭션을 위한 커넥션 동기화는 물론이고, 예외 발생시 스프링 예외 변환기도 자동으로 적용해서 실행해준다.
✔️ 참고
- 템플릿 콜백 패턴에 대해서 지금은 자세히 이해하지 못해도 괜찮다. 스프링이
JdbcTemplate이라는 편리한 기능을 제공하는구나 정도로 이해해도 된다. ( 템플릿 콜백 패턴에 대한 자세한 내용은 스프링 핵심 원리 - 고급편 강의를 참고하자. )
7) 정리
완성된 코드를 확인해보자.
- 서비스 계층의 순수성
- 트랜잭션 추상화 + 트랜잭션 AOP 덕분에 서비스 계층의 순수성을 최대한 유지하면서 서비스 계층에서 트랜잭션을 사용할 수 있다.
스프링이 제공하는 예외 추상화와 예외 변환기 덕분에, 데이터 접근 기술이 변경되어도 서비스 계층의 순수성을 유지하면서 예외도 사용할 수 있다. - 서비스 계층이 리포지토리 인터페이스에 의존한 덕분에 이후에 리포지토리가 다른 구현 기술로 변경되어도 서비스 계층을 순수하게 유지할 수 있다.
- 트랜잭션 추상화 + 트랜잭션 AOP 덕분에 서비스 계층의 순수성을 최대한 유지하면서 서비스 계층에서 트랜잭션을 사용할 수 있다.
- 리포지토리에서 JDBC를 사용하는 반복 코드가
JdbcTemplate으로 대부분 제거되었다.
강의를 듣고 정리한 글입니다. 코드와 그림 등의 출처는 김영한 강사님께 있습니다.
