萬字長文帶你看懂Mybatis緩存機制

Mybatis是什麼。
Mybatis一級和二級緩存如何配置使用。
Mybatis一級和二級緩存的工作流程及源碼分析。

本次分析中涉及到的代碼和數據庫表均放在Github上，地址: mybatis-cache-demo。

Mybatis的基礎概念

本章節會對Mybatis進行大體的介紹，分爲官方定義和核心組件介紹。

首先是Mybatis官方定義，如下所示。

MyBatis是支持定製化SQL、存儲過程以及高級映射的優秀的持久層框架。MyBatis避免了幾乎所有的JDBC代碼和手動設置參數以及獲取結果集。MyBatis可以對配置和原生Map使用簡單的XML或註解，將接口和Java 的POJOs(Plain Old Java Objects,普通的 Java對象)映射成數據庫中的記錄。

其次是Mybatis的幾個核心概念。

SqlSession : 代表和數據庫的一次會話，向用戶提供了操作數據庫的方法。
MappedStatement: 代表要發往數據庫執行的指令，可以理解爲是Sql的抽象表示。
Executor: 具體用來和數據庫交互的執行器，接受MappedStatement作爲參數。
映射接口: 在接口中會要執行的Sql用一個方法來表示，具體的Sql寫在映射文件中。
映射文件: 可以理解爲是Mybatis編寫Sql的地方，通常來說每一張單表都會對應着一個映射文件，在該文件中會定義Sql語句入參和出參的形式。

下圖就是一個針對Student表操作的接口文件StudentMapper，在StudentMapper中，我們可以若干方法，這個方法背後就是代表着要執行的Sql的意義。

通常也可以把涉及多表查詢的方法定義在StudentMapper中，如果查詢的主體仍然是Student表的信息。也可以將涉及多表查詢的語句單獨抽出一個獨立的接口文件。

在定義完接口文件後，我們會開發一個Sql映射文件，主要由mapper元素和select|insert|update|delete元素構成，如下圖所示。

mapper元素代表這個文件是一個映射文件，使用namespace和具體的映射接口綁定起來，namespace的值就是這個接口的全限定類名。select|insert|update|delete代表的是Sql語句，映射接口中定義的每一個方法也會和映射文件中的語句通過id的方式綁定起來，方法名就是語句的id，同時會定義語句的入參和出參，用於完成和Java對象之間的轉換。

在Mybatis初始化的時候，每一個語句都會使用對應的MappedStatement代表，使用namespace+語句本身的id來代表這個語句。如下代碼所示，使用mapper.StudentMapper.getStudentById代表其對應的Sql。

SELECT id,name,age FROM student WHERE id = #{id}

在Mybatis執行時，會進入對應接口的方法，通過類名加上方法名的組合生成id，找到需要的MappedStatement，交給執行器使用。

至此，Mybatis的基礎概念介紹完畢。

一級緩存

一級緩存介紹

在系統代碼的運行中，我們可能會在一個數據庫會話中，執行多次查詢條件完全相同的Sql，鑑於日常應用的大部分場景都是讀多寫少，這重複的查詢會帶來一定的網絡開銷，同時select查詢的量比較大的話，對數據庫的性能是有比較大的影響的。

如果是Mysql數據庫的話，在服務端和Jdbc端都開啓預編譯支持的話，可以在本地JVM端緩存Statement,可以在Mysql服務端直接執行Sql，省去編譯Sql的步驟，但也無法避免和數據庫之間的重複交互。關於Jdbc和Mysql預編譯緩存的事情，可以看我的這篇博客JDBC和Mysql那些事。

Mybatis提供了一級緩存的方案來優化在數據庫會話間重複查詢的問題。實現的方式是每一個SqlSession中都持有了自己的緩存，一種是SESSION級別，即在一個Mybatis會話中執行的所有語句，都會共享這一個緩存。一種是STATEMENT級別，可以理解爲緩存只對當前執行的這一個statement有效。如果用一張圖來代表一級查詢的查詢過程的話，可以用下圖表示。

每一個SqlSession中持有了自己的Executor，每一個Executor中有一個Local Cache。當用戶發起查詢時，Mybatis會根據當前執行的MappedStatement生成一個key，去Local Cache中查詢，如果緩存命中的話，返回。如果緩存沒有命中的話，則寫入Local Cache，最後返回結果給用戶。

一級緩存配置

上文介紹了一級緩存的實現方式，解決了什麼問題。在這個章節，我們學習如何使用Mybatis的一級緩存。只需要在Mybatis的配置文件中，添加如下語句，就可以使用一級緩存。共有兩個選項，SESSION或者STATEMENT，默認是SESSION級別。

<setting name="localCacheScope" value="SESSION"/>

一級緩存實驗

配置完畢後，通過實驗的方式瞭解Mybatis一級緩存的效果。每一個單元測試後都請恢復被修改的數據。
首先是創建了一個示例表student,爲其創建了對應的POJO類和增改的方法，具體可以在entity包和Mapper包中查看。

CREATE TABLE `student` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(200) COLLATE utf8_bin DEFAULT NULL,
  `age` tinyint(3) unsigned DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8 COLLATE=utf8_bin;

在以下實驗中，id爲1的學生名稱是凱倫。

實驗1

開啓一級緩存，範圍爲會話級別，調用三次getStudentById，代碼如下所示:

public void getStudentById() throws Exception {
        SqlSession sqlSession = factory.openSession(true); // 自動提交事務
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
        System.out.println(studentMapper.getStudentById(1));
        System.out.println(studentMapper.getStudentById(1));
        System.out.println(studentMapper.getStudentById(1));
    }

執行結果:

我們可以看到，只有第一次真正查詢了數據庫,後續的查詢使用了一級緩存。

實驗2

在這次的試驗中，我們增加了對數據庫的修改操作，驗證在一次數據庫會話中，對數據庫發生了修改操作，一級緩存是否會失效。

@Test
public void addStudent() throws Exception {
        SqlSession sqlSession = factory.openSession(true); // 自動提交事務
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
        System.out.println(studentMapper.getStudentById(1));
        System.out.println("增加了" + studentMapper.addStudent(buildStudent()) + "個學生");
        System.out.println(studentMapper.getStudentById(1));
        sqlSession.close();
}

執行結果:

我們可以看到，在修改操作後執行的相同查詢，查詢了數據庫，一級緩存失效。

實驗3

開啓兩個SqlSession，在sqlSession1中查詢數據，使一級緩存生效，在sqlSession2中更新數據庫，驗證一級緩存只在數據庫會話內部共享。

@Test
public void testLocalCacheScope() throws Exception {
        SqlSession sqlSession1 = factory.openSession(true); 
        SqlSession sqlSession2 = factory.openSession(true); 

       StudentMapper studentMapper = sqlSession1.getMapper(StudentMapper.class);
       StudentMapper studentMapper2 = sqlSession2.getMapper(StudentMapper.class);

        System.out.println("studentMapper讀取數據: " + studentMapper.getStudentById(1));
        System.out.println("studentMapper讀取數據: " + studentMapper.getStudentById(1));
        System.out.println("studentMapper2更新了" + studentMapper2.updateStudentName("小岑",1) + "個學生的數據");
        System.out.println("studentMapper讀取數據: " + studentMapper.getStudentById(1));
        System.out.println("studentMapper2讀取數據: " + studentMapper2.getStudentById(1));
}

我們可以看到，sqlSession2更新了id爲1的學生的姓名，從凱倫改爲了小岑，但session1之後的查詢中，id爲1的學生的名字還是凱倫，出現了髒數據，也證明了我們之前就得到的結論，一級緩存只存在於只在數據庫會話內部共享。

一級緩存工作流程&源碼分析

這一章節主要從一級緩存的工作流程和源碼層面對一級緩存進行學習。

工作流程

根據一級緩存的工作流程，我們繪製出一級緩存執行的時序圖，如下圖所示。

主要步驟如下:

對於某個Select Statement，根據該Statement生成key。
判斷在Local Cache中,該key是否用對應的數據存在。
如果命中，則跳過查詢數據庫，繼續往下走。
如果沒命中：
去數據庫中查詢數據，得到查詢結果。
將key和查詢到的結果作爲key和value，放入Local Cache中。
將查詢結果返回。
判斷緩存級別是否爲STATEMENT級別，如果是的話，清空本地緩存。

源碼分析

瞭解具體的工作流程後，我們隊Mybatis查詢相關的核心類和一級緩存的源碼進行走讀。這對於之後學習二級緩存時也有幫助。

SqlSession: 對外提供了用戶和數據庫之間交互需要的所有方法，隱藏了底層的細節。它的一個默認實現類是DefaultSqlSession。

Executor: SqlSession向用戶提供操作數據庫的方法，但和數據庫操作有關的職責都會委託給Executor。

如下圖所示，Executor有若干個實現類，爲Executor賦予了不同的能力，大家可以根據類名，自行私下學習每個類的基本作用。

在一級緩存章節，我們主要學習BaseExecutor。

BaseExecutor: BaseExecutor是一個實現了Executor接口的抽象類，定義若干抽象方法，在執行的時候，把具體的操作委託給子類進行執行。

protected abstract int doUpdate(MappedStatement ms, Object parameter) throws SQLException;
protected abstract List<BatchResult> doFlushStatements(boolean isRollback) throws SQLException;
protected abstract <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException;
protected abstract <E> Cursor<E> doQueryCursor(MappedStatement ms, Object parameter, RowBounds rowBounds, BoundSql boundSql) throws SQLException;

在一級緩存的介紹中，我們提到對Local Cache的查詢和寫入是在Executor內部完成的。在閱讀BaseExecutor的代碼後，我們也發現Local Cache就是它內部的一個成員變量，如下代碼所示。

public abstract class BaseExecutor implements Executor {
protected ConcurrentLinkedQueue<DeferredLoad> deferredLoads;
protected PerpetualCache localCache;

Cache: Mybatis中的Cache接口，提供了和緩存相關的最基本的操作，有若干個實現類，使用裝飾器模式互相組裝，提供豐富的操控緩存的能力。

BaseExecutor成員變量之一的PerpetualCache，就是對Cache接口最基本的實現，其實現非常的簡內部持有了hashmap，對一級緩存的操作其實就是對這個hashmap的操作。如下代碼所示。

public class PerpetualCache implements Cache {
  private String id;
  private Map<Object, Object> cache = new HashMap<Object, Object>();

在閱讀相關核心類代碼後，從源代碼層面對一級緩存工作中涉及到的相關代碼，出於篇幅的考慮，對源碼做適當刪減，讀者朋友可以結合本文，後續進行更詳細的學習。

爲了執行和數據庫的交互，首先會通過DefaultSqlSessionFactory開啓一個SqlSession，在創建SqlSession的過程中，會通過Configuration類創建一個全新的Executor，作爲DefaultSqlSession構造函數的參數，代碼如下所示。

private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
      ............
    final Executor executor = configuration.newExecutor(tx, execType);     
    return new DefaultSqlSession(configuration, executor, autoCommit);
}

如果用戶不進行制定的話，Configuration在創建Executor時，默認創建的類型就是SimpleExecutor,它是一個簡單的執行類，只是單純執行Sql。以下是具體用來創建的代碼。

public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
    executorType = executorType == null ? defaultExecutorType : executorType;
    executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
    Executor executor;
    if (ExecutorType.BATCH == executorType) {
      executor = new BatchExecutor(this, transaction);
    } else if (ExecutorType.REUSE == executorType) {
      executor = new ReuseExecutor(this, transaction);
    } else {
      executor = new SimpleExecutor(this, transaction);
    }
    // 尤其可以注意這裏，如果二級緩存開關開啓的話，是使用CahingExecutor裝飾BaseExecutor的子類
    if (cacheEnabled) {
      executor = new CachingExecutor(executor);                      
    }
    executor = (Executor) interceptorChain.pluginAll(executor);
    return executor;
}

在SqlSession創建完畢後，根據Statment的不同類型，會進入SqlSession的不同方法中，如果是Select語句的話，最後會執行到SqlSession的selectList，代碼如下所示。

@Override
public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) {
      MappedStatement ms = configuration.getMappedStatement(statement);
      return executor.query(ms, wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER);
}

在上文的代碼中，SqlSession把具體的查詢職責委託給了Executor。如果只開啓了一級緩存的話，首先會進入BaseExecutor的query方法。代碼如下所示。

@Override
public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
    BoundSql boundSql = ms.getBoundSql(parameter);
    CacheKey key = createCacheKey(ms, parameter, rowBounds, boundSql);
    return query(ms, parameter, rowBounds, resultHandler, key, boundSql);
}

在上述代碼中，會先根據傳入的參數生成CacheKey，進入該方法查看CacheKey是如何生成的，代碼如下所示。

CacheKey cacheKey = new CacheKey();
cacheKey.update(ms.getId());
cacheKey.update(rowBounds.getOffset());
cacheKey.update(rowBounds.getLimit());
cacheKey.update(boundSql.getSql());
//後面是update了sql中帶的參數
cacheKey.update(value);

在上述的代碼中，我們可以看到它將MappedStatement的Id、sql的offset、Sql的limit、Sql本身以及Sql中的參數傳入了CacheKey這個類，最終生成了CacheKey。我們看一下這個類的結構。

private static final int DEFAULT_MULTIPLYER = 37;
private static final int DEFAULT_HASHCODE = 17;

private int multiplier;
private int hashcode;
private long checksum;
private int count;
private List<Object> updateList;

public CacheKey() {
    this.hashcode = DEFAULT_HASHCODE;
    this.multiplier = DEFAULT_MULTIPLYER;
    this.count = 0;
    this.updateList = new ArrayList<Object>();
}

首先是它的成員變量和構造函數，有一個初始的hachcode和乘數，同時維護了一個內部的updatelist。在CacheKey的update方法中，會進行一個hashcode和checksum的計算，同時把傳入的參數添加進updatelist中。如下代碼所示。

public void update(Object object) {
    int baseHashCode = object == null ? 1 : ArrayUtil.hashCode(object); 
    count++;
    checksum += baseHashCode;
    baseHashCode *= count;
    hashcode = multiplier * hashcode + baseHashCode;
    
    updateList.add(object);
}

我們是如何判斷CacheKey相等的呢，在CacheKey的equals方法中給了我們答案，代碼如下所示。

@Override
public boolean equals(Object object) {
    .............
    for (int i = 0; i < updateList.size(); i++) {
      Object thisObject = updateList.get(i);
      Object thatObject = cacheKey.updateList.get(i);
      if (!ArrayUtil.equals(thisObject, thatObject)) {
        return false;
      }
    }
    return true;
}

除去hashcode，checksum和count的比較外，只要updatelist中的元素一一對應相等，那麼就可以認爲是CacheKey相等。只要兩條Sql的下列五個值相同，即可以認爲是相同的Sql。

Statement Id + Offset + Limmit + Sql + Params

BaseExecutor的query方法繼續往下走，代碼如下所示。

list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;
if (list != null) {
    // 這個主要是處理存儲過程用的。
    handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
    } else {
    list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
}

如果查不到的話，就從數據庫查，在queryFromDatabase中，會對localcache進行寫入。

在query方法執行的最後，會判斷一級緩存級別是否是STATEMENT級別，如果是的話，就清空緩存，這也就是STATEMENT級別的一級緩存無法共享localCache的原因。代碼如下所示。

if (configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) {
        clearLocalCache();
}

在源碼分析的最後，我們確認一下，如果是insert/delete/update方法，緩存就會刷新的原因。

SqlSession的insert方法和delete方法，都會統一走update的流程，代碼如下所示。

@Override
public int insert(String statement, Object parameter) {
    return update(statement, parameter);
  }
   @Override
  public int delete(String statement) {
    return update(statement, null);
}

update方法也是委託給了Executor執行。BaseExecutor的執行方法如下所示。

@Override
public int update(MappedStatement ms, Object parameter) throws SQLException {
    ErrorContext.instance().resource(ms.getResource()).activity("executing an update").object(ms.getId());
    if (closed) {
      throw new ExecutorException("Executor was closed.");
    }
    clearLocalCache();
    return doUpdate(ms, parameter);
}

每次執行update前都會清空localCache。

至此，一級緩存的工作流程講解以及源碼分析完畢。

總結

Mybatis一級緩存的生命週期和SqlSession一致。
Mybatis的緩存是一個粗粒度的緩存，沒有更新緩存和緩存過期的概念，同時只是使用了默認的hashmap，也沒有做容量上的限定。
Mybatis的一級緩存最大範圍是SqlSession內部，有多個SqlSession或者分佈式的環境下，有操作數據庫寫的話，會引起髒數據，建議是把一級緩存的默認級別設定爲Statement，即不使用一級緩存。

二級緩存

二級緩存介紹

在上文中提到的一級緩存中，其最大的共享範圍就是一個SqlSession內部，那麼如何讓多個SqlSession之間也可以共享緩存呢，答案是二級緩存。

當開啓二級緩存後，會使用CachingExecutor裝飾Executor，在進入後續執行前，先在CachingExecutor進行二級緩存的查詢，具體的工作流程如下所示。

在二級緩存的使用中，一個namespace下的所有操作語句，都影響着同一個Cache，即二級緩存是被多個SqlSession共享着的，是一個全局的變量。

當開啓緩存後，數據的查詢執行的流程就是二級緩存 -> 一級緩存 -> 數據庫。

二級緩存配置

要正確的使用二級緩存，需完成如下配置的。

在Mybatis的配置文件中開啓二級緩存。

<setting name="cacheEnabled" value="true"/>

在Mybatis的映射XML中配置cache或者 cache-ref 。

<cache/>

cache標籤用於聲明這個namespace使用二級緩存，並且可以自定義配置。

type: cache使用的類型，默認是PerpetualCache，這在一級緩存中提到過。
eviction: 定義回收的策略，常見的有FIFO，LRU。
flushInterval: 配置一定時間自動刷新緩存，單位是毫秒。
size: 最多緩存對象的個數。
readOnly: 是否只讀，若配置可讀寫，則需要對應的實體類能夠序列化。
blocking: 若緩存中找不到對應的key，是否會一直blocking，直到有對應的數據進入緩存。

<cache-ref namespace="mapper.StudentMapper"/>

cache-ref代表引用別的命名空間的Cache配置，兩個命名空間的操作使用的是同一個Cache。

二級緩存實驗

在本章節，通過實驗，瞭解Mybatis二級緩存在使用上的一些特點。

在以下實驗中，id爲1的學生名稱是點點。

實驗1

測試二級緩存效果，不提交事務，sqlSession1查詢完數據後，sqlSession2相同的查詢是否會從緩存中獲取數據。

@Test
public void testCacheWithoutCommitOrClose() throws Exception {
        SqlSession sqlSession1 = factory.openSession(true); 
        SqlSession sqlSession2 = factory.openSession(true); 
        
        StudentMapper studentMapper = sqlSession1.getMapper(StudentMapper.class);
        StudentMapper studentMapper2 = sqlSession2.getMapper(StudentMapper.class);

        System.out.println("studentMapper讀取數據: " + studentMapper.getStudentById(1));
        System.out.println("studentMapper2讀取數據: " + studentMapper2.getStudentById(1));
}

執行結果:

我們可以看到，當sqlsession沒有調用commit()方法時，二級緩存並沒有起到作用。

實驗2

測試二級緩存效果，當提交事務時，sqlSession1查詢完數據後，sqlSession2相同的查詢是否會從緩存中獲取數據。

@Test
public void testCacheWithCommitOrClose() throws Exception {
        SqlSession sqlSession1 = factory.openSession(true); 
        SqlSession sqlSession2 = factory.openSession(true); 
        
        StudentMapper studentMapper = sqlSession1.getMapper(StudentMapper.class);
        StudentMapper studentMapper2 = sqlSession2.getMapper(StudentMapper.class);

        System.out.println("studentMapper讀取數據: " + studentMapper.getStudentById(1));
        sqlSession1.commit();
        System.out.println("studentMapper2讀取數據: " + studentMapper2.getStudentById(1));
}

從圖上可知，sqlsession2的查詢，使用了緩存，緩存的命中率是0.5。

實驗3

測試update操作是否會刷新該namespace下的二級緩存。

@Test
public void testCacheWithUpdate() throws Exception {
        SqlSession sqlSession1 = factory.openSession(true); 
        SqlSession sqlSession2 = factory.openSession(true); 
        SqlSession sqlSession3 = factory.openSession(true); 
        
        StudentMapper studentMapper = sqlSession1.getMapper(StudentMapper.class);
        StudentMapper studentMapper2 = sqlSession2.getMapper(StudentMapper.class);
        StudentMapper studentMapper3 = sqlSession3.getMapper(StudentMapper.class);
        
        System.out.println("studentMapper讀取數據: " + studentMapper.getStudentById(1));
        sqlSession1.commit();
        System.out.println("studentMapper2讀取數據: " + studentMapper2.getStudentById(1));
        
        studentMapper3.updateStudentName("方方",1);
        sqlSession3.commit();
        System.out.println("studentMapper2讀取數據: " + studentMapper2.getStudentById(1));
}

我們可以看到，在sqlSession3更新數據庫，並提交事務後，sqlsession2的StudentMapper namespace下的查詢走了數據庫，沒有走Cache。

實驗4

驗證Mybatis的二級緩存不適應用於映射文件中存在多表查詢的情況。一般來說，我們會爲每一個單表創建一個單獨的映射文件，如果存在涉及多個表的查詢的話，由於Mybatis的二級緩存是基於namespace的，多表查詢語句所在的namspace無法感應到其他namespace中的語句對多表查詢中涉及的表進行了修改，引發髒數據問題。

@Test
public void testCacheWithDiffererntNamespace() throws Exception {
        SqlSession sqlSession1 = factory.openSession(true); 
        SqlSession sqlSession2 = factory.openSession(true); 
        SqlSession sqlSession3 = factory.openSession(true); 
    
        StudentMapper studentMapper = sqlSession1.getMapper(StudentMapper.class);
        StudentMapper studentMapper2 = sqlSession2.getMapper(StudentMapper.class);
        ClassMapper classMapper = sqlSession3.getMapper(ClassMapper.class);
        
        System.out.println("studentMapper讀取數據: " + studentMapper.getStudentByIdWithClassInfo(1));
        sqlSession1.close();
        System.out.println("studentMapper2讀取數據: " + studentMapper2.getStudentByIdWithClassInfo(1));

        classMapper.updateClassName("特色一班",1);
        sqlSession3.commit();
        System.out.println("studentMapper2讀取數據: " + studentMapper2.getStudentByIdWithClassInfo(1));
}

執行結果:

在這個實驗中，我們引入了兩張新的表，一張class，一張classroom。class中保存了班級的id和班級名，classroom中保存了班級id和學生id。我們在StudentMapper中增加了一個查詢方法getStudentByIdWithClassInfo，用於查詢學生所在的班級，涉及到多表查詢。在ClassMapper中添加了updateClassName，根據班級id更新班級名的操作。

當sqlsession1的studentmapper查詢數據後，二級緩存生效。保存在StudentMapper的namespace下的cache中。當sqlSession3的classMapper的updateClassName方法對class表進行更新時，updateClassName不屬於StudentMapper的namespace，所以StudentMapper下的cache沒有感應到變化，沒有刷新緩存。當StudentMapper中同樣的查詢再次發起時，從緩存中讀取了髒數據。

實驗5

爲了解決實驗4的問題呢，可以使用Cache ref，讓ClassMapper引用StudenMapper命名空間，這樣兩個映射文件對應的Sql操作都使用的是同一塊緩存了。

執行結果:

不過這樣做的後果是，緩存的粒度變粗了，多個Mapper namespace下的所有操作都會對緩存使用造成影響，其實這個緩存存在的意義已經不大了。

二級緩存源碼分析

Mybatis二級緩存的工作流程和前文提到的一級緩存類似，只是在一級緩存處理前，用CachingExecutor裝飾了BaseExecutor的子類，實現了緩存的查詢和寫入功能，所以二級緩存直接從源碼開始分析。

源碼分析

源碼分析從CachingExecutor的query方法展開，源代碼走讀過程中涉及到的知識點較多，不能一一詳細講解，可以在文後留言，我會在交流環節更詳細的表示出來。

CachingExecutor的query方法，首先會從MappedStatement中獲得在配置初始化時賦予的cache。

Cache cache = ms.getCache();

本質上是裝飾器模式的使用，具體的執行鏈是

SynchronizedCache -> LoggingCache -> SerializedCache -> LruCache -> PerpetualCache。

以下是具體這些Cache實現類的介紹，他們的組合爲Cache賦予了不同的能力。

SynchronizedCache: 同步Cache，實現比較簡單，直接使用synchronized修飾方法。
LoggingCache: 日誌功能，裝飾類，用於記錄緩存的命中率，如果開啓了DEBUG模式，則會輸出命中率日誌。
SerializedCache: 序列化功能，將值序列化後存到緩存中。該功能用於緩存返回一份實例的Copy，用於保存線程安全。
LruCache: 採用了Lru算法的Cache實現，移除最近最少使用的key/value。
PerpetualCache: 作爲爲最基礎的緩存類，底層實現比較簡單，直接使用了HashMap。

然後是判斷是否需要刷新緩存，代碼如下所示。

flushCacheIfRequired(ms);

在默認的設置中SELECT語句不會刷新緩存，insert/update/delte會刷新緩存。進入該方法。代碼如下所示。

private void flushCacheIfRequired(MappedStatement ms) {
    Cache cache = ms.getCache();
    if (cache != null && ms.isFlushCacheRequired()) {      
      tcm.clear(cache);
    }
}

Mybatis的CachingExecutor持有了TransactionalCacheManager，即上述代碼中的tcm。

TransactionalCacheManager中持有了一個Map，代碼如下所示。

private Map<Cache, TransactionalCache> transactionalCaches = new HashMap<Cache, TransactionalCache>();

這個Map保存了Cache和用TransactionalCache包裝後的Cache的映射關係。

TransactionalCache實現了Cache接口，CachingExecutor會默認使用他包裝初始生成的Cache，作用是如果事務提交，對緩存的操作纔會生效，如果事務回滾或者不提交事務，則不對緩存產生影響。

在TransactionalCache的clear，有以下兩句。清空了需要在提交時加入緩存的列表，同時設定提交時清空緩存，代碼如下所示。

@Override
public void clear() {
	clearOnCommit = true;
	entriesToAddOnCommit.clear();
}

CachingExecutor繼續往下走，ensureNoOutParams主要是用來處理存儲過程的，暫時不用考慮。

if (ms.isUseCache() && resultHandler == null) {
	ensureNoOutParams(ms, parameterObject, boundSql);

之後會嘗試從tcm中獲取緩存的列表。

List<E> list = (List<E>) tcm.getObject(cache, key);

在getObject方法中，會把獲取值的職責一路向後傳，最終到PerpetualCache。如果沒有查到，會把key加入Miss集合，這個主要是爲了統計命中率。

Object object = delegate.getObject(key);
if (object == null) {
	entriesMissedInCache.add(key);
}

CachingExecutor繼續往下走，如果查詢到數據，則調用tcm.putObject方法，往緩存中放入值。

if (list == null) {
	list = delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
	tcm.putObject(cache, key, list); // issue #578 and #116
}

tcm的put方法也不是直接操作緩存，只是在把這次的數據和key放入待提交的Map中。

@Override
public void putObject(Object key, Object object) {
    entriesToAddOnCommit.put(key, object);
}

從以上的代碼分析中，我們可以明白，如果不調用commit方法的話，由於TranscationalCache的作用，並不會對二級緩存造成直接的影響。因此我們看看Sqlsession的commit方法中做了什麼。代碼如下所示。

@Override
public void commit(boolean force) {
    try {
      executor.commit(isCommitOrRollbackRequired(force));

因爲我們使用了CachingExecutor，首先會進入CachingExecutor實現的commit方法。

@Override
public void commit(boolean required) throws SQLException {
    delegate.commit(required);
    tcm.commit();
}

會把具體commit的職責委託給包裝的Executor。主要是看下tcm.commit()，tcm最終又會調用到TrancationalCache。

public void commit() {
    if (clearOnCommit) {
      delegate.clear();
    }
    flushPendingEntries();
    reset();
}

看到這裏的clearOnCommit就想起剛纔TrancationalCache的clear方法設置的標誌位，真正的清理Cache是放到這裏來進行的。具體清理的職責委託給了包裝的Cache類。之後進入flushPendingEntries方法。代碼如下所示。

private void flushPendingEntries() {
    for (Map.Entry<Object, Object> entry : entriesToAddOnCommit.entrySet()) {
      delegate.putObject(entry.getKey(), entry.getValue());
    }
    ................
}

在flushPendingEntries中，就把待提交的Map循環後，委託給包裝的Cache類，進行putObject的操作。

後續的查詢操作會重複執行這套流程。如果是insert|update|delete的話，會統一進入CachingExecutor的update方法，其中調用了這個函數，代碼如下所示，因此不再贅述。

private void flushCacheIfRequired(MappedStatement ms)

總結

Mybatis的二級緩存相對於一級緩存來說，實現了SqlSession之間緩存數據的共享，同時粒度更加的細，能夠到Mapper級別，通過Cache接口實現類不同的組合，對Cache的可控性也更強。
Mybatis在多表查詢時，極大可能會出現髒數據，有設計上的缺陷，安全使用的條件比較苛刻。
在分佈式環境下，由於默認的Mybatis Cache實現都是基於本地的，分佈式環境下必然會出現讀取到髒數據，需要使用集中式緩存將Mybatis的Cache接口實現，有一定的開發成本，不如直接用Redis，Memcache實現業務上的緩存就好了。

全文總結

本文介紹了Mybatis的基礎概念，Mybatis一二級緩存的使用及源碼分析，並對於一二級緩存進行了一定程度上的總結。

最終的結論是Mybatis的緩存機制設計的不是很完善，在使用上容易引起髒數據問題，個人建議不要使用Mybatis緩存，在業務層面上使用其他機制實現需要的緩存功能，讓Mybatis老老實實做它的ORM框架就好了哈哈。

萬字長文帶你看懂Mybatis緩存機制

目錄

Mybatis的基礎概念

一級緩存

一級緩存介紹

一級緩存配置

一級緩存實驗

一級緩存工作流程&源碼分析

總結

二級緩存

二級緩存介紹

二級緩存配置

二級緩存實驗

二級緩存源碼分析

總結

全文總結

2024年DataOps趨勢預測：AI不會取代數據工程師

雲原生週刊：K8s 中的服務和網絡｜ 2024.4.29

通過Http鏈接地址爬取有贊微信商城商品信息及下載至EXCEL

多人同時導出 Excel 幹崩服務器！新來的阿里大佬給出的解決方案太優雅了！

[轉帖]cpupower

今天，昨天，近七天，近30天，近90天，js封裝

華爲云云原生FinOps解決方案，釋放雲原生最大價值

[沒事練練][Leetcode-2] Add Two Numbers

強烈推薦，做一個健康的RD

[沒事練練][Leetcode-9]Palindrome Number

2千字帶你看懂Mybatis TypeHandler的應用及源碼

4千字帶你看懂Mybatis $和#佔位符的作用

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結