[Spring] 트랜잭션 매니저

https://drcode-devblog.tistory.com/590

[Spring] 트랜잭션 추상화와 동기화 (스프링으로 트랜잭션 문제점 해결)

 

트랜잭션 추상화와 동기화를 적용하는 예제를 작성해보자.

 

MemberRepositoryV3

package hello.jdbc.repository;

import hello.jdbc.domain.Member;
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;

/**
 * 트랜잭션 - 트랜잭션 매니저
 * DataSourceUtils.getConnection()
 * DataSourceUtils.releaseConnection()
 * */
@Slf4j
public class MemberRepositoryV3 {

    private final DataSource dataSource;

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

    public Member save(Member member) throws SQLException {
        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) {
            log.error("db error", e);
            throw e;
        } finally {
            close(con, pstmt, null);
        }
    }

    public Member findById(String memberId) throws SQLException {
        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) {
            log.info("db error", e);
            throw e;
        } finally {
            close(con, pstmt, rs);
        }
    }

    public void update(String memberId, int money) throws SQLException {
        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) {
            log.info("error", e);
            throw e;
        } finally {
            close(con, pstmt, null);
        }
    }

    public void delete(String memberId) throws SQLException {
        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) {
            log.info("error", e);
            throw 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={}, class={}", con, con.getClass());
        return con;
    }
}

 

커넥션을 파라미터로 전달하는 부분들을 모두 제거하였다.

 

DataSourceUtils.getConnection()

getConnection() 에서 DataSourceUtils.getConnection() 를 사용하도록 변경된 부분을 주의해야한다.

 

DataSourceUtils.getConnection() 는

  트랜잭션 동기화 매니저가 관리하는 커넥션이 있으면 해당 커넥션을 반환한다.

  트랜잭션 동기화 매니저가 관리하는 커넥션이 없으면 새로운 커넥션을 생성해서 반환한다.

 

DataSourceUtils.releaseConnection()

  close() 에서 DataSourceUtils.releaseConnection()를 사용하도록 변경된 부분을 특히 주의 해야함.

  커넥션을 con.close()를 사용해서 직접 닫아버리면 커넥션이 유지되지 않는 문제가 발생한다.

  이 커넥션은 이후 로직은 물론, 트랜잭션 종료(커밋, 롤백)할 때까지 살아있어야 한다.

 

  DataSourceUtils.releaseConnection() 을 사용하면 커넥션을 바로 닫는 것이 아니다.

    트랜잭션을 사용하기 위해 동기화된 커넥션은 커넥션을 닫지 않고 그대로 유지해준다.

    트랜잭션 동기화 매니저가 관리하는 커넥션이 없는 경우 해당 커넥션을 닫는다.

 

MemberServiceV3_1

 

package hello.jdbc.service;

import hello.jdbc.domain.Member;
import hello.jdbc.repository.MemberRepositoryV1;
import hello.jdbc.repository.MemberRepositoryV3;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.TransactionStatus;
import org.springframework.transaction.support.DefaultTransactionDefinition;

import java.sql.SQLException;

/**
 * 트랜잭션 - 트랜잭션 매니저
 * **/

@Slf4j
@RequiredArgsConstructor
public class MemberServiceV3_1 {

    private final PlatformTransactionManager transactionManager;
    private final MemberRepositoryV3 memberRepository;

    public void accountTransfer(String fromId, String toId, int money) throws SQLException {
        // 트랜잭션 시작
        TransactionStatus status = transactionManager.getTransaction(new DefaultTransactionDefinition());

        try {
            // 비즈니스 로직
            bizLogic(fromId, toId, money);
            transactionManager.commit(status); // 성공시 커밋
        } catch (Exception e) {
            transactionManager.rollback(status); // 실패시 롤백
            throw new IllegalStateException(e);
        }
    }

    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 void validation(Member toMember) {
        if(toMember.getMemberId().equals("ex")) {
            throw new IllegalStateException("이체중 예외 발생");
        }
    }
}

 

private final PlatformTransactionManager transactionManager

  트랜잭션 매니저를 주입 받는다. 지금은 JDBC 기술을 사용하기 때문에

  DataSourceTransactionManager 구현체를 주입 받아야 한다

  JPA로 변경되면 JpaTransactionManager를 주입 받으면 된다.

 

transactionManager.getTransaction()

  트랜잭션을 시작하는 행위의 메서드

  TransactionStatus status 를 반환한다. 현재 트랜잭션의 상태 정보가 포함되어 있어,

  이후 트랜잭션을 커밋하거나 롤백 시에 필요한 데이터이다.

 

new DefaultTransactionDefinition()

  트랜잭션과 관련된 옵션을 지정할 수 있다.

 

transactionManager.commit(status)

  트랜잭션이 성공하면 이 로직을 호출해서 커밋하면 된다.

 

transactionManager.rollback(status)

  문제가 발생하면 이 로직을 호출해서 트랜잭션을 롤백하면 된다.

 

MemberServiceV3_1Test

package hello.jdbc.service;

import hello.jdbc.domain.Member;
import hello.jdbc.repository.MemberRepositoryV2;
import hello.jdbc.repository.MemberRepositoryV3;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.jdbc.datasource.DriverManagerDataSource;
import org.springframework.transaction.PlatformTransactionManager;

import java.sql.SQLException;

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

/**
 *  트랜잭션 - 트랜잭션 매니저
 * */
@Slf4j
class MemberServiceV3_1Test {

    public static final String Member_A = "memberA";
    public static final String Member_B = "memberB";
    public static final String Member_EX = "ex";

    private MemberRepositoryV3 memberRepository;
    private MemberServiceV3_1 memberService;

    @BeforeEach
    void before() {
        DriverManagerDataSource dataSource = new DriverManagerDataSource(URL, USERNAME, PASSWORD);
        memberRepository = new MemberRepositoryV3(dataSource);
        PlatformTransactionManager transactionManager = new DataSourceTransactionManager(dataSource);
        memberService = new MemberServiceV3_1(transactionManager, memberRepository);
    }

    @AfterEach
    void after() throws SQLException {
        memberRepository.delete("memberA");
        memberRepository.delete("memberB");
        memberRepository.delete("ex");
    }

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

        // when
        log.info("TX START");
        memberService.accountTransfer(memberA.getMemberId(), memberB.getMemberId(), 2000);
        log.info("TX END");

        // 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("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);

    }
}

 

 

@BeforeEach
void before() {
    DriverManagerDataSource dataSource = new DriverManagerDataSource(URL, USERNAME, PASSWORD);
    memberRepository = new MemberRepositoryV3(dataSource);
    PlatformTransactionManager transactionManager = new DataSourceTransactionManager(dataSource);
    memberService = new MemberServiceV3_1(transactionManager, memberRepository);
}

 

new DataSourceTransactionManager(dataSource)

  JDBC 기술을 사용하므로, JDBC용 트랜잭션 매니저(DataSourceTransactionManager)를 선택해서 서비스에 주입한다.

  트랜잭션 매니저는 데이터소스를 통해 커넥션을 생성하므로 DataSource가 필요하다.

 

트랜잭션 매니저 - 트랜잭션 시작

트랜잭션 시작

클라이언트의 요청으로 서비스 로직을 실행한다.

1. 서비스 계층에서 transactionManager.getTransaction()을 호출해서 트랜잭션을 시작한다.

2. 트랜잭션을 시작하려면 먼저 DB 커넥션이 필요하다. Tx 매니저는 내부에서 DataSource를 사용해서 커넥션을 생성한다

3. 커넥션을 수동 커밋 모드로 변경해서 실제 DB 트랜잭션을 시작한다.

4. 커넥션을 Tx 동가화 매니저에 보관한다.

5. Tx 동기화 매니저는 쓰레드 로컬에 커넥션을 보관한다. 따라서 멀티 쓰레드 환경에서 안전하게 커넥션 보관이 가능하다

 

트랜잭션 매니저 - 로직 실행

 

로직 실행

6. 서비스는 비즈니스 로직을 실행하면서 리포지토리의 메서드를 호출한다. 이때 커넥션을 파라미터로 전달하지 않는다.

7. 리포지토리 메서드들은 트랜잭션이 시작된 커넥션이 필요하다.

    리포지토라는 DataSourceUtils.getConnection()을 사용해서 Tx 동기화 매니저에 보관된 커넥션을 꺼내서 사용한다.

    이 과정을 통해서 자연스럽게 이전과 동일한 커넥션을 사용하고 Tx 도 유지된다.

8. 획득한 커넥션을 사용해서 SQL을 DB에 전달해서 실행한다.

 

트랜잭션 매니저 - 트랜잭션 종료

트랜잭션 종료

9. 비즈니스 로직이 끝나고 트랜잭션을 종료한다. 트랜잭션은 커밋하거나 롤백하면 종료된다.

10. Tx 를 종료하려면 동기화된 커넥션이 필요하다. Tx 동기화 매니저를 통해 동기화된 커넥션을 획득한다.

11. 획득한 커넥션을 통해 DB에 Tx을 커밋하거나 롤백한다.

12. 전체 리소스를 정리한다.

     - Tx 동기화 매니저를 정리한다. 쓰레드 로컬은 사용 후 꼭 정리한다.

     - con.setAutoCommit(true)로 되돌린다. 커넥션 풀을 고려해야 한다.

     - con.close() 를 호출해서 커넥션을 종료한다. 커넥션 풀을 사용하는 경우, con.close()를 호출하면 커넥션 풀에 반환된다.

 

 

정리하면, 

※ Tx 추상화 덕분에 서비스 코드는 이제 JDBC 기술에 의존하지 않는다.

이후 JDBC에서 JPA 로 변경해도 서비스 코드를 그대로 유지할 수 있다.

기술 변경 시 의존관계 주입만 DataSourceTransactionManager 에서 JpaTransactionManager로 변경해주면 된다.

java.sql.SQLException 이 아직 남아있지만, 예외로 처리할 수 있다.

 

※ 트랜잭션 동기화 매니저 덕분에 커넥션을 파라미터로 넘기지 않아도 된다.