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

[seyxxn]

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

#️⃣ 목차

• 체크 예외와 인터페이스
• 런타임 예외 적용
• 데이터 접근 예외 직접 만들기
• 스프링 예외 추상화 이해
• 스프링 예외 추상화 적용
• JDBC 반복 문제 해결 - JdbcTemplate

체크 예외와 인터페이스

서비스 계층은 가급적 특정 구현 기술에 의존하지 않는 것이 좋음

• 이를 위해서는 예외에 대한 의존도 함께 해결해야 함
  예를 들어, 서비스가 처리할 수 없는 SQLException에 대한 의존을 제거하려면 어떻게 해야할까>
• 서비스가 처리할 수 없으므로, 리포지토리가 던지는 SQLException 체크 예외를 런타임 예외로 전환해서 서비스 계층에 던지자
• 이렇게하면, 서비스 계층이 해당 예외를 무시할 수 있기 때문에 특정 구현 기술에 의존하는 부분을 제거하고 서비스 계층을 순수하게 유지할 수 있음

인터페이스 도입

먼저 MemberRepository 인터페이스도 도입해서 구현 기술을 쉽게 변경할 수 있게 해보자.

• 이렇게 인터페이스를 도입하면, MemberService는 MemberRepository 인터페이스에만 의존하면 됨
• 구현 기술을 변경하고 싶다면, DI를 사용해 MemberService 코드의 변경 없이 구현 기술을 변경할 수 있음

MemberRepository 인터페이스

package hello.jdbc.repository;
import hello.jdbc.domain.Member;

public interface MemberRepository {
    Member save(Member member);
    Member findById(String memberId);
    void update(String memberId, int money);
    void delete(String memberId);
}

특정 기술에 종속되지 않는 순수한 인터페이스

• 이 인터페이스를 기반으로 특정 기술을 사용하는 구현체를 만들면 됨

체크 예외와 인터페이스

기존에는 왜 이런 인터페이스를 만들지 않았을까?

• 왜냐하면, SQLException이 체크 예외이기 때문이다.
• 체크예외를 사용하려면 인터페이스에도 해당 체크 예외가 선언되어 있어야 한다.

체크 예외 코드에 인터페이스 도입시 문제점 - 인터페이스

package hello.jdbc.repository;
import hello.jdbc.domain.Member;
import java.sql.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을 해야함

체크 예외 코드에 인터페이스 도입시 문제점 - 구현 클래스

@Slf4j
public class MemberRepositoryV3 implements MemberRepositoryEx {
    public Member save(Member member) throws SQLException { 
            String sql = "insert into member(member_id, money) values(?, ?)";
        } 
}

• 인터페이스의 구현체가 체크 예외를 던지려면, 인터페이스의 메서드에 먼저 체크 예외를 던지는 부분이 선언되어 있어야 함. 그래야 구현 클래스의 메서드도 체크 예외를 던질 수 있음
  • 쉽게말해, MemberRepositoryV3가 throws SQLException을 하려면 MemberRepositoryEx 인터페이스에도 throws SQLException이 필요함
• 참고로 구현 클래스의 메서드에서 선언할 수 있는 예외는 부모 타입에서 던진 예외거나 하위타입이어야 함
  • 예를 들어, 인터페이스의 메서드에 throws Exception을 선언하면, 구현 클래스 메서드에 throws SQLException는 가능함. SQLException은 Exception의 하위 타입이기 때문임

특정 기술에 종속되는 인터페이스

구현 기술을 쉽게 변경하기 위해서 인터페이스를 도입하더라도, SQLException과 같은 특정 구현 기술에 종속적인 체크 예외를 사용하게 되면 인터페이스에도 해당 예외를 포함해야 함. 하지만 이것은 우리가 원하던 순수한 인터페이스가 아님. JDBC 기술에 종속적인 인터페이스일 뿐. 인터페이스를 만드는 목적은 구현체를 쉽게 변경하기 위함인데, 이미 인터페이스가 특정 구현 기술에 오염되어 버림. 향후 JDBC가 아닌 다른 기술로 변경한다면 인터페이스 자체를 변경해야 함

런타임 예외와 인터페이스

런타임 예외는 이런 부분에서 자유로움. 인터페이스에 런타임 예외를 따로 선언하지 않아도 됨. 따라서 인터페이스가 특정 기술에 종속적일 필요가 없음!

런타임 예외 적용

실제 코드에 런타임 예외를 사용하도록 적용해보자.

MemberRepository 인터페이스

package hello.jdbc.repository;
import hello.jdbc.domain.Member;

public interface MemberRepository {
    Member save(Member member);
    Member findById(String memberId);
    void update(String memberId, int money);
    void delete(String memberId);
}

MyDbException 런타임 예외

package hello.jdbc.repository.ex;

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

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

    @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 MyDbException(e);
        } finally {
            close(con, pstmt, rs);
        }
    }

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

    private void close(Connection con, Statement stmt, ResultSet rs) {
        JdbcUtils.closeResultSet(rs);
        JdbcUtils.closeStatement(stmt);
        DataSourceUtils.releaseConnection(con, dataSource);
    }
    private Connection getConnection() throws SQLException {
        Connection con = DataSourceUtils.getConnection(dataSource);
        log.info("get connection={}, class={}", con, con.getClass());
        return con;
    }
}

• MemberRepository 인터페이스를 구현 함
• 이 코드에서의 핵심은 SQLException이라는 체크 예외를 MyDbException이라는 런타임 예외로 변환해서 던지는 부분임

예외 변환

catch (SQLException e) {
    throw new MyDbException(e);
}

• 기존 예외를 생성자를 통해 포함하고 있음 (반드시 이렇게 해야함)
• 예외는 원인이 되는 예외를 내부에 포함할 수 있는데, 그래야 예외를 출력했을 때 원인이 되는 기존 예외도 확인할 수 있음
• MyDbException이 내부에 SQLException을 포함하고 있다고 이해하면 됨
  • 예외를 출력했을 때, 스택 트레이스를 통해 둘다 확인할 수 있음

MemberServiceV4

package hello.jdbc.service;

import hello.jdbc.domain.Member;
import hello.jdbc.repository.MemberRepository;
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){ // throws SQLException 제거
        bizLogic(fromId, toId, money);
    }

    private void bizLogic(String fromId, String toId, int money) { // throws SQLException 제거
        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 static void validation(Member toMember) {
        if (toMember.getMemberId().equals("ex")){
            throw new IllegalStateException("이체중 예외 발생");
        }
    }
}

• MemberRepository 인터페이스에 의존하도록 코드를 변경
• throws SQLException 제거 확인
• 순수한 서비스 완성

MemberServiceV4Test

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.assertj.core.api.Assertions;
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
    private MemberRepository memberRepository;
    @Autowired
    private MemberServiceV4 memberService;

    @AfterEach
    void after() throws SQLException {
        memberRepository.delete("memberA");
        memberRepository.delete("memberB");
        memberRepository.delete("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());
        Assertions.assertThat(AopUtils.isAopProxy(memberService)).isTrue();
        Assertions.assertThat(AopUtils.isAopProxy(memberRepository)).isFalse();
    }

    @Test
    @DisplayName("정상 이체")
    void accountTransfer() {
        //given
        Member memberA = new Member("memberA", 10000);
        Member memberB = new Member("memberB", 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(){
        //given
        Member memberA = new Member("memberA", 10000);
        Member memberEx = new Member("ex", 10000);
        memberRepository.save(memberA);
        memberRepository.save(memberEx);

        //when
        assertThatThrownBy(() -> memberService.accountTransfer(memberA.getMemberId(), memberEx.getMemberId(), 2000))
                .isInstanceOf(IllegalStateException.class);

        //then
        Member findMemberA = memberRepository.findById(memberA.getMemberId());
        Member findMemberEx = memberRepository.findById(memberEx.getMemberId());

        //memberA의 돈이 롤백 되어야함
        assertThat(findMemberA.getMoney()).isEqualTo(10000);
        assertThat(findMemberEx.getMoney()).isEqualTo(10000);
    }
}

• MemberRepository 인터페이스 사용하도록 함
• 테스트 모두 정상 동작

정리

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

남은 문제

• 리포지토리에서 넘어오는 특정한 예외의 경우 복구를 시도할 수도 있음
• 그런데, 지금 방식은 항상 MyDbException이라는 예외만 넘어오기에, 예외를 구분할 수 있는 단점이 존재함
  • 만약, 특정 상황에는 예외를 잡아 복구하고 싶다면 예외를 어떻게 구분해서 처리할 수 있을까?

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

데이터베이스 오류에 따라 특정 예외는 복구하고 싶을 수 있음

• 예를 들어, 회원 가입 시 DB에 이미 있는 같은 ID가 있는 경우, ID 뒤에 새로운 숫자를 붙여 새로운 ID를 만들어야 한다고 하자

데이터를 DB에 저장할 때 같은 ID가 이미 데이터베이스에 저장되어 있다면, 데이터베이스는 오류 코드를 반환하고, 이 오류 코드를 받은 JDBC 드라이버는 SQLExeption을 던짐

• 그리고 SQLException에는 데이터베이스가 제공하는 errorCode라는 것이 들어있음

데이터베이스 오류 코드 그림

H2 데이터베이스의 키 중복 오류 코드

e.getErrorCode() == 23505 

• SQLException 내부에 들어있는 errorCode를 활용하면 데이터베이스에서 어떤 문제가 발생했는지 확인할 수 있음

H2 데이터베이스의 예

• 23505 : 키 중복 오류
• 42000 : SQL 문법 오류
  • 같은 오류여도 각각의 데이터베이스마다 정의된 오류 코드가 다름. 따라서 오류 코드 사용시에는 데이터베이스 메뉴얼을 확인해야 함

서비스 계층에서는 예외 복구를 위해 키 중복 오류를 확인할 수 있어야 함

• 그래야 새로운 ID를 만들어 다시 저장을 시도하기 때문. 이러한 과정이 바로 예외를 확인해서 복구하는 과정임
• 리포지토리는 SQLException을 서비스 계층에 던지고 서비스 계층은 이 예외의 오류 코드를 확인해서 키 중복 오류(23505)인 경우 새로운 ID를 만들어서 다시 저장하면 됨
• 그런데 SQLException에 들어있는 오류 코드를 활용하기 위해서 SQLException을 서비스 계층으로 던지게 되면, 서비스 계층이 SQLException이라는 JDBC 기술에 의존하게 되며, 서비스 계층의 순수성이 무너지게 됨
• 이 문제를 해결하려면, 리포지토리에서 예외를 변환해서 던지면 된다.
  • SQLException -> MyDuplicateKeyException

MyDuplicateKeyException

package hello.jdbc.repository.ex;

public class MyDuplicateKeyException extends MyDbException{ // 기존에 있던 MyDbException을 상속 받아 데이터베이스 관련 예외라는 계층을 만들 수 있음
    // 데이터 중복인 경우에 던지는 예외
    // 특정 기술에 종속적이지 않음 !

    public MyDuplicateKeyException() {
    }

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

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

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

• 기존 사용했던 MyDbException을 상속받아서 의미있는 계층을 형성함
  • 이렇게하면 데이터베이스 관련 예외라는 계층을 만들 수 있음
• MyDuplicateKeyException은 데이터 중복의 경우에만 던져야함
• 이 예외는 우리가 직접 만든 예외이기에 JDBC나 JPA같은 특정 기술에 종속적이지 않음
  • 따라서 이 예외를 사용하더라도 서비스 계층의 순수성을 유지할 수 있음

ExTranslatorV1Test

package hello.jdbc.exception.translator;

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 javax.sql.DataSource;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.util.Random;

import static hello.jdbc.connection.ConnectionConst.*;

@Slf4j
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 {
                JdbcUtils.closeStatement(pstmt);
                JdbcUtils.closeConnection(con);
            }
        }
    }

}

리포지토리 코드

catch (SQLException e) {
                // h2 db
                if (e.getErrorCode() == 23505){ // 오류 코드가 키 중복 오류인 경우
                    throw new MyDuplicateKeyException(e); // 새로 만든 오류를 던짐
                }
                throw new MyDbException(e); // 이외의 나머지는 기존에 만든 오류를 던짐
            } 

• e.getErrroCode() == 23505
  • 오류 코드가 키 중복 오류인 경우
  • 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;
            }

• 처음에는 저장을 시도함
• 만약, 리포지토리에서 MyDuplicateKeyException 예외가 올라오면 이 예외를 잡음
• 예외를 잡아서 generateNewId(memberId)로 새로운 ID 생성 시도, 그리고 다시 저장
  • 여기가 예외를 복구하는 부분
• 만약 복구할 수 없는 예외라면 (MyDbException) 로그만 남기고 다시 예외를 던짐

실행결과

• 같은 ID를 저장했지만, 중간에 예외를 잡아서 복구한 것을 확인

• ID 뒤에 랜덤 숫자가 붙어 저장된 것을 확인

정리

• SQL ErrorCode로 데이터베이스에 어떤 오류가 있는지 확인할 수 있었음
• 예외 변환을 통해 SQLExcetpion을 특정 기술에 의존하지 않는 직접 만든 예외인 MyDuplicateKeyException으로 변환할 수 있었음
• 리포지토리 계층이 예외를 변환해준 덕분에 서비스 계층은 특정 기술에 의존하지 않는 MyDuplciateKeyException을 사용해서 문제를 복구하고, 서비스 계층의 순수성도 유지할 수 있었음

남은 문제

• SQL ErrorCode는 각각의 데이터베이스 마다 다름
  • 결과적으로 데이터베이스가 변경될 때 마다 ErrorCode도 모두 변경해야 함
• 데이터베이스가 전달하는 오류는 키 중복 뿐만아니라 락이 걸린 경우, SQL 문법에 오류가 있는 경우 등 수십 수백가지 오류코드가 존재함. 이 모든 상황에 맞는 예외를 지금처럼 다 만들어야 할까 ...?

스프링 예외 추상화 이해

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

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

• 스프링은 데이터 접근 계층에 대한 수십 가지 예외를 정리해서 일관된 예외 계층 제공
• 각각의 예외는 특정 기술에 종속적이지 않게 설계됨. 따라서 서비스 계층에서도 스프링이 제공하는 예외를 사용하면 됨. 예를 들어, 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 grammer"; // 문법이 잘못된 sql 문

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

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

SpringExceptionTranslatorTest - 추가 exceptionTranslator

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

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

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

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

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

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

각각의 DB 마다 SQL ErrorCode가 모두 다른데, 스프링은 어떻게 각각의 DB가 제공하는 SQL ErrorCode까지 고려해서 예외를 반환할 수 있을까?

• sql-error-codes.xml 파일에 명시되어 있음

스프링 예외 추상화 적용

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

MemberRepositoryV4_2

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);
        // 여러 구현체가 존재함 -> 그중에 우리는 SQLErrorCodeSQLExceptionTranslator를 사용할 예정
        // -> 이 구현체는 에러코드를 기반으로 스프링이 잡은 예외 계층으로 변환해줌
        // dataSource를 넣어주는 이유? 어떤 DB를 쓰는지 등의 정보를 찾아서 써야하기 때문
    }

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

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

    private void close(Connection con, Statement stmt, ResultSet rs) {
        JdbcUtils.closeResultSet(rs);
        JdbcUtils.closeStatement(stmt);
        DataSourceUtils.releaseConnection(con, dataSource);
    }
    private Connection getConnection() throws SQLException {
        Connection con = DataSourceUtils.getConnection(dataSource);
        log.info("get connection={}, class={}", con, con.getClass());
        return con;
    }
}

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

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

MemberServiceV4Test - 수정

        @Bean
        MemberRepository memberRepository(){
//            return new MemberRepositoryV4_1(dataSource);
           return new MemberRepositoryV4_2(dataSource);
        }

정리

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

JDBC 반복 문제 해결 - JdbcTemplate

JDBC 반복문제

• 커넥션 조회, 커넥션 동기화
• PreparedStatement 생성 및 파라미터 바인딩
• 쿼리 실행
• 결과 바인딩
• 예외 발생 시 스프링 예외 변환기 실행
• 리소스 종료
  리포지토리의 각각의 메서드를 살펴보면 상당히 많은 부분이 반복되고 있음. 이런 반복을 효과적으로 처리하는 방법이 바로 템플릿 콜백 패턴임
• 스프링은 JDBC의 반복 문제를 해결하기 위해 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 javax.sql.DataSource;

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


    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 - 수정

        @Bean
        MemberRepository memberRepository(){
//            return new MemberRepositoryV4_1(dataSource);
        //    return new MemberRepositoryV4_2(dataSource);
        return new MemberRepositoryV5(dataSource); //JdbcTemplate
        }

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

🔗 출처

• 김영한 - 스프링 DB 1편 - 데이터 접근 핵심 원리

[6om1n]

수고하셨습니당 ~~~ 😄

[YuDeokRin]

수고하셨습니다!