通过事务钩子避免在事务内部执行异步操作

在实际开发中经常遇到发送消息到MQ的方法被嵌套在事务内部的情况，一些情况下可以把发送消息的方法移到事务外，但是也有一些情况不得不写在事务内部， 但是这样做就会面临事务回滚，而消息发送成功的情况（当然，可以用本地消息表的方式进行处理），不过这里通过事务的钩子，将发送消息的方法放到事务提交后执行，这样就不会出现因为事务回滚导致的数据问题了。

1. Spring 管理的事务

Spring 管理的事务可以使用 Spring 提供的事务同步管理器TransactionSynchronizationManager

TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronization() {
    @Override
    public void afterCommit() {
        // 等待事务提交之后 发送消息
    }
});

需要注意 如果事务失效或者当前没有事务则会抛出异常

2. Seata 分布式事务

Seata也提供了一个事务同步管理器, 通过实现钩子方法可以在提交后执行指定操作

TransactionHookManager.registerHook(new TransactionAfterCommitHook(() -> {
    // 事务提交后执行
}));

/**
 * 分布式事务通用提交后钩子
 */
public class TransactionAfterCommitHook implements TransactionHook {

	private Runnable runnable;

	public TransactionAfterCommitHook(Runnable runnable) {
		this.runnable = runnable;
	}

	/**
	 * before tx begin
	 */
	@Override
	public void beforeBegin() {

	}

	/**
	 * after tx begin
	 */
	@Override
	public void afterBegin() {

	}

	/**
	 * before tx commit
	 */
	@Override
	public void beforeCommit() {

	}

	/**
	 * after tx commit
	 */
	@Override
	public void afterCommit() {

		// 仅实现提交后方法, 其他方法空实现
		runnable.run();
	}

	/**
	 * before tx rollback
	 */
	@Override
	public void beforeRollback() {

	}

	/**
	 * after tx rollback
	 */
	@Override
	public void afterRollback() {

	}

	/**
	 * after tx all Completed
	 */
	@Override
	public void afterCompletion() {

	}
}

3. 进阶版 支持 自动识别 Spring 事务和 Seata事务

/**
 * 事务钩子管理器
 */
@Slf4j
public class MyTransactionHookManager {


	/**
	 * 事务提交后钩子
	 * 不允许当前方法不在事务中执行
	 * @param runnable 传入一个 runnable
	 */
	public static void registerAfterCommitHook(Runnable runnable) {
		registerAfterCommitHook(runnable, false);
	}


	/**
	 * 事务提交后钩子
	 * @param runnable 传入一个 runnable
	 * @param allowNonTransactional 是否允许runnable 在没有事务时也会执行
	 */
	public static void registerAfterCommitHook(Runnable runnable, boolean allowNonTransactional) {

		if (TransactionSynchronizationManager.isSynchronizationActive()) {
			// 当前处于Spring 事务中使用 spring 的事务钩子
			log.info("当前方法在Spring 事务中, 执行Spring 事务钩子");
			TransactionSynchronizationManager.registerSynchronization(new SpringTransactionAfterCommitHook(runnable));
		} else if (RootContext.inGlobalTransaction()) {
			// 当前处于 Seata 事务中使用 Seata 的事务钩子
			log.info("当前方法在Seata 事务中, 执行Seata 事务钩子");
			TransactionHookManager.registerHook(new SeataTransactionAfterCommitHook(runnable));
		} else if (allowNonTransactional){
			log.info("非事务环境下直接执行提交后钩子");
			runnable.run();
		} else {
			throw new RuntimeException("当前方法不在事务中执行!");
		}
	}

}

/**
 * 分布式事务通用提交后钩子
 */
@Slf4j
public class SeataTransactionAfterCommitHook implements TransactionHook {

	private final Runnable runnable;

	public SeataTransactionAfterCommitHook(Runnable runnable) {
		this.runnable = runnable;
	}

	/**
	 * before tx begin
	 */
	@Override
	public void beforeBegin() {

	}

	/**
	 * after tx begin
	 */
	@Override
	public void afterBegin() {

	}

	/**
	 * before tx commit
	 */
	@Override
	public void beforeCommit() {

	}

	/**
	 * after tx commit
	 */
	@Override
	public void afterCommit() {

		// 仅实现提交后方法, 其他方法空实现
		runnable.run();
	}

	/**
	 * before tx rollback
	 */
	@Override
	public void beforeRollback() {

	}

	/**
	 * after tx rollback
	 */
	@Override
	public void afterRollback() {

	}

	/**
	 * after tx all Completed
	 */
	@Override
	public void afterCompletion() {

	}
}

@Slf4j
public class SpringTransactionAfterCommitHook implements TransactionSynchronization {

	private final Runnable runnable;

	public SpringTransactionAfterCommitHook(Runnable runnable) {
		this.runnable = runnable;
	}

	@Override
	public void afterCommit() {
		runnable.run();
	}
}