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

[seyxxn]

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

#️⃣ 목차

• 트랜잭션 문제 해결 - 트랜잭션 템플릿
• 트랜잭션 문제 해결 - 트랜잭션 AOP 이해
• 트랜잭션 문제 해결 - 트랜잭션 AOP 적용
• 트랜잭션 문제 해결 - 트랜잭션 AOP 정리
• 스프링 부트의 자동 리소스 등록

트랜잭션 문제 해결 - 트랜잭션 템플릿

트랜잭션을 사용하는 로직을 살펴보면 다음과 같은 패턴이 반복되는 것이 보임

트랜잭션 사용 코드

        // 트랜잭션 시작
        TransactionStatus status = transactionManager.getTransaction(new DefaultTransactionDefinition());

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

• 트랜잭션을 시작하고, 비즈니스 로직 실행, 성공하면 커밋, 예외가 발생해서 실패하면 롤백함
• 다른 서비스에서 트랜잭션을 시작하려면 try, catch, finally를 포함한 성공시 커밋, 롤백 코드가 반복될 것임
• 이런 형태는 각각의 서비스에서 반복된다는 문제점이 존재. 달라지는 부분은 비즈니스 로직일 뿐
  • 이럴 때, 템플릿 콜백 패턴을 활용하면 이런 반복 문제를 깔끔하게 해결할 수 있음!

트랜잭션 템플릿

템플릿 콜백 패턴을 적용하려면 템플릿이 제공하는 클래스를 작성해야 하는데, 스프링은 TransactionTemplate라는 템플릿 클래스를 제공함

TransactionTemplate

public class TransactionTemplate {

    private PlatformTransactionManager transactionManager;

    public <T> T execute(TransactionCallback<T> action){..}
    // 응답 값이 있을 때 사용

    void executeWithoutResult(Consumer<TransactionStatus> action){..}
    // 응답 값이 없을 때 사용
}

MemberServiceV3_2

트랜잭션 템플릿을 사용해서 반복하는 부분을 제거해보자

/**
 * 트랜잭션 - 트랜잭션 템플릿
 */
@Slf4j
@RequiredArgsConstructor
public class MemberServiceV3_2 {

    private final TransactionTemplate txTemplate;
    private final MemberRepositoryV3 memberRepository;

    public MemberServiceV3_2(PlatformTransactionManager transactionManager, MemberRepositoryV3 memberRepository) {
        this.txTemplate = new TransactionTemplate(transactionManager);
        this.memberRepository = memberRepository;
    }
    // TransactionTemplate을 사용하려면 transactionManager가 필요함
    // -> 생성자에서 transactionManager를 주입받으면서 TransactionTemplate을 생성함!

    public void accountTransfer(String fromId, String toId, int money) throws SQLException {
        txTemplate.executeWithoutResult((status) -> {
            // 비즈니스 로직
            try {
                bizLogic(fromId, toId, money);
            } catch (SQLException e) {
                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 static void validation(Member toMember) {
        if (toMember.getMemberId().equals("ex")){
            throw new IllegalStateException("이체중 예외 발생");
        }
    }
}

트랜잭션 템플릿 사용 로직

        txTemplate.executeWithoutResult((status) -> {
            // 비즈니스 로직
            try {
                bizLogic(fromId, toId, money);
            } catch (SQLException e) {
                throw new IllegalStateException(e);
            }
        });

• 트랜잭션 템플릿 덕분에 트랜잭션을 시작하고, 커밋하거나 롤백하는 코드가 모두 제거됨!
• 트랜잭션 템플릿의 기본 동작은 다음과 같음
  • 비즈니스 로직이 정상 수행되면 커밋함
  • 언체크 예외가 발생하면 롤백함. 그 외의 경우 커밋함
• 코드에서 예외를 처리하기 위해 try-catch가 들어갔는데, bizLogic() 메서드를 호출하면 SQLException 체크 예외를 넘겨줌. 해당 람다에서 체크 예외를 밖으로 던질 수 없기 때문에 언체크 예외로 바꾸어 던지도록 예외를 전환함

MemberServiceV3_2Test

테스트 코드는 MemberServiceV3_1Test와 동일하여 생략함

• 테스트 실행 시, 정상 동작하고 실패시에는 롤백도 잘 수행됨

정리

• 트랜잭션 템플릿 덕분에, 트랜잭션을 사용할 때 반복하는 코드를 제거할 수 있었음
• 하지만, 이곳은 서비스 로직인데, 비즈니스 로직뿐만 아니라 트랜잭션을 처리하는 기술 로직이 함께 포함되어 있음
  • txTemplate은 트랜잭션 관련 기술, bizLogic은 비즈니스 로직 ...
• 애플리케이션을 구성하는 로직을 핵심 기능과 부가 기능으로 구분하자면 서비스 입장에서 비즈니스 로직은 핵심 기능이고, 트랜잭션은 부가 기능임
• 이렇게 비즈니스 로직과 트랜잭션을 처리하는 기술 로직이 한 곳에 있으면 두 관심사를 하나의 클래스에서 처리하게 됨
  • 결과적으로 코드를 유지보수하기 어려워짐
• 서비스 로직은 가급적 핵심 비즈니스 로직만 있어야 함. 하지만 트랜잭션 기술을 사용하려면 어쩔 수 없이 트랜잭션 코드가 나와야 함
  • 어떻게 이 문제를 해결할까 ...?

트랜잭션 문제 해결 - 트랜잭션 AOP 이해

• 지금까지 트랜잭션을 편리하게 처리하기 위해서 트랜잭션 추상화도 도입하고, 추가로 반복적인 트랜잭션 로직을 해결하기 위해 트랜잭션 템플릿을 도입했음
• 트랜잭션 템플릿 덕분에 트랜잭션을 처리하는 반복 코드는 해결
• 하지만, 서비스 계층에 순수한 비즈니스 로직만 남기지는 못하고 있음
  • 이때, AOP를 통해 프록시를 도입하면 문제를 해결할 수 있음

프록시를 통한 문제 해결

• 프록시를 도입하기 전에는 기존처럼 서비스의 로직에서 트랜잭션을 직접 시작함

서비스 계층의 트랜잭션 사용 코드 예시

기존의 코드

프록시 도입 후

• 프록시를 사용하면 트랜잭션을 처리하는 객체와 비즈니스 로직을 처리하는 서비스 객체를 명확하게 분리할 수 있음

트랜잭션 프록시 코드 예시

public class TransactionProxy {
    private MemberService target;
    public void logic() {
    //트랜잭션 시작
    TransactionStatus status = transactionManager.getTransaction(..);
    try {
        //실제 대상 호출
        target.logic();
        transactionManager.commit(status); //성공시 커밋
    } catch (Exception e) {
        transactionManager.rollback(status); //실패시 롤백
        throw new IllegalStateException(e);
    }
    }
}

트랜잭션 프록시 적용 후 서비스 코드 예시

public class Service {
    public void logic() {
        //트랜잭션 관련 코드 제거, 순수 비즈니스 로직만 남음
        bizLogic(fromId, toId, money);
    }
}

• 프록시 도입 전 : 서비스에 비즈니스 로직과 트랜잭션 처리 로직이 섞여있음
• 프록시 도입 후 : 트랜잭션 프록시가 트랜잭션 처리 로직을 모두 가져감. 그리고 트랜잭션을 시작한 후에 실제 서비스를 대신 호출함. 트랜잭션 프록시 덕분에 서비스 계층에는 순순한 비즈니스 로직만 남음!

스프링이 제공하는 트랜잭션 AOP

• 스프링이 제공하는 AOP 기능을 사용하면 프록시를 편리하게 적용할 수 있음
• 개발자는 트랜잭션 처리가 필요한 곳에 @Transactional 애노테이션만 붙여주면 됨. 스프링의 트랜잭션 AOP는 이 애노테이션을 인식해서 트랜잭션 프록시를 적용해줌

트랜잭션 문제 해결 - 트랜잭션 AOP 적용

트랜잭션 AOP를 사용하는 새로운 서비스 클래스 만들기

MemberServiceV3_3

package hello.jdbc.service;

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

import java.sql.SQLException;

/**
 * 트랜잭션 - @Transactional AOP
 */
@Slf4j
@RequiredArgsConstructor
public class MemberServiceV3_3 {

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

• 순수한 비즈니스 로직만 남기고, 트랜잭션 관련 코드는 모두 제거함
• 스프링이 제공하는 트랜잭션 AOP를 적용하기 위해 @Transactional 애노테이션 추가
• @Transactional 애노테이션은 메서드에 붙여도 되고, 클래스에 붙여도 됨
  • 클래스에 붙이면 외부에서 호출 가능한 public 메서드가 AOP 적용 대상이 됨

MemberServiceV3_3Test

package hello.jdbc.service;

import hello.jdbc.domain.Member;
import hello.jdbc.repository.MemberRepositoryV3;
import lombok.extern.slf4j.Slf4j;
import org.assertj.core.api.Assertions;
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.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 org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.jdbc.datasource.DriverManagerDataSource;
import org.springframework.transaction.PlatformTransactionManager;

import javax.management.MXBean;
import javax.sql.DataSource;
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;

/**
 * 트랜잭션 - @Transactional AOP
 * */
@Slf4j
@SpringBootTest
class MemberServiceV3_3Test {

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

    @Autowired
    private MemberRepositoryV3 memberRepository;
    @Autowired
    private MemberServiceV3_3 memberService;

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

    @TestConfiguration
    static class TestConfig{
        @Bean
        DataSource dataSource(){
            return new DriverManagerDataSource(URL, USERNAME, PASSWORD);
        }

        @Bean
        PlatformTransactionManager transactionManager(){
            return new DataSourceTransactionManager(dataSource());
        }

        @Bean
        MemberRepositoryV3 memberRepositoryV3(){
            return new MemberRepositoryV3(dataSource());
        }

        @Bean
        MemberServiceV3_3 memberServiceV3_3(){
            return new MemberServiceV3_3(memberRepositoryV3());
        }
    }

    @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() throws SQLException {
        //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() 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);
    }
}

• @SpringBootTest
  • 스프링 AOP를 적용하려면 스프링 컨테이너가 필요함. 이 애노테이션이 있으면 테스트시 스프링 부트를 통해 스프링 컨테이너를 생성함. 그리고 테스트에서 @Autowired등을 통해 스프링 컨테이너가 관리하는 빈들을 사용할 수 있음
• @TestConfiguration
  • 테스트 안에서 내부 설정 클래스를 만들어서 사용하면서 이 애노테이션을 붙이면, 스프링 부트가 자동으로 만들어주는 빈들에 추가로 필요한 스프링 빈들을 등록하고 테스트를 수행할 수 있음
• TestConfig
  • DataSource 스프링에서 기본으로 사용할 데이터소스를 스프링 빈으로 등록함. 추가로 트랜잭션 매니저에서도 사용함
  • DataSourceTransactionManager 트랜잭션 매니저를 스프링빈으로 등록함
    • 스프링이 제공하는 트랜잭션 AOP는 스프링 빈에 등록된 트랜잭션 매니저를 찾아서 사용하기 때문에 트랜잭션 매니저를 스프링 빈으로 등록해두어야 함

AOP 프록시 적용 확인

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

실행결과

• 실행결과를 보면, memberService에 EnhancerBySpringCGLIB..라는 부분을 통해 프록시(CGLIB)가 적용된 것을 확인할 수 있음. memberRepository에는 AOP를 적용하지 않았기 때문에 프록시가 적용되지 않음
• 테스트 코드 정상 수행됨

트랜잭션 문제 해결 - 트랜잭션 AOP 정리

0. @Transactional 애노테이션이 있으면, 스프링은 AOP Proxy를 만들고 이 AOP Proxy에서 트랜잭션 로직을 모두 처리함
1. 프록시를 호출함
2. 스프링 컨테이너를 통해 트랜잭션 매니저 획득
   • 내부 프록시에서는 트랜잭션 매니저를 통해서 트랜잭션을 시작함
3. transactionManager.getTransaction() 으로 트랜잭션을 시작함
4. 데이터소스 -> 커넥션 생성
   • 데이터소스를 가지고 커넥션을 만든다
5. con.setAutoCommit(false)
   • setAucoCommit 수행을 해서 트랜잭션을 시작함 (수동 커밋으로 만듦)
6. 커넥션 보관
   • 커넥션을 동기화해야하기 때문에 트랜잭션 동기화 매니저에 보관함
7. 커넥션은 트랜잭션 동기화 매니저에 보관됨
8. AOP Proxy에서 실제 서비스로직을 호출함
   • 그러고나서 실제 서비스 로직이 수행되고, 비즈니스 로직에서 repository 호출함
9. 리포지토리에서는 트랜잭션 동기화 매니저에 있는 커넥션을 획득해서 이용함

선언적 트랜잭션 관리 vs 프로그래밍 방식 트랜잭션 관리

• 선언적 트랜잭션 관리(Declarative Transaction Management)

  • @Transactional 애노테이션 하나만 선언해서 매우 편리하게 트랜잭션을 적용하는 것을 선언적 트랜잭션 관리라 함
  • 선언적 트랜잭션 관리는 과거 XML에 설정하기도 함. 이름 그대로 해당 로직에 트랜잭션을 적용하겠다 라고 어딘가에 선언하기만 하면 트랜잭션이 적용되는 방식

• 프로그래밍 방식의 트랜잭션 관리(programmatic transaction management)

  • 트랜잭션 매니저 또는 트랜잭션 템플릿 등을 사용해서 트랜잭션 관련 코드를 직접 작성하는 것을 프로그래밍 방식의 트랜잭션 관리라 함

• 선언적 트랜잭션 관리가 프로그래밍 방식에 비해서 훨씬 간편하고 실용적이기 때문에 실무에서는 대부분 선언적 트랜잭션 관리를 사용

• 프로그래밍 방식의 트랜잭션 관리는 스프링 컨테이너나 스프링 AOP 기술 없이 간단히 사용할 수 있지만 실무에서는 대부분 스프링 컨테이너와 스프링 AOP를 사용하기 때문에 거의 사용되지 않음

스프링 부트의 자동 리소스 등록

스프링 부트가 등장하기 이전에는 데이터소스와 트랜잭션 매니저를 개발자가 직접 스프링 빈으로 등록해서 사용함

데이터소스와 트랜잭션 매니저를 스프링 빈으로 직접 등록

        @Bean
        DataSource dataSource(){
            return new DriverManagerDataSource(URL, USERNAME, PASSWORD);
        }

        @Bean
        PlatformTransactionManager transactionManager(){
            return new DataSourceTransactionManager(dataSource());
        }

• 기존에는 위와 같이 데이터소스와 트랜잭션 매니저를 직접 스프링 빈으로 등록해야 했음
• 스프링 부트가 나오면서 위와 같은 부분이 자동화 됨!

데이터 소스 - 자동 등록

• 스프링 부트는 데이터소스를 스프링빈에 자동으로 등록함
• 자동으로 등록되는 스프링 빈 이름 : dataSource
• 참고로 개발자가 직접 데이터소스를 빈으로 등록하면 스프링 부트는 데이터소스를 자동으로 등록하지 않음

이때, 스프링 부트는 다음과 같이 application.properties에 있는 속성을 사용해서 DataSource를 생성함. 그리고 스프링 빈에 등록함

application.properties

spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.username=sa
spring.datasource.password=

• 스프링 부트가 기본으로 생성하는 데이터소스는 커넥션풀을 제공하는 HikariDataSource 임. 커넥션풀과 관련된 설정도 application.properties 를 통해서 지정할 수 있음
• spring.datasource.url 속성이 없으면 내장 데이터베이스(메모리 DB)를 생성하려고 시도함

트랜잭션 매니저 - 자동 등록

• 스프링 부트는 적절한 트랜잭션 매니저를 자동으로 스프링 빈에 등록함
• 자동으로 등록되는 스프링 빈 이름 : transactionManager
• 개발자가 직접 트랜잭션 매니저를 빈으로 등록하면 스프링 부트는 트랜잭션 매니저를 자동으로 등록하지 않음

어떤 트랜잭션 매니저를 선택할지는 현재 등록된 라이브러리를 보고 판단함, JDBC 기술을 사용하면 DataSourceTransactionManager를 빈으로 등록하고, JPA를 사용하면 JpaTransactionManager를 빈으로 등록함. 둘 다 사용하는 경우 JpaTransactionManager를 등록함. 참고로 JpaTransactionManager는 DataSourceTransactionManager가 제공하는 기능도 대부분 지원함

데이터소스, 트랜잭션 매니저 직접 등록

    @TestConfiguration
    static class TestConfig{
        @Bean
        DataSource dataSource(){
            return new DriverManagerDataSource(URL, USERNAME, PASSWORD);
        }

        @Bean
        PlatformTransactionManager transactionManager(){
            return new DataSourceTransactionManager(dataSource());
        }

        @Bean
        MemberRepositoryV3 memberRepositoryV3(){
            return new MemberRepositoryV3(dataSource());
        }

        @Bean
        MemberServiceV3_3 memberServiceV3_3(){
            return new MemberServiceV3_3(memberRepositoryV3());
        }
    }

• 이전에 작성한 코드
  • 데이터 소스와 트랜잭션 매니저를 직접 등록하면 스프링 부트는 데이터 소스와 트랜잭션 매니저를 자동으로 등록하지 않음
    이번에는 스프링 부트가 제공하는 자동 등록을 이용해서 데이터소스와 트랜잭션 매니저를 편리하게 적용시켜 보자. 먼저 application.properties에 코드 추가

데이터소스와 트랜잭션 매니저 자동 등록 - MemberServiceV3_4Test

/**
 * 트랜잭션 - DataSource, transactionManager 자동 등록
 * */
@Slf4j
@SpringBootTest
class MemberServiceV3_4Test {

    // ...

    @TestConfiguration
    static class TestConfig{

        private final DataSource dataSource;

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

        @Bean
        MemberRepositoryV3 memberRepositoryV3(){
            return new MemberRepositoryV3(dataSource);
        }

        @Bean
        MemberServiceV3_3 memberServiceV3_3(){
            return new MemberServiceV3_3(memberRepositoryV3());
        }
    }
    // ...
}

• 기존코드와 동일하고, TestConfig 부분만 다름
• 데이터소스와 트랜잭션 매니저를 스프링 빈으로 등록하는 코드가 생략 됨
  • 따라서, 스프링 부트가 application.properties에 지정된 속성을 참고해서 데이터소스와 트랜잭션 매니저를 자동으로 생성해줌
• 코드에서 보는 것 처럼 생성자를 통해 스프링 부트가 만들어준 데이터소스 빈을 주입 받을 수도 있음

🔗 출처

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

[YuDeokRin]

수고하셨습니다 ㅎㅎ