mybatis一级缓存源码解读，从一个bug开始

本是古典何须时尚 2023-06-21 10:12 139阅读 0赞

### 文章目录 ###

*  案发现场
 *  mybatis-spring官网
 *  源码走起
 *   *  一级缓存
     *  CacheKey
     *  sqlSession
 *  BaseExecutor
 *  实践一哈
 *  纠错
 *  参考博客
 *  改正

# 案发现场 #

**描述**  
  一个servce里面，mapper查询，不存在数据，在另一个service新增，然后回到第一个service查询，返回null。也就是新增的数据第一个service是看不见的。

# mybatis-spring官网 #

[mybatis官网][mybatis]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70]

# 源码走起 #

## 一级缓存 ##

这个得从sqlSession说起，一级缓存以sqlSession commit结束，因为commit会清除缓存。  
一级缓存用的是**BaseExecutor**，二级使用**CachingExecutor**

## CacheKey ##

一级缓存使用key,value。key就是CacheKey。  
![在这里插入图片描述][20191212111813133.png]  
Mybatis 的缓存使用了 mappedStementId + offset + limit + SQL + queryParams + environment 生成的hashcode作为 key。

## sqlSession ##

**SqlSessionTemplate**  
  一个创建sqlSession的类，相当重要！  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 1]  
commit相当重要，一旦没有commit就可能命中mybatis缓存。

**SqlSessionUtils**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 2]  
这个决定了sqlSession是否要commit事务。也是**相当重要**

# BaseExecutor #

查询业务  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 3]  
新增，更新  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 4]  
clearLocalCache()清除缓存

# 实践一哈 #

**第一个栗子**  
使用单元测试Junit,测试一个mapper查询两个相同的sql

你会发现他们之间commit事务了。导致清除缓存，重新到数据库查询。

if (!isSqlSessionTransactional(sqlSession, SqlSessionTemplate.this.sqlSessionFactory)) {
              // force commit even on non-dirty sessions because some databases require
              // a commit/rollback before calling close()
              sqlSession.commit(true);
            }

在这里SqlSessionHolder为空，导致commit了。

**第二个栗子**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 5]  
[从StackOverflowError说到mybatis一级缓存][StackOverflowError_mybatis]

**分析**  
  我们在idea debug模式下，看到第一次查询创建了一个sqlSession，查询完没有commit，也就是缓存没有清除。为啥？因为service级别调用会有个tx事务的概念，根据spring事务还是有区别的。  
  这时SqlSessionHolder不为空，而且存了当前sqlSession。这个就是是否需要commit的依据！

在新建数据的时候是在其他的service，它会创建新的sqlSession来处理，处理完commit。

接着再返回原来的sqlSession再次查询数据，这个时候缓存不为空，命中缓存，查到的为空。

# 纠错 #

网上很多说sping里面使用mybatis一级缓存会失效，其实分情况的。  
  如果是mapper级别调用必然会commit事务，如果是service级别调用，如果没有insert,update,delete是不会清除缓存的！！！

# 参考博客 #

[Mybatis 缓存系统源码解析][Mybatis]

# 改正 #

2020/03/30 这一天技术群有位老哥，问了一个问题，就是一个mapper去查询，一个service去查询，结果命中缓存了，因为开了**事务**。

注意了**开了事务，开了事务，开了事务！！！**

上面说了文章说了很多，**重点：前提是开了事务，生命周期变成session级别**，因为我们项目是使用声明式事务，只要service方法开头以get,select开头都会默认加readonly为true事务。

当你加了事务一切就变了，以session为声明周期，只有出现update,insert才会去查数据库~

**解决方案：**

mybatis.configuration.local-cache-scope=statement

**mybatis-plus:**  
![在这里插入图片描述][20200330135218420.png]

[mybatis]: http://mybatis.org/spring/sqlsession.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191212105313876.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA==,size_16,color_FFFFFF,t_70
[20191212111813133.png]: https://img-blog.csdnimg.cn/20191212111813133.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191212104000663.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20191212104518500.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20191212105737215.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20191212105912924.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/2019121211101388.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA==,size_16,color_FFFFFF,t_70
[StackOverflowError_mybatis]: https://blog.csdn.net/weixin_38336658/article/details/103481230
[Mybatis]: https://my.oschina.net/mengyuankan/blog/2960728
[20200330135218420.png]: https://img-blog.csdnimg.cn/20200330135218420.png