mybatis源码-二级缓存

涉及到的模式：

执行查询：

可以看到cache为null，这是因为没有开启二级缓存，mybatis二级缓存是手动开启的，需要去开启

可以看到解析的是mapper节点下的cache节点

查看官网配置详情：

缓存

MyBatis 内置了一个强大的事务性查询缓存机制，它可以非常方便地配置和定制。 为了使它更加强大而且易于配置，我们对 MyBatis 3 中的缓存实现进行了许多改进。

默认情况下，只启用了本地的会话缓存，它仅仅对一个会话中的数据进行缓存。 要启用全局的二级缓存，只需要在你的 SQL 映射文件中添加一行：

<cache/>

基本上就是这样。这个简单语句的效果如下:

• 映射语句文件中的所有 select 语句的结果将会被缓存。
• 映射语句文件中的所有 insert、update 和 delete 语句会刷新缓存。
• 缓存会使用最近最少使用算法（LRU, Least Recently Used）算法来清除不需要的缓存。
• 缓存不会定时进行刷新（也就是说，没有刷新间隔）。
• 缓存会保存列表或对象（无论查询方法返回哪种）的 1024 个引用。
• 缓存会被视为读/写缓存，这意味着获取到的对象并不是共享的，可以安全地被调用者修改，而不干扰其他调用者或线程所做的潜在修改。

提示 缓存只作用于 cache 标签所在的映射文件中的语句。如果你混合使用 Java API 和 XML 映射文件，在共用接口中的语句将不会被默认缓存。你需要使用 @CacheNamespaceRef 注解指定缓存作用域。

这些属性可以通过 cache 元素的属性来修改。比如：

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

这个更高级的配置创建了一个 FIFO 缓存，每隔 60 秒刷新，最多可以存储结果对象或列表的 512 个引用，而且返回的对象被认为是只读的，因此对它们进行修改可能会在不同线程中的调用者产生冲突。

可用的清除策略有：

• LRU – 最近最少使用：移除最长时间不被使用的对象。
• FIFO – 先进先出：按对象进入缓存的顺序来移除它们。
• SOFT – 软引用：基于垃圾回收器状态和软引用规则移除对象。
• WEAK – 弱引用：更积极地基于垃圾收集器状态和弱引用规则移除对象。

默认的清除策略是 LRU。

flushInterval（刷新间隔）属性可以被设置为任意的正整数，设置的值应该是一个以毫秒为单位的合理时间量。 默认情况是不设置，也就是没有刷新间隔，缓存仅仅会在调用语句时刷新。

size（引用数目）属性可以被设置为任意正整数，要注意欲缓存对象的大小和运行环境中可用的内存资源。默认值是 1024。

readOnly（只读）属性可以被设置为 true 或 false。只读的缓存会给所有调用者返回缓存对象的相同实例。 因此这些对象不能被修改。这就提供了可观的性能提升。而可读写的缓存会（通过序列化）返回缓存对象的拷贝。 速度上会慢一些，但是更安全，因此默认值是 false。

提示 二级缓存是事务性的。这意味着，当 SqlSession 完成并提交时，或是完成并回滚，但没有执行 flushCache=true 的 insert/delete/update 语句时，缓存会获得更新。

对相应的映射文件进行配置：

<?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="com.laoxu.mybatis.mapper.PersonMapper">
    <cache
            eviction="FIFO"
            flushInterval="60000"
            size="512"
            readOnly="true"/>
    <resultMap id="BaseResultMap" type="com.laoxu.mybatis.modal.Person">
        <id column="id" jdbcType="VARCHAR" property="id" />
        <result column="name" jdbcType="VARCHAR" property="name" />
        <result column="sex" jdbcType="INTEGER" property="sex" />
        <result column="age" jdbcType="INTEGER" property="age" />
        <result column="create_time" jdbcType="TIMESTAMP" property="createTime" />
    </resultMap>
    <sql id="Base_Column_List">
        id, `name`, sex, age, create_time
    </sql>
    <select id="getPersonById" resultMap="BaseResultMap">
        select * from person where id = #{id}
    </select>

    <update id="updatePersonNameById">
        update person set `name` = #{name} where id = #{id}
    </update>

</mapper>

再次执行查询可以看到cache不为null了：

ms.isUseCache() && resultHandler == null

ms.isUseCache()  缓存是否开启，默认是开启的

resultHandler 自定义的结果集，不能有自定义的结果集才会走二级缓存

修改映射的select语句的标签usecache属性值为false则会关闭缓存：

<?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="com.laoxu.mybatis.mapper.PersonMapper">
    <cache
            eviction="FIFO"
            flushInterval="60000"
            size="512"
            readOnly="true"/>
    <resultMap id="BaseResultMap" type="com.laoxu.mybatis.modal.Person">
        <id column="id" jdbcType="VARCHAR" property="id" />
        <result column="name" jdbcType="VARCHAR" property="name" />
        <result column="sex" jdbcType="INTEGER" property="sex" />
        <result column="age" jdbcType="INTEGER" property="age" />
        <result column="create_time" jdbcType="TIMESTAMP" property="createTime" />
    </resultMap>
    <sql id="Base_Column_List">
        id, `name`, sex, age, create_time
    </sql>
    <select id="getPersonById" resultMap="BaseResultMap" useCache="false">
        select * from person where id = #{id}
    </select>

    <update id="updatePersonNameById">
        update person set `name` = #{name} where id = #{id}
    </update>

</mapper>

可以看到已经关闭了缓存：

第一次查询，获取缓存中的数据为空：

将查询的操作交给被装饰的执行器进行查询：

/**
 * @author Clinton Begin
 * @author Eduardo Macarron
 */
public class CachingExecutor implements Executor {

  private final Executor delegate;
  private final TransactionalCacheManager tcm = new TransactionalCacheManager();

  public CachingExecutor(Executor delegate) {
    this.delegate = delegate;
    delegate.setExecutorWrapper(this);
  }
   ......

}

Executor executor = new SimpleExecutor(configuration, jdbcTransaction);
// 装饰者模式
Executor cachingExecutor = new CachingExecutor(executor);

可以看到这个delegate就是传入的被装饰的执行器（简单执行器SimpleExecutor）

之后二级缓存就会进行缓存操作

第二次查询，直接获取缓存中的数据：

使用提供给用户的sqlsesson进行调用

package com.laoxu.mybatis.executor;

import com.laoxu.mybatis.mapper.PersonMapper;
import com.laoxu.mybatis.modal.Person;
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;

public class start {

    public static void main(String[] args) throws IOException {
        // user.dir指定了当前的路径
        String userDir = System.getProperty("user.dir");
        System.out.println(userDir);
        // 获取类路径
        String classPath = start.class.getResource("/").getPath();
        System.out.println(classPath);
        // 根据当前类路径下的相对路径 (classPath + {path})
        String resource = "mapper/mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        // 方式一
        // 开启一个会话
//        try (SqlSession session = sqlSessionFactory.openSession()) {
//            Person person = session.selectOne("com.laoxu.mybatis.mapper.PersonMapper.getPersonById", "20210420172645864088a2a1ba11eb886d525400146075");
//            System.out.println(person);
//        }
        // 方式二
        // 开启一个会话
        try (SqlSession session = sqlSessionFactory.openSession()) {
            PersonMapper personMapper = session.getMapper(PersonMapper.class);
            System.out.println(personMapper.getPersonById("20210420172645864088a2a1ba11eb886d525400146075"));
            System.out.println(personMapper.getPersonById("20210420172645864088a2a1ba11eb886d525400146075"));
        }
    }

}

Cache Hit Ratio [com.laoxu.mybatis.mapper.PersonMapper]: 0.0
Opening JDBC Connection
Created connection 438314766.
Setting autocommit to false on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@1a20270e]
==>  Preparing: select * from person where id = ?
==> Parameters: 20210420172645864088a2a1ba11eb886d525400146075(String)
<==    Columns: id, name, sex, age, create_time
<==        Row: 20210420172645864088a2a1ba11eb886d525400146075, 李四, 1, 20, 2021-04-20 17:26:45
<==      Total: 1
Person{id='20210420172645864088a2a1ba11eb886d525400146075', name='李四', sex='1', age='20', createTime='2021-04-20 17:26:45'}
Cache Hit Ratio [com.laoxu.mybatis.mapper.PersonMapper]: 0.0
Person{id='20210420172645864088a2a1ba11eb886d525400146075', name='李四', sex='1', age='20', createTime='2021-04-20 17:26:45'}
Resetting autocommit to true on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@1a20270e]
Closing JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@1a20270e]
Returned connection 438314766 to pool.

二级缓存命中率为0.0走的是一级缓存，是因为二级缓存需要先commit提交后才会缓存，因为二级缓存是跨线程的调用方式

添加commit再次执行：

package com.laoxu.mybatis.executor;

import com.laoxu.mybatis.mapper.PersonMapper;
import com.laoxu.mybatis.modal.Person;
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;

public class start {

    public static void main(String[] args) throws IOException {
        // user.dir指定了当前的路径
        String userDir = System.getProperty("user.dir");
        System.out.println(userDir);
        // 获取类路径
        String classPath = start.class.getResource("/").getPath();
        System.out.println(classPath);
        // 根据当前类路径下的相对路径 (classPath + {path})
        String resource = "mapper/mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        // 方式一
        // 开启一个会话
//        try (SqlSession session = sqlSessionFactory.openSession()) {
//            Person person = session.selectOne("com.laoxu.mybatis.mapper.PersonMapper.getPersonById", "20210420172645864088a2a1ba11eb886d525400146075");
//            System.out.println(person);
//        }
        // 方式二
        // 开启一个会话
        try (SqlSession session = sqlSessionFactory.openSession()) {
            PersonMapper personMapper = session.getMapper(PersonMapper.class);
            System.out.println(personMapper.getPersonById("20210420172645864088a2a1ba11eb886d525400146075"));
            session.commit();
            System.out.println(personMapper.getPersonById("20210420172645864088a2a1ba11eb886d525400146075"));
        }
    }

}

Cache Hit Ratio [com.laoxu.mybatis.mapper.PersonMapper]: 0.0
Opening JDBC Connection
Created connection 1804126860.
Setting autocommit to false on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@6b88ca8c]
==>  Preparing: select * from person where id = ?
==> Parameters: 20210420172645864088a2a1ba11eb886d525400146075(String)
<==    Columns: id, name, sex, age, create_time
<==        Row: 20210420172645864088a2a1ba11eb886d525400146075, 李四, 1, 20, 2021-04-20 17:26:45
<==      Total: 1
Person{id='20210420172645864088a2a1ba11eb886d525400146075', name='李四', sex='1', age='20', createTime='2021-04-20 17:26:45'}
Cache Hit Ratio [com.laoxu.mybatis.mapper.PersonMapper]: 0.5
Person{id='20210420172645864088a2a1ba11eb886d525400146075', name='李四', sex='1', age='20', createTime='2021-04-20 17:26:45'}
Resetting autocommit to true on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@6b88ca8c]
Closing JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@6b88ca8c]
Returned connection 1804126860 to pool.

可以看到缓存命中率为0.5，所以成功走二级缓存

总结：

sqlsession调用基本api，然后使用CachingExecutor对BaseExecutor执行器进行装饰，如果启用了二级缓存（即在mapper.xml中配置了cache标签），那么就走二级缓存相关的逻辑，二级缓存执行器CachingExecutor只负责缓存工作，查询修改操作就交给BaseExecutor进行操作，调用query/update方法，交给下面实现的三种执行器种的一种进行doQuery/doUpdate子方法进行查询或修改