MyBatis二级缓存

2022-07-13 本文已影响0人 AC编程

一、MyBatis缓存官网内容

1.1 缓存

MyBatis 内置了一个强大的事务性查询缓存机制，它可以非常方便地配置和定制。为了使它更加强大而且易于配置，我们对 MyBatis 3 中的缓存实现进行了许多改进。默认情况下，只启用了本地的会话缓存，它仅仅对一个会话(SqlSession)中的数据进行缓存。要启用全局的二级缓存，只需要在你的 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 语句时，缓存会获得更新。

1.2 使用自定义缓存

除了上述自定义缓存的方式，你也可以通过实现你自己的缓存，或为其他第三方缓存方案创建适配器，来完全覆盖缓存行为。

<cache type="com.domain.something.MyCustomCache"/>

这个示例展示了如何使用一个自定义的缓存实现。type 属性指定的类必须实现 org.apache.ibatis.cache.Cache 接口，且提供一个接受 String 参数作为 id 的构造器。这个接口是 MyBatis 框架中许多复杂的接口之一，但是行为却非常简单。

public interface Cache {
  String getId();
  int getSize();
  void putObject(Object key, Object value);
  Object getObject(Object key);
  boolean hasKey(Object key);
  Object removeObject(Object key);
  void clear();
}

为了对你的缓存进行配置，只需要简单地在你的缓存实现中添加公有的 JavaBean 属性，然后通过 cache 元素传递属性值，例如，下面的例子将在你的缓存实现上调用一个名为 setCacheFile(String file) 的方法：

<cache type="com.domain.something.MyCustomCache">
  <property name="cacheFile" value="/tmp/my-custom-cache.tmp"/>
</cache>

你可以使用所有简单类型作为 JavaBean 属性的类型，MyBatis 会进行转换。你也可以使用占位符（如 ${cache.file}），以便替换成在配置文件属性中定义的值。从版本 3.4.2 开始，MyBatis 已经支持在所有属性设置完毕之后，调用一个初始化方法。如果想要使用这个特性，请在你的自定义缓存类里实现org.apache.ibatis.builder.InitializingObject 接口。

public interface InitializingObject {
  void initialize() throws Exception;
}

上一节中对缓存的配置（如清除策略、可读或可读写等），不能应用于自定义缓存。

请注意，缓存的配置和缓存实例会被绑定到 SQL 映射文件的命名空间中。因此，同一命名空间中的所有语句和缓存将通过命名空间绑定在一起。每条语句可以自定义与缓存交互的方式，或将它们完全排除于缓存之外，这可以通过在每条语句上使用两个简单属性来达成。默认情况下，语句会这样来配置：

<select ... flushCache="false" useCache="true"/>
<insert ... flushCache="true"/>
<update ... flushCache="true"/>
<delete ... flushCache="true"/>

鉴于这是默认行为，显然你永远不应该以这样的方式显式配置一条语句。但如果你想改变默认的行为，只需要设置 flushCache 和 useCache 属性。比如，某些情况下你可能希望特定 select 语句的结果排除于缓存之外，或希望一条 select 语句清空缓存。类似地，你可能希望某些 update 语句执行时不要刷新缓存。

1.3 cache-ref

回想一下上一节的内容，对某一命名空间的语句，只会使用该命名空间的缓存进行缓存或刷新。但你可能会想要在多个命名空间中共享相同的缓存配置和实例。要实现这种需求，你可以使用 cache-ref 元素来引用另一个缓存。

<cache-ref namespace="com.someone.application.data.SomeMapper"/>

二、补充

2.1 Mybatis缓存介绍

Mybatis提供查询缓存，如果缓存中有数据就不用从数据库中获取，用于减轻数据压力，提高系统性能。Mybatis的查询缓存总共有两级，我们称之为一级缓存和二级缓存。

一级缓存是SqlSession级别的缓存。在操作数据库时需要构造 sqlSession对象，在对象中有一个数据结构（HashMap）用于存储缓存数据。不同的sqlSession之间的缓存数据区域（HashMap）是互相不影响的。

二级缓存是Mapper（namespace）级别的缓存。多个SqlSession去操作同一个Mapper的sql语句，多个SqlSession可以共用二级缓存，二级缓存是跨SqlSession的。

2.2 一级缓存

Mybatis的一级缓存是默认开启的，其实指的是Mybaits中SqlSession对象的缓存。当我们执行查询之后，查询的结果会同时存入到 SqlSession为我们提供的一块区域中。该区域的结构是一个Map。当我们再次查询同样的数据，Mybatis会先去SqlSession中查询是否存在，存在的话直接返回，而不会再去数据库查询。这里要注意一个点，因为一级缓存是依赖于SqlSession对象的，当SqlSession对象消失时，Mybaits的一级缓存也就消失了。

当Mybaits与Spring整合的时候，不带Spring事务的方法内，每次请求数据库，都会新建一个SqlSession，这时候是使用不到一级缓存的，代码示例如下：

public void test1(){
    MailConf mail1 = mailConfService.findByMailCode("11");
    System.out.println(mail1);
    MailConf mail2 = mailConfService.findByMailCode("11");
    System.out.println(mail2);
    System.out.println(mail1 == mail2);
}

可以看到，每次请求都新建了一个Sqlsession，返回的对象也不是同一个。

在带Spring事务的方法内，每次请求数据库，只新建一个SqlSession，这时候是可以使用到一级缓存的，代码示例如下：

@Transactional(rollbackFor = Exception.class)
public void test1(){
    MailConf mail1 = mailConfService.findByMailCode("11");
    System.out.println(mail1);
    MailConf mail2 = mailConfService.findByMailCode("11");
    System.out.println(mail2);
    System.out.println(mail1 == mail2);
}

这样就用到了一级缓存。

除了事务问题，还有一些问题也会影响到一级缓存，比如调用了Sqlsession的修改、添加、删除、commit()、close()等方法时，一级缓存也会被清空，底下示例就先删除一条记录，然后看下结果：

@Transactional(rollbackFor = Exception.class)
public void test1() {
    MailConf mail1 = mailConfService.findByMailCode("11");
    System.out.println(mail1);
    // 删除
    mailConfService.deleteConf(2);
    MailConf mail2 = mailConfService.findByMailCode("11");
    System.out.println(mail2);
    System.out.println(mail1 == mail2);
}

同样的代码，不同的执行结果，这时候也是没有用到一级缓存。只要不是放在两次查询的中间，都会使用到一级缓存。

2.2 二级缓存

2.2.1 开启二级缓存

Mybatis的二级缓存是默认关闭的，它指的是Mybatis中SqlSessionFactory对象的缓存，由同一个SqlSessionFactory对象创建的SqlSession共享其二级缓存。这里注意：一个SqlSessionFactory对象可能创建多个SqlSession。

SpringBoot项目中二级缓存使用步骤：

让当前的映射文件支持二级缓存(在xxx.xml中配置)
让当前的操作支持二级缓存(在select标签中配置)

<settings>
  <setting "cacheEnabled"value="true"/>
</settings>

在mapper.xml中加入标签<cache/>核心参数可不设置，使用默认参数。开启本mapper下的namespace的二级缓存，默认使用的是mybatis提供的PerpetualCache。

第一次调用mapper下的SQL去查询用户信息。查询到的信息会存到该mapper对应的二级缓存区域内。

第二次调用相同namespace下的mapper映射文件中相同的SQL去查询用户信息。会去对应的二级缓存内取结果。如果调用相同namespace下的mapper映射文件中的增删改SQL，并执行了commit操作。此时会清空该namespace下的二级缓存。

2.2.2 禁用二级缓存

默认二级缓存的粒度是mapper级别的，但是如果在同一个mapper文件中某个查询不想使用二级缓存的话，就需要对缓存的控制粒度更细。在select标签中设置useCache=false，可以禁用当前select语句的二级缓存，即每次查询都是去数据库中查询，默认情况下是true，即该statement使用二级缓存。

<select id="findUserById" 
parameterType="int" resultType="com.kkb.mybatis.po.User"useCache="true">
    SELECT * FROM user WHERE id = #{id}
</select>

2.2.3 刷新二级缓存

通过flushCache属性，可以控制select、insert、update、delete标签是否属性二级缓存。

默认情况下如果是select语句，那么flushCache是false。如果是insert、update、delete语句，那么flushCache是true。

如果查询语句设置成true，那么每次查询都是去数据库查询，即意味着该查询的二级缓存失效。

如果增删改语句设置成false，即使用二级缓存，那么如果在数据库中修改了数据，而缓存数据还是原来的，这个时候就会出现脏读。

flushCache设置如下：

<selectid="findUserById"parameterType="int" resultType="com.kkb.mybatis.po.User" useCache="true" flushCache="true">
   SELECT * FROM user WHERE id =#{id}
</select>

2.3 为什么使用缓存

使用缓存可以减少和数据库的交互次数，提高执行效率，并且可以保护数据库不被高并发的请求拖死。

2.3 适用于缓存的数据

经常查询并且不经常被改变的数据。
数据的正确与否对最终结果影响不大的数据。

2.4 不适用于缓存的数据

经常改变的数据。
数据的正确与否对最终结果影响很大的。

2.5 总结

1、Mybatis的一级缓存默认开启，而二级缓存默认关闭。

2、Mybatis的一级缓存指的是Mybaits中SqlSession对象的缓存，而二级缓存指的是SqlSessionFactory对象的缓存。一个SqlSessionFactory对象包括多个SqlSession对象。

3、SqlSession对象中存放的是返回数据的对象，而SqlSessionFactory对象中存放的是数据，不是对象。

4、Mybatis和Spring整合的时候，一级缓存与事务有关，而二级缓存与事务无关。