Mybatis的SqlSession和一級緩存的失效原因分析及解決

更新時間：2025年05月22日 09:21:26 作者：Linn-cn

這篇文章主要介紹了Mybatis的SqlSession和一級緩存的失效原因分析及解決,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

SqlSession解讀

SqlSession是什么？

SqlSession是Mybatis 中定義的，用來表示與關系數(shù)據(jù)庫的一次會話，會話定義了各種具體的操作，查詢、數(shù)據(jù)更新（包含保存、更新、刪除）操作。而這些操作都在與數(shù)據(jù)庫建立會話的基礎上進行的。

SqlSession 可以看作是對Connection 更加高級的抽象，從其方法上更加可以看出他具有更加明顯的操作特征。

SqlSession分類

mybatis的SqlSession有三種：

DefaultSqlSession、SqlSessionManager、SqlSessionTemplate，前兩者是mybtais默認情況下使用的，第三種主要用到mybatis和spring整合的時候。

SqlSession的創(chuàng)建

那么SqlSession 是如何被創(chuàng)建的？

在學習Mybatis時，我們常?？吹降?SqlSession 創(chuàng)建方式是 SqlSessionFactory.openSession() ，那么我們就從它作為切入點，先來看看 SqlSessionFactory.openSession() 的方法源碼（需要注意的是這里是實現(xiàn)類DefaultSqlSessionFactory ）

代碼如下：

  private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
    Transaction tx = null;
    try {
      // 獲取環(huán)境配置
      final Environment environment = configuration.getEnvironment();
      // 創(chuàng)建事務
      final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
      tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
      // 創(chuàng)建執(zhí)行器
      final Executor executor = configuration.newExecutor(tx, execType);
      // 創(chuàng)建sqlsession
      return new DefaultSqlSession(configuration, executor, autoCommit);
    } catch (Exception e) {
      closeTransaction(tx); // may have fetched a connection so lets call close()
      throw ExceptionFactory.wrapException("Error opening session.  Cause: " + e, e);
    } finally {
      ErrorContext.instance().reset();
    }
  }

通過源碼我們知道每次 SqlSession（準確地說是 DefaultSqlSession ）的創(chuàng)建都會有一個 Transaction 事務對象的生成。也就是說：

一個事務 Transaction 對象與一個 SqlSession 對象是一一對應的關系。
同一個SqlSession 不管執(zhí)行多少次數(shù)據(jù)庫操作。只要沒有執(zhí)行close，那么整個操作都是在同一個 Transaction 中執(zhí)行的。

但需要注意的是，我們整合Spring之后用到的其實都是 SqlSessionTemplate ，與這里的 DefaultSqlSession 不是同一個SqlSession對象，不懂的看上面的。

為什么和Spring整合后的SqlSession一級緩存偶爾會失效？

我們都知道m(xù)ybatis有一級緩存和二級緩存。一級緩存是SqlSession級別的緩存，在操作數(shù)據(jù)庫時，每個SqlSession類的實例對象緩存的數(shù)據(jù)區(qū)域（Map）可以用于存儲緩存數(shù)據(jù),不同的SqlSession類的實例對象緩存的數(shù)據(jù)區(qū)域是互不影響的。

一級緩存工作原理圖：

二級緩存是Mapper級別的緩存，多個SqlSession實例對象可以共用二級緩存，二級緩存是跨SqlSession的。

Mybatis緩存模式圖如下：

我們知道在和Mybatis和Spring的整合中不管是創(chuàng)建MapperProxy 的 SqlSession 還是 MapperMethod中調用的SqlSession其實都是** SqlSessionTemplate **。

SqlSessionTemplate的神秘面紗

如果你閱讀了上面的鏈接文章，就知道每創(chuàng)建一個 MapperFactoryBean 就會創(chuàng)建一個 SqlSessionTemplate 對象，而 MapperFactoryBean 在獲取 MapperProxy 時會將 SqlSessionTemplate 傳遞到 MapperProxy中。也就是說 SqlSessionTemplate 的生命周期是與 MapperProxy 的生命周期是一致的。

SqlSessionTemplate 內(nèi)部維護了一個 sqlSessionProxy ，而 sqlSessionProxy 是通過動態(tài)代理創(chuàng)建的一個 SqlSession 對象， SqlSessionTemplate 的數(shù)據(jù)庫操作方法 insert/update 等等都是委托 sqlSessionProxy 來執(zhí)行的，我們看一下它的構造方法：

// 構造方法
public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType executorType,
                          PersistenceExceptionTranslator exceptionTranslator) {
    ...省略無關緊要的代碼
        this.sqlSessionProxy = (SqlSession) newProxyInstance(
        SqlSessionFactory.class.getClassLoader(),
        new Class[] { SqlSession.class },
        new SqlSessionInterceptor());
}

我們會發(fā)現(xiàn)這個類也繼承了SqlSession接口，我們選擇一個查詢方法來深入看一下為什么mybatis一級緩存偶爾會失效，我們進入到他的selectList方法，看下他的實現(xiàn)邏輯：

public class SqlSessionTemplate implements SqlSession, DisposableBean {...}

@Override
public <E> List<E> selectList(String statement, Object parameter) {
    return this.sqlSessionProxy.selectList(statement, parameter);
}

我們發(fā)現(xiàn)，這個方法內(nèi)部內(nèi)部的查詢又交給了一層代理，由這一層代理去真正執(zhí)行的查詢操作，而這個代理就是在SqlSessionTemplate創(chuàng)建的時候進行設置的。

如果熟悉動態(tài)代理的話，就知道，我們接下來需要看的就是SqlSessionInterceptor，我們進入到里面看一下他的實現(xiàn)：

private class SqlSessionInterceptor implements InvocationHandler {
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
      // 去獲取SqlSession
      SqlSession sqlSession = getSqlSession(SqlSessionTemplate.this.sqlSessionFactory,
          SqlSessionTemplate.this.executorType, SqlSessionTemplate.this.exceptionTranslator);
      try {
        // 通過反射調用真正的處理方法
        Object result = method.invoke(sqlSession, args);
        if (!isSqlSessionTransactional(sqlSession, SqlSessionTemplate.this.sqlSessionFactory)) {
          // 提交數(shù)據(jù)
          sqlSession.commit(true);
        }
        // 返回查詢的數(shù)據(jù)
        return result;
      } catch (Throwable t) {
        ...省略無關緊要的代碼
      } finally {
        if (sqlSession != null) {
          // 關閉SqlSession的連接
          closeSqlSession(sqlSession, SqlSessionTemplate.this.sqlSessionFactory);
        }
      }
    }
  }

整個 invoke 分5個步驟：

根據(jù)條件獲取一個SqlSession(注意此時的SqlSession 是 DefaultSqlSession )，此時的SqlSession 可能是新創(chuàng)建的，也可能是上一次的請求的SqlSession。
反射執(zhí)行 SqlSession 方法
判斷當前的 SqlSession 是否由事務所管控，如果是則不commit
判斷如果是PersistenceExceptionTranslator且不為空，那么就關閉當前會話，并且將sqlSession置為空防止finally重復關閉
只要當前會話不為空，那么就會關閉當前會話操作，關閉當前會話操作又會根據(jù)當前會話是否有事務來決定會話是釋放還是直接關閉。

我們都知道一級緩存是SqlSession級別的緩存，那么一級緩存失效，肯定是因為SqlSession不一致，那么我們進入到getSqlSession方法中：

public static SqlSession getSqlSession(SqlSessionFactory sessionFactory, ExecutorType executorType,
      PersistenceExceptionTranslator exceptionTranslator) {
    ...省略無關緊要的代碼
    // 從ThreadLocal變量里面獲取到Spring的事務同步管理器
    SqlSessionHolder holder = (SqlSessionHolder) TransactionSynchronizationManager.getResource(sessionFactory);
    // 調用靜態(tài)方法sessionHoler 判斷是否存在符合要求的sqlSession
    SqlSession session = sessionHolder(executorType, holder);
    if (session != null) {
      return session;
    }
    // 如果SqlSessionHolder中獲取的SqlSession為空，則新建一個SqlSession
    session = sessionFactory.openSession(executorType);
    // 判斷當前是否存在事務，將sqlSession 綁定到sqlSessionHolder 中，并放到threadLoacl 當中
    registerSessionHolder(sessionFactory, executorType, exceptionTranslator, session);
    return session;
  }

看到這，我們應該知道為什么Spring和MyBatis整合后，偶爾會一級緩存失效了，是因為Spring只有在開啟了事務之后，在同一個事務里的SqlSession會被緩存起來，同一個事務中，多次查詢是可以命中緩存的！

在SqlSessionInterceptor#invoke方法里面，他在關閉的SqlSession的時候同樣對是否開啟事務做了處理，感興趣的可以看closeSqlSession方法的源碼：

public static void closeSqlSession(SqlSession session, SqlSessionFactory sessionFactory) {
	...省略無關緊要的代碼
    SqlSessionHolder holder = 
          (SqlSessionHolder) TransactionSynchronizationManager.getResource(sessionFactory);
    // 查看事務同步管理器是否存在 session 
    if ((holder != null) && (holder.getSqlSession() == session)) {
      holder.released();
    } else {
      // 如果不存在就將該Session關閉掉
      session.close();
    }
  }