[Spring] @TransactionalEventListener 호출 시 발생하는 문제

 

 

 

 

🧐 서론

도메인 이벤트를 한번 사용해보고자 이런저런 자료들을 참고하며 사용을 하던 중에 문제가 하나 발생했습니다.

 

제가 이벤트를 통해 하고자 했던 것은 다음과 같습니다.

모임 생성 (모임 생성 이벤트 발행)
-> 이벤트 처리 (모임 기본 역할 등록) & 모임 기본 역할 등록 이벤트 발행
-> 이벤트 처리 (모임을 생성한 회원을 회장으로 등록)

우선 모임과, 모임의 역할, 모임 참가자는 따로따로 수정되고 제거될 수 있으므로, 다른 에그리거트라 판단하여 이들을 분리하였습니다.

 

 

위 상황에서 저는 @TransactionalEventListener를 사용하여 다음과 같이 코드를 작성하였습니다.

@Transactional
@Service
public class CreateClub implements CreateClubUseCase {

    @Override
    public Long command(final Command command) {

        // ... 모임 생성하는 코드
        
        // CreateClubEvent 를 받으면 -> 모임 기본 역할 등록(등록 이후 모임 생성한 사람을 회장으로 만들기)
        Event.publish(new CreateClubEvent(this, member, club));

        return club.id();
    }
}

위와 같이 모임 생성 이벤트를 발행하면,

 

 

@Component
public class CreateDefaultRoleWithCreateClubEventHandler extends EventHandler<CreateClubEvent> {


    @Transactional
    @TransactionalEventListener
    @Override
    public void handle(final CreateClubEvent event) {

        // ... 모임 기본 역할 생성하는 코드

        // 기본 역할 생성 이벤트 -> 모임을 생성한 회원을 회장으로 만들기
        Event.publish(new CreateDefaultRoleEvent(...));
    }
}

위와 같이 해당 이벤트를 받아 모임의 기본 역할을 생성한 뒤, 모임 기본 역할 생성 이벤트를 발행합니다.

 

 

@Component
public class RegisterPresidentWithCreateDefaultRoleEventHandler extends EventHandler<CreateDefaultRoleEvent> {

    @Transactional
    @TransactionalEventListener
    @Override
    public void handle(final CreateDefaultRoleEvent event) {

        // ... 모임 생성한 회원을 회장으로 저장하는 코드
    }
}

위처럼 모임 기본 역할 생성 이벤트를 받으면 모임을 생성한 회원을 회장으로 저장하려 하였습니다.

 

 

 

 

 

 

 

 

 

 

 

 

🧐 문제 상황

위와 같이 코드를 작성하고 실행해보니 이벤트가 하나도 처리되지 않았습니다.

정확히는 아래 코드는 호출되지만 모임의 기본 역할이 저장되지 않았습니다.

@Component
public class CreateDefaultRoleWithCreateClubEventHandler extends EventHandler<CreateClubEvent> {


    @Transactional
    @TransactionalEventListener
    @Override
    public void handle(final CreateClubEvent event) {

        // ... 모임 기본 역할 생성하는 코드

        // 기본 역할 생성 이벤트 -> 모임을 생성한 회원을 회장으로 만들기
        Event.publish(new CreateDefaultRoleEvent(...));
    }
}

 

 

또한 모임 기본 역할 생성 이벤트를 받아 모임을 생성한 회원을 회장으로 저장하려는 코드는 호출되지도 않았습니다.

즉 아래 코드가 호출되지 않았습니다.

@Component
public class RegisterPresidentWithCreateDefaultRoleEventHandler extends EventHandler<CreateDefaultRoleEvent> {

    @Transactional
    @TransactionalEventListener
    @Override
    public void handle(final CreateDefaultRoleEvent event) {

        // ... 모임 생성한 회원을 회장으로 저장하는 코드
    }
}

 

 

 

 

 

 

 

 

 

 

 

 

🧐 원인 분석

(혹시 틀린 부분이 있다면 알려주시면 감사하겠습니다. 아래는 제가 조금 디버깅 해 본 결과를 토대로 작성합니다.)

 

@TransactionalEventListener 의 phase 속성의 기본값은 AFTER_COMMIT 입니다.

즉 트랜잭션이 커밋된 이후 이벤트 리스너가 동작하게 됩니다.

 

트랜잭션이 커밋된 이후 리스너가 동작한다고 해도, 여전히 하나의 트랜잭션에 묶여있음에 주의해야 합니다.

커밋된 트랜잭션을 다시 commit하는것은 불가능하기 때문에, 코드가 제대로 작동하지 않는 오류가 발생한 것입니다.

 

 

AbstractPlatformTransactionManager.processCommit() 메서드를 살펴보면, 다음과 같은 흐름을 가지는 것을 알 수 있습니다.

private void processCommit(DefaultTransactionStatus status) throws TransactionException {
    try {
        prepareForCommit(status);
        triggerBeforeCommit(status); // BEFORE_COMMIT
        triggerBeforeCompletion(status);


        doCommit(status); // 실제 커밋 수행
            
        triggerAfterCommit(status);  // AFTER_COMMIT
        cleanupAfterCompletion(status);  // AFTER_COMPLETION (트랜잭션 리소스 정리)
        
    } catch(...) {
        doRollbackOnCommitException(status, ex); // 롤백
    }
}

 

따라서 AFTER_COMMIT 시에는 실제 커밋이 실행된 상태이기 때문에 추가적인 insert sql이 커밋되지 않아 오류가 발생했던 것입니다.

 

 

 

 

 

 

 

 

 

 

 

🧐 해결

@TransactionalEventListener의 phase를 BEFORE_COMMIT으로 설정하거나,

@Transactional의 propagation을 REQUIRES_NEW로 설정하여 문제를 해결할 수 있습니다.

 

(정확히는 @TransactionalEventListener의 phase를 BEFORE_COMMIT으로 설정하면, 첫번째 이벤트의 처리는 성공적으로 처리되나 두번째 이벤트의 핸들러 역시 @TransactionalEventListener의 phase를 BEFORE_COMMIT으로 설정한 경우라면 처리되지 않습니다. (before_commit은 한번만 호출되므로, 이미 첫 호출에서 사용되었기 때문입니다.))

 

 

저는 @TransactionalEventListene대신 @EventListner를 사용하여 해결하였는데, 이유는 아래와 같습니다.

모임 생성 -> 모임 기본 역할 저장 -> 모임을 생성한 회원을 회장으로 등록 

생각해보니 위 흐름은 하나의 트랜잭션으로 묶이는 것이 올바르다 생각하여 @TransactionalEventListener 대신 @EventListner를 사용하여 해결하였습니다.

 

@TransactionalEventListener를 계속 사용할 것이라면 @Transactional(propagation = REQUIRES_NEW)를 사용할 수 있지만, 이때는 트랜잭션이 달라져 영속성 컨텍스트가 달라지기 때문에 이 부분에 유의해주시며 개발하시면 될 것 같습니다.

 

 

 

 

 

 

 

 

 

 

 

🧐 참고

https://suhwan.dev/2020/01/16/spring-transaction-common-mistakes/

Spring Transaction 사용 시 주의할 점

https://soongjamm.tistory.com/155?category=1217576 

스프링 이벤트 에러에 독립적으로 만들기 (트랜잭션 분리. @TransactionalEventListener, @Transactional)