【BUG】声明式事务失效导致日志记录失败

作者: zhl 分类: Spring 发布时间: 2024-10-18 15:57

内容隐藏

1 发生背景

2 问题复现

2.1 验证一：事务方法权限修饰符不是 public，导致事务失效

2.2 验证二：本类方法直接调用本类的事务方法，导致事务失效

3 结论

4 解决方法

发生背景

我们知道在这种场景下事务会失效

被@Transactional 注解修饰的事务方法权限修饰符只能是 public，否则事务会失效
当前类中的方法不能调用事务方法，否则事务失效

然而项目中有一段向数据库中添加日志的代码，都存在导致事务失效的问题；带着事务是否会失效的疑问，自己亲自在本地实现了类似的代码。

问题复现

@Transactional
@Service
public class UserServiceImpl {

    @Autowired
    private UserDao userDao;

    public void register(User user) {
        //...
        save(user);
        //...
    }

    // 模拟添加日志到数据库
    @Transactional(propagation = Propagation.REQUIRES_NEW)
    private void save(User user) {
        userDao.save(user);
    }
}

/**
 * <p>
 *  测试事务失效
 * @author zhl
 */
public class TransactionTest {
    @Test
    public void testTransaction(){
        ApplicationContext ctx = new AnnotationConfigApplicationContext(MyBatisAutoConfiguration.class);
        User user = new User();
        user.setName("zhangsan");
        user.setPassword("123456");
        UserServiceImpl userServiceImpl = (UserServiceImpl) ctx.getBean("userServiceImpl");
        userServiceImpl.register(user);
    }
}

被 @Transactional 修饰的save方法的事务失效，传播属性失效，由于当前类被 @Transactional 修饰，register 方法变成事务方法。并且通过控制台输出的日志，只有 register 方法开启了事务，save 方法事务确实失效了。
说明：权限修饰符不是 public 或当前类中直接调用事务方法都会导致事务失效。

验证一：事务方法权限修饰符不是 public，导致事务失效

当前类实现 ApplicationContextAware ，从 Spring 容器中获取代理后的 UserServiceImpl.save 方法，让执行事务方法的途径正确（排除当前类直接调用事务方法导致的事务方法失效）

权限修饰符非 public，控制台只输出了一个 register 事务，原save方法事务失效；
权限修饰符为 public，控制台输出了两个事务，且在最外层通过除零运行时异常，发现只有最外层 register 方法事务异常回滚，内部 save 方法事务正常提交，说明 save 方法的传播属性正常生效。

验证二：本类方法直接调用本类的事务方法，导致事务失效

将 save 方法的权限修饰符改为 public（排除权限修饰符非 public 导致的事务失效）

控制台只输出一个事务，说明原 save方法事务失效
当前类实现 ApplicationContextAware，从 Spring 容器中获取代理后的 UserServiceImpl.save 方法；发现控制台输出两个事务，且原 save 方法事务正常挂起，证明本类直接调用本类的事务方法，导致原事务方法失效。

结论

经过验证证明 save 方法事务失效。由于类上的 @Transactional 注解，为所有方法开启了事务，包括register方法，传播属性和隔离属性等都是默认值，如果在 save 方法外，register 方法中遇到异常，整个方法都会回滚，save 事务失效传播属性失效，同样随着外部方法回滚而回滚，save 方法插入数据库失败。

由于直接调用了 save 方法，save 方法没有被 Spring 加工代理，导致事务失效；
由于权限修饰符不是 public，导致在动态代理时，无法访问到事务方法，无法为该方法进行加工添加事务。

解决方法

从 Spring 容器获取 Bean，调用事务方法，并且修改事务方法的权限修饰符为 public

@Transactional
@Service
public class UserServiceImpl implements ApplicationContextAware {

    private ApplicationContext applicationContext;

    @Autowired
    private UserDao userDao;

    public void register(User user) {
        //...
        UserServiceImpl userServiceImpl = (UserServiceImpl) applicationContext.getBean("userServiceImpl");
        userServiceImpl.save(user);
        //...
    }

    //模拟日志记录
    @Transactional(propagation = Propagation.REQUIRES_NEW)
    public void save(User user) {
        userDao.save(user);
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
}

建议在方法上使用 @Transactional 注解

bug fix