MyBatis快取

mybatis – MyBatis 3 | cache

MyBatis 一級快取全詳解(一)

MyBatis 內置了一個強大的事務性查詢快取機制，它可以非常方便地配置和定制，為了使它更加強大而且易于配置，我們對 MyBatis 3 中的快取實作進行了許多改進，

1.一級快取

1.1基本說明

Mybatis的一級快取（也叫本地快取/Local Cache）是指SqlSession級別的，作用域是SqlSession，

Mybatis默認開啟一級快取，在同一個SqlSession中，相同的Sql查詢的時候，第一次查詢的時候，就會從快取中取，如果發現沒有資料，那么就從資料庫查詢出來，并且快取到HashMap中，如果下次還是相同的查詢，就直接從快取中查詢，就不在去查詢資料庫，對應的就不在去執行SQL陳述句，

當查詢到的資料，進行增刪改的操作的時候，快取將會失效，在spring容器管理中每次查詢都是創建一個新的sqlSession，所以在分布式環境中不會出現資料不一致的問題，

一級快取原理圖：

在引數和SQL完全一樣的情況下，我們使用同一個SqlSession物件呼叫一個Mapper方法，往往只執行一次SQL，因為使用SelSession第一次查詢后，MyBatis會將其放在快取中，以后再查詢的時候，如果沒有宣告需要重繪，并且快取沒有超時的情況下，SqlSession都會取出當前快取的資料，而不會再次發送SQL到資料庫，

每一次會話都對應自己的一級快取，作用范圍比較小，一旦會話關閉就查詢不到了，

1.2快速入門

需求：當第一次查詢id=1的Monster后，再次查詢id=1的monster物件，就會直接從一級快取獲取，不會再次發出sql

（1）Monster物體類

package com.li.entity;

import java.util.Date;

/**
 * @author 李
 * @version 1.0
 */
public class Monster {
    //屬性和表的欄位對應
    private Integer id;
    private Integer age;
    private String name;
    private String email;
    private Date birthday;
    private double salary;
    private Integer gender;
    
    //省略全參、無參構造器、setter、getter、toString方法
}

（2）MonsterMapper介面方法

//查詢-根據id
public Monster getMonsterById(Integer id);
//查詢所有的Monster
public List<Monster> findAllMonster();

（3）映射檔案（部分）

<mapper namespace="com.li.mapper.MonsterMapper">
    <!--配置getMonsterById方法-->
    <select id="getMonsterById" resultType="Monster">
        SELECT * FROM `monster` WHERE id=#{id};
    </select>

    <!--實作findAllMonster方法-->
    <select id="findAllMonster" resultType="Monster">
        SELECT * FROM `monster`;
    </select>
</mapper>

（4）測驗（部分代碼）

//測驗一級快取
@Test
public void level1CacheTest() {
    System.out.println("==========第一次查詢=========");
    Monster monster = monsterMapper.getMonsterById(10);
    System.out.println("monster=" + monster);
    System.out.println("==========第二次查詢=========");
    Monster monster2 = monsterMapper.getMonsterById(10);
    System.out.println("monster=" + monster2);
    //關閉sqlSession會話
    if (sqlSession != null) {
        sqlSession.close();
    }
}

一級快取默認打開，在同一個會話中，當重復查詢時，不會再發出sql陳述句，而是從一級快取中直接獲取資料：

注意是重復查詢，如果是不同的查詢操作還是會向資料庫發出sql

1.3一級快取是什么？

一級快取到底是什么？

我們通過查看SqlSession的結構可以看出，一級快取就是一個HashMap，快取其實就是一個本地存放的map物件，每一個SqlSession都會存放一個map對應的參考，

1.4一級快取的執行流程

MyBatis快取機制

1.5一級快取失效分析

1.5.1關閉SqlSession會話后，一級快取失效

我們知道，一級快取是和SqlSession會話關聯的，一旦SqlSession關閉了，一級快取就會失效，測驗如下：

//測驗一級快取失效
@Test
public void level1CacheTest2() {
    System.out.println("==========第1次查詢=========");
    Monster monster = monsterMapper.getMonsterById(10);
    System.out.println("monster=" + monster);
    //關閉sqlSession,一級快取失效
    if (sqlSession != null) {
        sqlSession.close();
    }

    System.out.println("==========第2次查詢=========");
    sqlSession = MybatisUtils.getSqlSession();//重新獲取SqlSession物件
    monsterMapper = sqlSession.getMapper(MonsterMapper.class);//重新初始化
    Monster monster2 = monsterMapper.getMonsterById(10);
    System.out.println("monster2=" + monster2);
    if (this.sqlSession != null) {
        this.sqlSession.close();
    }
}

結果：可以看到兩次查詢都發出了sql操作，說明如果SqlSession會話關閉了，第二次查詢依然回到資料庫查詢，一級快取失效，

1.5.2手動清理快取，一級快取失效

當執行sqlSession.clearCache()時（手動清理快取），一級快取失效，

clearCache()方法底層執行如下：

測驗方法如下：

//測驗一級快取失效
@Test
public void level1CacheTest3() {
    System.out.println("==========第1次查詢=========");
    Monster monster = monsterMapper.getMonsterById(10);
    System.out.println("monster=" + monster);

    //手動清理快取，也會導致一級快取失效
    sqlSession.clearCache();

    System.out.println("==========第2次查詢=========");
    Monster monster2 = monsterMapper.getMonsterById(10);
    System.out.println("monster2=" + monster2);
    if (this.sqlSession != null) {
        this.sqlSession.close();
    }
}

測驗結果如下，查詢操作相同，且在同一個SqlSession會話內，但底層仍然到資料庫執行了兩次相同操作，這說明當手動清理快取后，一級快取也會失效，

1.5.3對查詢的資料，進行增刪改操作時，一級快取失效

在兩次相同的查詢中間進行update操作，是否會對一級快取產生影響？

//如果被查詢的資料進行了增刪改操作，會導致一級快取資料失效
@Test
public void level1CacheTest4() {
    System.out.println("==========第1次查詢=========");
    Monster monster = monsterMapper.getMonsterById(10);
    System.out.println("monster=" + monster);

    //對要查詢的資料id=10進行update操作
    monster.setName("金蟬子");
    monsterMapper.updateMonster(monster);

    System.out.println("==========第2次查詢=========");
    Monster monster2 = monsterMapper.getMonsterById(10);
    System.out.println("monster2=" + monster2);
    if (sqlSession != null) {
        sqlSession.commit();//注意提交事務
        sqlSession.close();
    }
}

如下，在兩次相同查詢操作之間進行update操作，一級快取同樣失效了，因為第二次查詢操作仍然向資料庫發出sql陳述句，

2.二級快取

2.1基本介紹

二級快取和一級快取都是為了提高檢索效率而創建的技術
兩者最大的區別就是作用域范圍不一樣
- 一級快取的作用域是sqlSession會話級別，在一次會話中有效
- 二級快取的作用域是全域范圍，針對不同的SqlSession會話都有效，二級快取又稱"全域快取"，是基于namespace級別的快取，一個namespace對應一個二級快取
當一級快取的會話被關閉時，一級快取的資料就會被放入二級快取，前提是二級快取是開啟的，

二級快取原理圖：

開啟二級快取后，會使用CachingExecutor裝飾Executor，進入一級快取的查詢流程前，先在CachingExecutor進行二級快取的查詢，具體的作業流程如下所示，

二級快取開啟后，同一個namespace下的所有操作陳述句，都影響著同一個Cache，即二級快取被多個SqlSession共享，是一個全域的變數，當開啟快取后，資料的查詢執行的流程就是 二級快取 -> 一級快取 -> 資料庫，

2.2快速入門

（1）mybatis-config.xml配置中開啟二級快取

設定名	描述	有效值	默認值
cacheEnabled	全域性開啟或關閉所有映射器組態檔中已配置的任何快取	true、false	true

<settings>
    <!--開啟二級快取，默認下值為true-->
    <setting name="cacheEnabled" value="https://www.cnblogs.com/liyuelian/p/true"/>
</settings>

（2）使用二級快取時entity類實作序列化介面（serializable），因為二級快取可能使用到序列化技術

大部分情況下，二級快取不去置序列化也可以使用，只是有些二級快取產品可能用到序列化

（3）在對應的xxMapper.xml中設定二級快取的策略

<!--配置二級快取
FIFO：先進先出，按物件進入快取的順序來移除它們
flushInterval：重繪間隔為60000ms，即60s
size：存盤結果物件或串列的 512 個參考，默認為1024
readOnly：只讀屬性，如果只用于讀操作，建議設定成true，如果有修改操作，則設定為false（默認）
-->
<cache eviction="FIFO" flushInterval="60000" size="512" readOnly="true"/>

（4）測驗

//測驗二級快取
@Test
public void level2CacheTest() {
    System.out.println("==========第一次查詢=========");
    Monster monster = monsterMapper.getMonsterById(5);
    System.out.println("monster=" + monster);
    //關閉這個會話
    if (sqlSession != null) {
        sqlSession.close();
    }

    System.out.println("==========第二次查詢=========");
    //獲取新的sqlSession會話
    sqlSession = MybatisUtils.getSqlSession();
    monsterMapper = sqlSession.getMapper(MonsterMapper.class);
    Monster monster2 = monsterMapper.getMonsterById(5);
    System.out.println("monster=" + monster2);
    if (this.sqlSession != null) {
        this.sqlSession.close();
    }
}

測驗結果：二級快取的作用域是全域范圍，因此不同的sqlSession會話都有效

二級快取命中率 = 快取生效的次數 / 總查詢的次數

2.3注意事項和使用細節

2.3.1二級快取的策略的引數

要啟用全域的二級快取，只需要在你的 SQL 映射檔案中添加一行：

<cache/>

可以通過 cache 元素的屬性來修改你的策略，比如：

<cache
  eviction="FIFO"
  flushInterval="60000"
  size="512"
  readOnly="true"/>

配置創建了一個 FIFO 快取，每隔 60 秒重繪，最多可以存盤結果物件或串列的 512 個參考，而且回傳的物件被認為是只讀的，因此對它們進行修改可能會在不同執行緒中的呼叫者產生沖突，

eviction：快取的回收策略，

flushInterval（重繪間隔）屬性為任意的正整數，設定的值應該是一個以毫秒為單位時間，默認情況是不設定，也就是沒有重繪間隔，快取僅僅會在呼叫陳述句時重繪，

size（參考數目）屬性為任意正整數，欲快取物件的大小和運行環境中可用的記憶體資源有關，默認值為 1024，

readOnly（只讀）屬性可以為 true 或 false，只讀快取會給所有呼叫者回傳快取物件的相同實體，因此這些物件不能被修改，從而使性能提升，而可讀寫的快取會（通過序列化）回傳快取物件的拷貝，速度上會慢一些，但是更安全，因此默認值是 false，

2.3.2四大策略

LRU – 最近最少使用：移除最長時間不被使用的物件，（默認策略）
FIFO – 先進先出：按物件進入快取的順序來移除它們，
SOFT – 軟參考：基于垃圾回收器狀態和軟參考規則移除物件，
WEAK – 弱參考：更積極地基于垃圾收集器狀態和弱參考規則移除物件，

2.3.3如何禁用二級快取

（1）在mybatis-config.xml檔案的settings標簽中設定二級快取的開關，

注意這里的配置只是和二級快取有關，和一級快取無關

<settings>
    <!--全域性開啟或關閉所有映射器組態檔中已經配置的任何快取，可以理解為二級快取的總開關，默認為true-->
    <setting name="cacheEnabled" value="https://www.cnblogs.com/liyuelian/p/false"/>
</settings>

（2）二級快取的設定不僅要在組態檔中設定，還要在對應的映射檔案中配置才有效，因此如果要禁用二級快取，也可以在對應的映射檔案中注銷cache元素，這時候二級快取對該映射檔案無效，

（3）或者使用控制力度更加精確的方法，直接在配置方法上指定

設定useCache="false"可以禁用當前select陳述句的二級快取，即每次查詢都會發出sql去查詢，默認情況為true

注意：一般不用去修改，使用默認的即可

2.3.4重繪二級快取的設定

insert，update，delete 操作資料后需要重繪快取，如果不執行重繪快取會出現臟讀：

默認情況下 flushCache 的值為true，一般不用修改，

3.一級快取和二級快取的執行順序

快取的執行順序為：二級快取-->一級快取-->資料庫

測驗：驗證快取的執行順序，我們事先打開二級快取和一級快取，

//二級快取->一級快取->資料庫
@Test
public void cacheSeqTest() {
    System.out.println("==========第1次查詢=========");
    //Cache Hit Ratio: 0.0
    Monster monster = monsterMapper.getMonsterById(8);
    System.out.println(monster);

    //當一級快取的會話被關閉時，一級快取的資料就會被放入二級快取，前提是二級快取是開啟的
    sqlSession.close();

    sqlSession = MybatisUtils.getSqlSession();
    monsterMapper = sqlSession.getMapper(MonsterMapper.class);
    System.out.println("==========第2次查詢=========");
    //從二級快取獲取 id=8 的 monster資訊 
    //Cache Hit Ratio: 0.5
    Monster monster2 = monsterMapper.getMonsterById(8);
    System.out.println(monster2);

    System.out.println("==========第3次查詢=========");
    //這時一二級快取都有資料，但是由于先查詢二級快取，因此資料依然是從二級快取中獲取的
    //Cache Hit Ratio: 0.6666666666666666
    Monster monster3 = monsterMapper.getMonsterById(8);
    System.out.println(monster3);
    sqlSession.close();
}

注意事項：

不會出現一級快取和二級快取中有同一個資料，因為二級快取的資料是在一級快取關閉之后才有的，（當一級快取的會話被關閉時，如果二級快取開啟了，一級快取的資料就會被放入二級快取）

//分析執行順序，二級快取的資料是在一級快取被關閉之后才有的，不會出現一二級快取同時擁有相同資料的情況
@Test
public void cacheSeqTest2() {
    System.out.println("==========第1次查詢=========");
    //二級快取命中率 Cache Hit Ratio: 0.0，走資料庫
    Monster monster = monsterMapper.getMonsterById(8);
    System.out.println(monster);

    System.out.println("==========第2次查詢=========");
    //Cache Hit Ratio: 0.0
    //拿的是一級快取的資料，不會發出sql
    Monster monster2 = monsterMapper.getMonsterById(8);
    System.out.println(monster2);

    System.out.println("==========第3次查詢=========");
    //Cache Hit Ratio: 0.0
    //拿的是一級快取的資料，不會發出sql
    Monster monster3 = monsterMapper.getMonsterById(8);
    System.out.println(monster3);
    if (sqlSession != null) {
        sqlSession.close();
    }
}

4.EhCache快取

4.1基本介紹

Ehcache組態檔ehcache.xml

EhCache是一個純Java的快取框架，具有快速、精干等特點
Mybatis有自己默認的二級快取（前面我們已經講過了），但是在實際專案中，往往使用的是更加專業的第三方快取產品，作為MyBatis的二級快取，EhCache就是非常優秀的快取產品

4.2配置和使用EhCache

（1）加入相關依賴，修改pom.xml檔案

<dependencies>
    <!--引入EhCache核心庫-->
    <dependency>
        <groupId>net.sf.ehcache</groupId>
        <artifactId>ehcache-core</artifactId>
        <version>2.6.11</version>
    </dependency>
    <!--引入需要使用的slf4j-->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.25</version>
    </dependency>
    <!--引入mybatis整合ehcache庫-->
    <dependency>
        <groupId>org.mybatis.caches</groupId>
        <artifactId>mybatis-ehcache</artifactId>
        <version>1.2.1</version>
    </dependency>
</dependencies>

（2）確保mybatis-config.xml檔案打開了二級快取

<settings>
    <!--不配置也可以，因為二級快取默認是打開的-->
    <setting name="cacheEnabled" value="https://www.cnblogs.com/liyuelian/p/true"/>
</settings>

（3）在resource目錄下加入ehcache.xml 組態檔

Java Ehcache快取的timeToIdleSeconds和timeToLiveSeconds區別 - TaoBye

<?xml version="1.0" encoding="UTF-8"?>
<ehcache>
    <!--diskStore：為快取路徑，ehcache分為記憶體和磁盤兩級，此屬性定義磁盤的快取位置，引數解釋如下：
       user.home – 用戶主目錄
       user.dir  – 用戶當前作業目錄
       java.io.tmpdir – 默認臨時檔案路徑 -->
    <diskStore path="java.io.tmpdir/Tmp_EhCache"/>

    <!--defaultCache：默認快取策略，當ehcache找不到定義的快取時，使用這個快取策略，只能定義一個-->
    <!--name:快取名稱，
      maxElementsInMemory:快取最大數目
      maxElementsOnDisk：硬碟最大快取個數，
      eternal:物件是否永久有效，一但設定了，timeout將不起作用，
      overflowToDisk:是否保存到磁盤，當系統宕機時
      timeToIdleSeconds:設定物件在失效前的允許閑置時間（單位：秒），僅當eternal=false物件不是永久有效時使用，可選屬性，默認值是0，也就是可閑置時間無窮大，
      timeToLiveSeconds:設定物件在失效前允許存活時間（單位：秒），最大時間介于創建時間和失效時間之間，僅當eternal=false物件不是永久有效時使用，默認是0，也就是物件存活時間無窮大，
      diskPersistent：是否快取虛擬機重啟期資料 Whether the disk store persists between restarts of the Virtual Machine. The default value is false.
      diskSpoolBufferSizeMB：這個引數設定DiskStore（磁盤快取）的快取區大小，默認是30MB，每個Cache都應該有自己的一個緩沖區，
      diskExpiryThreadIntervalSeconds：磁盤失效執行緒運行時間間隔，默認是120秒，
      memoryStoreEvictionPolicy：當達到maxElementsInMemory限制時，Ehcache將會根據指定的策略去清理記憶體，默認策略是LRU（最近最少使用），你可以設定為FIFO（先進先出）或是LFU（較少使用），
      clearOnFlush：記憶體數量最大時是否清除，
      memoryStoreEvictionPolicy:可選策略有：LRU（最近最少使用，默認策略）、FIFO（先進先出）、LFU（最少訪問次數），
      FIFO，first in first out，這個是大家最熟的，先進先出，
      LFU， Less Frequently Used，就是上面例子中使用的策略，直白一點就是講一直以來最少被使用的，如上面所講，快取的元素有一個hit屬性，hit值最小的將會被清出快取，
      LRU，Least Recently Used，最近最少使用的，快取的元素有一個時間戳，當快取容量滿了，而又需要騰出地方來快取新的元素的時候，那么現有快取元素中時間戳離當前時間最遠的元素將被清出快取，-->
    <defaultCache
            eternal="false"
            maxElementsInMemory="10000"
            overflowToDisk="false"
            diskPersistent="false"
            timeToIdleSeconds="1800"
            timeToLiveSeconds="259200"
            memoryStoreEvictionPolicy="LRU"/>
</ehcache>

（4）在XxxMapper.xml中啟用了EhCace，當然原來Mybatis自帶的快取配置需要注銷

<!--啟用ehcache-->
<cache type="org.mybatis.caches.ehcache.EhcacheCache"/>

（5）測驗

//測驗二級快取
@Test
public void ehCacheTest() {
    System.out.println("==========第1次查詢=========");
    Monster monster = monsterMapper.getMonsterById(5);
    System.out.println("monster=" + monster);

    //關閉當前會話，一級快取資料失效，將資料放入二級快取（此時為 ehcache）
    if (sqlSession != null) {
        sqlSession.close();
    }

    //獲取新的sqlSession會話
    sqlSession = MybatisUtils.getSqlSession();
    monsterMapper = sqlSession.getMapper(MonsterMapper.class);

    System.out.println("==========第2次查詢=========");
    //從二級快取ehcache中獲取資料，不會發出sql
    Monster monster2 = monsterMapper.getMonsterById(5);
    System.out.println("monster=" + monster2);

    System.out.println("==========第3次查詢=========");
    //還是從二級快取獲取資料，不會發出sql
    Monster monster3 = monsterMapper.getMonsterById(5);
    System.out.println("monster=" + monster3);
    if (this.sqlSession != null) {
        this.sqlSession.close();
    }
}