深入了解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的前提下才可以！

四、避免使用二级缓存

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

• 缓存是以namespace为单位的，不同namespace下的操作互不影响。
• insert,update,delete操作会清空所在namespace下的全部缓存。
• 通常使用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，就一定会涉及到多表的操作。

<select id="selectuserroles" resulttype="userrolevo">
 select * from user_role a,role b where a.roleid = b.roleid and a.userid = #{userid}
</select>

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

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

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

这点应该很容易理解。

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

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

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

五、挽救二级缓存？

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

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

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

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

推荐：集成 spring redis 缓存
https://www.jb51.net/article/153343.htm

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对的支持。如果你想了解更多相关内容请查看下面相关链接