前言

在計算機的世界中，緩存無處不在，操作系統有操作系統的緩存，數據庫也會有數據庫的緩存，各種中間件如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中爲了實現二級緩存，專門用了一個裝飾器來維護，這就是：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中所有緩存的包裝彙總：

緩存包裝器	描述	作用	裝飾條件
PerpetualCache	緩存默認實現類	-	基本功能，默認攜帶
LruCache	LRU淘汰策略緩存（默認淘汰策略）	當緩存達到上限，刪除最近最少使用緩存	eviction=“LRU”
FifoCache	FIFO淘汰策略緩存	當緩存達到上限，刪除最先入隊的緩存	eviction=“FIFO”
SoftCache	JVM軟引用淘汰策略緩存	基於JVM的SoftReference對象	eviction=“SOFT”
WeakCache	JVM弱引用淘汰策略緩存	基於JVM的WeakReference對象	eviction=“WEAK”
LoggingCache	帶日誌功能緩存	輸出緩存相關日誌信息	基本功能，默認包裝
SynchronizedCache	同步緩存	基於synchronized關鍵字實現，用來解決併發問題	基本功能，默認包裝
BlockingCache	阻塞緩存	get/put操作時會加鎖，防止併發，基於Java重入鎖實現	blocking=true
SerializedCache	支持序列化的緩存	通過序列化和反序列化來存儲和讀取緩存	readOnly=false(默認)
ScheduledCache	定時調度緩存	操作緩存時如果緩存已經達到了設置的最長緩存時間時會移除緩存	flushInterval屬性不爲空
TransactionalCache	事務緩存	在TransactionalCacheManager中用於維護緩存map的value值	-

二級緩存應該開啓嗎

既然一級緩存默認是開啓的，而二級緩存是需要我們手動開啓的，那麼我們什麼時候應該開啓二級緩存呢？

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

作者：雙子孤狼
鏈接：https://blog.csdn.net/zwx900102/article/details/108696005
版權聲明：本文爲博主原創文章，遵循 CC 4.0 BY-SA 版權協議，轉載請附上原文出處鏈接和本聲明。

近期熱文推薦：

1.600+ 道 Java面試題及答案整理(2021最新版)

2.終於靠開源項目弄到 IntelliJ IDEA 激活碼了，真香！

3.阿里 Mock 工具正式開源，幹掉市面上所有 Mock 工具！

4.Spring Cloud 2020.0.0 正式發佈，全新顛覆性版本！

5.《Java開發手冊（嵩山版）》最新發布，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！

5 分鐘，徹底掌握 MyBatis 緩存！前言爲什麼要緩存 MyBatis緩存總結

前言

爲什麼要緩存

MyBatis緩存

一級緩存

一級緩存真的存在嗎

一級緩存作用範圍

一級緩存原理分析

一級緩存CacheKey的構成

一級緩存的使用

一級緩存的創建

一級緩存什麼時候會被清除

二級緩存

二級緩存的作用範圍

如何開啓二級緩存

二級緩存原理分析

二級緩存的創建和使用

二級緩存如何進行包裝

二級緩存應該開啓嗎

自定義緩存

MyBatis官方提供的第三方緩存

自己實現二級緩存

總結

爲什麼要⽤ Foundry

【筆記】動手學深度學習-預備知識

py發送email

MySQL 分庫分表方案，總結太全了。。

Qt/C++音視頻開發71-指定mjpeg/h264格式採集本地攝像頭/存儲文件到mp4/設備推流/採集推流

WPF開源輕便、快速的桌面啓動器

公司來了個新同事，把 DDD 運用得爐火純青！

MyBatis 動態 SQL 最全教程，這樣寫 SQL 太優雅了！

MySQL 分庫分表方案，總結太全了。。

公司來了個新同事，把 DDD 運用得爐火純青！

公司新來一個幹練小夥，把 MyBatis 替換成 MyBatis-Plus，上線後哭暈在廁所。。。

美團二面：爲什麼不推薦使用 MyBatis 二級緩存？大部分人都答不上來！

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

linux以太網驅動總結

5 分鐘，徹底掌握 MyBatis 緩存！ 前言 爲什麼要緩存 MyBatis緩存 總結

前言

爲什麼要緩存

MyBatis緩存

一級緩存

一級緩存真的存在嗎

一級緩存作用範圍

一級緩存原理分析

一級緩存CacheKey的構成

一級緩存的使用

一級緩存的創建

一級緩存什麼時候會被清除

二級緩存

二級緩存的作用範圍

如何開啓二級緩存

二級緩存原理分析

二級緩存的創建和使用

二級緩存如何進行包裝

二級緩存應該開啓嗎

自定義緩存

MyBatis官方提供的第三方緩存

自己實現二級緩存

總結

5 分鐘，徹底掌握 MyBatis 緩存！前言爲什麼要緩存 MyBatis緩存總結