mybatis源码解析之调用流程（二级缓存）

逃离我推掉我的手 2022-09-01 09:25 214阅读 0赞

> 原创不易，转载请注明出处

### 文章目录 ###

*   *   *  前言
         *  1. 入口
         *  2.二级缓存
         *  总结

--------------------

### 前言 ###

在《[mybatis源码解析之调用流程（一级缓存）][mybatis]》一文中，我们介绍了一级缓存的原理，由于一级缓存是namespace级别甚至namespace共享级别的缓存，又加上现在服务都是多节点集群部署，容易出现数据一致性问题，所以一般情况我们不会用到，默认它是关闭的，本文将接着mybatis调用流程往下介绍，看看mybatis二级缓存是什么样子的，实现原理。

### 1. 入口 ###

在CachingExecutor 的query 方法中，如果你开启了一级缓存，它就会先去一级缓存中查询，如果一级缓存中没有或者是没有开启一级缓存，这个时候，就会继续调用它包装的Executor进行获取，也就是SimpleExecutor。

public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql)
        throws SQLException { 
      // 这个cache 是需要在namespace 级别上配置的
      Cache cache = ms.getCache();
      if (cache != null) { 
        //判断如果需要刷新缓存的话，就要刷新缓存了，update|delete|insert
        flushCacheIfRequired(ms);
        // UseCache 这个东西select 语句的话，默认是true的 //如果使用缓存 并且 结果处理器是null
        if (ms.isUseCache() && resultHandler == null) { 
          ensureNoOutParams(ms, boundSql);
          @SuppressWarnings("unchecked")  
          //先去缓存中获取，如果不存在的话，就会走下面的查询操作，然后放入缓存中，如果已经存在了，直接返回即可
          List<E> list = (List<E>) tcm.getObject(cache, key);
          if (list == null) { 
            list = delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
            tcm.putObject(cache, key, list); // issue #578 and #116
          }
          return list;
        }
      }
      return delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
    }

这就是进行一级缓存中查询的代码。可以看到，如果一级缓存没有或者是没有开启一级缓存，这个时候就会调用delegate.query 方法进行获取，这个 delegate 就是它包装的那个SimpleExecutor  
接下来我们看下。

### 2.二级缓存 ###

SimpleExecutor 没有重写query这个方法，所以走的是它父类BaseExecutor的query方法，我们看下。

public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException { 
        ErrorContext.instance().resource(ms.getResource()).activity("executing a query").object(ms.getId());
        // 如果需要刷新缓存的话
        if (queryStack == 0 && ms.isFlushCacheRequired()) { 
          clearLocalCache();
        }
        List<E> list;
        try { 
          queryStack++;
          // 先去cache中查询，如果存在的话，就处理处理返回了
          list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;
          if (list != null) { 
            handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
          } else { 
            // 缓存中没有的话 从数据库中查询
            list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
          }
        } finally { 
          queryStack--;
        }
        if (queryStack == 0) { 
          for (DeferredLoad deferredLoad : deferredLoads) { 
            deferredLoad.load();
          }
          // issue #601
          deferredLoads.clear();
          if (configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) { 
            // issue #482
            clearLocalCache();
          }
        }
        return list;
      }

如果是需要刷新缓存的话，调用clearLocalCache(); 方法，进行清理缓存。

> 什么情况下会刷新缓存呢?  
> insert，update，delete 语句默认是flushCache的，默认会清空缓存。  
> 当然你也可以在你的mapper xml 文件中的insert，update，delete，select 标签上设置flushCache=“true” 来刷新缓存。

接着往下， `list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;` 我们这个resultHandler 是null，这个时候就会找localCache获取缓存内容，如果获取到了，处理处理就返回了，如果获取不到调用queryFromDatabase 方法去数据库里面查询。  
其实这个localCache 就是传说中的二级缓存了，它默认是sqlSession级别的，也就是说，你在这个sqlSession中设置的缓存信息，在其他sqlSession查询是获取不到的，它不像一级缓存那样，是namespace级别的，是可以跨sqlSession获取到的。  
我们来看下这个localCache是个什么东西。  
其实在创建sqlSession的时候，会创建Executor，而这个localCache 就是创建Executor的时候实例化的。

protected BaseExecutor(Configuration configuration, Transaction transaction) { 
        this.transaction = transaction;// 事务
        this.deferredLoads = new ConcurrentLinkedQueue<>();
        // 本地缓存/一级缓存
        this.localCache = new PerpetualCache("LocalCache");
        this.localOutputParameterCache = new PerpetualCache("LocalOutputParameterCache");
        this.closed = false;
        this.configuration = configuration;
        // 这个wrapper就是它自己
        this.wrapper = this;
      }

可以看到localCache 就是个PerpetualCache ，而PerpetualCache里面非常的简单，就是一个map

public class PerpetualCache implements Cache { 
      private final String id;
      // 其实就是个map
      private final Map<Object, Object> cache = new HashMap<>();
      ...
    }

可以看到就是个HashMap。  
好了，localCache的底层实现就知道了，接下来就是总结一下了。

### 总结 ###

本文主要介绍了mybatis调用流程中的二级缓存部分，可以看到所谓的二级缓存底层实现非常简单，就是个HashMap,  
它的默认作用域是SqlSession级别，当然你也可以设置成statement级别，同一个SqlSession中，默认遇到update，insert，delete会刷新缓存，也会是清空缓存，这里需要注意的是，我们集成spring的时候，一个事务里面用的是同一个SqlSession。

[mybatis]: https://inetyoung.blog.csdn.net/article/details/119118536