如何在数据库事务提交成功后进行异步操作

本文介绍如何在Spring事务成功提交后执行异步操作,并确保这些操作不会在事务回滚时执行。通过使用TransactionSynchronizationManager和线程池,可以在事务成功提交后执行诸如发送邮件等异步任务。

问题

业务场景

业务需求上经常会有一些边缘操作,比如主流程操作A:用户报名课程操作入库,边缘操作B:发送邮件或短信通知。

业务要求

  • 操作A操作数据库失败后,事务回滚,那么操作B不能执行。

  • 操作A执行成功后,操作B也必须执行成功

如何实现

  • 普通的执行A,之后执行B,是可以满足要求1,对于要求2通常需要设计补偿的操作

  • 一般边缘的操作,通常会设置成为异步的,以提升性能,比如发送MQ,业务系统负责事务成功后消息发送成功,然后接收系统负责保证通知成功完成

本文内容

如何在spring事务提交之后进行异步操作,这些异步操作必须得在该事务成功提交后才执行,回滚则不执行。

要点

  • 如何在spring事务提交之后操作

  • 如何把操作异步化

实现方案

使用TransactionSynchronizationManager在事务提交之后操作

public void insert(TechBook techBook){
        bookMapper.insert(techBook);
       // send after tx commit but is async
        TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronizationAdapter() {
            @Override
            public void afterCommit() {
                System.out.println("send email after transaction commit...");
            }
        }
       );
        ThreadLocalRandom random = ThreadLocalRandom.current();
        if(random.nextInt() % 2 ==0){
            throw new RuntimeException("test email transaction");
        }
        System.out.println("service end");
    }

该方法就可以实现在事务提交之后进行操作

操作异步化

使用mq或线程池来进行异步,比如使用线程池:

private final ExecutorService executorService = Executors.newFixedThreadPool(5);
    public void insert(TechBook techBook){
        bookMapper.insert(techBook);
 
//        send after tx commit but is async
        TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronizationAdapter() {
            @Override
            public void afterCommit() {
                executorService.submit(new Runnable() {
                    @Override
                    public void run() {
                        System.out.println("send email after transaction commit...");
                        try {
                            Thread.sleep(10*1000);
                        } catch (InterruptedException e) {
                            e.printStackTrace();
                        }
                        System.out.println("complete send email after transaction commit...");
                    }
                });
            }
        }
        );
 
//        async work but tx not work, execute even when tx is rollback
//        asyncService.executeAfterTxComplete();
 
        ThreadLocalRandom random = ThreadLocalRandom.current();
        if(random.nextInt() % 2 ==0){
            throw new RuntimeException("test email transaction");
        }
        System.out.println("service end");
    }

封装以上两步

对于第二步来说,如果这类方法比较多的话,则写起来重复性太多,因而,抽象出来如下:
这里改造了azagorneanu的代码:

public interface AfterCommitExecutor extends Executor {
}
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.transaction.support.TransactionSynchronizationAdapter;
import org.springframework.transaction.support.TransactionSynchronizationManager;
 
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
 
@Component
public class AfterCommitExecutorImpl extends TransactionSynchronizationAdapter implements AfterCommitExecutor {
    private static final Logger LOGGER = LoggerFactory.getLogger(AfterCommitExecutorImpl.class);
    private static final ThreadLocal<List<Runnable>> RUNNABLES = new ThreadLocal<List<Runnable>>();
    private ExecutorService threadPool = Executors.newFixedThreadPool(5);
 
    @Override
    public void execute(Runnable runnable) {
        LOGGER.info("Submitting new runnable {} to run after commit", runnable);
        if (!TransactionSynchronizationManager.isSynchronizationActive()) {
            LOGGER.info("Transaction synchronization is NOT ACTIVE. Executing right now runnable {}", runnable);
            runnable.run();
            return;
        }
        List<Runnable> threadRunnables = RUNNABLES.get();
        if (threadRunnables == null) {
            threadRunnables = new ArrayList<Runnable>();
            RUNNABLES.set(threadRunnables);
            TransactionSynchronizationManager.registerSynchronization(this);
        }
        threadRunnables.add(runnable);
    }
 
    @Override
    public void afterCommit() {
        List<Runnable> threadRunnables = RUNNABLES.get();
        LOGGER.info("Transaction successfully committed, executing {} runnables", threadRunnables.size());
        for (int i = 0; i < threadRunnables.size(); i++) {
            Runnable runnable = threadRunnables.get(i);
            LOGGER.info("Executing runnable {}", runnable);
            try {
                threadPool.execute(runnable);
            } catch (RuntimeException e) {
                LOGGER.error("Failed to execute runnable " + runnable, e);
            }
        }
    }
 
    @Override
    public void afterCompletion(int status) {
        LOGGER.info("Transaction completed with status {}", status == STATUS_COMMITTED ? "COMMITTED" : "ROLLED_BACK");
        RUNNABLES.remove();
    }
 
}
public void insert(TechBook techBook){
        bookMapper.insert(techBook);
 
//        send after tx commit but is async
//        TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronizationAdapter() {
//            @Override
//            public void afterCommit() {
//                executorService.submit(new Runnable() {
//                    @Override
//                    public void run() {
//                        System.out.println("send email after transaction commit...");
//                        try {
//                            Thread.sleep(10*1000);
//                        } catch (InterruptedException e) {
//                            e.printStackTrace();
//                        }
//                        System.out.println("complete send email after transaction commit...");
//                    }
//                });
//            }
//        }
//        );
 
        //send after tx commit and is async
        afterCommitExecutor.execute(new Runnable() {
            @Override
            public void run() {
                try {
                    Thread.sleep(5*1000);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
                System.out.println("send email after transactioin commit");
            }
        });
 
//        async work but tx not work, execute even when tx is rollback
//        asyncService.executeAfterTxComplete();
 
        ThreadLocalRandom random = ThreadLocalRandom.current();
        if(random.nextInt() % 2 ==0){
            throw new RuntimeException("test email transaction");
        }
        System.out.println("service end");
    }

关于Spring的Async

spring为了方便应用使用线程池进行异步化,默认提供了@Async注解,可以整个app使用该线程池,而且只要一个@Async注解在方法上面即可,省去重复的submit操作。关于async要注意的几点:

1、async的配置

<context:component-scan base-package="com.yami" />
   <!--配置@Async注解使用的线程池,这里的id随便命名,最后在task:annotation-driven executor= 指定上就可以-->
    <task:executor id="myExecutor" pool-size="5"/>
    <task:annotation-driven executor="myExecutor" />

这个必须配置在root context里头,而且web context不能扫描controller层外的注解,否则会覆盖掉。

<context:component-scan base-package="com.yami.web.controller"/>
<mvc:annotation-driven/>

2、async的调用问题

async方法的调用,不能由同类方法内部调用,否则拦截不生效,这是spring默认的拦截问题,必须在其他类里头调用另一个类中带有async的注解方法,才能起到异步效果。

3、事务问题

async方法如果也开始事务的话,要注意事务传播以及事务开销的问题。而且在async方法里头使用如上的TransactionSynchronizationManager.registerSynchronization不起作用,值得注意。

为了确保异步通知在 **数据库事务提交之后** 才触发,我们需要保证: - 事务提交成功后再触发通知; - 如果事务回滚,则不触发通知; - 异步任务不能在事务提交时就执行。 在 Spring 中,可以通过以下几种方式实现这一点: --- ## ✅ 方法一:使用 `TransactionSynchronizationManager` Spring 提供了 `TransactionSynchronizationManager`,可以注册事务同步回调,只有在事务成功提交后才会执行回调。 ### 示例代码: ```java import org.springframework.stereotype.Service; import org.springframework.transaction.support.TransactionSynchronization; import org.springframework.transaction.support.TransactionSynchronizationManager; @Service public class TransactionService { public void performTransaction(String operationType) { // 模拟数据库操作 System.out.println("执行数据库操作: " + operationType); // 注册事务提交后的回调 if (TransactionSynchronizationManager.isActualTransactionActive()) { TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronization() { @Override public void afterCommit() { // 事务提交后执行 sendNotificationAsync(operationType); } }); } else { // 没有事务时直接执行 sendNotificationAsync(operationType); } } private void sendNotificationAsync(String operationType) { new Thread(() -> { System.out.println("推送通知:操作 " + operationType + " 已完成"); }).start(); } } ``` ### 说明: - `TransactionSynchronizationManager.registerSynchronization(...)` 注册一个事务同步对象; - `afterCommit()` 方法只会在事务成功提交后执行; - 这样可以确保通知逻辑在事务提交之后才执行; - 使用线程或线程池异步执行通知,不影响主流程。 --- ## ✅ 方法二:结合 Spring AOP + 事件机制(推荐) ### 1. 定义注解用于标记需要通知的方法 ```java import java.lang.annotation.*; @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface NotifyAfterCommit { } ``` --- ### 2. 使用 AOP 在事务提交后触发通知 ```java import org.aspectj.lang.annotation.AfterReturning; import org.aspectj.lang.annotation.Aspect; import org.springframework.context.ApplicationEventPublisher; import org.springframework.stereotype.Component; @Aspect @Component public class NotificationAspect { private final ApplicationEventPublisher eventPublisher; public NotificationAspect(ApplicationEventPublisher eventPublisher) { this.eventPublisher = eventPublisher; } @AfterReturning("execution(* com.example.service.*.*(..)) && @annotation(notifyAfterCommit)") public void afterMethodExecution(NotifyAfterCommit notifyAfterCommit) { if (TransactionSynchronizationManager.isActualTransactionActive()) { TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronization() { @Override public void afterCommit() { eventPublisher.publishEvent(new TransactionCompletedEvent(this, "custom")); } }); } } } ``` --- ### 3. 在业务方法上使用注解 ```java @Service public class SomeService { @NotifyAfterCommit @Transactional public void doSomething() { // 数据库操作 } } ``` --- ## ✅ 方法三:使用 Spring Event + `@TransactionalEventListener` Spring 提供了一个专门用于事务事件监听的注解:`@TransactionalEventListener`,它可以在事务的特定阶段触发事件。 ```java import org.springframework.transaction.event.TransactionalEventListener; import org.springframework.stereotype.Component; @Component public class TransactionNotificationListener { @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT) public void handleTransactionCompleted(TransactionCompletedEvent event) { // 只有在事务提交后才会执行 System.out.println("推送通知:操作 " + event.getOperationType() + " 已完成"); } } ``` ### 说明: - `@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)`:确保监听器只在事务提交后执行; - 如果事务回滚,该监听器不会被触发; - 你可以结合 `@Async` 实现异步执行。 --- ## ✅ 总结 | 方法 | 是否保证事务提交后触发 | 是否异步 | 是否推荐 | |------|--------------------------|-----------|-----------| | `TransactionSynchronizationManager` | ✅ | ✅(需手动实现) | ✅✅✅ | | AOP + 事件机制 | ✅ | ✅ | ✅✅ | | `@TransactionalEventListener` | ✅ | ❌(默认同步) | ✅✅✅ | --- ###
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值