MyBatis 缓存配置之二级缓存

二级缓存

MyBatis 的二级缓存非常强大，它不同于一级缓存只存在于 SqlSession 的生命周期中，而是可以理解为存在于 SqlSessionFactory 的生命周期中。

配置二级缓存

MyBatis 的二级缓存是和命名空间绑定的，即二级缓存需要配置在 Mapper.xml 映射文件中，或者配置在 Mapper.java 接口中。在映射文件中，命名空间就是 XML 根节点 mapper 的 namespace 属性。在 Mapper 接口中，命名空间就是接口的全限定名称。

开启二级缓存

在 MyBatis 的全局配置 settings 中有一个参数 cacheEnabled，这个参数是二级缓存的全局开关，默认值是 true ，初始状态为启用状态。如果把这个参数设置为 false，即使有后面的二级缓存配置，也不会生效。由于这个参数值默认为 true，所以不必配置，如果想配置，可以在 mybatis-config.xml 中添加如下代码。

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

Mapper.xml 中配置二级缓存

在保证二级缓存的全局配置开启的情况下，给 UserMapper.xml 开启二级缓存只需要在 UserMapper.xml 中添加 <cache/> 标签即可，添加后的 UserMapper.xml 如下。

<?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.mybatis.mapper.UserMapper">
    <!--二级缓存默认配置-->
    <cache/>
    
    <!--其他配置-->
</mapper>

默认的二级缓存会有如下效果。

映射语句文件中的所有 SELECT 语句将会配缓存。
映射语句文件中的所有 INSERT、UPDATE、DELETE 语句会刷新缓存。
缓存会使用 Least Recently Used （LRU，最近最少使用的）算法来回收。
根据时间表（如 no Flush Interval，没有刷新时间），缓存不会以任何时间顺序来刷新。
缓存会存储集合或对象（无论查询方法返回什么类型的值）的1024个引用。
缓存会被视为 read/write（可读/可写）的，意味着对象检索不是共享的，而且可以安全的被调用者修改，而不干扰其他调用者或线程所做的潜在修改。

所有的这些属性都可以通过缓存原属的属性来修改，示例如下。

<?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.mybatis.mapper.UserMapper">
    <!--二级缓存自定义配置-->
    <cache eviction="FIFO"
           flushInterval="60000"
           size="512"
           readOnly="true"/>
    
    <!--其他配置-->
</mapper>

这个更高级的配置创建了一个 FIFO 缓存，并每隔60秒刷新一次，存储集合或对象的512个引用，而且返回的对象被认为是只读的，因此在不同的线程中的调用者之间修改它们会导致冲突。

<cache> 标签可以配置的属性如下。

eviction（回收策略）
- LUR（最近最少使用）：移除最长时间不被使用的对象，这是默认值。
- FIFO（先进先出）：按对象进入缓存的顺序来析出它们。
- SOFT（软引用）：移除基于垃圾回收器状态和软引用规则的对象。
- WEAK（弱引用）：更积极的移除基于垃圾收集器状态和弱引用规则的对象。
flushInterval（刷新时间）

可以被设置为任意的正整数，而且她们代表一个合理的毫秒形成的时间段。默认情况不设置，即没有刷新间隔，缓存仅仅在调用语句时刷新。
size（引用数目）

可以被设置为任意的正整数，要记住缓存的对象数目和运行环境的可用内存资源数目。默认值是 1024。
readOnly（只读）

readOnly 属性可以配设置为 true 或 false。只读的缓存会给所有调用者返回缓存对象的相同实例，因此这些对象不能被修改，这提供了很重要的性能优势。可读写的缓存会通过序列化返回缓存对象的拷贝，这种方式会慢一些，但是安全，因此默认是 false。

Mapper 接口中配置二级缓存

在使用注解方式进行开发时，如果相对注解方法启用二级缓存，则需要在 Mapper 接口中进行配置。

@CacheNamespace
public interface AnnotationUserMapper {
    // 接口方法
}

只需要在接口类上增加 @CacheNamespace 注解即可，该注解同 XML 文件中的 <cache/> 标签。

自定义配置各项属性，示例如下。

@CacheNamespace(
        eviction = FifoCache.class,
        flushInterval = 60000,
        size = 512,
        readWrite = true
)

这里的 readWrite 属性和 XML 中的 readOnly 属性一样，用于配置缓存是否为只读类型，在这里 true 为读写，false为只读，默认为 true。

xml 和接口中同时配置二级缓存

当同时使用注解方式和 XML 映射文件时，如果同时配置了二级缓存，就会抛出如下异常。

Cause: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: java.lang.IllegalArgumentException: Caches collection already contains value for com.mybatis.mapper.AnnotationUserMapper

这是应为 Mapper 接口和对应的 XML 文件是相同的命名空间，想使用二级缓存，两者必须同时配置，如果接口中不存在使用注解的方法，则可以只在 XML 文件中配置。

因此这个时候应该使用参照缓存来避免同时配置二级缓存导致的错误。

1.在 Mapper 接口中进行修改

@CacheNamespaceRef(AnnotationUserMapper.class)
public interface AnnotationUserMapper {
    // 接口方法
}

如例所示，想让 AnnotationUserMapper 接口中的注释方法和 XML 中的方法使用相同缓存，因此使用参照缓存 AnnotationUserMapper.class ，这样就会使用命名空间为 com.mybatis.mapper.AnnotationUserMapper 的缓存配置，即 AnnotationUserMapper.xml 中配置的缓存。

2.在 XML 映射文件中修改

<?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.mybatis.mapper.AnnotationUserMapper">
    <cache-ref namespace="com.mybatis.mapper.AnnotationUserMapper"/>

</mapper>

这样配置后，XML 就会引用 Mapper 接口中配置的二级缓存。

参考资料：MyBatis 从入门到精通作者：刘增辉

MyBatis 缓存配置 之 二级缓存