스프링 DB 1편 - 데이터 접근 핵심 원리 (16) - 스프링과 문제 해결 - 예외 처리, 반복 - 2

8 분 소요

인프런 스프링 DB 1편 - 데이터 접근 핵심 원리편을 학습하고 정리한 내용 입니다.

스프링과 문제 해결 - 예외 처리, 반복 - 1

스프링 예외 추상화 이해

스프링은 데이터 접근과 관련된 예외를 추상화해서 제공한다.

스프링은 데이터 접근 계층에 대한 수십 가지 예외를 정리해서 일관된 예외 계층을 제공한다.
각각의 예외는 특정 기술에 종속적이지 않게 설계되어 있다. 따라서 서비스 계층에서도 스프링이 제공하는 예외를 사용하면 된다. 예를 들어서 JDBC 기술을 사용하든, JPA 기술을 사용하든 스프링이 제공하는 예외를 사용하면 된다.
JDBC나 JPA를 사용할 때 발생하는 예외를 스프링이 제공하는 예외로 변환해주는 역할도 스프링이 제공한다.
예외의 최고 상위는 org.springframework.dao.DataAccessException 이다. 그림에서 보는 것 처럼 런타임 예외를 상속 받았기 때문에 스프링이 제공하는 데이터 접근 계층의 모든 예외는 런타임 예외이다.
DataAccessException은 크게 2가지로 구분하는데 NonTransient예외와 Transient예외이다.
- Transient는 일시적이라는 뜻이다. Transient하위 예외는 동일한 SQL을 다시 시도했을 때 성공할 가능성이 있다.
  - 예를 들어서 쿼리 타임아웃, 락과 관련된 오류들이다. 이런 오류들은 데이터베이스 상태가 좋아지거나, 락이 풀렸을 때 다시 시도하면 성공할 수 도 있다.
- NonTransient는 일시적이지 않다는 뜻이다. 같은 SQL을 그대로 반복해서 실행하면 실패한다.
  - SQL 문법 오류, 데이터베이스 제약 조건 위배 등이 있다.

참고: 스프링 메뉴얼에 모든 예외가 정리되어 있지는 않기 때문에 코드를 직접 열어서 확인해보는 것이 필요하다.

엄청 많다.

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

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

코드를 통해 스프링이 제공하는 예외 변환기를 알아보자. 먼저 에러 코드를 확인하는 부분을 간단히 복습해보자.

SpringExceptionTranslatorTest

@Slf4j  
public class SpringExceptionTranslatorTest {  
  
    DataSource dataSource;  
  
    @BeforeEach  
    void init() {  
        dataSource = new DriverManagerDataSource(URL, USERNAME, PASSWORD);  
    }  
  
    @Test  
    void sqlExceptionErrorCode() {  
        String sql = "select bad grammar";  
  
        try {  
            Connection con = dataSource.getConnection();  
            PreparedStatement ps = con.prepareStatement(sql);  
            ps.executeQuery();  
  
        } catch (SQLException e) {  
            assertThat(e.getErrorCode()).isEqualTo(42122);  
            int errorCode = e.getErrorCode();  
            log.info("SQL error Code: {}", errorCode);  
            log.info("error", e);  
        }  
    }  
}

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

SpringExceptionTranslatorTest - 추가 exceptionTranslator

@Test  
void exceptionTranslator() {  
    String sql = "select bad grammar";  
  
    try {  
        Connection con = dataSource.getConnection();  
        PreparedStatement ps = con.prepareStatement(sql);  
        ps.executeQuery();  
    } catch (SQLException e) {  
        assertThat(e.getErrorCode()).isEqualTo(42122);  
  
        SQLErrorCodeSQLExceptionTranslator exTranslator = new SQLErrorCodeSQLExceptionTranslator();  
        DataAccessException resultEx = exTranslator.translate("select", sql, e);  
        log.info("resultEx", resultEx);  
  
        assertThat(resultEx.getClass()).isEqualTo(BadSqlGrammarException.class);  
    }  
}

스프링이 제공하는 SQL 예외 변환기는 다음과 같이 사용하면 된다.

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

translate() 메서드의 첫번째 파라미터는 읽을 수 있는 설명이고, 두번째는 실행한 sql, 마지막은 발생된 SQLException을 전달하면 된다. 이렇게 하면 적절한 스프링 데이터 접근 계층의 예외로 변환해서 반환해준다.
예제에서는 SQL 문법이 잘못되었으므로 BadSqlGrammarException을 반환하는 것을 확인할 수 있다.
- 눈에 보이는 반환 타입은 최상위 타입인 DataAccessException이지만 실제로는 BadSqlGrammarException예외가 반환 된다. 마지막에 assertThat()부분을 확인하자.
- 참고로 BadSqlGrammarException은 최상위 타입인 DataAccessException를 상속 받아서 만들어진다.

sql-error-codes.xml

해당 파일에 각각 DB에 맞는 에러 코드를 다 가지고 있다.

org.springframework.jdbc.support.sql-error-codes.xml
스프링 SQL 예외 변환기는 SQL ErrorCode를 이 파일에 대입해서 어떤 스프링 데이터 접근 예외로 전환해야 할지 찾아낸다. 예를 들어서 H2 데이터베이스에서 42000이 발생하면 badSqlGrammarCodes이기 때문에 BadSqlGrammarException을 반환한다.

해당 파일을 확인해보면 10개 이상의 우리가 사용하는 대부분의 관계형 데이터베이스를 지원하는 것을 확인할 수 있다.

정리

스프링은 데이터 접근 계층에 대한 일관된 예외 추상화를 제공한다.
스프링은 예외 변환기를 통해서 SQLException의 ErrorCode에 맞는 적절한 스프링 데이터 접근 예외로 변환해준다.
만약 서비스, 컨트롤러 계층에서 예외 처리가 필요하면 특정 기술에 종속적인 SQLException같은 예외를 직접 사용하는 것이 아니라, 스프링이 제공하는 데이터 접근 예외를 사용하면 된다.
스프링 예외 추상화 덕분에 특정 기술에 종속적이지 않게 되었다. 이제 JDBC에서 JPA같은 기술로 변경되어도 예외로 인한 변경을 최소화 할 수 있다. 향후 JDBC에서 JPA로 구현 기술을 변경하더라도, 스프링은 JPA 예외를 적절한 스프링 데이터 접근 예외로 변환해준다.
물론 스프링이 제공하는 예외를 사용하기 때문에 스프링에 대한 기술 종속성은 발생한다.
- 스프링에 대한 기술 종속성까지 완전히 제거하려면 예외를 모두 직접 정의하고 예외 변환도 직접 하면 되지만, 실용적인 방법은 아니다.

스프링 예외 추상화 적용

이제 우리가 만든 애플리케이션에 스프링이 제공하는 데이터 접근 예외 추상화와 SQL 예외 변환기를 적용해보자.

MemberRepositoryV4_2

/**  
 * SQLExceptionTranslator 추가  
 * */  
@Slf4j  
public class MemberRepositoryV4_2 implements MemberRepository {  
  
    private final DataSource dataSource;  
    private final SQLExceptionTranslator exTranslator;  
  
    public MemberRepositoryV4_2(final DataSource dataSource) {  
        this.dataSource = dataSource;  
        this.exTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);  
    }  
  
    @Override  
    public Member save(Member member) {  
        String sql = "insert into member(member_id, money) values (?, ?)";  
  
        Connection con = null;  
        PreparedStatement pstmt = null;  
  
        try {  
            con = getConnection();  
            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);  
        }  
    }  
  
    @Override  
    public Member findById(String memberId) {  
        String sql = "select * from member where member_id = ?";  
  
        Connection con = null;  
        PreparedStatement pstmt = null;  
        ResultSet rs = null;  
  
        try {  
            con = getConnection();  
            pstmt = con.prepareStatement(sql);  
            pstmt.setString(1, memberId);  
  
            rs = pstmt.executeQuery();  
            if (rs.next()) {  
                Member member = new Member();  
                member.setMemberId(rs.getString("member_id"));  
                member.setMoney(rs.getInt("money"));  
                return member;  
            } else {  
                throw new NoSuchElementException("member not found, memberId= " + memberId);  
            }  
  
        } catch (SQLException e) {  
            throw exTranslator.translate("findById", sql, e);  
        } finally {  
            close(con, pstmt, rs);  
        }  
    }  
  
    @Override  
    public void update(String memberId, int money) {  
        String sql = "update member set money=? where member_id=?";  
        Connection con = null;  
        PreparedStatement pstmt = null;  
  
        try {  
            con = getConnection();  
            pstmt = con.prepareStatement(sql);  
            pstmt.setInt(1, money);  
            pstmt.setString(2, memberId);  
            pstmt.executeUpdate();  
        } catch (SQLException e) {  
            throw exTranslator.translate("update", sql, e);  
        } finally {  
            close(con, pstmt, null);  
        }  
    }  
  
    @Override  
    public void delete(String memberId) {  
        String sql = "delete from member where member_id = ?";  
  
        Connection con = null;  
        PreparedStatement pstmt = null;  
  
        try {  
            con = getConnection();  
            pstmt = con.prepareStatement(sql);  
            pstmt.setString(1, memberId);  
  
            pstmt.executeUpdate();  
  
        } catch (SQLException e) {  
            throw exTranslator.translate("delete", sql, e);  
        } finally {  
            close(con, pstmt, null);  
        }  
    }  
  
    private void close(Connection con, Statement stmt, ResultSet rs) {  
        JdbcUtils.closeResultSet(rs);  
        JdbcUtils.closeStatement(stmt);  
        //주의! 트랜잭션 동기화를 사용하려면 DataSourceUtils를 사용해야 한다.  
        DataSourceUtils.releaseConnection(con, dataSource);  
    }  
  
    private Connection getConnection() throws SQLException {  
        //주의! 트랜잭션 동기화를 사용하려면 DataSourceUtils를 사용해야 한다.  
        Connection con = DataSourceUtils.getConnection(dataSource);  
        log.info("get connection= {}", con);  
        return con;  
    }  
}

기존 코드에서 스프링 예외 변환기를 사용하도록 변경되었다.

private final SQLExceptionTranslator exTranslator;  
  
public MemberRepositoryV4_2(final DataSource dataSource) {  
    this.dataSource = dataSource;  
    this.exTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);  
}


...

catch (SQLException e) {  
    throw exTranslator.translate("save", sql, e);  
}

정리

드디어 예외에 대한 부분을 깔끔하게 정리했다.

스프링이 예외를 추상화해준 덕분에, 서비스 계층은 특정 리포지토리의 구현 기술과 예외에 종속적이지 않게 되었다. 따라서 서비스 계층은 특정 구현 기술이 변경되어도 그대로 유지할 수 있게 되었다. 다시 DI를 제대로 활용할 수 있게 된 것이다.

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

JDBC 반복 문제 해결 - JdbcTemplate

지금까지 서비스 계층의 순수함을 유지하기 위해 수 많은 노력을 했고, 덕분에 서비스 계층의 순수함을 유지하게 되었다. 이번에는 리포지토리에서 JDBC를 사용하기 때문에 발생하는 반복 문제를 해결해보자.

JDBC 반복 문제

커넥션 조회, 커넥션 동기화
PreparedStatement 생성 및 파라미터 바인딩
쿼리 실행
결과 바인딩
예외 발생 시 스프링 예외 변환기 실행
리소스 종료

리포지토리의 각각의 메서드를 살펴보면 상당히 많은 부분이 반복된다. 이런 반복을 효과적으로 처리하는 방법이 바로 템플릿 콜백 패턴이다.

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

MemberRepositoryV5

/**  
 * JdbcTemplate 사용  
 * */  
@Slf4j  
public class MemberRepositoryV5 implements MemberRepository {  
  
    private final JdbcTemplate template;  
      
    public MemberRepositoryV5(DataSource dataSource) {  
        this.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;  
    }  
  
    @Override  
    public Member findById(String memberId) {  
        String sql = "select * from member where member_id = ?";  
        return template.queryForObject(sql, memberRowMapper(), memberId);  
    }  
    @Override  
    public void update(String memberId, int money) {  
        String sql = "update member set money=? where member_id=?";  
        template.update(sql, money, memberId);  
    }  
  
    @Override  
    public void delete(String memberId) {  
        String sql = "delete from member where member_id = ?";  
        template.update(sql, memberId);  
    }  
    private RowMapper<Member> memberRowMapper() {  
        return (rs, rowNum) -> {  
            Member member = new Member();  
            member.setMemberId(rs.getString("member_id"));  
            member.setMoney(rs.getInt("money"));  
            return member;  
        };  
    }  
}

MemberServiceV4Test에서 MemberRepository에 MemberRepositoryV5만 주입해서 테스트했더니 잘 작동한다.

코드가 매우 간결해졌다.

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

정리

완성된 코드를 확인해보자.

서비스 계층의 순수성
- 서비스 코드
- 트랜잭션 추상화 + 트랜잭션 AOP 덕분에 서비스 계층의 순수성을 최대한 유지하면서 서비스 계층에서 트랜잭션을 사용할 수 있다.
- 스프링이 제공하는 예외 추상화와 예외 변환기 덕분에, 데이터 접근 기술이 변경되어도 서비스 계층의 순수성을 유지하면서 예외도 사용할 수 있다.
- 서비스 계층이 리포지토리 인터페이스에 의존한 덕분에 향후 리포지토리가 다른 구현 기술로 변경되어도 서비스 계층을 순수하게 유지할 수 있다.
리포지토리에서 JDBC를 사용하는 반복 코드가 JdbcTemplate으로 대부분 제거되었다.
- 리포지토리 코드

Minseong Kim

스프링 DB 1편 - 데이터 접근 핵심 원리 (16) - 스프링과 문제 해결 - 예외 처리, 반복 - 2

스프링 예외 추상화 이해

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

SpringExceptionTranslatorTest - 추가 exceptionTranslator

정리

스프링 예외 추상화 적용

MemberRepositoryV4_2

정리

JDBC 반복 문제 해결 - JdbcTemplate

JDBC 반복 문제

MemberRepositoryV5

정리

댓글남기기

참고

초보를 위한 도커 안내서 (2) 도커 설치부터 실행까지

초보를 위한 도커 안내서 (1) 도커란 무엇인가

모든 개발자를 위한 HTTP 웹 기본 지식 (8) - HTTP 헤더 2 - 캐시와 조건부 요청

모든 개발자를 위한 HTTP 웹 기본 지식 (7) - HTTP 헤더 1 - 일반 헤더