@TransactionalEventListener 사용 시 주의점

문제 상황

@Service
@RequiredArgsConstructor
public class CurrentValueChangeService {
    private final ExampleRepository exampleRepository;
    private final ApplicationEventPublisher applicationEventPublisher;

    @Transactional
    public void changeValue(String value) {
        Example example = exampleRepository.find(1L);

        String beforeValue = example.getCurrentValue();

        example.updateCurrentValue(value);

        applicationEventPublisher.publishEvent(new ValueChangeEvent(beforeValue));
    }
}

@Component
@RequiredArgsConstructor
public class ValueChangeEventListener {
    private final BeforeValueChangeService beforeValueChangeService;

    @TransactionalEventListener
    public void onExampleEvent(ValueChangeEvent valueChangeEvent) {
        beforeValueChangeService.changeBeforeValue(valueChangeEvent.beforeValue());
    }
}

@Service
@RequiredArgsConstructor
@Slf4j
public class BeforeValueChangeService {
    private final ExampleRepository exampleRepository;

    @Transactional
    public void changeBeforeValue(String value) {
        log.info("정상적으로 진입함.");
        Example example = exampleRepository.find(1L);
		
        example.updateBeforeValue(value); // 동작하지 않음.
    }
}

@TransactionalEventListener의 기본 값인 phase = TransactionPhase.AFTER_COMMIT을 사용하는 과정에서 이벤트는 정상적으로 수신되지만 그 이후로 어떠한 insert 쿼리(커밋)도 수행되지 않는 문제가 발생했다.

더군다나 별다른 에러도 발생하지 않고 단순히 커밋만 되지 않아 실제로 데이터가 반영되었는지 확인하기 전까지는 문제가 발생했는지조차 알 수 없어서 매우 당황스러웠다.

영속성에 포함되지 않았나 싶어 entityManager를 통해 확인했는데 해당 엔티티는 영속성 상태임에도 불구하고 select만 수행되고, insert 및 update 쿼리는 나가지 않음을 확인할 수 있었다. 혹시나 하는 마음에 여기서 saveAndFlush()를 통해 변경사항을 즉시 반영해 보고자 시도했는데, 이 경우에는 TransactionSynchronization.afterCompletion threw exception 에러가 발생했다.

saveAndFlush()로 강제로 반영하려고 했을 때

재현 코드: https://github.com/dkswnkk/transactionaleventlistener

 

원인

일단 이 문제의 주요 원인은 @TransactionalEventListener의 AFTER_COMMIT을 사용하게 되면 트랜잭션이 커밋된 후에 이벤트가 처리되기 때문이다. 이벤트가 처리된 시점에는 기존 트랜잭션의 커밋이 끝난 상태에서 그 트랜잭션에 다시 참여하는 것이기 때문에 새로운 트랜잭션을 시작하지 않으면 데이터베이스에 변경 사항을 적용할 수 없게 된다.

참고로 기존의 트랜잭션이 커밋된다고 해서 트랜잭션 리소스가 해제되는 것은 아니기 때문에 계속 액세스 될 수 있으며, 커넥션 풀에서 커넥션이 반환되지 않고 계속해서 연관된 영속성 콘텍스트가 열려있는다(HikariCP의 활성된 연결을 의미하는 active가 1을 가짐). 따라서 AFTER_COMMIT이 적용된 @TransactionalEventListener 메서드는 발행한 트랜잭션 외부에서 실행되는 것이 아니라 계속해서 이전의 트랜잭션에 참여한다.

이와 관련된 자세한 내용은 공식 문서에서 확인할 수 있다.

phase는 트랜잭션의 어느 시점에 이벤트 핸들러가 호출되어야 하는지를 결정하며, 다음과 같은 값들을 가질 수 있다.

• AFTER_COMMIT : 기본 값으로, 트랜잭션이 성공적으로 커밋된 후에 이벤트 핸들러를 실행
• AFTER_ROLLBACK: 트랜잭션이 롤백된 후에 이벤트 핸들러를 실행
• AFTER_COMPLETION: 트랜잭션이 커밋되거나 롤백된 후에 이벤트 핸들러를 실행
• BEFORE_COMMIT: 트랜잭션이 커밋되기 전에 이벤트 핸들러를 실행

여기서 AFTER_COMMIT, AFTER_ROLLBACK, AFTER_COMPLETION을 사용할 경우, 이벤트를 호출하는 메인 트랜잭션에서 커밋이 완료된 후 후속 작업에서 변경 사항을 시도하려면 변경 사항이 반영되지 않는 문제가 발생한다.

 

 

해결 방법

이 문제를 해결하기 위해서는 이벤트 실행 시 실행하는 로직에서 트랜잭션을 새로 열거나, 이벤트 실행 시점을 AFTER_COMMIT이 아닌 BEFORE_COMMIT으로 설정하여 트랜잭션을 끝까지 유지하는 방법이 있다. 아래는 이 방법들을 활용하는 세 가지 방안이다.

각각의 상황에 따라 다르게 적용될 수 있으며, 각 방법의 장단점을 고려하여 선택하면 된다.

1. TransactionPhase.BEFORE_COMMIT로 변경

이벤트 리스너가 트랜잭션 커밋 전에 호출되도록 설정한다.

@TransactionalEventListener(phase = TransactionPhase.BEFORE_COMMIT)
public void onExampleEvent(ValueChangeEvent valueChangeEvent) {
    beforeValueChangeService.changeBeforeValue(valueChangeEvent.beforeValue());
}

다만 BEFORE_COMMIT으로 설정하면 이벤트가 기존 트랜잭션 내에서 실행되므로, 이벤트 처리 로직이 실패하면 메인 트랜잭션도 롤백될 수 있으니 이 점을 고려하면 좋다.

2. 별도의 트랜잭션 시작

이벤트 리스너에서 호출하는 메서드에서 Propagation.REQUIRES_NEW를 통해 새로운 트랜잭션을 시작한다.

@Service
@RequiredArgsConstructor
public class BeforeValueChangeService {
    private final ExampleRepository exampleRepository;

    @Transactional(propagation = Propagation.REQUIRES_NEW) // 새로운 트랜잭션 시작
    public void changeBeforeValue(String value) {
        Example example = exampleRepository.find(1L);
        
        example.updateBeforeValue(value);  // 이제 동작함
    }
}

이 경우에는 새로운 트랜잭션을 시작하면 메인 트랜잭션과 독립적으로 동작하게 되므로 메인 트랜잭션이 롤백되더라도 새로운 트랜잭션에서의 변경 사항은 유지되기에 이 점을 고려해야 한다. 즉 이벤트 로직의 실패가 메인 트랜잭션에 영향을 미치지 않는다.

또한 이 시간 동안 2개의 데이터베이스 커넥션이 활성화된다. 위 예시 코드에서는 발행한 쪽 트랜잭션(CurrentValueChangeService), 수신한 쪽 트랜잭션(BeforeValueChangeService)

 

3. 비동기로 수행

이벤트 리스너를 비동기로 수행하여 메인 트랜잭션과 독립적으로 동작하도록 한다. 이 경우에는 메인 트랜잭션의 성능에 영향을 주지 않고, 별도의 스레드에서 비동기적으로 실행되므로 메인 트랜잭션의 완료를 기다리지 않는다. 다만 스레드가 달라져 예외처리나 트랜잭션 관리 등 고려해야 할게 많아지는데, 이전에 작성한 스프링에서 @Async를 사용할 때 주의점 글이 있으니 참고하면 좋을 것 같다.

@Async
@TransactionalEventListener
public void onExampleEvent(ValueChangeEvent valueChangeEvent) {
    beforeValueChangeService.changeBeforeValue(valueChangeEvent.beforeValue());
}