前言

在計算機的世界中，快取無處不在，作業系統有作業系統的快取，資料庫也會有資料庫的快取，各種中間件如Redis也是用來充當快取的作用，編程語言中又可以利用記憶體來作為快取，自然的，作為一款優秀的ORM框架，MyBatis中又豈能少得了快取，那么本文的目的就是帶領大家一起探究一下MyBatis的快取是如何實作的，給我五分鐘，帶你徹底掌握MyBatis的快取作業原理

為什么要快取

在計算機的世界中，CPU的處理速度可謂是一馬當先，遠遠甩開了其他操作，尤其是I/O操作，除了那種CPU密集型的系統，其余大部分的業務系統性能瓶頸最后或多或少都會出現在I/O操作上，所以為了減少磁盤的I/O次數，那么快取是必不可少的，通過快取的使用我們可以大大減少I/O操作次數，從而在一定程度上彌補了I/O操作和CPU處理速度之間的鴻溝，而在我們ORM框架中引入快取的目的就是為了減少讀取資料庫的次數，從而提升查詢的效率，

MyBatis快取

MyBatis中的快取相關類都在cache包下面，而且定義了一個頂級介面Cache，默認只有一個實作類PerpetualCache，PerpetualCache中是內部維護了一個HashMap來實作快取，

下圖就是MyBatis中快取相關類：

需要注意的是decorators包下面的所有類也實作了Cache介面，那么為什么我還是要說Cache只有一個實作類呢？其實看名字就知道了，這個包里面全部是裝飾器，也就是說這其實是裝飾器模式的一種實作，

我們隨意打開一個裝飾器：

可以看到，最終都是呼叫了delegate來實作，只是將部分功能做了增強，其本身都需要依賴Cache的唯一實作類PerpetualCache(因為裝飾器內需要傳入Cache物件，故而只能傳入PerpetualCache物件，因為介面是無法直接new出來傳進去的)，

在MyBatis中存在兩種快取，即一級快取和二級快取，

一級快取

一級快取也叫本地快取，在MyBatis中，一級快取是在會話(SqlSession)層面實作的，這就說明一級快取作用范圍只能在同一個SqlSession中，跨SqlSession是無效的，

MyBatis中一級快取是默認開啟的，不需要任何配置，
我們先來看一個例子驗證一下一級快取是不是真的存在，作用范圍又是不是真的只是對同一個SqlSession有效，

一級快取真的存在嗎

package com.lonelyWolf.mybatis;

import com.lonelyWolf.mybatis.mapper.UserAddressMapper;
import com.lonelyWolf.mybatis.mapper.UserMapper;
import com.lonelyWolf.mybatis.model.LwUser;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

public class TestMyBatisCache {
    public static void main(String[] args) throws IOException {
        String resource = "mybatis-config.xml";
        //讀取mybatis-config組態檔
        InputStream inputStream = Resources.getResourceAsStream(resource);
        //創建SqlSessionFactory物件
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        //創建SqlSession物件
        SqlSession session = sqlSessionFactory.openSession();

        UserMapper userMapper = session.getMapper(UserMapper.class);
        List<LwUser> userList =  userMapper.selectUserAndJob();
        List<LwUser> userList2 =  userMapper.selectUserAndJob();
    }
}

執行后，輸出結果如下：

我們可以看到，sql陳述句只列印了一次，這就說明第2次用到了快取，這也足以證明一級快取確實是存在的而且默認就是是開啟的，

一級快取作用范圍

現在我們再來驗證一下一級快取是否真的只對同一個SqlSession有效，我們對上面的示例代碼進行如下改變：

 SqlSession session1 = sqlSessionFactory.openSession();
 SqlSession session2 = sqlSessionFactory.openSession();

 UserMapper userMapper1 = session1.getMapper(UserMapper.class);
 UserMapper userMapper2 = session2.getMapper(UserMapper.class);
 List<LwUser> userList =  userMapper1.selectUserAndJob();
 List<LwUser> userList2 =  userMapper2.selectUserAndJob();

這時候再次運行，輸出結果如下：

可以看到，列印了2次，沒有用到快取，也就是不同SqlSession中不能共享一級快取，

一級快取原理分析

首先讓我們來想一想，既然一級快取的作用域只對同一個SqlSession有效，那么一級快取應該存盤在哪里比較合適是呢？

是的，自然是存盤在SqlSession內是最合適的，那我們來看看SqlSession的唯一實作類DefaultSqlSession：

DefaultSqlSession中只有5個成員屬性，后面3個不用說，肯定不可能用來存盤快取，然后Configuration又是一個全域的組態檔，也不合適存盤一級快取，這么看來就只有Executor比較合適了，因為我們知道，SqlSession只提供對外介面，實際執行sql的就是Executor，

既然這樣，那我們就進去看看Executor的實作類BaseExecutor：

看到果然有一個localCache，而上面我們有提到PerpetualCache內快取是用一個HashMap來存盤快取的，那么接下來大家肯定就有以下問題：

• 快取是什么時候創建的？
• 快取的key是怎么定義的？
• 快取在何時使用
• 快取在什么時候會失效?

接下來就讓我們逐一分析

一級快取CacheKey的構成

既然快取那么肯定是針對的查詢陳述句，一級快取的創建就是在BaseExecutor中的query方法內創建的：

createCacheKey這個方法的代碼就不貼了，在這里我總結了一下CacheKey的組成，CacheKey主要是由以下6部分組成

• 1、將Statement中的id添加到CacheKey物件中的updateList屬性
• 2、將offset(分頁偏移量)添加到CacheKey物件中的updateList屬性(如果沒有分頁則默認0)
• 3、將limit(每頁顯示的條數)添加到CacheKey物件中的updateList屬性(如果沒有分頁則默認Integer.MAX_VALUE)
• 4、將sql陳述句(包括占位符?)添加到CacheKey物件中的updateList屬性
• 5、回圈用戶傳入的引數，并將每個引數添加到CacheKey物件中的updateList屬性
• 6、如果有配置Environment，則將Environment中的id添加到CacheKey物件中的updateList屬性

一級快取的使用

創建完CacheKey之后，我們繼續進入query方法：

可以看到，在查詢之前就會去localCache中根據CacheKey物件來獲取快取，獲取不到才會呼叫后面的queryFromDatabase方法

一級快取的創建

queryFromDatabase方法中會將查詢得到的結果存盤到localCache中

一級快取什么時候會被清除

一級快取的清除主要有以下兩個地方：

• 1、就是獲取快取之前會先進行判斷用戶是否配置了flushCache=true屬性（參考一級快取的創建代碼截圖），如果配置了則會清除一級快取，
• 2、MyBatis全域配置屬性localCacheScope配置為Statement時，那么完成一次查詢就會清除快取，
• 3、在執行commit，rollback，update方法時會清空一級快取，

PS：利用插件我們也可以自己去將快取清除，后面我們會介紹插件相關知識，

二級快取

一級快取因為只能在同一個SqlSession中共享，所以會存在一個問題，在分布式或者多執行緒的環境下，不同會話之間對于相同的資料可能會產生不同的結果，因為跨會話修改了資料是不能互相感知的，所以就有可能存在臟資料的問題，正因為一級快取存在這種不足，所以我們需要一種作用域更大的快取，這就是二級快取，

二級快取的作用范圍

一級快取作用域是SqlSession級別，所以它存盤的SqlSession中的BaseExecutor之中，但是二級快取目的就是要實作作用范圍更廣，那肯定是要實作跨會話共享的，在MyBatis中二級快取的作用域是namespace，也就是作用范圍是同一個命名空間，所以很顯然二級快取是需要存盤在SqlSession之外的，那么二級快取應該存盤在哪里合適呢？

在MyBatis中為了實作二級快取，專門用了一個裝飾器來維護，這就是我們上一篇文章介紹Executor時還留下的沒有介紹的一個物件：CachingExecutor，

如何開啟二級快取

二級快取相關的配置有三個地方：
1、mybatis-config中有一個全域配置屬性，這個不配置也行，因為默認就是true，

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

想詳細了解mybatis-config的可以點擊這里，
2、在Mapper映射檔案內需要配置快取標簽：

<cache/>
或
<cache-ref namespace="com.lonelyWolf.mybatis.mapper.UserAddressMapper"/>

想詳細了解Mapper映射的所有標簽屬性配置可以點擊這里，
3、在select查詢陳述句標簽上配置useCache屬性，如下：

<select id="selectUserAndJob" resultMap="JobResultMap2" useCache="true">
        select * from lw_user
    </select>

以上配置第1點是默認開啟的，也就是說我們只要配置第2點就可以打開二級快取了，而第3點是當我們需要針對某一條陳述句來配置二級快取時候則可以使用，

不過開啟二級快取的時候有兩點需要注意：
1、需要commit事務之后才會生效
2、如果使用的是默認快取，那么結果集物件需要實作序列化介面(Serializable)

如果不實作序列化介面則會報如下錯誤：

接下來我們通過一個例子來驗證一下二級快取的存在，還是用上面一級快取的例子進行如下改造：

 SqlSession session1 = sqlSessionFactory.openSession();
        UserMapper userMapper1 = session1.getMapper(UserMapper.class);
        List<LwUser> userList =  userMapper1.selectUserAndJob();
        session1.commit();//注意這里需要commit,否則快取不會生效

        SqlSession session2 = sqlSessionFactory.openSession();
        UserMapper userMapper2 = session2.getMapper(UserMapper.class);
        List<LwUser> userList2 =  userMapper2.selectUserAndJob();

然后UserMapper.xml映射檔案中，新增如下配置：

<cache/>

運行代碼，輸出如下結果:

上面輸出結果中只輸出了一次sql，說明用到了快取，而因為我們是跨會話的，所以肯定就是二級快取生效了，

二級快取原理分析

上面我們提到二級快取是通過CachingExecutor物件來實作的，那么就讓我們先來看看這個物件：

我們看到CachingExecutor中只有2個屬性，第1個屬性不用說了，因為CachingExecutor本身就是Executor的包裝器，所以屬性TransactionalCacheManager肯定就是用來管理二級快取的，我們再進去看看TransactionalCacheManager物件是如何管理快取的：

TransactionalCacheManager內部非常簡單，也是維護了一個HashMap來存盤快取，
HashMap中的value是一個TransactionalCache物件，繼承了Cache，

注意上面有一個屬性是臨時存盤二級快取的，為什么要有這個屬性，我們下面會解釋，

二級快取的創建和使用

我們在讀取mybatis-config全域組態檔的時候會根據我們配置的Executor型別來創建對應的三種Executor中的一種，然后如果我們開啟了二級快取之后，只要開啟(全域組態檔中配置為true)就會使用CachingExecutor來對我們的三種基本Executor進行包裝，即使Mapper.xml映射檔案沒有開啟也會進行包裝，

接下來我們看看CachingExecutor中的query方法：

上面方法大致經過如下流程：

• 1、創建一級快取的CacheKey
• 2、獲取二級快取
• 3、如果沒有獲取到二級快取則執行被包裝的Executor物件中的query方法，此時會走一級快取中的流程，
• 4、查詢到結果之后將結果進行快取，

需要注意的是在事務提交之前，并不會真正存盤到二級快取，而是先存盤到一個臨時屬性，等事務提交之后才會真正存盤到二級快取，這么做的目的就是防止臟讀，因為假如你在一個事務中修改了資料，然后去查詢，這時候直接快取了，那么假如事務回滾了呢？所以這里會先臨時存盤一下，
所以我們看一下commit方法：

二級快取如何進行包裝

最開始我們提到了一些快取的包裝類，這些都到底有什么用呢？
在回答這個問題之前，我們先斷點一下看看獲取到的二級快取長啥樣：

從上面可以看到，經過了層層包裝，從內到外一次經過如下包裝：

• 1、PerpetualCache：第一層快取，這個是快取的唯一實作類，肯定需要，
• 2、LruCache：二級快取淘汰機制之一，因為我們配置的默認機制，而默認就是LRU演算法淘汰機制，淘汰機制總共有4中，我們可以自己進行手動配置，
• 3、SerializedCache：序列化快取，這就是為什么開啟了默認二級快取我們的結果集物件需要實作序列化介面，
• 4、LoggingCache：日志快取，
• 5、SynchronizedCache：同步快取機制，這個是為了保證多執行緒機制下的執行緒安全性，

下面就是MyBatis中所有快取的包裝匯總：

二級快取應該開啟嗎

既然一級快取默認是開啟的，而二級快取是需要我們手動開啟的，那么我們什么時候應該開啟二級快取呢？

1、因為所有的update操作(insert,delete,uptede)都會觸發快取的重繪，從而導致二級快取失效，所以二級快取適合在讀多寫少的場景中開啟，

2、因為二級快取針對的是同一個namespace，所以建議是在單表操作的Mapper中使用，或者是在相關表的Mapper檔案中共享同一個快取，

自定義快取

一級快取可能存在臟讀情況，那么二級快取是否也可能存在呢？

是的，默認的二級快取畢竟也是存盤在本地快取，所以對于微服務下是可能出現臟讀的情況的，所以這時候我們可能會需要自定義快取，比如利用redis來存盤快取，而不是存盤在本地記憶體當中，

MyBatis官方提供的第三方快取

MyBatis官方也提供了一些第三方快取的支持，如：encache和redis，下面我們以redis為例來演示一下：
引入pom檔案：

<dependency>
            <groupId>org.mybatis.caches</groupId>
            <artifactId>mybatis-redis</artifactId>
            <version>1.0.0-beta2</version>
        </dependency>

然后快取配置如下：

<cache type="org.mybatis.caches.redis.RedisCache"></cache>

然后在默認的resource路徑下新建一個redis.properties檔案：

host=localhost
port=6379

然后執行上面的示例，查看Cache，已經被Redis包裝：

自己實作二級快取

如果要實作一個自己的快取的話，那么我們只需要新建一個類實作Cache介面就好了，然后重寫其中的方法,如下：

package com.lonelyWolf.mybatis.cache;

import org.apache.ibatis.cache.Cache;

public class MyCache implements Cache {
    @Override
    public String getId() {
        return null;
    }
    @Override
    public void putObject(Object o, Object o1) {
        
    }
    @Override
    public Object getObject(Object o) {
        return null;
    }

    @Override
    public Object removeObject(Object o) {
        return null;
    }

    @Override
    public void clear() {
    }

    @Override
    public int getSize() {
        return 0;
    }
}

上面自定義的快取中,我們只需要在對應方法，如putObject方法，我們把快取存到我們想存的地方就行了，方法全部重寫之后，然后配置的時候type配上我們自己的類就可以實作了，在這里我們就不做演示了

總結

本文主要分析了MyBatis的快取是如何實作的，并且分別演示了一級快取和二級快取，并分析了一級快取和二級快取所存在的問題，最后也介紹了如何使用第三方快取和如何自定義我們自己的快取，通過本文，我想大家應該可以徹底掌握MyBatis的快取作業原理了，

下一篇，將會介紹MyBatis插件的實作原理

請關注我，和孤狼一起學習進步，