인프런 김영한님 스프링 DB 1편 - 데이터 접근 핵심 원리
강의 중 6장을 보고 핵심 내용을 정리했습니다.
체크 예외와 인터페이스
서비스 계층은 가급적 특정 구현 기술에 의존하지 않고, 순수하게 유지하는 것이 좋다.
이렇게 하려면 예외에 대한 의존도 함께 해결해야한다.
예를 들어서 서비스가 처리할 수 없는 SQLException 에 대한 의존을 제거하려면 어떻게 해야할까? 예외 전환!!
서비스가 처리할 수 없으므로 리포지토리가 던지는 SQLException 체크 예외를 런타임 예외로 전환해서 서비스 계층에 던지자.
이렇게 하면 서비스 계층이 해당 예외를 무시할 수 있기 때문에, 특정 구현 기술에 의존하는 부분을 제거하고 서비스 계층을 순수하게 유지할 수 있다.
인터페이스 도입
MemberService 는 MemberRepository 인터페이스에만 의존하면 된다.
이제 구현 기술을 변경하고 싶으면 DI를 사용해서 MemberService 코드의 변경 없이 구현 기술을 변경할 수 있다.
MemberRepository 인터페이스
public interface MemberRepository {
Member save(Member member);
Member findById(String memberId);
void update(String memberId, int money);
void delete(String memberId);
}
(중요) 체크 예외와 인터페이스
기존에는 왜 이런 인터페이스를 만들지 않았을까?
왜냐하면 SQLException이 체크 예외이기 때문이다. 여기서 체크 예외가 또 발목을 잡는다.
체크 예외를 사용하려면 인터페이스에도 해당 체크 예외가 선언 되어 있어야 한다.
체크 예외 코드에 인터페이스 도입시 문제점 - 인터페이스
인터페이스
public interface MemberRepositoryEx {
Member save(Member member) throws SQLException;
Member findById(String memberId) throws SQLException;
void update(String memberId, int money) throws SQLException;
void delete(String memberId) throws SQLException;
}인터페이스의 메서드에 throws SQLException 이 있는 것을 확인할 수 있다.
체크 예외 코드에 인터페이스 도입시 문제점 - 구현 클래스
public class MemberRepositoryV3 implements MemberRepositoryEx {
public Member save(Member member) throws SQLException {
String sql = "insert into member(member_id, money) values(?, ?)";
}
}
인터페이스의 구현체가 체크 예외를 던지려면,
인터페이스 메서드에 먼저 체크 예외를 던지는 부분이 선언 되어있어야 한다.
그래야 구현 클래스의 메서드도 체크 예외를 던질 수 있다.
특정 기술에 종속되는 인터페이스
구현 기술을 쉽게 변경하기 위해서 인터페이스를 도입하더라도 SQLException 과 같은 특정 구현 기술에 종속적인 체크 예외를 사용하게 되면 인터페이스에도 해당 예외를 포함해야 한다.
이것은 우리가 원하던 순수한 인터페이스가 아니다. JDBC 기술에 종속적인 인터페이스일 뿐이다.
인터페이스를 만드는 목적은 구현체를 쉽게 변경하기 위함인데, 이미 인터페이스가 특정 구현 기술에 오염이 되어 버렸다. 향후 JDBC가 아닌 다른 기술로 변경한다면 인터페이스 자체를 변경해야 한다.
런타임 예외와 인터페이스
런타임 예외는 이런 부분에서 자유롭다.
인터페이스에 런타임 예외를 따로 선언하지 않아도 된다.
따라서 인터페이스가 특정 기술에 종속적일 필요가 없다.
예시 CustomException 코드 (RuntimeException 상속)
public class MyDbException extends RuntimeException {
public MyDbException() {}
public MyDbException(String message) {
super(message);
}
public MyDbException(String message, Throwable cause) {
super(message, cause);
}
public MyDbException(Throwable cause) {
super(cause);
}
}
예외 변환 (무조건 기존 예외를 포함할 것! 그러지 않으면 원인이 되는 부분을 확인할 수 없게 된다.)
catch (SQLException e) {
throw new MyDbException(e);
}이렇게 SQLException 이라는 체크 예외를 MyDbException 이라는 런타임 예외로 변환
기존 예외를 생성자를 통해서 포함하고 있는 것을 확인할 수 있다.
예외는 원인이 되는 예외를 내부에 포함할 수 있는데, 꼭 이렇게 작성해야 한다.
그래야 예외를 출력했을 때 스택 트레이스를 통해 둘다 (SQL Exception, MyDbException) 확인할 수 있다.
정리
체크 예외를 런타임 예외로 변환하면서 인터페이스와 서비스 계층의 순수성을 유지할 수 있게 되었다.
덕분에 향후 JDBC에서 다른 구현 기술로 변경하더라도 서비스 계층의 코드를 변경하지 않고 유지할 수 있다.
남은 문제
리포지토리에서 넘어오는 특정한 예외의 경우 복구를 시도할 수도 있다.
그런데 지금 방식은 항상 MyDbException이라는 예외만 넘어오기 때문에 예외를 구분할 수 없는 단점이 있다.
만약 특정 상황에는 예외를 잡아서 복구하고 싶으면 예외를 어떻게 구분해서 처리할 수 있을까?
데이터 접근 예외 직접 만들기
상황 예시
데이터베이스 오류에 따라서 특정 예외는 복구하고 싶을 수 있다.
회원 가입시 DB에 이미 같은 ID가 있으면 ID 뒤에 숫자를 붙여서 새로운 ID를 만들어야 한다고 가정해보자.
(ID를 hello 라고 가입 시도 했는데, 이미 같은 아이디가 있으면 hello12345 와 같이 뒤에 임의의 숫자를 붙여서 가입)
데이터를 DB에 저장할 때 같은 ID가 이미 데이터베이스에 저장되어 있다면,
데이터베이스는 오류 코드를 반환하고, 이 오류 코드를 받은 JDBC 드라이버는 SQLException을 던진다.
그리고 SQLException에는 데이터베이스가 제공하는 errorCode라는 것이 들어있다. (e.getErrorCode())
서비스 계층에서는 예외 복구를 위해 키 중복 오류를 확인할 수 있어야 한다.
그래야 새로운 ID를 만들어서 다시 저장을 시도할 수 있기 때문이다.
이러한 과정이 바로 예외를 확인해서 복구하는 과정이다.
그런데 SQLException 에 들어있는 오류 코드를 활용하기 위해 SQLException 을 서비스 계층으로 던지게 되면,
서비스 계층이 SQLException 이라는 JDBC 기술에 의존하게 되면서, 지금까지 우리가 고민했던 서비스 계층의 순수성이 무너진다.
어떻게 해결 할 수 있을까??? 리포지토리에서 예외를 변환해서 던지면 된다. (예외 전환)
리포지토리
} catch (SQLException e) {
//h2 db
if (e.getErrorCode() == 23505) {
throw new MyDuplicateKeyException(e);
}
throw new MyDbException(e);
}
예외 전환 참고로 MyDuplicateKeyException 직접 만든 커스텀 Exception이고 RuntimeException을 상속받는다.
서비스
try {
repository.save(new Member(memberId, 0));
log.info("saveId={}", memberId);
} catch (MyDuplicateKeyException e) {
log.info("키 중복, 복구 시도");
String retryId = generateNewId(memberId);
log.info("retryId={}", retryId);
repository.save(new Member(retryId, 0));
} catch (MyDbException e) {
log.info("데이터 접근 계층 예외", e);
throw e;
}MyDuplicateKeyException 예외가 올라오면
예외를 잡아서 generateNewId(memberId) 로 새로운 ID 생성을 시도한다. 그리고 다시 저장한다.
이렇게 예외를 복구할 수 있다.
여기선 복구할 수 없는 예외( MyDbException )면 로그만 남기고 다시 예외를 던진다.
실제로는 복구 할 수 없는 예외는 공통으로 예외를 처리하는 곳에서 예외 로그를 남기는 것이 좋다.
리포지토리 계층이 예외를 변환해준 덕분에
서비스 계층은 특정 기술에 의존하지 않는 MyDuplicateKeyException을 사용해서
문제를 복구하고, 서비스 계층의 순수성도 유지할 수 있었다.
남은 문제
- SQL ErrorCode는 각각의 데이터베이스 마다 다르다. 결과적으로 데이터베이스가 변경될 때 마다 ErrorCode도 모두 변경해야 한다.
- 데이터베이스가 전달하는 오류는 키 중복 뿐만 아니라 락이 걸린 경우, SQL 문법에 오류 있는 경우 등등 수십 수백가지 오류 코드가 있다. 이 모든 상황에 맞는 예외를 지금처럼 다 만들어야 할까?
- 추가로 앞서 이야기한 것 처럼 데이터베이스마다 이 오류 코드는 모두 다르다.
스프링 예외 추상화 이해
스프링은 앞서 설명한 문제들을 해결하기 위해 데이터 접근과 관련된 예외를 추상화해서 제공한다
스프링 데이터 접근 예외 계층 (일부 생략)
org.springframework.dao.DataAccessException : 런타임 예외를 상속 받았기 때문에 스프링이 제공하는 데이터 접근 계층의 모든 예외는 런타임 예외이다.
DataAccessException 은 크게 2가지로 구분하는데 NonTransient 예외와 Transient 예외이다.
Transient 는 일시적이라는 뜻이다. Transient 하위 예외는 동일한 SQL을 다시 시도했을 때 성공할 가능성이 있다.
- 예를 들어서 쿼리 타임아웃, 락과 관련된 오류들이다.
- 이런 오류들은 데이터베이스 상태가 좋아지거나, 락이 풀렸을 때 다시 시도하면 성공할 수 도 있다.
NonTransient 는 일시적이지 않다는 뜻이다. 같은 SQL을 그대로 반복해서 실행하면 실패한다.
- SQL 문법 오류, 데이터베이스 제약조건 위배 등이 있다.
스프링은 데이터 접근 계층에 대한 수십 가지 예외를 정리해서 일관된 예외 계층을 제공한다.
각각의 예외는 특정 기술에 종속적이지 않게 설계되어 있다.
따라서 서비스 계층에서도 스프링이 제공하는 예외를 사용하면 된다.
JDBC나 JPA를 사용할 때 발생하는 예외를 스프링이 제공하는 예외로 변환해주는 역할도 스프링이 제공한다.
스프링이 제공하는 예외 변환기
SQL ErrorCode를 직접 확인하는 방법은
직접 예외를 확인하고 하나하나 스프링이 만들어준 예외로 변환하는 것은 현실성이 없다.
이렇게 하려면 해당 오류 코드를 확인하고 스프링의 예외 체계에 맞추어 예외를 직접 변환해야 할 것이다.
그리고 데이터베이스마다 오류 코드가 다르다는 점도 해결해야 한다.
그래서 우리 멋진 스프링은 이것도!! 스프링은 예외 변환기를 제공한다.
스프링 예외 변환기 - 코드
SQLExceptionTranslator exTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);
DataAccessException resultEx = exTranslator.translate("select", sql, e);translate() 메서드의 첫번째 파라미터는 읽을 수 있는 설명이고,
두번째는 실행한 sql,
마지막은 발생된 SQLException 을 전달하면 된다.
이렇게 하면 적절한 스프링 데이터 접근 계층의 예외로 변환해서 반환해준다.
각각의 DB마다 SQL ErrorCode는 다른데 어떻게 각각의 DB가 제공하는 SQL ErrorCode까지 고려해서 예외를 변환할 수 있을까?
그건 바로 sql.error-codes.xml 파일에 있다.
스프링 SQL 예외 변환기는 SQL ErrorCode를 이 파일에 대입해서,
어떤 스프링 데이터 접근 예외로 전환해야 할지 찾아낸다.
예를 들어서 H2 데이터베이스에서 42000 이 발생하면 badSqlGrammarCodes 이기 때문에 BadSqlGrammarException 을 반환한다.
정리
- 스프링은 데이터 접근 계층에 대한 일관된 예외 추상화를 제공한다.
- 스프링은 예외 변환기를 통해서 SQLException 의 ErrorCode 에 맞는 적절한 스프링 데이터 접근 예외로 변환해준다.
- 만약 서비스, 컨트롤러 계층에서 예외 처리가 필요하면 특정 기술에 종속적인 SQLException 같은 예외를 직접 사용하는 것이 아니라, 스프링이 제공하는 데이터 접근 예외를 사용하면 된다.
- 스프링 예외 추상화 덕분에 특정 기술에 종속적이지 않게 되었다. (물론 스프링이 제공하는 예외를 사용하기에 스프링 종속성은 발생 하지만 이것도 제거하려고 예외를 모두 직접 정의하고 예외 변환도 직접한다???좋지 않다...)
추가로
스프링이 예외를 추상화해준 덕분에, 서비스 계층은 특정 리포지토리의 구현 기술과 예외에 종속적이지 않게 되었다. 따
라서 서비스 계층은 특정 구현 기술이 변경되어도 그대로 유지할 수 있게 되었다. 다시 DI를 제대로 활용할 수 있게 된
것이다.
추가로 서비스 계층에서 예외를 잡아서 복구해야 하는 경우, 예외가 스프링이 제공하는 데이터 접근 예외로 변경되어서
서비스 계층에 넘어오기 때문에 필요한 경우 예외를 잡아서 복구하면 된다.
JDBC 반복 문제 해결 - JdbcTemplate
드디어 서비스 계층의 순수함을 유지하게 되었다.
이번에는 리포지토리에서 JDBC를 사용하기 때문에 발생하는 반복 문제를 해결해보자.
JDBC 반복 문제
- 커넥션 조회, 커넥션 동기화
- PreparedStatement 생성 및 파라미터 바인딩
- 쿼리 실행
- 결과 바인딩
- 예외 발생시 스프링 예외 변환기 실행
- 리소스 종료
이런 반복을 효과적으로 처리하는 방법이 바로 템플릿 콜백 패턴이다.
스프링은 JDBC의 반복 문제를 해결하기 위해 JdbcTemplate 이라는 템플릿을 제공한다.
private final JdbcTemplate template;
public MemberRepository(DataSource dataSource) {
template = new JdbcTemplate(dataSource);
}
@Override
public Member save(Member member) {
String sql = "insert into member(member_id, money) values(?, ?)";
template.update(sql, member.getMemberId(), member.getMoney());
return member;
}
JdbcTemplate 은 JDBC로 개발할 때 발생하는 반복을 대부분 해결해준다.
그 뿐만 아니라 지금까지 학습했던, 트랜잭션을 위한 커넥션 동기화는 물론이고,
예외 발생시 스프링 예외 변환기도 자동으로 실행해준다.
이번 강의 총 정리
서비스 계층의 순수성
- 트랜잭션 추상화 + 트랜잭션 AOP 덕분에 서비스 계층의 순수성을 최대한 유지하면서 서비스 계층에서 트랜잭션을 사용할 수 있다.
- 스프링이 제공하는 예외 추상화와 예외 변환기 덕분에, 데이터 접근 기술이 변경되어도 서비스 계층의 순수성을 유지하면서 예외도 사용할 수 있다.
- 서비스 계층이 리포지토리 인터페이스에 의존한 덕분에 향후 리포지토리가 다른 구현 기술로 변경되어도 서
비스 계층을 순수하게 유지할 수 있다.
반복 제거
- 리포지토리에서 JDBC를 사용하는 반복 코드가 JdbcTemplate 으로 대부분 제거되었다.
참고자료 및 출처
https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-db-1/dashboard