10、Mybatis之缓存

10.1、环境搭建

10.1.1、创建新module

创建名为mybatis_cache的新module，过程参考5.1节

10.1.2、创建Mapper接口和映射文件

package org.rain.mybatis.mapper;

import org.apache.ibatis.annotations.Param;
import org.rain.mybatis.pojo.Emp;

public interface CacheMapper {

    Emp getEmpById(@Param("empId") Integer empId);

}

++++++++++++++++++++++++++++分割线++++++++++++++++++++++++++++

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.rain.mybatis.mapper.CacheMapper">

    <!--Emp getEmpById(@Param("empId") Integer empId);-->
    <select id="getEmpById" resultType="Emp">
        select * from t_emp where emp_id = #{empId}
    </select>

</mapper>

10.1.3、创建测试类

10.2、一级缓存

10.2.1、一级缓存示例

注意：从该示例的控制台日志可知，通过同一个SqlSession的第二次相同查询并没有访问数据库

    /*
    *  Mybatis的一级缓存（默认开启）是SqlSession级别的，通过同一个SqlSession查询的数据会被缓存；
    * 下次查询相同的数据，就会从缓存中直接获取，不会从数据库重新访问
    * */
    @Test
    public void testGetEmpById(){
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();

        CacheMapper cacheMapper1 = sqlSession.getMapper(CacheMapper.class);
        Emp emp1 = cacheMapper1.getEmpById(1);
        System.out.println(emp1);

        CacheMapper cacheMapper2 = sqlSession.getMapper(CacheMapper.class);
        Emp emp2 = cacheMapper2.getEmpById(1);
        System.out.println(emp2);
    }

10.2.2、一级缓存失效的四种情况

10.2.2.1、不同的SqlSession对应不同的一级缓存

注意：从该示例的控制台日志可知，通过不同SqlSession的相同条件查询，没有使用到缓存，而是都访问了数据库

    @Test
    public void testGetEmpByIdOne(){
        SqlSession sqlSession1 = SqlSessionUtils.getSqlSession();
        CacheMapper cacheMapper1 = sqlSession1.getMapper(CacheMapper.class);
        Emp emp1 = cacheMapper1.getEmpById(1);
        System.out.println(emp1);

        SqlSession sqlSession2 = SqlSessionUtils.getSqlSession();
        CacheMapper cacheMapper2 = sqlSession2.getMapper(CacheMapper.class);
        Emp emp2 = cacheMapper2.getEmpById(1);
        System.out.println(emp2);
    }

10.2.2.2、同一个SqlSession但查询条件不同

注意：从该示例的控制台日志可知，通过同一个SqlSession的不同条件查询，因为没有缓存，所以都访问了数据库

    @Test
    public void testGetEmpByIdTwo(){
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        CacheMapper cacheMapper = sqlSession.getMapper(CacheMapper.class);

        Emp emp1 = cacheMapper.getEmpById(1);
        System.out.println(emp1);

        Emp emp2 = cacheMapper.getEmpById(2);
        System.out.println(emp2);
    }

10.2.2.3、同一个SqlSession但两次查询期间执行了任何一次增删改操作

void insertEmp(Emp emp);

++++++++++++++++++++++++++++分割线++++++++++++++++++++++++++++

    <!--void insertEmp(Emp emp);-->
    <insert id="insertEmp">
        insert into t_emp values (null,#{empName},#{age},#{gender},null )
    </insert>

++++++++++++++++++++++++++++分割线++++++++++++++++++++++++++++

注意：从该示例的控制台日志可知，同一个SqlSession两次查询期间执行了任何一次增删改操作后，会自动清空缓存

    @Test
    public void testGetEmpByIdThree(){
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        CacheMapper cacheMapper = sqlSession.getMapper(CacheMapper.class);

        Emp emp1 = cacheMapper.getEmpById(1);
        System.out.println(emp1);

        Emp emp = new Emp(null, "小红", 25, "男");
        cacheMapper.insertEmp(emp);

        Emp emp2 = cacheMapper.getEmpById(1);
        System.out.println(emp2);
    }

10.2.2.4、同一个SqlSession但两次查询期间手动清空了缓存

注意：从该示例的控制台日志可知，因为同一个SqlSession两次查询期间手动清空了缓存，所以会再次访问数据库

    @Test
    public void testGetEmpByIdFour(){
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        CacheMapper cacheMapper = sqlSession.getMapper(CacheMapper.class);

        Emp emp1 = cacheMapper.getEmpById(1);
        System.out.println(emp1);

        sqlSession.clearCache();

        Emp emp2 = cacheMapper.getEmpById(1);
        System.out.println(emp2);
    }

10.3、二级缓存

10.3.1、开启的条件

10.3.1.1、设置全局配置属性cacheEnabled

注意：该全局配置属性默认为true，所以可以不用手动开启

        <!--开启二级缓存-->
        <setting name="cacheEnabled" value="true"/>

10.3.1.2、在映射文件中设置cache标签

<cache/>

10.3.1.3、存储查询数据的实体类必须实现序列化接口

public class Emp implements Serializable

10.3.1.4、二级缓存在SqlSession关闭或提交之后才有效

注意：第一个sqlSession关闭后，才有缓存数据给第二个sqlSession使用

    @Test
    public void testSecondCache() throws IOException {

        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        // 二级缓存是SqlSessionFactory级别的
        // 通过同一个SqlSessionFactory创建的SqlSession查询结果才会被缓存
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);

        SqlSession sqlSession1 = sqlSessionFactory.openSession(true);
        CacheMapper cacheMapper1 = sqlSession1.getMapper(CacheMapper.class);
        Emp emp1 = cacheMapper1.getEmpById(1);
        System.out.println(emp1);

        sqlSession1.close();

        SqlSession sqlSession2 = sqlSessionFactory.openSession(true);
        CacheMapper cacheMapper2 = sqlSession2.getMapper(CacheMapper.class);
        Emp emp2 = cacheMapper2.getEmpById(1);
        System.out.println(emp2);
    }

10.3.2、二级缓存失效的三种情况

10.3.2.1、不同的SqlSessionFactory对应不同的二级缓存

注意：从该示例的控制台日志可知，通过不同SqlSessionFactory的相同条件查询，没有使用到缓存，而是都访问了数据库

    @Test
    public void testSecondCacheOne() throws IOException {

        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();

        SqlSessionFactory sqlSessionFactory1 = sqlSessionFactoryBuilder.build(is);
        SqlSession sqlSession1 = sqlSessionFactory1.openSession(true);
        CacheMapper cacheMapper1 = sqlSession1.getMapper(CacheMapper.class);
        Emp emp1 = cacheMapper1.getEmpById(1);
        System.out.println(emp1);

        sqlSession1.close();

        InputStream is2 = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactory sqlSessionFactory2 = sqlSessionFactoryBuilder.build(is2);
        SqlSession sqlSession2 = sqlSessionFactory2.openSession(true);
        CacheMapper cacheMapper2 = sqlSession2.getMapper(CacheMapper.class);
        Emp emp2 = cacheMapper2.getEmpById(1);
        System.out.println(emp2);
    }

10.3.2.2、同一个SqlSessionFactory但查询条件不同

注意：从该示例的控制台日志可知，通过同一个SqlSessionFactory的不同条件查询，因为没有对应的缓存，所以都访问了数据库

    @Test
    public void testSecondCacheTwo() throws IOException {

        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);

        SqlSession sqlSession1 = sqlSessionFactory.openSession(true);
        CacheMapper cacheMapper1 = sqlSession1.getMapper(CacheMapper.class);
        Emp emp1 = cacheMapper1.getEmpById(1);
        System.out.println(emp1);

        sqlSession1.close();

        SqlSession sqlSession2 = sqlSessionFactory.openSession(true);
        CacheMapper cacheMapper2 = sqlSession2.getMapper(CacheMapper.class);
        Emp emp2 = cacheMapper2.getEmpById(2);
        System.out.println(emp2);
    }

10.3.2.3、同一个SqlSessionFactory但两次查询期间执行了任何一次增删改操作

注意：两次查询之间执行了任意的增删改，会使一级和二级缓存同时失效

    @Test
    public void testSecondCacheThree() throws IOException {

        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);

        SqlSession sqlSession1 = sqlSessionFactory.openSession(true);
        CacheMapper cacheMapper1 = sqlSession1.getMapper(CacheMapper.class);
        Emp emp1 = cacheMapper1.getEmpById(1);
        System.out.println(emp1);

        sqlSession1.close();

        SqlSession sqlSession2 = sqlSessionFactory.openSession(true);
        CacheMapper cacheMapper2 = sqlSession2.getMapper(CacheMapper.class);
        Emp emp = new Emp(null, "小红", 25, "男");
        cacheMapper2.insertEmp(emp);
        Emp emp2 = cacheMapper2.getEmpById(1);
        System.out.println(emp2);
    }

10.3.3、二级缓存的相关配置(了解即可)

在映射文件的cache标签中，可以设置以下属性：

10.3.3.1、eviction属性

该属性用于设置缓存回收策略，属性值默认是LRU。

LRU（Least Recently Used）：最近最少使用的，移除最长时间不被使用的对象。
FIFO（First in First out）：先进先出，按对象进入缓存的顺序来移除它们。

10.3.3.2、flushInterval属性

该属性用于设置刷新（清空）缓存的时间间隔，单位毫秒；
默认情况是不设置，也就是没有刷新间隔，缓存仅在调用（增删改）语句时刷新。

10.3.3.3、size属性

该属性用于设置缓存最多可以存储多少个对象，太大容易导致内存溢出

10.3.3.4、readOnly属性

true：只读缓存；会返回缓存对象的引用；优点是有性能优势，缺点是对象不能被修改。
false（默认值）：读写缓存；会返回缓存对象的拷贝（通过序列化）；优点是安全，缺点是会慢一些。

10.3.4、第三方缓存(了解即可)

10.3.4.1、引入依赖

<!-- Mybatis EHCache整合包 -->
<dependency>
<groupId>org.mybatis.caches</groupId>
<artifactId>mybatis-ehcache</artifactId>
<version>1.2.1</version>
</dependency>
<!-- slf4j日志门面的一个具体实现 -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>

10.3.4.2、创建EHCache的配置文件

注意：文件名必须为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:\ehcache"/>
    <defaultCache
            maxElementsInMemory="1000"
            maxElementsOnDisk="10000000"
            eternal="false"
            overflowToDisk="true"
            timeToIdleSeconds="120"
            timeToLiveSeconds="120"
            diskExpiryThreadIntervalSeconds="120"
            memoryStoreEvictionPolicy="LRU">
    </defaultCache>
</ehcache>

10.3.4.3、创建logback日志配置文件

注意：当存在SLF4J时，作为简易日志的log4j将失效；因此需要借助SLF4J接口的具体实现logback来打印日志。
logback日志配置文件名必须为logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true">
    <!-- 指定日志输出的位置 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!-- 日志输出的格式 -->
            <!-- 按照顺序分别是： 时间、日志级别、线程名称、打印日志的类、日志主体内容、换行
            -->
            <pattern>[%d{HH:mm:ss.SSS}] [%-5level] [%thread] [%logger]
                [%msg]%n</pattern>
        </encoder>
    </appender>
    <!-- 设置全局日志级别。日志级别按顺序分别是： DEBUG、INFO、WARN、ERROR -->
    <!-- 指定任何一个日志级别都只打印当前级别和后面级别的日志。 -->
    <root level="DEBUG">
        <!-- 指定打印日志的appender，这里通过“STDOUT”引用了前面配置的appender -->
        <appender-ref ref="STDOUT" />
    </root>
    <!-- 根据特殊需求指定局部日志级别 -->
    <logger name="org.rain.mybatis.mapper" level="DEBUG"/>
</configuration>

10.3.4.4、设置二级缓存的类型

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

10.3.4.5、执行效果

10.3.4.6、EHCache配置文件说明

属性名	是否必须	作用
maxElementsInMemory	是	在内存中缓存的element的最大数目
maxElementsOnDisk	是	在磁盘上缓存的element的最大数目，若是0表示无穷大
eternal	是	设定缓存的elements是否永远不过期。如果为true，则缓存的数据始终有效，如果为false那么还要根据timeToIdleSeconds、timeToLiveSeconds判断
overflowToDisk	是	设定当内存缓存溢出的时候是否将过期的element缓存到磁盘上
timeToIdleSeconds	否	当缓存在EhCache中的数据前后两次访问的时间超过timeToIdleSeconds的属性取值时，这些数据便会删除，默认值是0,也就是可闲置时间无穷大
timeToLiveSeconds	否	缓存element的有效生命期，默认是0.,也就是element存活时间无穷大
diskSpoolBufferSizeMB	否	DiskStore(磁盘缓存)的缓存区大小。默认是30MB。每个Cache都应该有自己的一个缓冲区
diskPersistent	否	在VM重启的时候是否启用磁盘保存EhCache中的数据，默认是false
diskExpiryThreadIntervalSeconds	否	磁盘缓存的清理线程运行间隔，默认是120秒。每个120s，相应的线程会进行一次EhCache中数据的清理工作
memoryStoreEvictionPolicy	否	当内存缓存达到最大，有新的element加入的时候，移除缓存中element的策略。默认是LRU （最近最少使用），可选的有LFU （最不常使用）和FIFO （先进先出）