【Mybatis源码解析第九章】说说Mybatis中的ExecutorType

绝地灬酷狼 2023-07-08 10:27 43阅读 0赞

# 缘起 #

在使用mybatisplue的过程中，发现如果一个事务中执行了插入又执行了批量插入的话就会报错

> Cannot change the ExecutorType when there is an existing transaction  
> ![在这里插入图片描述][20200727150408906.png]

# 问题原因 #

揪其原因，通过报错信息我们已经获知了是由于`ExecutorType`被更改导致的。那么为什么我们进行单条插入又执行批量插入以后会去修改`ExecutorType`呢？这个`ExecutorType`是个什么东西呢？  
我通过源码得知获取`Sqlsession`的时候，最终调用的是`SqlSessionUtils`里面的`getSqlSession`方法，那么这个方法为什么会引起这个错误呢？

public static SqlSession getSqlSession(SqlSessionFactory sessionFactory, ExecutorType executorType, PersistenceExceptionTranslator exceptionTranslator) { 
    　　 //从从前线程的threadLocal 中获取sqlSessionHolder
        SqlSessionHolder holder = (SqlSessionHolder) TransactionSynchronizationManager.getResource(sessionFactory);
        //调用静态方法sessionHoler 判断是否存在符合要求的sqlSession
        SqlSession session = sessionHolder(executorType, holder);
    　　 // 判断当前sqlSessionHolder 中是否持有sqlSession (即当前操作是否在事务当中)
        if (session != null) { 
    　　　　//如果持有sqlSesison 的引用，则直接获取
          return session;
        }
    
        if (LOGGER.isDebugEnabled()) { 
          LOGGER.debug("Creating a new SqlSession");
        }
        //获取新的sqlSession 对象。这里由sessionFacory产生的defaultSqlSession
        session = sessionFactory.openSession(executorType);
        //判断判断，当前是否存在事务，将sqlSession 绑定到sqlSessionHolder 中，并放到threadLoacl 当中
        registerSessionHolder(sessionFactory, executorType, exceptionTranslator, session);
        return session;
      }

里面调用了`sessionHolder`方法，代码如下

private static SqlSession sessionHolder(ExecutorType executorType, SqlSessionHolder holder) { 
        SqlSession session = null;
        if (holder != null && holder.isSynchronizedWithTransaction()) { 
          //hodler保存的执行类型和获取SqlSession的执行类型不一致，就会抛出异常，也就是说在同一个事务中，执行类型不能变化，原因就是同一个事务中同一个sqlSessionFactory创建的sqlSession会被重用 
          if (holder.getExecutorType() != executorType) { 
            throw new TransientDataAccessResourceException("Cannot change the ExecutorType when there is an existing transaction");
          }
          //增加该holder,也就是同一事务中同一个sqlSessionFactory创建的唯一sqlSession，其引用数增加，被使用的次数增加 
          holder.requested();
    
          if (LOGGER.isDebugEnabled()) { 
            LOGGER.debug("Fetched SqlSession [" + holder.getSqlSession() + "] from current transaction");
          }
          //返回sqlSession 
          session = holder.getSqlSession();
        }
        return session;
      }

通过以上代码我们明白，当我们要获取一个`SqlSession`对象的时候，`Mybatis`会进行一下步骤

1.  如果`SqlSessionHolder`不为空，并且被事务锁定，则可以通过`holder.getSqlSession()`方法，从当前事务中获取`SqlSession`，即 `Fetched SqlSession from current transaction`。
2.  如果`SqlSessionHolder`为空或没有被事务锁定，则会通过`sessionFactory.openSession()`方法创建新的`SqlSession`对象，即 `Creating a new SqlSession`。
3.  如果当前线程的事务是活跃的，将会为SqlSession注册事务同步，即`Registering transaction synchronization for SqlSession`。

报错的原因就在上面，获取`SqlSession`的时候会对`ExecutorType`进行验证，如果`SqlSessionHolder`中保存的`ExecutorType`和本次的`ExecutorType`不一致，就会抛出异常。  
那么也就是说在同一个事务中，同一个`SqlSessionFactory`创建的`SqlSession`会被重用，从而`ExecutorType`不能变化。

**到底什么是ExecutorType**  
顾名思义，`ExecutorType`即执行类型，这是个枚举类型，共有三个类型

public enum ExecutorType { 
      SIMPLE, REUSE, BATCH
    }

1.  SIMPLE  
    这个类型不做特殊的事情，它只为每个语句创建一个PreparedStatement。可以返回自增键，自增键会在事务提交后，自动设置到传入的对象中。
2.  REUSE  
    这种类型将重复使用PreparedStatements。
3.  BATCH  
    这个类型批量更新，性能更优，但batch模式也有自己的问题，比如在Insert操作时，在事务没有提交之前，是没有办法获取到自增的id，这在某型情形下是不符合业务要求的，而且假如有一条sql语句报错，则整个事务回滚，虽然这条sql语句不是太重要。注意：在同一事务中batch模式和simple模式之间无法转换。

那么当我们执行单次插入的时候默认的`ExecutorType`是`SIMPLE`.但是执行批量插入的时候`ExecutorType`又变成了`BATCH`，所以就会引起这个报错`Cannot change the ExecutorType when there is an existing transaction`。

# 解决方案 #

显然，你知道了问题的原因，是由于同一个事务中更改了`ExecutorType`引起的，这个问题其实并没有太好的解决方案，只能是通过业务妥协，比如不在同一个事务中即执行单条插入又执行批量插入。但很明显，在某些情况下你确实会有这样的业务需求，如果你需要把插入订单表和插入订单明细表的逻辑放到同一个事务当中。那么就可以指定插入类型为`BATCH`，你可以通过如下方式来更改`ExecutorType`

<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
        <constructor-arg name="sqlSessionFactory" ref="sqlSessionFactoryBean"></constructor-arg>
        <constructor-arg name="executorType" value="BATCH"></constructor-arg>
    </bean>

或者采用注解的形式

@Bean("batchSqlSessionTemplate")
    public SqlSessionTemplate setSqlSessionTemplate(@Qualifier("sqlSessionFactory-dataSource")SqlSessionFactory sqlSessionFactory){ 
    	return new SqlSessionTemplate(sqlSessionFactory,ExecutoryType.BATCH);
    }

但需要注意的是如果是`BATCH`那么你将无法获取到插入之后数据ID，这在很多业务场景下是行不通的，比如你需要获取订单主表插入后生成的ID来赋值订单明细表以使得他们之间具有关联关系。  
那么更推荐的做法是当你要插入集合时，不采用批量插入的方式，而是通过for循环一条条插入，如下代码

for(User user:users){ 
    	userDao.save(user);
    }

但这显然会影响性能。

[20200727150408906.png]: https://img-blog.csdnimg.cn/20200727150408906.png