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

四、避免使用二級緩存

可能會有很多人不理解這里，二級緩存帶來的好處遠遠比不上他所隱藏的危害。

• 緩存是以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>）來避免臟數據，那就失去了緩存的意義。

看完上述內容，你們對MyBatis中怎么實現二級緩存有進一步的了解嗎？如果還想了解更多知識或者相關內容，請關注億速云行業資訊頻道，感謝大家的支持。