MyBatis-05 缓存机制

MyBatis框架具有非常强大的查询缓存特性，可以非常方便地配置和定制，能够极大提升查询效率。

MyBatis框架默认定义了两级缓存，即一级缓存和二级缓存。

• 默认情况下，只有一级缓存开启，而二级缓存需要手动开启和配置。
• 一级缓存是SqlSession级别的缓存，也称为本地缓存，而二级缓存是基于namespace级别的缓存。
• 为了提高扩展性，MyBatis框架定义了缓存接口Cache，可通过实现Cache接口来自定义二级缓存。

其中，MyBatis中缓存机制的具体测试代码下载地址：https://download.csdn.net/download/bingbeichen/10537412。

---

1. 一级缓存

什么是一级缓存，具体体验是什么样的？

一级缓存默认开启，即与数据库同一次回话期间查询到的数据会存放在本地缓存（本质上是一个Map对象）中，后续如果需要获取相同的数据，则直接从本地缓存中读取数据，而无需再去数据库中查询数据。

一级缓存(local cache)，即本地缓存, 作用域默认为sqlSession。当Session flush或close后, 该Session中的所有Cache将被清空。本地缓存不能被关闭, 但可以调用clearCache()方法来清空本地缓存, 或者改变缓存的作用域。

体验一级缓存的测试代码段如下：

@Test
public void testFirstLevelCache() throws IOException {
    SqlSession sqlSession = getSqlSessionFactory().openSession();
    try {
        EmployeeMapper mapper = sqlSession.getMapper(EmployeeMapper.class);
        Employee emp01 = mapper.getEmployeeByID(1); //查询1号员工并将其放入本地缓存中
        System.out.println(emp01);
        Employee emp02 = mapper.getEmployeeByID(1); //本地缓存中含有1号员工，直接读取
        System.out.println(emp02);
        System.out.println(emp01 == emp02); //true
    } finally {
        sqlSession.close();
    }
}

一级缓存失效的情况：

• SqlSession不同；
• SqlSession相同，但查询条件不同；
• SqlSession相同，但两次查询之间执行了任何一次增删改操作；
• SqlSession相同，但使用clearCache()方法手动清除了一级缓存。

---

2. 二级缓存

二级缓存，也叫全局缓存，其是基于namespace级别的缓存，即一个namespace对应一个二级缓存（Map对象）。

工作机制：

• 一个会话查询数据时，获取的数据会被存放在当前会话的一级缓存中；
• 当前会话关闭或提交后，一级缓存的数据会被转移保存到二级缓存中；
• 当新的会话查询相同数据时，即可直接参照二级缓存中的所保存的数据。
• 注意：不同的namespace查询出的数据会存放在自己对应的缓存（Map对象）中。

使用步骤：

• 在全局配置文件中开启二级缓存：<setting name="cacheEnabled" value="true"/>;
• 在SQL映射文件中使用cache标签配置二级缓存：<cache></cache>;
• 注意：对应的POJO需要实现Serializable接口。

缓存相关属性：

<cache eviction="FIFO" flushInterval="60000" readOnly="false" size="1024">
<!--  
    eviction : 缓存的回收策略
        • LRU  – 最近最少使用的：移除最长时间不被使用的对象。
        • FIFO – 先进先出：按对象进入缓存的顺序来移除。
        • SOFT – 软引用：移除基于垃圾回收器状态和软引用规则的对象。
        • WEAK – 弱引用：更积极地移除基于垃圾收集器状态和弱引用规则的对象。
        • 默认的是 LRU。
    flushInterval : 缓存刷新间隔
        缓存多长时间清空一次，默认不清空，设置一个毫秒值
    readOnly : 是否只读
        • true  – 只读：MyBatis认为所有从缓存中获取数据的操作都是只读操作，不会修改数据。
                       MyBatis为了加快获取速度，直接就将数据在缓存中的引用交给用户。
                               不安全，但速度快。
        • false – 非只读：MyBatis认为获取的数据可能会被修改。
                        MyBatis会利用序列化&反序列技术克隆一份新的数据给用户。
                                 安全，但速度慢。
    size : 缓存最多可以存放多少对象，太大容易导致内存溢出。
    type="" : 指定自定义缓存的全类名；实现Cache接口即可；
-->

体验二级缓存的测试代码段如下：

/**
 * Caused by: java.io.NotSerializableException: com.qiaobc.mybatis.bean.Employee
 *   注意：对应的POJO需要实现序列化接口
 * @throws IOException
 */
@Test
public void testSecondLevelCache() throws IOException {
    SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();
    SqlSession sqlSession01 = sqlSessionFactory.openSession();
    SqlSession sqlSession02 = sqlSessionFactory.openSession();

    try {
        EmployeeMapper mapper01 = sqlSession01.getMapper(EmployeeMapper.class);
        EmployeeMapper mapper02 = sqlSession02.getMapper(EmployeeMapper.class);

        Employee emp01 = mapper01.getEmployeeByID(1);
        System.out.println(emp01);
        sqlSession01.close();

        Employee emp02 = mapper02.getEmployeeByID(1);
        System.out.println(emp02);
        sqlSession02.close();

    } finally { }
}

---

3. 缓存总结

/**
 * 与缓存有关的设置/属性：
 *  1). 默认cacheEnabled=true，若为false则关闭二级缓存，而一级缓存一直可用的
 *  2). 每个select标签都有useCache="true"属性
 *          若为false则不使用缓存（一级缓存依然使用，二级缓存不使用）
 *  3). 每个增删改标签都有flushCache="true"属性，即两级缓存都会清除
 *          增删改执行完成后即会自动清除缓存；
 *          查询标签的flushCache="false"，若其为true则每次查询后都会清空缓存。
 *  4). sqlSession.clearCache()方法只是清除当前session的一级缓存
 *  5). localCacheScope属性为本地缓存作用域，一级缓存取值SESSION，取值STATEMENT即可禁用一级缓存     
 */

---

4. 第三方缓存整合

MyBatis框架定义了Cache接口方便开发者进行自定义扩展，以实现更加专业与强大的缓存功能。

EhCache是一个纯Java的进程内缓存框架，具有快速、精干等特点，是Hibernate中默认的CacheProvider。
其中，MyBatis框架整合EnCache缓存可参看https://github.com/mybatis/ehcache-cache。

EhCache缓存整合步骤：
第一步，导入ehcache包、整合包、日志包：
ehcache-core-2.6.8.jar、mybatis-ehcache-1.0.3.jar、slf4j-api-1.6.1.jar、slf4j-log4j12-1.6.2.jar；

第二步，编写ehcache.xml配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:noNamespaceSchemaLocation="../config/ehcache.xsd">
 <!-- 磁盘保存路径 -->
 <diskStore path="D:\IBABEI\Java\Workspace\44\ehcache" />

 <defaultCache 
   maxElementsInMemory="10000" 
   maxElementsOnDisk="10000000"
   eternal="false" 
   overflowToDisk="true" 
   timeToIdleSeconds="120"
   timeToLiveSeconds="120" 
   diskExpiryThreadIntervalSeconds="120"
   memoryStoreEvictionPolicy="LRU">
 </defaultCache>
</ehcache>

<!-- 
属性说明：
l diskStore：指定数据在磁盘中的存储位置。
l defaultCache：当借助CacheManager.add("demoCache")创建Cache时，EhCache便会采用<defalutCache/>指定的的管理策略

以下属性是必须的：
l maxElementsInMemory - 在内存中缓存的element的最大数目 
l maxElementsOnDisk - 在磁盘上缓存的element的最大数目，若是0表示无穷大
l eternal - 设定缓存的elements是否永远不过期。如果为true，则缓存的数据始终有效，如果为false那么还要根据timeToIdleSeconds，timeToLiveSeconds判断
l overflowToDisk - 设定当内存缓存溢出的时候是否将过期的element缓存到磁盘上

以下属性是可选的：
l timeToIdleSeconds - 当缓存在EhCache中的数据前后两次访问的时间超过timeToIdleSeconds的属性取值时，这些数据便会删除，默认值是0,也就是可闲置时间无穷大
l timeToLiveSeconds - 缓存element的有效生命期，默认是0.,也就是element存活时间无穷大
 diskSpoolBufferSizeMB 这个参数设置DiskStore(磁盘缓存)的缓存区大小.默认是30MB.每个Cache都应该有自己的一个缓冲区.
l diskPersistent - 在VM重启的时候是否启用磁盘保存EhCache中的数据，默认是false。
l diskExpiryThreadIntervalSeconds - 磁盘缓存的清理线程运行间隔，默认是120秒。每个120s，相应的线程会进行一次EhCache中数据的清理工作
l memoryStoreEvictionPolicy - 当内存缓存达到最大，有新的element加入的时候， 移除缓存中element的策略。默认是LRU（最近最少使用），可选的有LFU（最不常使用）和FIFO（先进先出）
 -->

第三步，在namespace中配置cache标签：

<cache type="org.mybatis.caches.ehcache.EhcacheCache"></cache>