Spring事务注解使用注意问题

205 阅读3分钟

概要

最近在review代码过程中,发现部分同学在使用spring的@Transactional注解时,有一些细节问题没有注意到,导致事务处理并不会按照预期的效果执行。

这里大概整理了几点,记录下来,提醒大家以后不要发生类似的问题。

注意:示例代码均为kotlin

private方法上注解是无效的

 @Transactional
private fun saveFlowFromTrade(trade: LoanTrade, tradeType: TradeType) {
    //保存交易单流水
    //do something
}

原因很简单,spring默认的事务代理是通过动态代理来实现的,也就是说会为bean创建一个代理对象,在代理对象里面实现了事务处理的逻辑。如图所示:

内部的private方法调用显然不会走到代理对象的逻辑中,所以这里的事务注解是无效的。

同一个类内部的调用也是无效的

即使是public的方法,如果是同一个类中的调用也是无效的,原因和上面的private上调用无效是同一种情况,例如如下的代码也是错误的:

public fun createTrade(){
    saveFlowFromTrade()
}
    
@Transactional
public fun saveFlowFromTrade() {
        //保存交易单流水
}

默认只有异常是RuntimeException和Error时才会回滚事务

查看org.springframework.transaction.interceptor.TransactionAspectSupport这个事务拦截器的实现代码可以看到:

protected void completeTransactionAfterThrowing(@Nullable TransactionInfo txInfo, Throwable ex) {
		if (txInfo != null && txInfo.getTransactionStatus() != null) {
			if (logger.isTraceEnabled()) {
				logger.trace("Completing transaction for [" + txInfo.getJoinpointIdentification() +
						"] after exception: " + ex);
			}
			if (txInfo.transactionAttribute != null && txInfo.transactionAttribute.rollbackOn(ex)) {
				try {
					txInfo.getTransactionManager().rollback(txInfo.getTransactionStatus());
				}
				catch (TransactionSystemException ex2) {
					logger.error("Application exception overridden by rollback exception", ex);
					ex2.initApplicationException(ex);
					throw ex2;
				}
				catch (RuntimeException | Error ex2) {
					logger.error("Application exception overridden by rollback exception", ex);
					throw ex2;
				}
			}

注意其中的txInfo.transactionAttribute.rollbackOn(ex)这个判断,只有符合条件的异常才会触发事务的回滚,找到默认的DefaultTransactionAttribute实现类:

	@Override
	public boolean rollbackOn(Throwable ex) {
		return (ex instanceof RuntimeException || ex instanceof Error);
	}

也就是说默认情况下只有RuntimeException和Error的异常才会回滚事务,Spring认为普通的受检异常是业务上的错误,这种情况下业务逻辑可能还是可以正常执行完成的,不属于需要回滚的类型。

如果我们需要针对所有的或者特定的异常才触发回滚,就需要在注解中指定:

@Transactional(rollbackFor = [Exception::class])
fun saveFlowFromTrade(trade: LoanTrade, tradeType: TradeType) {
    
}

事务传播配置

假定业务中有这样一个场景,先创建一笔订单,同时也会创建一笔支付交易单,示例如下:

class OrderService{
    @Transactional
    fun createOrder(){
        saveOrder()
        payService.createPay()
    }
}

class PayService{
    @Transactional
    fun createPay(){
        
    }
}

现在我们希望在交易单创建失败时,并不会回滚订单的创建,我们可能会这样去实现:

class OrderService{
    @Transactional
    fun createOrder(){
        saveOrder()
        try{
            payService.createPay()
        }catch(e: Exception){
            
        }
    }
}

class PayService{
    @Transactional
    fun createPay(){
        
    }
}

在createOrder方法里面捕获了createPay的异常,这样是不是前面的saveOrder的操作就不会被回滚了?

答案当然是否定的,这种情况下子方法的回滚依然会导致父方法的被回滚。这时我们需要修改默认的事务传播配置:

@Transactional(propagation = Propagation.REQUIRES_NEW)

Spring默认的传播策略是:

/**
	 * Support a current transaction, create a new one if none exists.
	 * Analogous to EJB transaction attribute of the same name.
	 * <p>This is the default setting of a transaction annotation.
	 */
	REQUIRED(TransactionDefinition.PROPAGATION_REQUIRED),

注释的解释很明确,当前没有事务创建一个,当前有事务则复用当前事务,回头去看我们上面的实现,在这个默认设置下,子方法会复用父方法开启的事务,所以当子方法有异常回滚的时候,其实是回滚的父方法开启的事务,所以不能满足我们的需求。

修改之后的传播策略:

/**
	 * Create a new transaction, and suspend the current transaction if one exists.
	 * Analogous to the EJB transaction attribute of the same name.
	 * <p><b>NOTE:</b> Actual transaction suspension will not work out-of-the-box
	 * on all transaction managers. This in particular applies to
	 * {@link org.springframework.transaction.jta.JtaTransactionManager},
	 * which requires the {@code javax.transaction.TransactionManager} to be
	 * made available to it (which is server-specific in standard Java EE).
	 * @see org.springframework.transaction.jta.JtaTransactionManager#setTransactionManager
	 */
	REQUIRES_NEW(TransactionDefinition.PROPAGATION_REQUIRES_NEW),

一定会创建一个新事务,所以子方法的事务回滚就不会影响到父方法的代码了