서비스 계층은 가급적 특정 구현 기술에 의존하지 않고, 순수하게 유지하는 것이 좋다. 서비스가 처리할 수 없는 SQLException에 대한 의존을 제거하기 위해서는 리포지토리가 던지는 SQLException 체크 예외를 런타임 예외로 전환해서 서비스 계층으로 던지면된다. 이렇게 하면 서비스 계층이 해당 예외를 무시할 수 있기 때문에, 특정 구현 기술에 의존하는 부분을 제거하고 서비스 계층을 순수하게 유지할 수 있다.
기존의 코드에서 체크 예외를 런타임 예외로 전환하고 서비스 계층을 순수하게 유지해보자.
public interface MemberRepository {
Member save(Member member);
Member findById(String memberId);
void update(String memberId, int money);
void delete(String memberId);
}
@Slf4j
public class MemberRepositoryV4_1 implements MemberRepository {
private final DataSource dataSource;
public MemberRepositoryV4_1(DataSource dataSource) {
this.dataSource = dataSource;
}
@Override
public Member save(Member member) {
//...
try {
//...
} catch (SQLException e) {
//RuntimeException을 상속받은 예외
throw new MyDbException(e);
//기존 예외를 생성자를 통해서 포함해야 예외를 출력했을 때 원인이 되는 기존 예외도 함께 확인할 수 있음(스택 트레이스)
} finally {
//...
}
}
//...
}(1) 예외 누수 문제 해결
(2) 체크 예외 SQLException -> 런타임 예외 RuntimeException
(3) MemberRepository 인터페이스 사용
(4) throws SQLException 제거
MemberServiceV4는 이제 MemberRepository 인터페이스에 의존하고 throws SQLException 부분을 제거할 수 있다. 드디어 순수한 서비스 계층을 완성했다.
남은 문제
- Repository에서 넘어오는 특정 예외의 경우 복구를 시도할 수 있는데 지금 방식은 MyDbException라는 예외만 넘어오기 때문에 예외를 구분할 수 없다.
- 특정 상황에 예외를 잡아서 복구하고 싶으면 데이터 접근 예외를 직접 만들어서 예외를 구분하고 처리해보자.
데이터 접근 예외 직접 만들기
데이터베이스 오류에 따라 특정 예외는 복구하고 싶을 수 있다. 예를 들어, 회원 가입시 DB에 이미 같은 ID가 있으면 ID 뒤에 숫자를 붙여서 새로운 ID를 만들어야 한다고 가정하자.
데이터를 DB에 저장할 때 같은 ID가 데이터베이스에 저장되어 있다면, 데이터베이스는 오류 코드를 반환하고, 오류 코드를 받은 JDBC 드라이버는 SQLException을 던진다. 그리고 SQLException에는 데이터베이스가 제공하는 errorCode가 들어있다. 이를 활용하면 데이터베이스에서 어떤 문제가 발생했는지 확인할 수 있다.
ex) H2 데이터베이스에서는 23505: 키 중복오류, 42000: SQL 문법 오류
참고로 같은 오류여도 각각의 데이터베이스마다 정의된 오류 코드가 다르다.
@RequiredArgsConstructor
static class Service {
private final Repository repository;
public void create(String memberId) {
try {
repository.save(new Member(memberId, 0));
} catch (MyDuplicateKeyException e) {
//키 중복, 복구 시도
String retryId = generateNewId(memberId);
repository.save(new Member(retryId, 0));
} catch (MyDbException e) {
//복구할 수 없는 예외
throw e;
}
}
private String generateNewId(String memberId) {
return memberId + new Random().nextInt(10000);
}
}
@RequiredArgsConstructor
static class Repository {
private final DataSource dataSource;
public Member save(Member member) {
String sql = "insert into member(member_id, money) values(?, ?)";
Connection con = null;
PreparedStatement pstmt = null;
try {
//...데이터 저장
} catch (SQLException e) {
//h2 db
if (e.getErrorCode() == 23505) {
throw new MyDuplicateKeyException(e);
}
throw new MyDbException(e);
} finally {
closeStatement(pstmt);
closeConnection(con);
}
}
}남은 문제
- SQL ErrorCode는 각각의 데이터베이스 마다 다르기 때문에 데이터베이스가 변경될 때마다 ErrorCode도 모두 변경해야 한다.
- 데이터베이스가 전달하는 오류는 키 중복 뿐만 아니라 수백가지 오류 코드가 있다. 이 모든 상황에 맞는 예외를 지금처럼 다 만들 수 있을까?
스프링 예외 추상화
스프링은 앞서 설명한 문제들을 해결하기 위해 데이터 접근과 관련된 예외를 추상화해서 제공한다.
NonTransient 예외 : 일시적이지 않다는 뜻으로 동일한 SQL을 그대로 반복해서 실행하면 실패
ex) SQL 문법 오류, 데이터베이스 제약조건 위배
Transient 예외 : 일시적이라는 뜻으로 동일한 SQL을 다시 시도했을 때 성공할 가능성이 있음
ex) 쿼리 타임아웃, 락과 관련된 오류
스프링은 데이터베이스에서 발생하는 오류 코드를 스프링이 정의한 예외로 자동으로 변환해주는 변환기를 제공한다.
@Test
void exceptionTranslator() {
String sql = "select bad grammar";
try {
Connection con = dataSource.getConnection();
PreparedStatement stmt = con.prepareStatement(sql);
stmt.executeQuery();
} catch (SQLException e) {
assertThat(e.getErrorCode()).isEqualTo(42122);
//org.springframework.jdbc.support.sql-error-codes.xml
SQLExceptionTranslator exTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);
//org.springframework.jdbc.BadSqlGrammarException
DataAccessException resultEx = exTranslator.translate("select", sql, e);
assertThat(resultEx.getClass()).isEqualTo(BadSqlGrammarException.class);
}
}new SQLErrorCodeSQLExceptionTranslator(dataSource)
- 스프링이 정의한 예외로 자동으로 변환해주는 변환기
exTranslator.translate("select", sql, e);
- (읽을 수 있는 설명, 실행한 sql, 발생된 SQLExcpetion 전달)
- 적절한 스프링 데이터 접근 계층의 예외로 변환해서 반환해줌
- SQL 문법이 잘못되었으므로 BadSqlGrammarException 반환
앞서 만든 애플리케이션에 스프링이 제공하는 데이터 접근 예외 추상화와 SQL 예외 변환기를 적용해보자.
@Slf4j
public class MemberRepositoryV4_2 implements MemberRepository {
private final DataSource dataSource;
private final SQLExceptionTranslator extranslator;
public MemberRepositoryV4_2(DataSource dataSource) {
this.dataSource = dataSource;
this.extranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);
}
@Override
public Member save(Member member) {
//...연결 & SQL 전달
try {
//...
} catch (SQLException e) {
throw extranslator.translate("save", sql, e);
} finally {
//사용한 con, psmt 리소스 정리
}
}
//...
}throw new MyDbException(e) -> throw extranslator.translate("save", sql, e)
기존 코드에서 스프링 예외 변환기를 사용하도록 변경했고, 이제는 MyDbException과 같은 예외를 직접 지정해줄 필요가 없다. 서비스 계층은 특정 리포지토리의 구현 기술과 예외에 종속적이지 않게 되었다.
서비스 계층에서 예외를 잡아서 복구해야 하는 경우, 예외가 스프링이 제공하는 데이터 접근 예외로 변경되어 서비스 계층에 넘어오기 때문에 필요한 경우 예외를 잡아서 복구하면 된다.
JdbcTemplate을 통한 반복 문제 해결
지금까지 서비스 계층의 순수함을 유지하기 위해 수 많은 노력을 했다. 이번에는 리포지토리에서 JDBC를 사용하기 때문에 발생하는 문제를 해결해보자.
<JDBC 반복 문제>
@Override
public Member save(Member member) {
String sql = "insert into member(member_id, money) values(?, ?)";
Connection con = null;
PreparedStatement pstmt = null;
try {
//커넥션 조회, 커넥션 동기화
con = getConnection();
//`PreparedStatement`쿼리 실행
pstmt = con.prepareStatement(sql);
//생성 및 파라미터 바인딩
pstmt.setString(1, member.getMemberId());
pstmt.setInt(2, member.getMoney());
pstmt.executeUpdate();
return member;
} catch (SQLException e) {
//예외 발생시 스프링 예외 변환기 실행
throw extranslator.translate("save", sql, e);
} finally {
//리소스 종료
close(con, pstmt, null);
}
}- 커넥션 조회, 커넥션 동기화
PreparedStatement쿼리 실행- 결과 바인딩
- 생성 및 파라미터 바인딩
- 예외 발생시 스프링 예외 변환기 실행
- 리소스 종료
리포지토리의 각각의 메소드에서 위와 같은 많은 부분이 반복되는 것을 확인할 수 있는데 이러한 반복은 템플릿 콜백 패턴을 통해 효과적으로 해결할 수 있다. 스프링은 JDBC의 반복 문제를 해결하기 위해 JdbcTemplate이라는 템플릿을 제공한다.
public class MemberRepositoryV5 implements MemberRepository {
private final JdbcTemplate template;
public MemberRepositoryV5(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이 모두 해준다. JdbcTemplate은 JDBC로 개발할 때 발생하는 반복을 대부분 해결해준다. 또, 트랜잭션을 위한 커넥션 동기화는 물론이고, 예외 발생시 스프링 예외 변환기도 자동으로 실행해준다.
