Spring Boot中如何监听JPA全局事务提交事件？

JPA本身不会直接发布Spring标准的ApplicationEvent类型全局事务事件，但要实现全局监听所有JPA事务的提交操作，有几种可行的方案：

方案一：利用Spring的TransactionSynchronizationManager注册全局同步器 #

Spring的TransactionSynchronizationManager支持在事务生命周期的各个阶段添加回调逻辑，结合AOP就能实现全局监听：

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;
import org.springframework.transaction.support.TransactionSynchronization;
import org.springframework.transaction.support.TransactionSynchronizationManager;

@Aspect
@Component
public class GlobalTransactionListener {

    @Before("execution(* *(..)) && @annotation(org.springframework.transaction.annotation.Transactional)")
    public void registerTransactionSync() {
        if (TransactionSynchronizationManager.isSynchronizationActive()) {
            TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronization() {
                @Override
                public void afterCommit() {
                    // 这里写事务提交后的处理逻辑
                    System.out.println("全局捕获：JPA事务已提交");
                }
            });
        }
    }
}

这个切面会拦截所有标注了@Transactional的方法，在事务开启时注册同步器，只要事务提交，就会触发afterCommit里的逻辑。

方案二：扩展JpaTransactionManager发布自定义事件 #

通过继承Spring的JpaTransactionManager，重写提交方法，在事务完成后发布自定义全局事件，再用Spring的事件监听机制处理：

1. 定义自定义事件类：

import org.springframework.context.ApplicationEvent;

public class JpaTransactionCommittedEvent extends ApplicationEvent {
    public JpaTransactionCommittedEvent(Object source) {
        super(source);
    }
}

2. 扩展事务管理器：

import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationEventPublisherAware;
import org.springframework.orm.jpa.JpaTransactionManager;
import org.springframework.transaction.support.DefaultTransactionStatus;

public class CustomJpaTransactionManager extends JpaTransactionManager implements ApplicationEventPublisherAware {
    private ApplicationEventPublisher eventPublisher;

    @Override
    protected void doCommit(DefaultTransactionStatus status) {
        super.doCommit(status);
        // 事务提交完成后发布事件
        eventPublisher.publishEvent(new JpaTransactionCommittedEvent(this));
    }

    @Override
    public void setApplicationEventPublisher(ApplicationEventPublisher eventPublisher) {
        this.eventPublisher = eventPublisher;
    }
}

3. 替换默认的事务管理器：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;

@Configuration
public class TransactionConfig {
    @Bean
    public JpaTransactionManager transactionManager(LocalContainerEntityManagerFactoryBean entityManagerFactory) {
        return new CustomJpaTransactionManager(entityManagerFactory.getObject());
    }
}

4. 编写事件监听器：

import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

@Component
public class TransactionCommitListener {
    @EventListener
    public void handleTransactionCommit(JpaTransactionCommittedEvent event) {
        // 处理事务提交后的逻辑
        System.out.println("全局捕获：JPA事务已提交");
    }
}

方案三：JTA事务场景下的监听（可选） #

如果你的应用用JTA管理分布式事务，可以通过JTA的TransactionSynchronizationRegistry注册Synchronization来监听事务提交，不过这种场景相对少见。

需要注意的是，以上方案仅针对Spring管控的JPA事务，只要事务是由Spring事务管理器处理的，就能被全局监听。

内容的提问来源于stack exchange，提问作者Javaddict