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

[seyxxn]

4. 스프링과 문제 해결 - 트랜잭션 (1)

#️⃣ 목차

• 문제점들
• 트랜잭션 추상화
• 트랜잭션 동기화
• 트랜잭션 문제 해결 - 트랜잭션 매니저1
• 트랜잭션 문제 해결 - 트랜잭션 매니저2

문제점들

애플리케이션 구조

여러가지 애플리케이션 구조가 있지만, 가장 단순하면서 많이 사용하는 방법은 역할에 따라 3가지 계층으로 나누는 것임

• 프레젠테이션 계층
  • UI와 관련된 처리 담당
  • 웹 요청과 응답
  • 사용자 요청을 검증
  • 주 사용 기술 : 서블릿과 HTTP 같은 웹 기술, 스프링 MVC
• 서비스 계층
  • 비즈니스 로직을 담당
  • 주 사용 기술 : 가급적 특정 기술에 의존하지 않고, 순수 자바 코드로 작성
• 데이터 접근 계층
  • 실제 데이터베이스에 접근하는 코드
  • 주 사용 기술 : JDBC, JPA, File, Redis, Mongo ...

순수한 서비스 계층

• 가장 중요한 곳은 핵심 비즈니즈 로직이 들어있는 서비스 계층이다.
  • 시간이 흘러서 UI와 관련된 부분이 변경되어도 비즈니스 로직은 최대한 변경없이 유지되어야 함
  • 이렇게하려면 서비스 계층을 특정 기술에 종속되지 않게 개발해야 함

문제점들

서비스 계층을 순수하게 유지하려면 어떻게 해야할까?

• 기존 코드를 먼저 살펴보자

MemberServiceV1

@RequiredArgsConstructor
public class MemberServiceV1 {
    private final MemberRepositoryV1 memberRepository;

    public void accountTransfer(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);

        // 커밋, 롤백
    }
}

• MemberServiceV1은 특정 기술에 종속적이지 않고, 순수한 비즈니스 로직만 존재함
• 특정 기술과 관련된 코드가 거의 없음
• 향후 비즈니스 로직의 변경이 필요하면 이 부분을 변경하면 됨

하지만, 여기에도 남은 문제가 있음 (지금 단계에서서는 참고만)

• SQLException` 이라는 JDBC 기술에 의존한다는 점
• 이 부분은 memberRepository 에서 올라오는 예외이기 때문에 memberRepository 에서 해결해야 함
• MemberRepositoryV1 이라는 구체 클래스에 직접 의존하고 있음
  • MemberRepository 인터페이스를 도입하면 향후 MemberService 의 코드의 변경 없이 다른 구현 기술로 손쉽게 변경할 수 있음

MemberServiceV2

트랜잭션을 적용한 MemberServiceV2 코드를 살펴보자

/**
 * 트랜잭션 - 파라미터 연동, 풀을 고려한 종료
 */
@Slf4j
@RequiredArgsConstructor
public class MemberServiceV2 {
    private final DataSource dataSource;
    private final MemberRepositoryV2 memberRepository;

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

        Connection con = dataSource.getConnection();
        try {
            con.setAutoCommit(false); // 트랜잭션 시작
            // 비즈니스 로직 수행
            bizLogic(con, fromId, toId, money);
            con.commit(); // 성공시 커밋
        } catch (Exception e){
            con.rollback(); // 실패시 롤백
            throw new IllegalStateException(e);
        } finally {
            release(con);
        }
    }

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

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

• 트랜잭션은 비즈니스 로직이 있는 서비스 계층에서 시작하는 것이 좋음
• 그런데 문제는 트랜잭션을 사용하기 위해서 javax.sql.DataSource, java.sql.Connection, java.sql.SQLException과 같은 JDBC 기술에 의존해야한다는 점임
• 트랜잭션을 사용하기 위해 JDBC 기술에 의존함. 결과적으로 비즈니스 로직보다 JDBC를 사용해서 트랜잭션을 처리하는 코드가 더 많음
• 향후 JDBC에서 JPA 같은 다른 기술로 바꾸어 사용하게 되면 서비스 코드도 모두 함께 변경해야 함 (JPA는 트랜잭션을 사용하는 코드가 JDBC와 다름)
• 핵심 비즈니스 로직과 JDBC 기술이 섞여 있어서 유지보수하기 어려움

문제 정리

지금까지 우리가 개발한 애플리케이션의 문제점은 크게 3가지

• 트랜잭션 문제
• 예외 누수 문제
• JDBC 반복 문제

트랜잭션 문제

가장 큰 문제는 트랜잭션을 적용하면서 생긴 다음과 같은 문제들

• JDBC 구현 기술이 서비스 계층에 누수되어 문제
  • 트랜잭션을 적용하기 위해 JDBC 구현 기술이 서비스 계층에 누수됨
  • 서비스 계층은 순수해야 함 -> 구현 기술을 변경해도 서비스 계층 코드는 최대한 유지할 수 있어야 함
    • 그래서 데이터 접근 계층에 JDBC 코드를 다 몰아두는 것임
    • 물론 데이터 접근 계층의 구현 기술이 변경될 수도 있으니 데이터 접근 계층은 인터페이스를 제공하는 것이 좋음
  • 서비스 계층은 특정 기술에 종속되지 않아야 함
• 트랜잭션 동기화 문제
  • 같은 트랜잭션을 유지하기 위해 커넥션을 파라미터로 넘겨야 함
  • 이때 파생되는 문제들이 있음. 똑같은 기능고 트랜잭션용 기능과 트랜잭션을 유지하지 않아도 되는 기능으로 분리해야 함
• 트랜잭션 적용 반복 문제
  • 트랜잭션 적용 코드를 보면 반복이 많음 (try, catch, finally)

예외 누수

• 데이터 접근 계층의 JDBC 구현 기술 예외가 서비스 계층으로 전파됨
• SQLException은 체크 예외이기 때문에 데이터 접근 계층을 호출한 서비스 계층에서 해당 예외를 잡아서 처리하거나 명시적으로 throws를 통해서 다시 밖으로 던져야 함
• SQLException은 JDBC 전용 기술임. 향후 JPA나 다른 데이터 접근 기술을 사용하면, 그에 맞는 다른 예외로 변경해야 하고, 결국 서비스 코드도 수정해야 함

JDBC 반복 문제

• 지금까지 작성한 MemberRepository 코드는 순수한 JDBC를 사용함
• 이 코드들은 유사한 코드의 반복이 너무 많음 (try, catch, finally, 커넥션 열고 ptmtm 사용, 결과 패핑, 커넥션 리소스 정리 등)

트랜잭션 추상화

현재 서비스 계층은 트랜잭션을 사용하기 위해 JDBC 기술에 의존하고 있음

• 향후, JDBC에서 JPA 같은 다른 데이터 접근 기술로 변경한다면, 서비스 계층의 트랜잭션 관련 코드도 모두 함께 수정해야 . 하하

구현 기술에 따른 트랜잭션 사용법

• 트랜잭션을 원자적 단위의 비즈니스 로직을 처리하기 위해 사용함
  • JDBC : con.setAutoCommit(false)
  • JPA : transaction.begin()

JDBC 트랜잭션 코드 예시

public void accountTransfer(String fromId, String toId, int money) throws SQLException {
    Connection con = dataSource.getConnection();
    try {
        con.setAutoCommit(false); //트랜잭션 시작
        //비즈니스 로직
        bizLogic(con, fromId, toId, money);
        con.commit(); //성공시 커밋
        }
    catch (Exception e) {
        con.rollback(); //실패시 롤백
    throw new IllegalStateException(e);
        } finally {
    release(con);
        }
    }

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 기술로 변경하게 되면 서비스 계층의 트랜잭션을 처리하는 코드도 모두 함께 변경해야 함

JDBC 트랜잭션 의존

JDBC 기술 -> JPA 기술로 변경

• 이렇게 JDBC 기술을 사용하다가 JPA 기술로 변경하게 되면, 서비스 계층의 코드도 JPA 기술을 사용하도록 함께 수정해야 함

트랜잭션 추상화

이 문제를 해결하려면, 트랜잭션 기능을 추상화하면 됨 !

• 다음과 같은 인터페이스를 사용할 수 있음

트랜잭션 추상화 인터페이스

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

• 트랜잭션은 단순함. 트랜잭션을 시작하고, 비즈니스 로직의 수행이 끝나면 커밋하거나 롤백하면 됨
• 그리고 다음과 같이 TxManager 인터페이스를 기반으로 각각의 기술에 맞는 구현체를 만들면 됨
  • JdbcTxManager : JDBC 트랜잭션 기능을 제공하는 구현체
  • JpaTxManager : JPA 트랜잭션 기능을 제공하는 구현체

트랜잭션 추상화와 의존관계

• 서비스는 특정 트랜잭션에 의존하는 것이 아니라, TxManager라는 추상화된 인터페이스에 의존함
  • 이제 원하는 구현체를 DI를 통해 주입하면 됨.
  • 예를 들어, JDBC 트랜잭션 기능이 필요하다면 JdbcTxManager를 서비스에 주입하고, JPA 트랜잭션 기능으로 변경해야 하면 JpaTxManager를 주입하면 됨
• 클라이언트인 서비스는 인터페이스에 의존하고 DI를 사용한 덕분에 OCP 원칙을 지키게 됨
  • 이제 트랜잭션을 사용하는 서비스 코드를 전혀 변경하지 않고, 트랜잭션 기술을 변경할 수 있게됨

스프링의 트랜잭션 추상화

• 스프링에서 제공하는 트랜잭션 추상화 기술을 사용하면 됨
• 데이터 접근 기술에 따른 트랜잭션 구현체도 대부분 만들어두어서 가져다 사용하기만 하면 됨

• 스프링 트랜잭션 추상화의 핵심은 PlatformTransactionManager 인터페이스임

PlatformTransactionManager 인터페이스

package org.springframework.transaction;

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() : 트랜잭션을 시작

  • 이름이 getTransaction()인 이유 : 기존에 이미 진행중인 트랜잭션이 있는 경우 해당 트랜잭션에 참여할 수 있기 때문
  • 참고로, 트랜잭션 참여, 전파에 대한 부분은 뒤에서 설명함

• commit() : 트랜잭션 커밋

• rollback() : 트랜잭션 롤백

• 앞으로 platformTransactionManager 인터페이스와 구현체를 포함해서 트랜잭션 매니저로 이야기 함

트랜잭션 동기화

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

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

트랜잭션 추상화

앞에서 설명함

리소스 동기화

트랜잭션을 유지하려면 시작부터 끝까지 같은 데이터베이스 커넥션을 유지해야 함

• 결국, 같은 커넥션을 동기화(맞추어 사용)하기 위해서 이전에는 파라미터로 커넥션을 전달하는 방법을 사용함
• 파라미터로 커넥션을 전달하는 것은 코드가 지저분해지고, 커넥션을 넘기는 메서드와 넘기지 않는 메서드를 중복해서 만들어야 하는 등 여러가지 단점들이 많음

커넥션과 세션

트랜잭션 매니저와 트랜잭션 동기화 매니저

• 스프링은 트랜잭션 동기화 매니저를 제공함
  • 이것은 쓰레드 로컬(ThreadLocal)을 사용해서 커넥션을 동기화해줌
  • 트랜잭션 매니저는 내부에서 이 트랜잭션 동기화 매니저를 사용함
• 트랜잭션 동기화 매니저는 쓰레드 로컬을 사용하기 때문에 멀티쓰레드 상황에 안전하게 커넥션을 동기화할 수 있음
  • 따라서, 커넥션이 필요하면 트랜잭션 동기화 매니저를 통해 커넥션을 획득하면 됨!
  • 따라서 이전처럼 파라미터로 커넥션을 전달하지 않아도 됨

동작방식 설명

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

정리

• 커넥션을 예전처럼 파라미터로 전달할 필요가 없어짐 !
• 트랜잭션 매니저가 트랜잭션을 시작하면 트랜잭션 동기화 매니저에 커넥션을 보관해놓음
• 그리고선, 필요할 때 트랜잭션 동기화 매니저를 통해서 꺼내 쓰면 됨

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

본격적으로 애플리케이션 코드에 트랜잭션 매니저를 적용해보자

MemberRepositoryV3

/**
 * 트랜잭션 - 트랜잭션 매니저
 * DataSourceUtils.getConnection()을 사용할 예정 -> 트랜잭션 동기화 매니저에 접근해서 커넥션을 가져오는 것
 * DataSourceUtils.releaseConnection() 사용예정 -> 커넥션을 닫는 것
 */
@Slf4j
public class MemberRepositoryV3 {

    private final DataSource dataSource;

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

    // save(), findById(), update(), delete() 등 ..

    // 수정
    private void close(Connection con, Statement stmt, ResultSet rs) throws SQLException {
        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()

• getConnection()에서 DataSourceUtils.getConnection()를 사용하도록 변경된 부분을 특히 주의해야 함
• DataSourceUtils.getConnection()는 다음과 같이 동작함
  • 트랜잭션 동기화 매니저가 관리하는 커넥션이 있으면 해당 커넥션을 반환함
  • 트랜잭션 동기화 매니저가 관리하는 커넥션이 없는 경우 새로운 커넥션을 생성해서 반환함

DataSourceUtils.releaseConnection()

• close()에서 DataSourceUtils.releaseConnection()를 사용하도록 바뀐 부분을 특히 주의하기
  • 커넥션을 con.close()를 사용해서 직접 닫아버리면 커넥션이 유지되지 않는 문제가 발생함
  • 이 커넥션은 이후 로직은 물론이고, 트랜잭션을 종료(커밋, 롤백)할 때 까지 살아있어야 함
• DataSourceUtils.releaseConnection()을 사용하면 커넥션을 바로 닫는 것이 아님
  • 트랜잭션을 사용하기 위해 동기화된 커넥션은 커넥션을 닫지 않고 그대로 유지해줌
  • 트랜잭션 동기화 매니저가 관리하는 커넥션이 없는 경우 해당 커넥션을 닫음

MemberServiceV3_1

트랜잭션 매니저를 사용하는 서비스 코드

/**
 * 트랜잭션 - 트랜잭션 매니저
 */
@Slf4j
@RequiredArgsConstructor
public class MemberServiceV3_1 {
//    private final DataSource dataSource;
    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);
        }
        // 트랜잭션이 자동으로 릴리즈해주기 때문에 finally 필요없음
    }

    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("이체중 예외 발생");
        }
    }
}

• private final PlatformTransactionManager transactionManager

  • 트랜잭션 매니저 주입받음. 지금은 JDBC 기술을 사용하기에, DataSourceTransactionManager 구현체를 주입받아야 함
  • JPA 같은 기술로 변경되면 JpaTransactionManager를 주입받으면 됨

• transactionManager.getTransaction()

  • 트랜잭션 시작
  • TransactionStatus status를 반환함. 현재 트랜잭션의 상태 정보가 포함되어 있음. 이후 트랜잭션을 커밋, 롤백할 때 필요함

• new DefaultTransactionDefinition()

  • 트랜잭션과 관련된 옵션을 지정할 수 있음

• transactionManager.commit(status)

  • 트랜잭션이 성공하면 이 로직을 호출해서 커밋하면 됨

• transactionManager.rollback(status)

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

MemberServiceV3_1Test

/**
 * 트랜잭션 - 트랜잭션 매니저
 * */
class MemberServiceV3_1Test {
    private MemberRepositoryV3 memberRepository;
    private MemberServiceV3_1 memberService;
    @BeforeEach
    void before() { // 초기화 코드 
        DriverManagerDataSource dataSource = new DriverManagerDataSource(URL, USERNAME, PASSWORD);
        memberRepository = new MemberRepositoryV3(dataSource);

        DataSourceTransactionManager transactionManager = new DataSourceTransactionManager(dataSource);
        memberService = new MemberServiceV3_1(transactionManager, memberRepository);
    }
    
    // 코드 생략 ...
}

• new DataSourceTransactionManager(dataSource)
  • JDBC 기술을 사용하므로, JDBC용 트랜잭션 매니저(DataSourceTransactionManager)를 선택해서 서비스에 주입함
  • 트랜잭션 매니저는 데이터소스를 통해 커넥션을 생성하므로 DataSource가 필요함

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

트랜잭션 매니저의 전체 동작 흐름을 살펴보자

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

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

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

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

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

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

9. 비즈니스 로직이 끝나고 트랜잭션을 종료. 트랜잭션은 커밋하거나 롤백하면 종료
10. 트랜잭션을 종료하려면 동기화된 커넥션이 필요함. 트랜잭션 동기화 매니저를 통해 동기화된 커넥션을 획득함
11. 획득한 커넥션을 통해 데이터베이스에 트랜잭션을 커밋하거나 롤백
12. 전체 리소스를 정리
    • 트랜잭션 동기화 매니저를 정리. 쓰레드 로컬은 사용후 꼭 정리해야 함
    • con.setAutoCommit(true) 로 되돌림. 커넥션 풀을 고려해야 함
    • con.close() 를 호출해셔 커넥션을 종료. 커넥션 풀을 사용하는 경우
    • con.close() 를 호출하면 커넥션 풀에 반환

🔗 출처

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

[YuDeokRin]

고생하셨습니다. !