Spring Exception & Transaction commit, rollback

강정우·2024년 2월 12일
Spring
0

Spring-boot

목록 보기
69/73

예외와 트랜잭션 커밋, 롤백

  • 예외가 발생했는데, 내부에서 예외를 처리하지 못하고, 트랜잭션 범위( @Transactional가 적용된 AOP ) 밖으로 예외를 던지면 어떻게 될까?

예외 발생시 스프링 트랜잭션 AOP는 예외의 종류에 따라 트랜잭션을 커밋하거나 롤백한다.

  1. 언체크 예외인 RuntimeException , Error 와 그 하위 예외일 때 : 트랜잭션을 롤백한다.
  2. 체크 예외인 Exception 과 그 하위 예외일 때 : 트랜잭션을 커밋한다.
  3. 정상 응답(리턴)일 때 : 트랜잭션을 커밋한다.

아래는 예제 코드이다.

언체크 예외 => 롤백, 체크 예외 => 커밋

예외 테스트 코드

@SpringBootTest
public class RollbackTest {

    @Autowired RollbackService service;

    @Test
    void runtimeException() {
        Assertions.assertThatThrownBy(() -> service.runtimeException())
                .isInstanceOf(RuntimeException.class);
    }

    @Test
    void checkedException() {
        Assertions.assertThatThrownBy(() -> service.checkedException())
                .isInstanceOf(MyException.class);
    }

    @Test
    void rollbackFor() {
        Assertions.assertThatThrownBy(() -> service.rollbackFor())
                .isInstanceOf(MyException.class);
    }

    @TestConfiguration
    static class RollbackTestConfig {
        @Bean
        RollbackService rollbackService() {
            return new RollbackService();
        }
    }

    @Slf4j
    static class RollbackService {

        //런타임 예외 발생: 롤백
        @Transactional
        public void runtimeException() {
            log.info("call runtimeException");
            throw new RuntimeException();
        }

        //체크 예외 발생: 커밋
        @Transactional
        public void checkedException() throws MyException {
            log.info("call checkedException");
            throw new MyException();
        }

        //체크 예외 rollbackFor 지정: 롤백
        @Transactional(rollbackFor = MyException.class)
        public void rollbackFor() throws MyException {
            log.info("call rollbackFor");
            throw new MyException();
        }
    }

    static class MyException extends Exception {
    	// 커스텀 체크예외
    }

}

로그 옵션 설정

트랜잭션이 커밋되었는지 롤백 되었는지 로그로 확인하기 위해 아래 properties를 추가하자.
application.properties

logging.level.org.springframework.transaction.interceptor=TRACE
logging.level.org.springframework.jdbc.datasource.DataSourceTransactionManager=DEBUG
// JPA log
logging.level.org.springframework.orm.jpa.JpaTransactionManager=DEBUG
logging.level.org.hibernate.resource.transaction=DEBUG

참고로 지금은 JPA를 사용하므로 트랜잭션 매니저로 JpaTransactionManager 가 실행되고, 여기의 로그를 출력하게 된다.

언체크 예외 결과

체크 예외 결과

체크 예외 rollbackFor 지정 결과

  • 그럼 이제 궁금증이 생길 것이다.
    아니 왜 체크 예외는 커밋해버림?! Exception 이 터졌으니 롤백해야하는거 아님?!

체크 예외 커밋 이유

스프링은 왜 체크 예외는 커밋하고, 언체크(런타임) 예외는 롤백할까?
스프링 기본적으로
체크 예외는 비즈니스 의미가 있을 때 사용하고,
런타임(언체크) 예외는 복구 불가능한 예외로 가정한다.

  • 참고로 꼭 이런 정책을 따를 필요는 없다. 그때는 앞서 배운 rollbackFor 라는 옵션을 사용해서 체크 예외도 롤백하면 된다.

그럼 이제 "비즈니스 예외" 가 궁금한데

비즈니스 요구사항

상황을 가정해보자. 주문을 하는데 상황에 따라 다음과 같이 조치한다.

  1. 정상: 주문시 결제를 성공하면 주문 데이터를 저장하고 결제 상태를 완료 로 처리한다.
  2. 시스템 예외: 주문시 내부에 복구 불가능한 예외가 발생하면 전체 데이터를 롤백한다.
  3. 비즈니스 예외: 주문시 결제 잔고가 부족하면 주문 데이터를 저장하고, 결제 상태를 대기 로 처리한다.
    • 이 경우 고객에게 잔고 부족을 알리고 별도의 계좌로 입금하도록 안내한다.

이때 결제 잔고가 부족하면 "NotEnoughMoneyException" 이라는 체크 예외가 발생한다고 가정하겠다. 이 예외는 시스템에 문제가 있어서 발생하는 시스템 예외가 아니다. 시스템은 정상 동작했지만, 비즈니스 상황에서 문제가 되기 때문에 발생한 예외이다.

더 자세히 설명하자면, 고객의 잔고가 부족한 것은 시스템에 문제가 있는 것이 아니다. 오히려 시스템은 문제 없이 동작한 것이고, 비즈니스 상황이 예외인 것이다. 이런 예외를 비즈니스 예외라 한다. 그리고 비즈니스 예외는 매우 중요하고, 반드시 처리해야 하는 경우가 많으므로 체크 예외를 고려할 수 있다.

그럼 이제 위 비즈니스 요구사항에 맞는 예제 코드를 한 번 만들어보자.

비즈니스 시나리오 요구사항에 따른 예제 코드 구현

NotEnoughMoneyException

public class NotEnoughMoneyException extends Exception {
	public NotEnoughMoneyException(String message) {
    	super(message);
    }
}

결제 잔고가 부족하면 발생하는 비즈니스 예외이다. Exception 을 상속 받아서 체크 예외가 된다.

Order entity

@Entity
@Table(name = "orders")
@Getter
@Setter
public class Order {
    @Id
    @GeneratedValue
    private Long id;
    private String username; //정상, 예외, 잔고부족
    private String payStatus;//대기, 완료
}

JPA를 사용하는 Order 엔티티.
예제를 단순하게 하기 위해 @Getter , @Setter 를 사용했다. 참고로 실무에서 엔티티에 @Setter 를 남발해서 불필요한 변경 포인트를 노출하는 것은 좋지 않다.
참고로 @Table(name = "orders") 라고 했는데, 테이블 이름을 지정하지 않으면 테이블 이름이 클래스 이름인 order 가 된다. order 는 데이터베이스 예약어( order by )여서 사용할 수 없다. 그래서 orders 라는 테이블 이름을 따로 지정해주었다.

JPA repo

public interface OrderRepository extends JpaRepository<Order, Long> {}

spring data jpa를 사용한 간단한 CRUD 구현

Service 로직

@Slf4j
@Service
@RequiredArgsConstructor
public class OrderService {

    private final OrderRepository orderRepository;

    //JPA는 트랜잭션 커밋 시점에 Order 데이터를 DB에 반영한다.
    @Transactional
    public void order(Order order) throws NotEnoughMoneyException {
        log.info("order 호출");
        orderRepository.save(order);
        log.info("결제 프로제스 진입");
        if (order.getUsername().equals("예외")) {
            log.info("시스템 예외 발생");
            throw new RuntimeException("시스템 예외");
        } else if (order.getUsername().equals("잔고부족")) {
            log.info("잔고 부족 비즈니스 예외 발생");
            order.setPayStatus("대기");
            throw new NotEnoughMoneyException("잔고가 부족합니다");
        } else {
            //정상 승인
            log.info("정상 승인");
            order.setPayStatus("완료");
        }
        log.info("결제 프로세스 완료");
    }
}

"시스템 예외" 는 언체크 예외이기 때문에 rollback을 "잔고 부족" 은 체크 예외이기 때문에 커밋을 기대한다.

  • 참고 그리고 아래 코드를 추가하면 JPA(하이버네이트)가 실행하는 SQL을 로그로 확인할 수 있다.
logging.level.org.hibernate.SQL=DEBUG

비즈니스 로직 테스트 코드

@Slf4j
@SpringBootTest
class OrderServiceTest {

    @Autowired OrderService orderService;
    @Autowired OrderRepository orderRepository;

    @Test
    void complete() throws NotEnoughMoneyException {
        //given
        Order order = new Order();
        order.setUsername("정상");

        //when
        orderService.order(order);

        //then
        Order findOrder = orderRepository.findById(order.getId()).get();
        assertThat(findOrder.getPayStatus()).isEqualTo("완료");
    }

    @Test
    void runtimeException() throws NotEnoughMoneyException {
        //given
        Order order = new Order();
        order.setUsername("예외");

        //when
        Assertions.assertThatThrownBy(() -> orderService.order(order))
                .isInstanceOf(RuntimeException.class);

        //then
        Optional<Order> orderOptional = orderRepository.findById(order.getId());
        assertThat(orderOptional.isEmpty()).isTrue();
    }

    @Test
    void bizException() {
        //given
        Order order = new Order();
        order.setUsername("잔고부족");

        //when
        try {
            orderService.order(order);
        } catch (NotEnoughMoneyException e) {
            log.info("고객에게 잔고 부족을 알리고 별도의 계좌로 입금하도록 안내");
        }

        //then
        Order findOrder = orderRepository.findById(order.getId()).get();
        assertThat(findOrder.getPayStatus()).isEqualTo("대기");
    }
}
  1. complete()
    사용자 이름을 정상 으로 설정했다. 모든 프로세스가 정상 수행된다.
  1. runtimeException()
    사용자 이름을 예외 로 설정했다. RuntimeException("시스템 예외") 이 발생한다.
    런타임 예외로 롤백이 수행되었기 때문에 Order 데이터가 비어 있는 것을 확인할 수 있다.
  1. bizException()
    사용자 이름을 잔고부족 으로 설정했다. NotEnoughMoneyException("잔고가 부족합니다") 이 발생한다.
    체크 예외로 커밋이 수행되었기 때문에 Order 데이터가 저장된다.
  • 참고로 테이블을 생성한 기억이 없을 것인데 지금처럼 메모리 DB를 통해 테스트를 수행하면 테이블 자동 생성 옵션이 활성화 된다. JPA는 엔티티 정보를 참고해서 테이블을 자동으로 생성해준다.
    참고로 테이블 자동 생성은 application.properties 에 spring.jpa.hibernate.ddl-auto 옵션을 조정할 수 있다.
    none : 테이블을 생성하지 않는다.
    create : 애플리케이션 시작 시점에 테이블을 생성한다.

정리

NotEnoughMoneyException 은 시스템에 문제가 발생한 것이 아니라, 비즈니스 문제 상황을 예외를 통해 알려준다. 마치 예외가 리턴 값 처럼 사용된다. 따라서 이 경우에는 트랜잭션을 커밋하는 것이 맞다. 이 경우 롤백하면 생성한 Order 자체가 사라진다. 그러면 고객에게 잔고 부족을 알리고 별도의 계좌로 입금하도록 안내해도 주문( Order ) 자체가 사라지기 때문에 문제가 된다.

그런데 비즈니스 상황에 따라 체크 예외의 경우에도 트랜잭션을 커밋하지 않고, 롤백하고 싶을 수 있다. 이때는 rollbackFor 옵션을 사용하면 된다.
런타임 예외는 항상 롤백된다. 체크 예외의 경우 rollbackFor 옵션을 사용해서 비즈니스 상황에 따라서 커밋과 롤백을 선택하면 된다

profile
강정우
智(지)! 德(덕)! 體(체)!
이전 포스트

Spring Transaction Option

다음 포스트

Spring Transaction propagation - commit, rollback

0개의 댓글