[스프링 DB 1편] #6. 스프링과 문제 해결 - 예외 처리, 반복 - (2)

[newh08]

스프링 예외 추상화 이해

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

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

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

• 따라서 서비스 계층에서도 이 예외를 사용하면 된다. 즉 JPA 를 쓰던, JDBC 를 쓰던 스프링이 제공한 예외를 사용하면 됨.

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

• 예외의 최고 상위는 org.springframework.dao.DataAccessException 이다. 그림에서 보는 것 처럼 런타임 예외를 상속 받음.

• 그래서 스프링이 제공하는 데이터 접근 계층의 모든 예외는 런타임 예외이다.

• DataAccessException 는 2가지로 구분된다

  • Transient : 일시적, 다시 시도시 성공 가능성 있음. (쿼리 타임아웃, 락 관련 오류)
  • NonTransient : 일시적이지 않음. 다시 시도해도 실패함
    DataAccessException 를 상속한 예외를 보면 매우 많음.

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

스프링은 DB 에서 발생한 오류 코드를 스프링이 정의한 예외로 자동 변환하는 변환기를 제공함.
스프링이 SQL Exception을 해석해 스프링 예외로 변환해줌.

public class SpringExceptionTranslatorTest {

    DataSource dataSource;

    @BeforeEach
    void init() {
        dataSource = new DriverManagerDataSource(URL, USERNAME, PASSWORD);
    }

    @Test
    void sqlExceptionErrorCode() {
        String sql = "select bad grammer";

        try {
            Connection connection = dataSource.getConnection();
            PreparedStatement preparedStatement = connection.prepareStatement(sql);
            preparedStatement.executeQuery();
        } catch (SQLException e) {
            Assertions.assertThat(e.getErrorCode()).isEqualTo(42122);
            log.info("error", e);
        }
    }
}

이렇게 기존엔 예외를 잡아서 하나씩 잡아야했음.
그러나 이렇게 하나하나 스프링 예외로 변환하는건 현실성 없음. 데이터베이스마다 에러코드가 다른것도 있음.
그래서 스프링은 예외 변환기를 제공함.

    @Test
    void exceptionTranslator() {
        String sql = "select bad grammer";
        try {
            Connection connection = dataSource.getConnection();
            PreparedStatement preparedStatement = connection.prepareStatement(sql);
            preparedStatement.executeQuery();
        } catch (SQLException e) {
            Assertions.assertThat(e.getErrorCode()).isEqualTo(42122);

            SQLExceptionTranslator sqlExceptionTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);
            DataAccessException resultEx = sqlExceptionTranslator.translate("select", sql, e);
            log.info("resultEX", resultEx);
            Assertions.assertThat(resultEx.getClass()).isEqualTo(BadSqlGrammarException.class);
        }
    }

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

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

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

• 예제에서는 SQL 문법이 잘못되었으므로 BadSqlGrammarException 을 반환하는 것을 확인할 수 있다.
  • 눈에 보이는 반환 타입은 최상위 타입인 DataAccessException 이지만 실제로는 BadSqlGrammarException 예외가 반환된다. 마지막에 assertThat() 부분을 확인하자.
  • 참고로 BadSqlGrammarException 은 최상위 타입인 DataAccessException 를 상속 받아서 만들 어진다.

각각의 DB 마다 에러코드가 다른데, 스프링은 어떻게 이를 예외로 변환할 수 있을까?
sql-error-codes.xml
비밀은 이 파일에 있음.

	<bean id="H2" class="org.springframework.jdbc.support.SQLErrorCodes">
		<property name="badSqlGrammarCodes">
			<value>42000,42001,42101,42102,42111,42112,42121,42122,42132</value>
		</property>

각 DB 에 맞는 에러코드 표를 다 가지고 있음.
스프링 SQL 예외 변환기는 SQL ErrorCode를 이 파일에 대입해서 어떤 스프링 데이터 접근 예외로 전환해야 할 지 찾아낸다. 예를 들어서 H2 데이터베이스에서 42000 이 발생하면 badSqlGrammarCodes 이기 때문에 BadSqlGrammarException 을 반환한다.

이제는 SQLException을 스프링 예외로 변환해 서비스 계층에서 사용 가능.

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

스프링 예외 추상화 적용

우리 코드에 스프링 예외 추상화 적용

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); // 어떤 디비 쓰는지 확인 위해 dataSource 넣음
    }
// 이후에 예외 던치는 부분에서

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

// 이렇게 변환하기. 모든 메서드!

테스트 추가하지 않고, 기존 테스트 코드에서 구현체만 V4_2로 바꿔서 테스트

        @Bean
        MemberRepository memberRepositoryV3() {
            return new MemberRepositoryV4_2(dataSource);
        }

• 드디어 예외에 대한 부분을 깔끔하게 정리했다.
• 스프링이 예외를 추상화해준 덕분에, 서비스 계층은 특정 리포지토리의 구현 기술과 예외에 종속적이지 않게 되었다. 따 라서 서비스 계층은 특정 구현 기술이 변경되어도 그대로 유지할 수 있게 되었다. 다시 DI를 제대로 활용할 수 있게 된 것이다.
• 추가로 서비스 계층에서 예외를 잡아서 복구해야 하는 경우, 예외가 스프링이 제공하는 데이터 접근 예외로 변경되어서 서비스 계층에 넘어오기 때문에 필요한 경우 예외를 잡아서 복구하면 된다.

JDBC 반복 문제 해결 - JdbcTemplate

리포지토리에서 반복되는 코드를 해결해보자.

커넥션 조회
prepareStatement 만들기
파라미터 바인딩하기
쿼리 실행
결과 바인딩
예외 변환
리소스 종료

틀은 전부 똑같고
sql 문, 결과받아오는 부분만 변경됨.

리포지토리의 각각의 메서드를 살펴보면 상당히 많은 부분이 반복된다. 이런 반복을 효과적으로 처리하는 방법이 바로 템플릿 콜백 패턴이다.
스프링은 JDBC의 반복 문제를 해결하기 위해 JdbcTemplate 이라는 템플릿을 제공한다. (트렌잭션 템플릿과 비슷)
JdbcTemplate 에 대한 자세한 사용법은 뒤에서 설명하겠다. 지금은 전체 구조와, 이 기능을 사용해서 반복 코드를 제 거할 수 있다는 것에 초점을 맞추자.

@Slf4j
public class MemberRepositoryV5 implements MemberRepository{

    private final JdbcTemplate jdbcTemplate;

    public MemberRepositoryV5(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    @Override
    public Member save(Member member) {
        String sql = "insert into member(member_id, money) values(?, ?)";
        jdbcTemplate.update(sql, member.getMemberId(), member.getMoney());
        return member;
    }

    public Member findById(String memberId) {
        String sql = "select * from Member where member_id = ?";
        return jdbcTemplate.queryForObject(sql, memberRowMapper(), 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;
        };
    }

    public void update(String memberId, int money) {
        String sql = "update member set money=? where member_id=?";
        jdbcTemplate.update(sql, money, memberId); // sql 문에서 순서 주의
    }

    @Override
    public void delete(String memberId)  {
        String sql = "delete from member where member_id = ?";
        jdbcTemplate.update(sql, memberId);
    }
}

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

JDBC Template 에 기본적인 틀은 다 있고 SQL 부분, 결과 맵핑 부분만 바꿔서 실행해준다.