【Mybatis源码分析】07-SqlSession执行过程之二级缓存

最新推荐文章于 2024-07-23 15:38:42 发布

smart哥

最新推荐文章于 2024-07-23 15:38:42 发布

阅读量697

点赞数 16

分类专栏： mybatis专题文章标签： mybatis

本文链接：https://blog.csdn.net/smart_an/article/details/138704972

版权

mybatis专题专栏收录该内容

44 篇文章 1 订阅

订阅专栏

作者简介：大家好，我是smart哥，前中兴通讯、美团架构师，现某互联网公司CTO

联系qq：184480602，加我进群，大家一起学习，一起进步，一起对抗互联网寒冬

学习必须往深处挖，挖的越深，基础越扎实！

阶段1、深入多线程

 阶段2、深入多线程设计模式

 阶段3、深入juc源码解析

阶段4、深入jdk其余源码解析

阶段5、深入jvm源码解析

码哥源码部分

码哥讲源码-原理源码篇【2024年最新大厂关于线程池使用的场景题】

码哥讲源码【炸雷啦！炸雷啦！黄光头他终于跑路啦！】

码哥讲源码-【jvm课程前置知识及c/c++调试环境搭建】

码哥讲源码-原理源码篇【揭秘join方法的唤醒本质上决定于jvm的底层析构函数】

码哥源码-原理源码篇【Doug Lea为什么要将成员变量赋值给局部变量后再操作？】

码哥讲源码【你水不是你的错,但是你胡说八道就是你不对了！】

码哥讲源码【谁再说Spring不支持多线程事务，你给我抽他！】

终结B站没人能讲清楚红黑树的历史，不服等你来踢馆！

打脸系列【020-3小时讲解MESI协议和volatile之间的关系，那些将x86下的验证结果当作最终结果的水货们请闭嘴】

DefaultSqlSession执行selectList方法内实际调用CachingExecutor的query方法，上篇文章分析过了BoundSql的获取过程，下面继续往下说一下二级缓存。

    public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
      BoundSql boundSql = ms.getBoundSql(parameterObject);
      CacheKey key = createCacheKey(ms, parameterObject, rowBounds, boundSql);
      return query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
    }

在得到BoiundSql后，使用ms,parameterObject,rowBounds,boundSql构造出一个CacheKey，这个CacheKey就是缓存命中的key。

    public CacheKey createCacheKey(MappedStatement ms, Object parameterObject, RowBounds rowBounds, BoundSql boundSql) {
      return delegate.createCacheKey(ms, parameterObject, rowBounds, boundSql);
    }

    public CacheKey createCacheKey(MappedStatement ms, Object parameterObject, RowBounds rowBounds, BoundSql boundSql) {
      if (closed) {
        throw new ExecutorException("Executor was closed.");
      }
      CacheKey cacheKey = new CacheKey();
      cacheKey.update(ms.getId());
      cacheKey.update(rowBounds.getOffset());
      cacheKey.update(rowBounds.getLimit());
      cacheKey.update(boundSql.getSql());
      List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
      TypeHandlerRegistry typeHandlerRegistry = ms.getConfiguration().getTypeHandlerRegistry();
      // mimic DefaultParameterHandler logic
      for (ParameterMapping parameterMapping : parameterMappings) {
        if (parameterMapping.getMode() != ParameterMode.OUT) {
          Object value;
          String propertyName = parameterMapping.getProperty();
          if (boundSql.hasAdditionalParameter(propertyName)) {
            value = boundSql.getAdditionalParameter(propertyName);
          } else if (parameterObject == null) {
            value = null;
          } else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
            value = parameterObject;
          } else {
            MetaObject metaObject = configuration.newMetaObject(parameterObject);
            value = metaObject.getValue(propertyName);
          }
          cacheKey.update(value);
        }
      }
      if (configuration.getEnvironment() != null) {
        // issue #176
        cacheKey.update(configuration.getEnvironment().getId());
      }
      return cacheKey;
    }

我们再看一下命中二级缓存的query方法:

    public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql)
        throws SQLException {
      Cache cache = ms.getCache();
      if (cache != null) {
        flushCacheIfRequired(ms);
        if (ms.isUseCache() && resultHandler == null) {
          ensureNoOutParams(ms, boundSql);
          @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);
    }

1.首先从MappedStatement取出对应Mapper配置的实现Cache类。

2.flushCacheIfRequired根据ms判断是否需要清空Cache的缓存，默认查询是不清除的，分析到这就会发现一个问题：默认情况下更新一张表的一条数据就会将整个这个表对应的整个Cache缓存的内容都清空，所以Mybatis二级缓存只适合数据不太变动的缓存。

    private void flushCacheIfRequired(MappedStatement ms) {
      Cache cache = ms.getCache();
      if (cache != null && ms.isFlushCacheRequired()) {      
        tcm.clear(cache);
      }
    }

3.如果我们没有自定义resultHandler则可以使用缓存了，从tcm检测是否命中缓存，如果没有缓存对象则调用委托对象默认为SimpleExecutor的query方法。

可以看到不管事清空缓存还是命中缓存都是通过tcm()这个对象完成的，下面分析一下这个tcm(TransactionalCacheManager)是如何配合Cache实现类完成缓存的。

    public class TransactionalCacheManager {
      private final Map<Cache, TransactionalCache> transactionalCaches = new HashMap<Cache, TransactionalCache>();
      public void clear(Cache cache) {
        getTransactionalCache(cache).clear();
      }
      public Object getObject(Cache cache, CacheKey key) {
        return getTransactionalCache(cache).getObject(key);
      }
      public void putObject(Cache cache, CacheKey key, Object value) {
        getTransactionalCache(cache).putObject(key, value);
      }
      public void commit() {
        for (TransactionalCache txCache : transactionalCaches.values()) {
          txCache.commit();
        }
      }
      public void rollback() {
        for (TransactionalCache txCache : transactionalCaches.values()) {
          txCache.rollback();
        }
      }
      private TransactionalCache getTransactionalCache(Cache cache) {
        TransactionalCache txCache = transactionalCaches.get(cache);
        if (txCache == null) {
          txCache = new TransactionalCache(cache);
          transactionalCaches.put(cache, txCache);
        }
        return txCache;
      }
    
    }

此类内部维护了一个HashMap<Cache,TransactionalCache>,避免同一session下重复创建TransactionalCache。先来看一下putObject方法是调用了TransactionalCache的putObject方法。

    private final Map<Object, Object> entriesToAddOnCommit;

    public void putObject(Object key, Object object) {
      entriesToAddOnCommit.put(key, object);
    }

可以看到只是用了一个Map简单的将CacheKey和结果对象做了一个映射，而是在commit方法中将结果放入Cache中的，我们看一下commit的调用链。

可以看到在SqlSession关闭的时候才会调用commit方法。

如果缓存中存在结果对象则直接返回，否则调用委托对象的query方法获取结果在放入缓存。

    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;

下一篇分析下SimpleExecutor是如何真正访问数据库的。