[Spring] 예외 처리하기(체크/언체크), 트랜잭션 처리에 따른 예외 종속 해결 2편

인프런 강의

인프런 김영한님의 Spring Boot 강의 시리즈를 듣고 Spring 프레임워크의 방대한 기술들을 복기하고자 공부한 내용을 가볍게 정리한 것입니다. 문제가 될 시 삭제하겠습니다.

 

해당 프로젝트에서 배우는 내용

• 섹션 6 | 스프링과 문제 해결 - 예외 처리, 반복

 

앞선 1편에서 트랜잭션 사용에 따른 특정 기술에 종속적인 문제로 체크 예외를 해결할 수 없음에도 불구하고 서비스, 컨트롤 단까지 예외를 의존해야 하는 문제가 있었다. 또한 JDBC 기술 사용으로 반복되는 코드가 있다.

이번에 체크 예외를 언체크 예외로 변환하기, 스프링의 예외 추상화, 스프링의 예외 변환기, JdbcTemplate 사용으로 반복되는 코드를 없애고, 특정 기술에 의존해야 하는 코드를 없애 유연한 코드가 되도록 수정해보자 

 

체크 예외와 인터페이스

---

앞서 살펴본 바와 같이 서비스 계층은 가급적 특정 구현 기술에 의존하지 않고, 순수하게 유지하는 것이 좋다.
이렇게 하려면 예외에 대한 의존도 함께 해결해야 한다. 예외 의존을 해결하기 위해 체크 예외를 런타임 예외로 변경해야 한다.

 

인터페이스 도입

인터페이스 도입을 통해 구현 기술을 쉽게 변경할 수 있게 변경한다.

• 이렇게 인터페이스를 도입하면 MemberSerive는 MemberRepository 인터페이스에만 의존하면 된다.
• 구현 기술을 변경하고 싶으면 DI를 사용해서 MemberSerivce 코드의 변경 없이 구현 기술을 변경할 수 있다.

 

예제

[MemberRepository]

• 기존에는 체크 예외이기 때문에 인터페이스를 도입할 수 없었다.
• 체크 예외인 경우 무조건 예외를 잡아서 처리하거나 던져야 하기 때문에 체크 예외도 인터페이스에 선언되어야 한다.
  • 따라서 차후 체크 예외를 런타임 예외로 변경할 예정이다.
• 참고로 구현 클래스의 메서드에 선언할 수 있는 예외는 부모 타입에서 던진 예외와 같거나 하위 타입이어야 한다.

package hello.jdbc.repository;

import hello.jdbc.domain.Member;

public interface MemberRepository {

    Member save(Member save);

    Member findById(String memberId);

    void update(String memberId, int money);

    void delete(String memberId);
}

 

런타임 예외 적용

---

내용

• 앞서 만들었던 인터페이스를 적용해 DI통해 구현체를 쉽게 변경할 수 있도록 변경
• 런타임 예외를 정의하고 리포지토리의 의존적인 체크 예외를 런타임 예외로 변경
• 서비스 계층을 순수한 자바 코드로 변경

 

예제

[MyDbException]

RuntimeException을 상속받았으므로 런타임 예외가 된다.

package hello.jdbc.repository.ex;

/**
 * RuntimeException을 상속받아기 때문에 MyDbException은 런타임 예외가 된다.
 */
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);
    }
}

 

 

[MemberRepositoryV4_1]

리포지토리의 의존적 체크 예외를 런타임 예외로 바꾸자

• 메서드 시그니처에 체크 예외를 던지는 부분을 제거했다.
• 대신 throw new MyDbException(e);을 통해 체크 예외를 런타임 예외로 전환했다.
  • 여기서 중요한 점은 꼭 발생한 원인이 되는 예외를 우리가 정의한 예외 객체의 생성자에 포함해야한다.
  • 기존에 발생한 예외를 포함하지 않으면, 예외를 스택 트레이스를 통해 출력했을 때 기존에 원인이 되는 부분을 확인할 수 없다.

package hello.jdbc.repository;

import hello.jdbc.domain.Member;
import hello.jdbc.repository.ex.MyDbException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.jdbc.datasource.DataSourceUtils;
import org.springframework.jdbc.support.JdbcUtils;

import javax.sql.DataSource;
import java.sql.*;
import java.util.NoSuchElementException;

/**
 * 예외 누수 문제 해결
 * 체크 예외를 런타임 예외로 변경
 * MemberRepository 인터페이스 사용
 * throws SQLException 제거
 */
@Slf4j
public class MemberRepositoryV4_1 implements MemberRepository {

    private final DataSource dataSource;

    public MemberRepositoryV4_1(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    private Connection getConnection() {
        Connection con = DataSourceUtils.getConnection(dataSource);
        log.info("get connection = {}, class = {}", con, con.getClass());
        return con;
    }

    private void close(Connection con, Statement stmt, ResultSet rs) {
        JdbcUtils.closeResultSet(rs);
        JdbcUtils.closeStatement(stmt);
        DataSourceUtils.releaseConnection(con, 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 new MyDbException(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 new NoSuchElementException("member not found memberId = " + memberId);
        } 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);
            int resultSize = pstmt.executeUpdate();
            log.info("resultSize = {}", resultSize);

        } catch (SQLException e) {
            throw new MyDbException(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 new MyDbException(e);
        } finally {
            close(con, pstmt, null);
        }
    }
}

 

 

[MemberServiceV4]

서비스 계층을 비즈니스 로직만 있는 순수한 자바코드로 바꿔보자

• MemberRepository로 인터페이스에 의존하도록 변경
• 리포지토리에서 체크 예외를 던지지 않기 때문에 드디어 예외에 대한 의존을 벗어날 수 있다.(throws SQLException)

package hello.jdbc.service;

import hello.jdbc.domain.Member;
import hello.jdbc.repository.MemberRepository;
import hello.jdbc.repository.MemberRepositoryV3;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.transaction.annotation.Transactional;

import java.sql.SQLException;

/**
 * 예외 누수 문제 해결
 * SQLException 제거
 *
 * MemberRepository 인터페이스 의존
 */
@Slf4j
@RequiredArgsConstructor
public class MemberServiceV4 {

    private final MemberRepository memberRepository;

    @Transactional
    public void accountTransfer(String fromId, String toId, int money) {
        // 비즈니스 로직
        bizLogic(fromId, toId, money);
    }

    private void bizLogic(String fromId, String toId, int money) {
        Member fromMember = memberRepository.findById(fromId);
        Member toMember = memberRepository.findById(toId);

        memberRepository.update(fromId, fromMember.getMoney() - money);
        validation(toMember);
        memberRepository.update(toId, toMember.getMoney() + money);
    }


    private void validation(Member toMember) {
        if (toMember.getMemberId().equals("ex")) {
            throw new IllegalStateException("이체중 예외 발생");
        }
    }
}

 

 

[MemberServiceV4Test]

• MemberRepository로 인터페이스 변경

package hello.jdbc.service;

import hello.jdbc.domain.Member;
import hello.jdbc.repository.MemberRepository;
import hello.jdbc.repository.MemberRepositoryV3;
import hello.jdbc.repository.MemberRepositoryV4_1;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.aop.support.AopUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;

import javax.sql.DataSource;
import java.sql.SQLException;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;

/**
 * 예외 누수 문제 해결
 * SQLException 제거
 *
 * MemberRepository 인터페이스 의존
 */
@Slf4j
@SpringBootTest
class MemberServiceV4Test {

    public static final String MEMBER_A = "memberA";
    public static final String MEMBER_B = "memberB";
    public static final String MEMBER_EX = "ex";

    @Autowired
    MemberRepository memberRepository;
    @Autowired
    MemberServiceV4 memberService;

    @AfterEach
    void afterEach() throws SQLException {
        memberRepository.delete(MEMBER_A);
        memberRepository.delete(MEMBER_B);
        memberRepository.delete(MEMBER_EX);
    }

    @TestConfiguration
    static class TestConfig {

        private final DataSource dataSource;

        public TestConfig(DataSource dataSource) {
            this.dataSource = dataSource;
        }


        @Bean
        MemberRepository memberRepository() {
            // 단순 예외 반환
            return new MemberRepositoryV4_1(dataSource);
        }

        @Bean
        MemberServiceV4 memberServiceV4() {
            return new MemberServiceV4(memberRepository());
        }

    }

    @Test
    void AopCheck() {
        log.info("memberService class = {}", memberService.getClass());
        log.info("memberRepository class = {}", memberRepository.getClass());
        assertThat(AopUtils.isAopProxy(memberService)).isTrue();
        assertThat(AopUtils.isAopProxy(memberRepository)).isFalse();
    }

    @Test
    @DisplayName("정상 이체")
    void accountTransfer() throws SQLException {
        // given
        Member memberA = new Member(MEMBER_A, 10000);
        Member memberB = new Member(MEMBER_B, 10000);
        memberRepository.save(memberA);
        memberRepository.save(memberB);

        // when
        memberService.accountTransfer(memberA.getMemberId(), memberB.getMemberId(), 2000);

        // then
        Member findMemberA = memberRepository.findById(memberA.getMemberId());
        Member findMemberB = memberRepository.findById(memberB.getMemberId());
        assertThat(findMemberA.getMoney()).isEqualTo(8000);
        assertThat(findMemberB.getMoney()).isEqualTo(12000);
    }

    @Test
    @DisplayName("이체중 예외 발생")
    void accountTransferEx() throws SQLException {
        // given: 다음 데이터를 저장해서 테스트를 준비한다.
        Member memberA = new Member(MEMBER_A, 10000);
        Member memberEx = new Member(MEMBER_EX, 10000);
        memberRepository.save(memberA);
        memberRepository.save(memberEx);

        // when: 계좌이체 로직을 실행한다.
        // memberEx 회원의 ID는 ex 이므로 중간에 예외가 발생한다.
        assertThatThrownBy(() ->
                memberService.accountTransfer(memberA.getMemberId(), memberEx.getMemberId(), 2000))
                .isInstanceOf(IllegalStateException.class);

        // then: memberA의 돈이 롤백 되어야함
        Member findMemberA = memberRepository.findById(memberA.getMemberId());
        Member findMemberB = memberRepository.findById(memberEx.getMemberId());
        assertThat(findMemberA.getMoney()).isEqualTo(10000);
        assertThat(findMemberB.getMoney()).isEqualTo(10000);
    }
}

 

정리

• 체크 예외를 런타임 예외로 변환하면서 인터페이스와 서비스 계층의 순수성을 유지할 수 있게 되었다.
• 덕분에 JDBC에서 향후 다른 기술로 변경하더라도 서비스 계층의 코드를 변경하지 않고 유지할 수 있다.

 

데이터 접근 예외 직접 만들기

---

데이터베이스에서 특정 예외의 경우 복구를 시도할 수도 있다.
앞서 만든 예외는 런타임 예외로 처리하여 예외 의존성 문제를 해결하였지만, 예외를 구분할 수 없다는 단점이 있다.
따라서 이번에는 회원가입 시 같은 아이디가 있으면 뒤에 임의의 숫자를 붙여서 가입이 가능하도록 특정 예외를 만들어보려고 한다.

• 데이터베이스는 에러가 발생할 때 오류 코드를 반환하고, 이 에러 코드를 받은 JDBC 드라이버는 SQLExcetpion을 던지며, 이 안에는 데이터베이스가 제공하는 errorCode라는 것이 들어있다.
• 아래는 데이터베이스의 오류가 발생했을 때 시나리오다.

서비스 계층에서는 예외 복구를 위해 키 중복 오류를 확인할 수 있어야 한다. 그래야 새로운 ID를 만들어서 다시 저장을 시도할 수 있기 떄문이다. 이런 과정이 바로 예외를 확인해서 복구하는 과정이다.

H2 데이터베이스의 키 중복 오류는 23505인데 이 에러가 발생했을 때 새로운 ID를 만들어서 다시 저장하면 된다.

 

예제

[MyDuplicateKeyException]

SQLException은 체크 예외이기 때문에 런타임 예외로 바꿔줄 필요가 있다.

• 기존에 사용했던 MyDbException을 상속받아 의미있는 계층을 형성한다. 이렇게하면 데이터베이스 관련 예외라는 계층을 만들 수 있다.

package hello.jdbc.repository.ex;

public class MyDuplicateKeyException extends MyDbException {

    public MyDuplicateKeyException() {
    }

    public MyDuplicateKeyException(String message) {
        super(message);
    }

    public MyDuplicateKeyException(String message, Throwable cause) {
        super(message, cause);
    }

    public MyDuplicateKeyException(Throwable cause) {
        super(cause);
    }
}

 

 

[ExTranslatorV1Test] - 아이디 중복 가입 시 예외 복구 테스트 코드

이제 실제 예제 코드를 만들어서 확인해보자

package hello.jdbc.exception.translator;

import hello.jdbc.connection.ConnectionConst;
import hello.jdbc.domain.Member;
import hello.jdbc.repository.ex.MyDbException;
import hello.jdbc.repository.ex.MyDuplicateKeyException;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.jdbc.datasource.DriverManagerDataSource;
import org.springframework.jdbc.support.JdbcUtils;
import org.springframework.stereotype.Repository;

import javax.sql.DataSource;
import javax.xml.crypto.Data;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.util.Random;

import static hello.jdbc.connection.ConnectionConst.*;
import static org.springframework.jdbc.support.JdbcUtils.*;

public class ExTranslatorV1Test {

    Repository repository;
    Service service;

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

    @Test
    void duplicateKeySave() {
        service.create("myId");
        service.create("myId"); // 같은 ID 저장 시도
    }

    @Slf4j
    @RequiredArgsConstructor
    static class Service {

        private final Repository repository;

        public void create(String memberId) {
            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;
            }
        }

        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 {
                con = dataSource.getConnection();
                pstmt = con.prepareStatement(sql);
                pstmt.setString(1, member.getMemberId());
                pstmt.setInt(2, member.getMoney());
                pstmt.executeUpdate();
                return member;
            } catch (SQLException e) {
                // h2 db
                if (e.getErrorCode() == 23505) {
                    throw new MyDuplicateKeyException(e);
                }

                throw new MyDbException(e);
            } finally {
                closeStatement(pstmt);
                closeConnection(con);
            }
        }
    }
}

 

실행 결과

같은 아이디를 저장했지만 서비스 계층에서 예외를 잡고 복구했다.

13:03:33.882 [Test worker] INFO  h.j.e.t.ExTranslatorV1Test$Service --
                saveId = myId
13:03:33.890 [Test worker] INFO  h.j.e.t.ExTranslatorV1Test$Service --
                키 중복, 복구 시도
13:03:33.891 [Test worker] INFO  h.j.e.t.ExTranslatorV1Test$Service --
                retryId = myId1480

 

리포지토리

• e.getErrorCode() == 23505: 오류 코드가 키 중복 오류인 경우 우리가 정의한 MyDuplicateKeyException을 새로 만들어서 서비스 계층에 던진다.
• 나머지 경우 기존에 만들었던 MyDbException을 던진다.

} catch (SQLException e) {
// h2 db
if (e.getErrorCode() == 23505) {
  throw new MyDuplicateKeyException(e);
}

throw new MyDbException(e);

 

서비스

• 처음엔 저장을 시도하고, 리포지토리에서 MyDuplicateKeyException 예외가 올라오면 예외를 잡아서 복구를 시도하고 다시 저장을 시도한다.
• 만약 복구가 불가능한 에러라면(MyDbException) 로그만 남기고 예외를 던진다.
  • 만약 어차피 복구할 수 없는 예외라면 예외를 공통으로 처리하는 부분까지 전달되어서 그 곳에서 예외 로그를 남기고 처리하는 것이 좋다.

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;
}

 

스프링 예외 추상화 이해

---

위와 같은 방식으로 특정 예외에 대한 처리를 할 수 있었지만, 데이터베이스마다 에러 코드도 다르고 무수히 많은 예외 상황을 모두 작성하기는 효율적이지 않다. 데이터베이스가 바뀐다면 모두 수정해야 할 것이다.

이를 해결하기 위해 스프링에서는 데이터 접근과 관련된 예외를 추상화해서 제공한다.

 

스프링 데이터 접근 예외 계층

• 스프링은 데이터 접근 계층에 대한 수십 가지 예외를 정리해서 일관된 예외 계층을 제공한다.
• 각각의 예외는 특정 기술에 종속적이지 않게 설계되어 있다. 따라서 서비스 계층에서도 스프링이 제공하는 예외를 사용하면 된다.
• 예외의 최고 상위는 DataAccessException인데, 런타임 예외를 상속 받았기 떄문에 스프링이 제공하는 데이터 접근 계층의 모든 예외는 런타임 예외이다.
• DataAccessException은 크게 두 가지로 구분한다.
  • Transient: 일시적이라는 뜻이다. Trasient 하위 예외는 동일한 SQL을 다시 시도했을 때 성공할 가능성이 있다.
    • 예를 들어 쿼리 타임아웃, 락과 관련된 오류들이다.
  • NonTransient: 일시적이지 않다는 뜻이다. 같은 SQL을 그대로 반복해서 실행하면 실패한다.
    • SQL 문법 오류, 데이터베이스 제약조건 위배 등이 있다.

 

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

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

 

예제

[SpringExceptionTranslatorTest]

• sqlExceptionErrorCode: 해당 테스트는 SQL ErrorCode를 직접 확인해보는 테스트이다
  • 이렇게 직접 예외를 확인하고, 스프링이 만들어준 예외(BadSqlGrammarException)로 변환하는 것은 현실성이 없다.
  • 하나하나 다 에러를 확인하고 그에 맞게 스프링이 제공하는 예외를 던져줘야한다.
• exceptionTranslator: 해당 테스트는 스프링이 에러를 확인하고 적절한 에러로 변환시켜준다.
  • 아래처럼 단 2줄로 적절한 에러를 데이터베이스에 맞게 변환해서 던져준다.
  • DataAccessException은 최상위 부모 타입이지만, 실제 구현체는 Assertions.assertThat으로 확인해보면 BadSqlGrammarException이라는 것을 확인할 수 있다.
  • SQLErrorCodeSQLExceptionTranslator exTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource); DataAccessException resultEx = exTranslator.translate("select", sql, e);

package hello.jdbc.exception.translator;

import hello.jdbc.connection.ConnectionConst;
import lombok.extern.slf4j.Slf4j;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.BadSqlGrammarException;
import org.springframework.jdbc.datasource.DriverManagerDataSource;
import org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator;

import javax.sql.DataSource;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;

import static hello.jdbc.connection.ConnectionConst.*;
import static org.assertj.core.api.Assertions.*;

@Slf4j
public class SpringExceptionTranslatorTest {

    DataSource dataSource;

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

    /**
     * SQL ErrorCode를 직접 확인하는 방법
     * 직접 예외를 확인하고 하나하나 스프링이 만들어준 예외로 변환하는 것은 현실성이 없다.
     */
    @Test
    void sqlExceptionErrorCode() {
        String sql = "select bad grammar";

        try {
            Connection con = dataSource.getConnection();
            PreparedStatement pstmt = con.prepareStatement(sql);
            pstmt.executeQuery();
        } catch (SQLException e) {
            assertThat(e.getErrorCode()).isEqualTo(42122);
//            throw new BadSqlGrammarException(e);
            int errorCode = e.getErrorCode();
            log.info("errorCode = {}", errorCode);
            log.info("error", e);
        }
    }


    /**
     * 스프링이 제공하는 예외 변환기
     */
    @Test
    void exceptionTranslator() {
        String sql = "select bad grammar";

        try {
            Connection con = dataSource.getConnection();
            PreparedStatement pstmt = con.prepareStatement(sql);
            pstmt.executeQuery();
        } catch (SQLException e) {
            assertThat(e.getErrorCode()).isEqualTo(42122);

            // org.springframework.jdbc.support.sql-error-codes.xml
            SQLErrorCodeSQLExceptionTranslator exTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);
            DataAccessException resultEx = exTranslator.translate("select", sql, e);
            log.info("resultEx", resultEx);
            assertThat(resultEx.getClass()).isEqualTo(BadSqlGrammarException.class);
        }
    }
}

 

스프링이 적절한 예외로 변환해 줄 수 있는 비밀

org.springframework.jdbc.support.sql-error-codes.xml 해당 파일에 비밀이 숨어있다.

• 해당 파일에는 다양한 데이터베이스에 대한 에러코드를 정의하고 있다.
• 스프링 SQL 예외 변환기는 SQL ErrorCode를 이 파일에 대입해서 어떤 스프링 데이터 접근 예외로 전환해야 할 지 찾아낸다.

 

정리

• 스프링은 데이터 접근 계층에 대한 일관된 예외 추상화를 제공한다.
• 스프링은 예외 변환기를 통해 SQLException의 ErrorCode에 맞는 적절한 스프링 데이터 접근 예외로 변환해준다.
• 이제 서비스, 컨틀로럴 계층에서 예외 처리가 필요하면 특정 기술에 종속적인 SQLException 같은 예외를 사용하는 것이 아니라, 스프링이 제공하는 데이터 접근 예외를 사용하면 된다.
  • 스프링의 예외 추상화 덕분에 특정 기술에 종속적이지 않게 된다.

 

스프링 예외 추상화 적용

---

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

 

예제

[MemberRepositoryV4_2]

• 예외를 던지는 부분을 throw exTranslator.translate(...)으로 변경하여 특정 기술의 특정 예외를 잡을 필요 없이 스프링의 예외 추상화를 통해 특정 기술에 종속적이지 않게 되었다.

package hello.jdbc.repository;

import hello.jdbc.domain.Member;
import hello.jdbc.repository.ex.MyDbException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.jdbc.datasource.DataSourceUtils;
import org.springframework.jdbc.support.JdbcUtils;
import org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator;
import org.springframework.jdbc.support.SQLExceptionTranslator;

import javax.sql.DataSource;
import java.sql.*;
import java.util.NoSuchElementException;

/**
 * SQLExceptionTranslator 추가
 * - 스프링이 제공하는 예외 변환기
 * - 데이터 접근 예외 추상화 적용
 */
@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);
    }

    private Connection getConnection() {
        Connection con = DataSourceUtils.getConnection(dataSource);
        log.info("get connection = {}, class = {}", con, con.getClass());
        return con;
    }

    private void close(Connection con, Statement stmt, ResultSet rs) {
        JdbcUtils.closeResultSet(rs);
        JdbcUtils.closeStatement(stmt);
        DataSourceUtils.releaseConnection(con, 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);
            int resultSize = pstmt.executeUpdate();
            log.info("resultSize = {}", resultSize);

        } 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);
        }
    }
}

 

 

[MemberServiceV4Test]

• MemberRepository 인터페이스가 제공되므로 스프링 빈에 등록할 빈만 MemberRepositoryV4_1에서 MemberRepositoryV4_2로 교체하면 리포지토리를 변경해서 테스트를 확인할 수 있다.

package hello.jdbc.service;

import hello.jdbc.domain.Member;
import hello.jdbc.repository.MemberRepository;
import hello.jdbc.repository.MemberRepositoryV3;
import hello.jdbc.repository.MemberRepositoryV4_1;
import hello.jdbc.repository.MemberRepositoryV4_2;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.aop.support.AopUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;

import javax.sql.DataSource;
import java.sql.SQLException;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;

/**
 * 예외 누수 문제 해결
 * SQLException 제거
 *
 * MemberRepository 인터페이스 의존
 */
@Slf4j
@SpringBootTest
class MemberServiceV4Test {

    public static final String MEMBER_A = "memberA";
    public static final String MEMBER_B = "memberB";
    public static final String MEMBER_EX = "ex";

    @Autowired
    MemberRepository memberRepository;
    @Autowired
    MemberServiceV4 memberService;

    @AfterEach
    void afterEach() throws SQLException {
        memberRepository.delete(MEMBER_A);
        memberRepository.delete(MEMBER_B);
        memberRepository.delete(MEMBER_EX);
    }

    @TestConfiguration
    static class TestConfig {

        private final DataSource dataSource;

        public TestConfig(DataSource dataSource) {
            this.dataSource = dataSource;
        }


        @Bean
        MemberRepository memberRepository() {
//            return new MemberRepositoryV4_1(dataSource); // 단순 예외 반환
            return new MemberRepositoryV4_2(dataSource); // 스프링 예외 변환
        }

        @Bean
        MemberServiceV4 memberServiceV4() {
            return new MemberServiceV4(memberRepository());
        }

    }

    @Test
    void AopCheck() {
        log.info("memberService class = {}", memberService.getClass());
        log.info("memberRepository class = {}", memberRepository.getClass());
        assertThat(AopUtils.isAopProxy(memberService)).isTrue();
        assertThat(AopUtils.isAopProxy(memberRepository)).isFalse();
    }

    @Test
    @DisplayName("정상 이체")
    void accountTransfer() throws SQLException {
        // given
        Member memberA = new Member(MEMBER_A, 10000);
        Member memberB = new Member(MEMBER_B, 10000);
        memberRepository.save(memberA);
        memberRepository.save(memberB);

        // when
        memberService.accountTransfer(memberA.getMemberId(), memberB.getMemberId(), 2000);

        // then
        Member findMemberA = memberRepository.findById(memberA.getMemberId());
        Member findMemberB = memberRepository.findById(memberB.getMemberId());
        assertThat(findMemberA.getMoney()).isEqualTo(8000);
        assertThat(findMemberB.getMoney()).isEqualTo(12000);
    }

    @Test
    @DisplayName("이체중 예외 발생")
    void accountTransferEx() throws SQLException {
        // given: 다음 데이터를 저장해서 테스트를 준비한다.
        Member memberA = new Member(MEMBER_A, 10000);
        Member memberEx = new Member(MEMBER_EX, 10000);
        memberRepository.save(memberA);
        memberRepository.save(memberEx);

        // when: 계좌이체 로직을 실행한다.
        // memberEx 회원의 ID는 ex 이므로 중간에 예외가 발생한다.
        assertThatThrownBy(() ->
                memberService.accountTransfer(memberA.getMemberId(), memberEx.getMemberId(), 2000))
                .isInstanceOf(IllegalStateException.class);

        // then: memberA의 돈이 롤백 되어야함
        Member findMemberA = memberRepository.findById(memberA.getMemberId());
        Member findMemberB = memberRepository.findById(memberEx.getMemberId());
        assertThat(findMemberA.getMoney()).isEqualTo(10000);
        assertThat(findMemberB.getMoney()).isEqualTo(10000);
    }
}

 

정리

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

 

JDBC 반복 문제 해결 - JdbcTemplate

---

지금까지 서비스 계층의 순수함을 유지하기 위해 많은 부분을 수정했지만 리포지토리에서 JDBC를 사용하기 때문에 반복되는 문제가 있다. JdbcTemplate 통해 반복되는 문제를 해결해보자.

 

JDBC 반복 문제

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

 

이러한 반복 문제를 해결하기 위한 효과적인 방법은 바로 템플릿 콜백 패턴이다.
스프링은 JDBC 반복 문제를 해결하기 위해 JdbcTemplate이라는 템플릿을 제공한다.

 

예제

JdbcTemplate을 사용하여 반복되는 코드 없애기

[MemberRepositoryV5]

package hello.jdbc.repository;

import hello.jdbc.domain.Member;
import lombok.extern.slf4j.Slf4j;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.datasource.DataSourceUtils;
import org.springframework.jdbc.support.JdbcUtils;
import org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator;
import org.springframework.jdbc.support.SQLExceptionTranslator;

import javax.sql.DataSource;
import java.sql.*;
import java.util.NoSuchElementException;

/**
 * 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);
    }

    private RowMapper<Member> memberRowMapper() {
        return ((rs, rowNum) -> {
            Member member = new Member();
            member.setMemberId(rs.getString("member_id"));
            member.setMoney(rs.getInt("money"));
            return member;
        });
    }

    @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);
    }
}

 

 

[MemberServiceV4Test]

JdbcTemplate 적용을 위해 빈을 변경(새로운 구현체)

@Bean
MemberRepository memberRepository() {
//            return new MemberRepositoryV4_1(dataSource); // 단순 예외 반환
//            return new MemberRepositoryV4_2(dataSource); // 스프링 예외 변환
    return new MemberRepositoryV5(dataSource); // JdbcTemplate
}

 

정리

JdbcTemplate은 JDBC로 개발할 때 발생하는 반복을 대부분 해결해준다.

• 트랜잭션을 위한 커넥션 동기화
• 예외 발생 시 스프링 예외 변환기 등록
• 리소스 반환 등

 

최종 정리

---

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