深入了解MyBatis二级缓存

深入了解MyBatis二级缓存

一、创建Cache的完整过程

我们从SqlSessionFactoryBuilder解析mybatis-config.xml配置文件开始：

Reader reader = Resources.getResourceAsReader("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);

然后是：

XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
return build(parser.parse());

看parser.parse()方法：

parseConfiguration(parser.evalNode("/configuration"));

看处理Mapper.xml文件的位置：

mapperElement(root.evalNode("mappers"));

看处理Mapper.xml的XMLMapperBuilder：

XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration,
                    resource, configuration.getSqlFragments());
mapperParser.parse();

继续看parse方法：

configurationElement(parser.evalNode("/mapper"));

到这里：

String namespace = context.getStringAttribute("namespace");
if (namespace.equals("")) {
     throw new BuilderException("Mapper's namespace cannot be empty");
}
builderAssistant.setCurrentNamespace(namespace);
cacheRefElement(context.evalNode("cache-ref"));
cacheElement(context.evalNode("cache"));

从这里看到namespace就是xml中<mapper>元素的属性。然后下面是先后处理的cache-ref和cache，后面的cache会覆盖前面的cache-ref，但是如果一开始cache-ref没有找到引用的cache，他就不会被覆盖，会一直到最后处理完成为止，最后如果存在cache，反而会被cache-ref覆盖。这里是不是看着有点晕、有点乱？所以千万别同时配置这两个，实际上也很少有人会这么做。

看看MyBatis如何处理<cache/>：

private void cacheElement(XNode context) throws Exception {
    if (context != null) {
        String type = context.getStringAttribute("type", "PERPETUAL");
        Class<? extends Cache> typeClass = typeAliasRegistry.resolveAlias(type);
        String eviction = context.getStringAttribute("eviction", "LRU");
        Class<? extends Cache> evictionClass = typeAliasRegistry.resolveAlias(eviction);
        Long flushInterval = context.getLongAttribute("flushInterval");
        Integer size = context.getIntAttribute("size");
        boolean readWrite = !context.getBooleanAttribute("readOnly", false);
        boolean blocking = context.getBooleanAttribute("blocking", false);
        Properties props = context.getChildrenAsProperties();
        builderAssistant.useNewCache(typeClass, evictionClass,
                         flushInterval, size, readWrite, blocking, props);
    }
}

从源码可以看到MyBatis读取了那些属性，而且很容易可以到这些属性的默认值。

创建Java的cache对象方法为builderAssistant.useNewCache，我们看看这段代码：

public Cache useNewCache(Class<? extends Cache> typeClass,
                         Class<? extends Cache> evictionClass,
                         Long flushInterval,
                         Integer size,
                         boolean readWrite,
                         boolean blocking,
                         Properties props) {
    typeClass = valueOrDefault(typeClass, PerpetualCache.class);
    evictionClass = valueOrDefault(evictionClass, LruCache.class);
    Cache cache = new CacheBuilder(currentNamespace)
            .implementation(typeClass)
            .addDecorator(evictionClass)
            .clearInterval(flushInterval)
            .size(size)
            .readWrite(readWrite)
            .blocking(blocking)
            .properties(props)
            .build();
    configuration.addCache(cache);
    currentCache = cache;
    return cache;
}

从调用该方法的地方，我们可以看到并没有使用返回值cache，在后面的过程中创建MappedStatement的时候使用了currentCache。

二、使用Cache过程

在系统中，使用Cache的地方在CachingExecutor中：

@Override
public <E> List<E> query(
        MappedStatement ms, Object parameterObject,
        RowBounds rowBounds, ResultHandler resultHandler,
        CacheKey key, BoundSql boundSql) throws SQLException {
  Cache cache = ms.getCache();

获取cache后，先判断是否有二级缓存。 
只有通过<cache/>,<cache-ref/>或@CacheNamespace,@CacheNamespaceRef标记使用缓存的Mapper.xml或Mapper接口（同一个namespace，不能同时使用）才会有二级缓存。

  if (cache != null) {

如果cache存在，那么会根据sql配置(<insert>,<select>,<update>,<delete>的flushCache属性来确定是否清空缓存。

    flushCacheIfRequired(ms);

然后根据xml配置的属性useCache来判断是否使用缓存(resultHandler一般使用的默认值，很少会null)。

    if (ms.isUseCache() && resultHandler == null) {

确保方法没有Out类型的参数，mybatis不支持存储过程的缓存，所以如果是存储过程，这里就会报错。

      ensureNoOutParams(ms, parameterObject, boundSql);

没有问题后，就会从cache中根据key来取值：

      @SuppressWarnings("unchecked")
      List<E> list = (List<E>) tcm.getObject(cache, key);

如果没有缓存，就会执行查询，并且将查询结果放到缓存中。

      if (list == null) {
        list = delegate.<E>query(ms, parameterObject,
                        rowBounds, resultHandler, key, boundSql);
        tcm.putObject(cache, key, list); // issue #578 and #116
      }

返回结果

      return list;
    }
  }

没有缓存时，直接执行查询

  return delegate.<E>query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
}

在上面的代码中tcm.putObject(cache, key, list);这句代码是缓存了结果。但是实际上直到sqlsession关闭，MyBatis才以序列化的形式保存到了一个Map（默认的缓存配置）中。

三、Cache使用时的注意事项

1. 只能在【只有单表操作】的表上使用缓存

不只是要保证这个表在整个系统中只有单表操作，而且和该表有关的全部操作必须全部在一个namespace下。

2. 在可以保证查询远远大于insert,update,delete操作的情况下使用缓存

这一点不需要多说，所有人都应该清楚。记住，这一点需要保证在1的前提下才可以！ 

四、避免使用二级缓存

可能会有很多人不理解这里，二级缓存带来的好处远远比不上他所隐藏的危害。

  1. 缓存是以namespace为单位的，不同namespace下的操作互不影响。
  2. insert,update,delete操作会清空所在namespace下的全部缓存。
  3. 通常使用MyBatis Generator生成的代码中，都是各个表独立的，每个表都有自己的namespace。

为什么避免使用二级缓存

在符合【Cache使用时的注意事项】的要求时，并没有什么危害。

其他情况就会有很多危害了。

针对一个表的某些操作不在他独立的namespace下进行。

例如在UserMapper.xml中有大多数针对user表的操作。但是在一个XXXMapper.xml中，还有针对user单表的操作。

这会导致user在两个命名空间下的数据不一致。如果在UserMapper.xml中做了刷新缓存的操作，在XXXMapper.xml中缓存仍然有效，如果有针对user的单表查询，使用缓存的结果可能会不正确。

更危险的情况是在XXXMapper.xml做了insert,update,delete操作时，会导致UserMapper.xml中的各种操作充满未知和风险。

有关这样单表的操作可能不常见。但是你也许想到了一种常见的情况。

多表操作一定不能使用缓存

为什么不能？

首先不管多表操作写到那个namespace下，都会存在某个表不在这个namespace下的情况。

例如两个表：role和user_role，如果我想查询出某个用户的全部角色role，就一定会涉及到多表的操作。

<code class="language-xml hljs  has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; word-wrap: normal; background: transparent;"><span class="hljs-tag" style="color: rgb(0, 102, 102); box-sizing: border-box;"><<span class="hljs-title" style="box-sizing: border-box; color: rgb(0, 0, 136);">select</span> <span class="hljs-attribute" style="box-sizing: border-box; color: rgb(102, 0, 102);">id</span>=<span class="hljs-value" style="box-sizing: border-box; color: rgb(0, 136, 0);">"selectUserRoles"</span> <span class="hljs-attribute" style="box-sizing: border-box; color: rgb(102, 0, 102);">resultType</span>=<span class="hljs-value" style="box-sizing: border-box; color: rgb(0, 136, 0);">"UserRoleVO"</span>></span>
    select * from user_role a,role b where a.roleid = b.roleid and a.userid = #{userid}
<span class="hljs-tag" style="color: rgb(0, 102, 102); box-sizing: border-box;"></<span class="hljs-title" style="box-sizing: border-box; color: rgb(0, 0, 136);">select</span>></span></code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li></ul>

像上面这个查询，你会写到那个xml中呢？？

不管是写到RoleMapper.xml还是UserRoleMapper.xml，或者是一个独立的XxxMapper.xml中。如果使用了二级缓存，都会导致上面这个查询结果可能不正确。

如果你正好修改了这个用户的角色，上面这个查询使用缓存的时候结果就是错的。

这点应该很容易理解。

在我看来，就以MyBatis目前的缓存方式来看是无解的。多表操作根本不能缓存。

如果你让他们都使用同一个namespace（通过<cache-ref>）来避免脏数据，那就失去了缓存的意义。

看到这里，实际上就是说，二级缓存不能用。整篇文章介绍这么多也没什么用了。

五、挽救二级缓存？

想更高效率的使用二级缓存是解决不了了。

但是解决多表操作避免脏数据还是有法解决的。解决思路就是通过拦截器判断执行的sql涉及到那些表（可以用jsqlparser解析），然后把相关表的缓存自动清空。但是这种方式对缓存的使用效率是很低的。

设计这样一个插件是相当复杂的，既然我没想着去实现，就不废话了。

最后还是建议，放弃二级缓存，在业务层使用可控制的缓存代替更好。

时间： 2024-09-23 09:14:06

深入了解MyBatis二级缓存的相关文章

mybatis 二级缓存-Mybatis 二级缓存的问题

问题描述 Mybatis 二级缓存的问题 我实现了Mybatis 提供的Cache 接口,并且实现了每个方法, 在update修改数据的时候也能调用clear,和remove 方法, 但是在delete 的时候,Mybatis 不能调用我的实现方法 ,cache 接口的实现类 public class MybatisMemCached implements Cache { private int timeOut = 3000; // 单位毫秒 private int cacheTime = 0;

深入理解Mybatis二级缓存_java

上篇文章给大家介绍了mybatis一级缓存,有需要的朋友可以参考下. 与一级缓存相比,二级缓存范围更大了一些,可以被多个SqlSession所共用. 同样是发送同样的查询sql会先去缓存中找,找不到再去查询数据库. 每个namespace的mapper都会有自己的一个缓存的空间. 如果两个mapper的namespace相同,执行mapper查询到的数据将存储到相同的二级缓存. 同样如果有sqlSession执行了commit 会清空二级缓存. 配置文件(不用配置也是默认开启的): 在sqlMa

MyBatis的一级缓存和二级缓存 以及 mybatis和ehcache缓存框架整合

查询缓存 缓存的意义 将用户经常查询的数据放在缓存(内存)中,用户去查询数据就不用从磁盘上(关系型数据库数据文件)查询,从缓存中查询,从而提高查询效率,解决了高并发系统的性能问题. 基本由此图可以看出,我们在每一层都需要相应的缓存. mybatis持久层缓存 mybatis提供一级缓存和二级缓存 mybatis一级缓存是一个SqlSession级别,sqlsession只能访问自己的一级缓存的数据,二级缓存是跨sqlSession,是mapper级别的缓存,对于mapper级别的缓存不同的sql

MyBatis中的一级缓存和二级缓存介绍

先说缓存,合理使用缓存是优化中最常见的,将从数据库中查询出来的数据放入缓存中,下次使用时不必从数据库查询,而是直接从缓存中读取,避免频繁操作数据库,减轻数据库的压力,同时提高系统性能. 一级缓存 一级缓存是SqlSession级别的缓存.在操作数据库时需要构造sqlSession对象,在对象中有一个数据结构用于存储缓存数据.不同的sqlSession之间的缓存数据区域是互相不影响的.也就是他只能作用在同一个sqlSession中,不同的sqlSession中的缓存是互相不能读取的. 一级缓存的工

【MyBatis框架】查询缓存-二级缓存原理

二级缓存原理 1.原理 首先看图 首先开启mybatis的二级缓存. sqlSession1去查询用户id为1的用户信息,查询到用户信息会将查询数据存储到二级缓存中. 如果SqlSession3去执行相同 mapper下sql,执行commit提交,清空该 mapper下的二级缓存区域的数据. sqlSession2去查询用户id为1的用户信息,去缓存中找是否存在数据,如果存在直接从缓存中取出数据. 二级缓存与一级缓存区别,二级缓存的范围更大,多个sqlSession可以共享一个UserMapp

mybatis 一级缓存与二级缓存调用顺序问题

问题描述 mybatis 一级缓存与二级缓存调用顺序问题 mybatis 中当一次查询数据库后是将数据同时写入一级缓存与二级缓存中吗?(二级缓存已开)那么当我再次使用同一sql语句时,mybatis是先从一级缓存中查找是否有同样数据还是从二级缓存中查找? 解决方案 http://www.mamicode.com/info-detail-890951.html 解决方案二: mybatis 一级缓存和二级缓存简介

mybatis一级缓存(session cache)引发的问题

问题回顾 最近项目功能单元测试中,出现了一个奇怪的bug.远程调试发现,程序进行了2次相同的查询,返回了实体类(ClassA)的2个对象:classAInstance1和classAInstance2,当修改classAInstance1.property1时,竟然classAInstance2.property1也被改了!!! 很快发现classAInstance1和classAInstance2地址是相同的,它们是同一个内存对象! 原因分析 经调试发现,mybatis返回的实体类的内存地址是

03_MyBatis基本查询，mapper文件的定义，测试代码的编写，resultMap配置返回值，sql片段配置，select标签标签中的内容介绍，配置使用二级缓存，使用别名的数据类型，条件查询ma

 1 PersonTestMapper.xml中的内容如下: <?xmlversion="1.0"encoding="UTF-8"?> <!DOCTYPEmapper PUBLIC"-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <!--  namespace:命名空间,用来唯

CPU的二级缓存对CPU超频有影响吗

问:听说CPU的二级缓存对CPU超频有一定的影响,请问影响是什么? 答:是的,CPU内集成的二级缓存,可以有效地提高CPU的性能,但对超频来说,它却算是一个瓶颈问题.老的PⅡ.PⅢ处理器的二级缓存频率是CPU主频的一半,当CPU被超频后,二级缓存的频率也会相应提高,所以说超频是对CPU和二级缓存的考验.一般情况下,在主板CMOS设置中关闭二级缓存选项,有利于超频的成功,但这是以牺牲CPU性能为代价的.