前言

在計算機的世界中，緩存無處不在，操作系統有操作系統的緩存，數據庫也會有數據庫的緩存，各種中間件如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"/>

2、在Mapper映射文件內需要配置緩存標簽：

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

3、在select查詢語句標簽上配置useCache屬性，如下：

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

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

不過開啟二級緩存的時候有兩點需要注意：
1、需要commit事務之后才會生效
2、如果使用的是默認緩存，那么結果集對象需要實現序列化接口(Serializable)

如果不實現序列化接口則會報如下錯誤：

image.png

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

 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的緩存工作原理了。