[스프링 DB 1편] #4. 스프링과 문제 해결 - 트랜잭션 (2)

[newh08]

트랜잭션 추상화

현재 서비스 계층은 트랜잭션 사용 위해 JDBC 의존중임 나중에 JDBC 에서 다른 기술로 변경시 이 코드를 다 변경해야함.

    public void accountTransfer(String fromId, String toId, int money) throws SQLException {

        Connection con = dataSource.getConnection(); // 커넥션 가져오기 JDBC
        try {
            con.setAutoCommit(false);
            bizLogic(fromId, toId, money, con);
            // 성공시 커밋
            con.commit();
        } catch (Exception e) {
            con.rollback();
            throw new IllegalStateException(e);
        }finally {
            if (con != null) {
                try {
                    // 위에서 autocommit 이 false 인데 그냥 풀에 반환하면 나중에 사용할때 헷갈림.
                    con.setAutoCommit(true);
                    con.close();
                } catch (Exception e) {
                    log.info("error", e);
                }
            }
        }
    }

구현기술마다 다른 트랜잭션 사용법
JDBC : con.serAutoCommit(false)
JPA : transaction.begin()

JPA 코드 예시

    public static void main(String[] args) {//엔티티 매니저 팩토리 생성
        EntityManagerFactory emf = Persistence.createEntityManagerFactory("jpabook");
        EntityManager em = emf.createEntityManager(); //엔티티 매니저 생성 
        EntityTransaction tx = em.getTransaction(); //트랜잭션 기능 획득
        try {
            tx.begin(); //트랜잭션 시작 
            logic(em); //비즈니스 로직 
            tx.commit();//트랜잭션 커밋
        } catch (Exception e) { 
            tx.rollback(); //트랜잭션 롤백
        } finally {
            em.close(); //엔티티 매니저 종료
        }
        emf.close(); //엔티티 매니저 팩토리 종료 
        }

JDBC 를 사용하면 리포지토리, 서비스 둘 다 JDBC라는 기술을 쓰므로 위와 같은 의존관계가 만들어짐.
이 때 JPA 로 바꾸면?

서비스 코드도 전부 고처야함. 단일 책임 원칙에 맞지 않음.

이를 해결하려면 트랜잭션을 추상화 하면 된다.

 public interface TxManager {
     begin();
     commit();
     rollback();
 }

트랜잭션은 사실 단순하다. 트랜잭션을 시작하고, 비즈니스 로직의 수행이 끝나면 커밋하거나 롤백하면 된다.
이 TxManager 인터페이스를 기반으로 각 기술에 맞는 구현체를 만들면 된다.

• JdbcTxManager
• JpaTxManager

서비스가 특정 트랜잭션 기술에 의존하는게 아니라 TxManager 라는 추상화 인터페이스에 의존하고 구체적인 구현체는 DI 를 통해 주입하면 된다.
스프링은 대부분의 것들이 이런식으로 추상화 되어있음!! OOP(객체 지향점 프로그래밍) 의 장점을 극대화.

클라이언트인 서비스는 인터페이스에 의존하고 DI를 사용한 덕분에 OCP 원칙을 지키게 되었다. 이제 트랜잭션 을 사용하는 서비스 코드를 전혀 변경하지 않고, 트랜잭션 기술을 마음껏 변경할 수 있다.

스프링은 이미 이런 고민을 다 해서 구현해둔 인터페이스가 있음. 이를 사용하면 된다.

스프링 트랜잭션 추상화의 핵심은 PlatformTransactionManager 인터페이스이다. org.springframework.transaction.PlatformTransactionManager

public interface PlatformTransactionManager extends TransactionManager {

        TransactionStatus getTransaction(@Nullable TransactionDefinition definition) throws TransactionException;

        void commit(TransactionStatus status) throws TransactionException;
        void rollback(TransactionStatus status) throws TransactionException;
    }

getTransaction() : 트랜잭션 시작.

• 이름이 get 인 이유는 이미 진행중인 트랜잭션이 있는 경우 해당 트랜잭션에 참여할 수 있기 때문.
• 트랜잭션 참여, 전파 라는 개념도 있음. 지금은 단순히 트랜잭션을 시작하는 것으로 이해하자.
  commit() : 트랜잭션 커밋
  rollback() : 트랜잭션 롤백

트랜잭션 동기화

이전엔 트랜잭션 동기화를 위해 파라미터로 커낵션을 전달했음.

스프링이 제공하는 트랜잭션 매니저는 크게 2가지 역할을 한다.

• 트랜잭션 추상화
• 리소스 동기화

리소스 동기화
트랜잭션을 유지하려면 트랜잭션의 시작부터 끝까지 같은 데이터베이스 커넥션을 유지해아한다. 결국 같은 커넥션을 동 기화(맞추어 사용)하기 위해서 이전에는 파라미터로 커넥션을 전달하는 방법을 사용했다.
파라미터로 커넥션을 전달하는 방법은 코드가 지저분해지는 것은 물론이고, 커넥션을 넘기는 메서드와 넘기지 않는 메 서드를 중복해서 만들어야 하는 등 여러가지 단점들이 많다.

스프링은 트랜잭션 동기화 매니저 라는것을 가지고 있다.
이것은 쓰레드 로컬 (ThreadLocal)을 사용해 커넥션을 동기화 해주는 역할. (커넥션을 안전하게 잘 보관해 주는 역할을 함)
트랜잭션 매니저는 이 트랜잭션 동기화 매니저를 사용한다. (사용해 커넥션을 보관하고 얻음)

트랜잭션 동기화 매니저는 쓰레드 로컬을 사용하기 때문에 멀티쓰레드 상황에 안전하게 커넥션을 동기화 할 수 있 다. 따라서 커넥션이 필요하면 트랜잭션 동기화 매니저를 통해 커넥션을 획득하면 된다. 따라서 이전처럼 파라미 터로 커넥션을 전달하지 않아도 된다.

트랜잭션 매니저가 커넥션 얻는 방법!

1. 트랜잭션을 시작하려면 커넥션이 필요하다. 트랜잭션 매니저는 데이터소스를 통해 커넥션을 만들고 트랜잭션을 시작한다. (setAutoCommit false)
2. 트랜잭션 매니저는 트랜잭션이 시작된 커넥션을 트랜잭션 동기화 매니저에 보관한다.
3. 리포지토리는 트랜잭션 동기화 매니저에 보관된 커넥션을 꺼내서 사용한다. 따라서 파라미터로 커넥션을 전달하지 않아도 된다.
4. 트랜잭션이 종료되면 트랜잭션 매니저는 트랜잭션 동기화 매니저에 보관된 커넥션을 통해 트랜잭션을 종료하고, 커넥션도 닫는다.

트랜잭션 동기화 매니저
다음 트랜잭션 동기화 매니저 클래스를 열어보면 쓰레드 로컬을 사용하는 것을 확인할 수 있다.
org.springframework.transaction.support.TransactionSynchronizationManager

참고
쓰레드 로컬을 사용하면 각각의 쓰레드마다 별도의 저장소가 부여된다. 따라서 해당 쓰레드만 해당 데이터에 접근 할 수 있다.

트랜잭션 문제 해결 - 트랜잭션 매니저1

코드로 적용해보기.
Connection 얻기 + 닫기 방법 변경
con 을 파라미터로 사용하던 메서드 지우기

/**
 * 트랜잭션 - 트랜잭션 매니저
 * 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; // 이걸 가지고 DB 에 쿼리를 날림.

        try {
            con = getConnection();
            pstmt = con.prepareStatement(sql);
            // 위의 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 해야함. connection 을 안닫아주면 계속 열린체로 유지될 수 도.
            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);

            // 쿼리의 결과를 ResultSet 으로 반환함.
            rs = pstmt.executeQuery();
            // rs 에서 값을 꺼내야함.
            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.error("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);
            int resultSize = pstmt.executeUpdate();
            log.info("resultSize={}", resultSize);
        } catch (SQLException e) {
            log.error("db 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);
            int resultSize = pstmt.executeUpdate();
            log.info("resultSize={}", resultSize);
        } catch (SQLException e) {
            log.error("db error", e);
            throw e;
        }finally {
            close(con, pstmt, null);
        }
    }

    private void close(Connection con, Statement stmt, ResultSet rs) {
        // 더 잘 짜야진 close 코드
        JdbcUtils.closeResultSet(rs);
        JdbcUtils.closeStatement(stmt);
        // 주의! 트랜잭션 동기화를 사용하려면 DataSourceUtils 를 사용해야함.
        DataSourceUtils.releaseConnection(con, dataSource);
        //JdbcUtils.closeConnection(con);
    }

    private Connection getConnection() throws SQLException {
        // 트랜잭션 동기화를 사용하려면 DataSourceUtils 를 사용해야 함.
        Connection con = DataSourceUtils.getConnection(dataSource);
        log.info("get connection = {}, class = {}", con, con.getClass());
        return con;
    }
}

DataSourceUtils.getConnection()
트랜잭션 동기화 매니저에 관리하는 커넥션이 있으면 해당 커넥션 반환!
없으면 커넥션을 새로 생성해서 반환 (트랜잭션을 사용하지 않는 경우!)

DataSourceUtils.releaseConnection()
커넥션을 con.close() 로 닫아버리면 커넥션이 유지되지 않는 문제 발생.
이 커넥션은 트랜잭션 종료 (커밋 or 롤백) 할 때 까지 살아있어야함.
이 메서드를 사용하면
트랜잭션 위해 동기화된 커넥션은 닫지 않고 유지,
트랜잭션 동기화 매니저가 관리하는 커넥션이 아닌 경우 커넥션을 닫음.

이제 서비스 코드 작성해보자.
기존 서비스 코드에서 문제 :

    private final DataSource dataSource;

/**
 * 트랜잭션 - 트랜잭션 매니저
 */
@RequiredArgsConstructor
@Slf4j
public class MemberServiceV3_1 {

    //    private final DataSource dataSource;
    private final PlatformTransactionManager transactionManager;
    private final MemberRepositoryV3 memberRepositoryV3;


    public void accountTransfer(String fromId, String toId, int money) throws SQLException {

        // Connection con = dataSource.getConnection();
        // 트랜잭션 시작
        TransactionStatus status = transactionManager.getTransaction(
                new DefaultTransactionDefinition());// 안에 파라미터는 옵션임
        try {
            bizLogic(fromId, toId, money);
            // 성공시 커밋
            transactionManager.commit(status);
        } catch (Exception e) {
            transactionManager.rollback(status); // 트랜잭션 매니저가 커밋 or 롤백 하면 커넥션 다 정리해줌.
            throw new IllegalStateException(e);
        }
    }


    private void bizLogic(String fromId, String toId, int money) throws SQLException {
        // 비즈니스 로직
        Member fromMember = memberRepositoryV3.findById(fromId);
        Member toMember = memberRepositoryV3.findById(toId);
        memberRepositoryV3.update(fromId, fromMember.getMoney() - money);
        // 예외 발생
        validation(toMember);
        memberRepositoryV3.update(toId, toMember.getMoney() + money);
    }

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

private final PlatformTransactionManager transactionManager
트랜잭션 메니저를 사용 기술에 따라 구현체를 주입하면 된다.
transactionManager.getTransaction() : 트랜잭션을 시작한다.
TransactionStatus status 를 반환한다. 현재 트랜잭션의 상태 정보가 포함되어 있다. 이후 트랜잭션을 커밋, 롤백할 때 필요하다.

테스트해보자.

    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); // JDBC
        memberService = new MemberServiceV3_1(transactionManager, memberRepository);
    }

테스트 코드에서 이 부분만 변경.
new DataSourceTransactionManager(dataSource);
에서 dataSource가 빠졌을 때 오류가 발생했는데,
이는 트랜잭션 매니저에서 커넥션을 만들 때 dataSource 가 없으니 커넥션을 만들지 못해서 발생한 오류.

Service 에서 DataSourceTransactionManager 를 주입받음.
Service 에서 로직호출시 커넥션을 받기 위해 트랜잭션 매니저에서 커넥션 획득함.
그럼 트랜잭션 매니저가 케넥션의 setAutocommit(false) 를 하고 트랜잭션 동기화 매니저에 보관함.
(리포지토리) 이후 비즈니스 로직 수행! (앞으로 커넥션은 트랜잭션 동기화 매니저에서 획득)
(리포지토리) 끝나면 close 를 하는데 release 시 트랜잭션 동기화 매니저에서 꺼낸거면 커넥션을 닫지 않고 그냥 넘김.
이후 Service 로 돌아와 commit 호출 리소스를 릴리즈하고 트랜잭션 동기화 매니저에 있던 것도 정리함.

트랜잭션 문제 해결 - 트랜잭션 매니저2

앞서 했던 로직을 그림으로 정리하며 복습하자.
이 전체적인 동작 흐름을 잘 이해해야함!!

** 트랜잭션 시작**
클라이언트의 요청으로 서비스 로직을 실행한다.

1. 서비스 계층에서 transactionManager.getTransaction() 을 호출해서 트랜잭션을 시작한다.
2. 트랜잭션을 시작하려면 먼저 데이터베이스 커넥션이 필요하다. 트랜잭션 매니저는 내부에서 데이터소스를 사용해서 커넥션을 생성한다.
3. 커넥션을 수동 커밋 모드로 변경해서 실제 데이터베이스 트랜잭션을 시작한다.
4. 커넥션을 트랜잭션 동기화 매니저에 보관한다.
5. 트랜잭션 동기화 매니저는 쓰레드 로컬에 커넥션을 보관한다. 따라서 멀티 쓰레드 환경에 안전하게 커넥션을 보관할 수 있다.

로직 실행
6. 서비스는 비즈니스 로직을 실행하면서 리포지토리의 메서드들을 호출한다. 이때 커넥션을 파라미터로 전달하지 않는다.
7. 리포지토리 메서드들은 트랜잭션이 시작된 커넥션이 필요하다. 리포지토리는 DataSourceUtils.getConnection() 을 사용해서 트랜잭션 동기화 매니저에 보관된 커넥션을 꺼내서 사용한다. 이 과정을 통해서 자연스럽게 같은 커넥션을 사용하고, 트랜잭션도 유지된다.
8. 획득한 커넥션을 사용해서 SQL을 데이터베이스에 전달해서 실행한다.

트랜잭션 종료
9. 비즈니스 로직이 끝나고 트랜잭션을 종료한다. 트랜잭션은 커밋하거나 롤백하면 종료된다.
10. 트랜잭션을 종료하려면 동기화된 커넥션이 필요하다. 트랜잭션 동기화 매니저를 통해 동기화된 커넥션을 획득한다.
11. 획득한 커넥션을 통해 데이터베이스에 트랜잭션을 커밋하거나 롤백한다.
12. 전체 리소스를 정리한다.

• 트랜잭션 동기화 매니저를 정리한다. 쓰레드 로컬은 사용후 꼭 정리해야 한다.
• con.setAutoCommit(true) 로 되돌린다. 커넥션 풀을 고려해야 한다.
• con.close() 를 호출해셔 커넥션을 종료한다. 커넥션 풀을 사용하는 경우 con.close() 를 호출하면 커넥션 풀에 반환된다.

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

[YuDeokRin]

오 윤혁님 고생하셨습니다!