Mybatis 源码解析(三) Mybatis 一级缓存（本地缓存）

淡淡的烟草味﹌ 2022-04-25 04:54 252阅读 0赞

### 文章目录 ###

*   *  一级缓存
     *   *  缓存实现
         *  缓存作用域
         *   *  session
             *  statement
         *  缓存key生成策略
         *  添加缓存
         *  清空缓存
         *  例子解析
         *  总结

## 一级缓存 ##

官方解释：

> MyBatis uses local cache to prevent circular references and speed up repeated nested queries. MyBatis使用本地缓存来防止循环引用并加速重复的嵌套查询。

这个缓存是离sql执行前后最近的一层缓存。是SqlSession级别的，底层通过HashMap进行实现。

### 缓存实现 ###

SqlSession的执行方法调用的是BaseExecutor，在BaseExecutor中有一个类型为HashMap的localCache字段，用来缓存查询结果。

通过queryStack来设置当前查询的个数，第一次进行查询的时候，会设置一个PlaceHolder来表示当前查询已经正在查询了，对于懒加载的在当前执行器里面没有待查询的语句的时候，也就是queryStack=0时，会将所有懒加载的内容进行加载。这个懒加载的相关内容还需要进一步的研究

### 缓存作用域 ###

#### session ####

**默认**。在单个sqlsession执行的所有语句可以使用这些缓存，只要没有更新缓存就一直可以获取。

#### statement ####

可以理解为缓存只对当前执行的这一个statement有效。即每一次查询都不缓存。所有的查询数据都不会被共享。

### 缓存key生成策略 ###

*BaseExecutor\#createCacheKey*

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;
      }

**例子**: 849177396:715770766:com.wuhulala.springboot.mybatis.mapper.CountryMapper.selectAll:0:2147483647:select id,countryname,countrycode from country:development

**解释**：hashcode+checksum+statementId + start + limit + sql + \*\*sql 查询参数 \*\*+ 当前configuration的名称

这里的sql查询参数指的是： **真正的拼接到sql上的参数，比如select \* from user ，那么你无论传入什么参数，都还是会使用此缓存的。**

### 添加缓存 ###

*  queryFromDatabase

### 清空缓存 ###

*  commit(boolean)
 *  rollback(boolean)
 *  update(MappedStatement, Object)
 *  queryStack == 0 && ms.isFlushCacheRequired()
 *  queryStack ==0 && configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT

### 例子解析 ###

try (SqlSession session = sqlSessionFactory.openSession()) { 
        List<Country> countries = session.selectList("com.wuhulala.springboot.mybatis.mapper.CountryMapper.selectAll");
        System.out.println(">>>>>>>> 第一次查询..." + countries);
        countries = session.selectList("com.wuhulala.springboot.mybatis.mapper.CountryMapper.selectAll");
        System.out.println(">>>>>>>> 第二次查询..." + countries);
        // 会清空缓存
        session.commit();
        countries = session.selectList("com.wuhulala.springboot.mybatis.mapper.CountryMapper.selectAll");
        System.out.println(">>>>>>>> 第三次查询..." + countries);
        System.out.println(countries);
    }

以上会在第二次查询的时候使用第一次查询的缓存，但是由于第三次的时候缓存已经被清空，所以会继续进行查询数据库，对应序列图如下。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNzYwNDQ_size_16_color_FFFFFF_t_70]

### 总结 ###

*  mybatis 在实现一级缓存还是比较简单的，只是使用一个HashMap，这里也没有理解这样设计的意图？
 *  如果全部使用单个session查询的话或者结果集比较大，可能会**挤爆HashMap**。
 *  **不是线程安全**的，在有多个线程的情况操作同一个session。目前很多线程安全是使用ThreadLocal包装sqlSession，进行线程隔离。做的粒度比较大。但是如果设置的线程安全的话，可能会造成数据库
 *  粒度特别**粗**，清空的时候是清空所有的缓存
 *  在多个SqlSession或者分布式的部署方式，操作了同一个表或者行等竞争资源后，会引起脏数据，如果对**数据一致性**特别敏感的话，可以把一级缓存的Scope级别设为`LocalCacheScope.STATEMENT`。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwNzYwNDQ_size_16_color_FFFFFF_t_70]: /images/20220210/77893b74aa674ea29046e6c1ede1a0df.png