聊聊MyBatis缓存机制

概述https://tech.meituan.com/mybatis_cache.html前言MyBatis是常见的Java数据库访问层框架。在日常工作中，开发人员多数情况下是使用MyBatis的默认缓存配置，但是MyBatis缓存机制有一些不足之处，在使用中容易引起脏数据，形成一些潜在的隐患。个人在业务开发中也处理过一些由于MyBatis缓存引发的开发问题，带着个人的兴趣，希望从应用及源码的角度为读者梳理MyBatis缓存机制。本次分析中涉及到的代码和数据库表均放在GitHub上，地址： mybatis-cache-demo 。目录本文按照以下顺序展开。一级缓存介绍及相关配置。一级缓存工作流程及源码分析。一级缓存总结。二级缓存介绍及相关配置。二级缓存源码分析。二级缓存总结。全文总结。一级缓存一级缓存介绍在应用运行过程中，我们有可能在一次数据库会话中，执行多次查询条件完全相同的SQL，MyBatis提供了一级缓存的方案优化这部分场景，如果是相同的SQL语句，会优先命中一级缓存，避免直接对数据库进行查询，提高性能。具体执行过程如下图所示。每个SqlSession中持有了Executor，每个Executor中有一个LocalCache。当用户发起查询时，MyBatis根据当前执行的语句生成MappedStatement，在Local Cache进行查询，如果缓存命中的话，直接返回结果给用户，如果缓存没有命中的话，查询数据库，结果写入Local Cache，最后返回结果给用户。具体实现类的类关系图如下图所示。一级缓存配置我们来看看如何使用MyBatis一级缓存。开发者只需在MyBatis的配置文件中，添加如下语句，就可以使用一级缓存。共有两个选项，SESSION或者STATEMENT，默认是SESSION级别，即在一个MyBatis会话中执行的所有语句，都会共享这一个缓存。一种是STATEMENT级别，可以理解为缓存只对当前执行的这一个Statement有效。<setting name="localCacheScope" value="SESSION"/>一级缓存实验接下来通过实验，了解MyBatis一级缓存的效果，每个单元测试后都请恢复被修改的数据。首先是创建示例表student，创建对应的POJO类和增改的方法，具体可以在entity包和mapper包中查看。CREATE TABLE `student` (`id` int(11) unsigned NOT NULL AUTO_INCREMENT,`name` varchar(200) COLLATE utf8_bin DEFAULT NULL,`age` tinyint(3) unsigned DEFAULT NULL,PRIMARY KEY (`id`)) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8 COLLATE=utf8_bin;在以下实验中，id为1的学生名称是凯伦。实验1开启一级缓存，范围为会话级别，调用三次getStudentById，代码如下所示：public void getStudentById() throws Exception {SqlSession sqlSession = factory.openSession(true); // 自动提交事务StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);System.out.println(studentMapper.getStudentById(1));System.out.println(studentMapper.getStudentById(1));System.out.println(studentMapper.getStudentById(1));}执行结果：我们可以看到，只有第一次真正查询了数据库，后续的查询使用了一级缓存。实验2增加了对数据库的修改 *** 作，验证在一次数据库会话中，如果对数据库发生了修改 *** 作，一级缓存是否会失效。@Testpublic void addStudent() throws Exception {SqlSession sqlSession = factory.openSession(true); // 自动提交事务StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);System.out.println(studentMapper.getStudentById(1));System.out.println("增加了" + studentMapper.addStudent(buildStudent()) + "个学生");System.out.println(studentMapper.getStudentById(1));sqlSession.close();}执行结果：我们可以看到，在修改 *** 作后执行的相同查询，查询了数据库，一级缓存失效。实验3开启两个SqlSession，在sqlSession1中查询数据，使一级缓存生效，在sqlSession2中更新数据库，验证一级缓存只在数据库会话内部共享。@Testpublic void testLocalCacheScope() throws Exception {SqlSession sqlSession1 = factory.openSession(true);SqlSession sqlSession2 = factory.openSession(true);StudentMapper studentMapper = sqlSession1.getMapper(StudentMapper.class);StudentMapper studentMapper2 = sqlSession2.getMapper(StudentMapper.class);System.out.println("studentMapper读取数据: " + studentMapper.getStudentById(1));System.out.println("studentMapper读取数据: " + studentMapper.getStudentById(1));System.out.println("studentMapper2更新了" + studentMapper2.updateStudentName("小岑",1) + "个学生的数据");System.out.println("studentMapper读取数据: " + studentMapper.getStudentById(1));System.out.println("studentMapper2读取数据: " + studentMapper2.getStudentById(1));}sqlSession2更新了id为1的学生的姓名，从凯伦改为了小岑，但session1之后的查询中，id为1的学生的名字还是凯伦，出现了脏数据，也证明了之前的设想，一级缓存只在数据库会话内部共享。一级缓存工作流程&源码分析那么，一级缓存的工作流程是怎样的呢？我们从源码层面来学习一下。工作流程一级缓存执行的时序图，如下图所示。源码分析接下来将对MyBatis查询相关的核心类和一级缓存的源码进行走读。这对后面学习二级缓存也有帮助。SqlSession： 对外提供了用户和数据库之间交互需要的所有方法，隐藏了底层的细节。默认实现类是DefaultSqlSession。Executor： SqlSession向用户提供 *** 作数据库的方法，但和数据库 *** 作有关的职责都会委托给Executor。如下图所示，Executor有若干个实现类，为Executor赋予了不同的能力，大家可以根据类名，自行学习每个类的基本作用。在一级缓存的源码分析中，主要学习BaseExecutor的内部实现。BaseExecutor： BaseExecutor是一个实现了Executor接口的抽象类，定义若干抽象方法，在执行的时候，把具体的 *** 作委托给子类进行执行。protected abstract int doUpdate(MappedStatement ms, Object parameter) throws SQLException;protected abstract List<BatchResult> doFlushStatements(boolean isRollback) throws SQLException;protected abstract <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException;protected abstract <E> Cursor<E> doQueryCursor(MappedStatement ms, Object parameter, RowBounds rowBounds, BoundSql boundSql) throws SQLException;在一级缓存的介绍中提到对Local Cache的查询和写入是在Executor内部完成的。在阅读BaseExecutor的代码后发现Local Cache是BaseExecutor内部的一个成员变量，如下代码所示。public abstract class BaseExecutor implements Executor {protected ConcurrentLinkedQueue<DeferredLoad> deferredLoads;protected PerpetualCache localCache;Cache： MyBatis中的Cache接口，提供了和缓存相关的最基本的 *** 作，如下图所示。有若干个实现类，使用装饰器模式互相组装，提供丰富的 *** 控缓存的能力，部分实现类如下图所示。BaseExecutor成员变量之一的PerpetualCache，是对Cache接口最基本的实现，其实现非常简单，内部持有HashMap，对一级缓存的 *** 作实则是对HashMap的 *** 作。如下代码所示。public class PerpetualCache implements Cache {private String id;private Map<Object, Object> cache = new HashMap<Object, Object>();在阅读相关核心类代码后，从源代码层面对一级缓存工作中涉及到的相关代码，出于篇幅的考虑，对源码做适当删减，读者朋友可以结合本文，后续进行更详细的学习。为执行和数据库的交互，首先需要初始化SqlSession，通过DefaultSqlSessionFactory开启SqlSession：private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {............final Executor executor = configuration.newExecutor(tx, execType);return new DefaultSqlSession(configuration, executor, autoCommit);}在初始化SqlSesion时，会使用Configurati

https://tech.meituan.com/mybatis_cache.HTML

MyBatis是常见的Java数据库访问层框架。在日常工作中，开发人员多数情况下是使用MyBatis的默认缓存配置，但是MyBatis缓存机制有一些不足之处，在使用中容易引起脏数据，形成一些潜在的隐患。个人在业务开发中也处理过一些由于MyBatis缓存引发的开发问题，带着个人的兴趣，希望从应用及源码的角度为读者梳理MyBatis缓存机制。本次分析中涉及到的代码和数据库表均放在GitHub上，地址： href="https://github.com/kailuncen/mybatis-cache-demo">mybatis-cache-demo 。

本文按照以下顺序展开。

一级缓存介绍及相关配置。一级缓存工作流程及源码分析。一级缓存总结。二级缓存介绍及相关配置。二级缓存源码分析。二级缓存总结。全文总结。

在应用运行过程中，我们有可能在一次数据库会话中，执行多次查询条件完全相同的sql，MyBatis提供了一级缓存的方案优化这部分场景，如果是相同的SQL语句，会优先命中一级缓存，避免直接对数据库进行查询，提高性能。具体执行过程如下图所示。

我们来看看如何使用MyBatis一级缓存。开发者只需在MyBatis的配置文件中，添加如下语句，就可以使用一级缓存。共有两个选项，SESSION或者STATEMENT，默认是SESSION级别，即在一个MyBatis会话中执行的所有语句，都会共享这一个缓存。一种是STATEMENT级别，可以理解为缓存只对当前执行的这一个Statement有效。

接下来通过实验，了解MyBatis一级缓存的效果，每个单元测试后都请恢复被修改的数据。首先是创建示例表student，创建对应的POJO类和增改的方法，具体可以在entity包和mapper包中查看。

在以下实验中，ID为1的学生名称是凯伦。

开启一级缓存，范围为会话级别，调用三次getStudentByID，代码如下所示：

执行结果：

增加了对数据库的修改 *** 作，验证在一次数据库会话中，如果对数据库发生了修改 *** 作，一级缓存是否会失效。

执行结果：

一级缓存失效。

开启两个sqlSession，在sqlSession1中查询数据，使一级缓存生效，在sqlSession2中更新数据库，验证一级缓存只在数据库会话内部共享。

    StudentMapper studentMapper = <a href="https://www.jb51.cc/tag/sql/" target="_blank" >sql</a>Session1.getMapper(StudentMapper.class);    StudentMapper studentMapper2 = <a href="https://www.jb51.cc/tag/sql/" target="_blank" >sql</a>Session2.getMapper(StudentMapper.class);    Sy<a href="https://www.jb51.cc/tag/stem/" target="_blank" >stem</a>.out.println(<span &gt;"studentMapper读取数据: " + studentMapper.getStudentBy<a href="https://m.jb51.cc/tag/ID/" target="_blank" >ID</a>(<span &gt;1));    Sy<a href="https://www.jb51.cc/tag/stem/" target="_blank" >stem</a>.out.println(<span &gt;"studentMapper读取数据: " + studentMapper.getStudentBy<a href="https://m.jb51.cc/tag/ID/" target="_blank" >ID</a>(<span &gt;1));    Sy<a href="https://www.jb51.cc/tag/stem/" target="_blank" >stem</a>.out.println(<span &gt;"studentMapper2<a href="https://m.jb51.cc/tag/gengxin/" target="_blank" >更新</a>了" + studentMapper2.updateStudent<a href="https://m.jb51.cc/tag/name/" target="_blank" >name</a>(<span &gt;"小岑",<span &gt;1) + <span &gt;"个学生的数据");    Sy<a href="https://www.jb51.cc/tag/stem/" target="_blank" >stem</a>.out.println(<span &gt;"studentMapper读取数据: " + studentMapper.getStudentBy<a href="https://m.jb51.cc/tag/ID/" target="_blank" >ID</a>(<span &gt;1));    Sy<a href="https://www.jb51.cc/tag/stem/" target="_blank" >stem</a>.out.println(<span &gt;"studentMapper2读取数据: " + studentMapper2.getStudentBy<a href="https://m.jb51.cc/tag/ID/" target="_blank" >ID</a>(<span &gt;1));

}


那么，一级缓存的工作流程是怎样的呢？我们从源码层面来学习一下。

一级缓存执行的时序图，如下图所示。

接下来将对MyBatis查询相关的核心类和一级缓存的源码进行走读。这对后面学习二级缓存也有帮助。sqlSession： 对外提供了用户和数据库之间交互需要的所有方法，隐藏了底层的细节。默认实现类是DefaultsqlSession。

Executor： sqlSession向用户提供 *** 作数据库的方法，但和数据库 *** 作有关的职责都会委托给Executor。

如下图所示，Executor有若干个实现类，为Executor赋予了不同的能力，大家可以根据类名，自行学习每个类的基本作用。

在一级缓存的源码分析中，主要学习BaseExecutor的内部实现。BaseExecutor： BaseExecutor是一个实现了Executor接口的抽象类，定义若干抽象方法，在执行的时候，把具体的 *** 作委托给子类进行执行。

在一级缓存的介绍中提到对Local Cache的查询和写入是在Executor内部完成的。在阅读BaseExecutor的代码后发现Local Cache是BaseExecutor内部的一个成员变量，如下代码所示。

 deferredLoads;

Cache： MyBatis中的Cache接口，提供了和缓存相关的最基本的 *** 作，如下图所示。

 cache = ();

在阅读相关核心类代码后，从源代码层面对一级缓存工作中涉及到的相关代码，出于篇幅的考虑，对源码做适当删减，读者朋友可以结合本文，后续进行更详细的学习。为执行和数据库的交互，首先需要初始化sqlSession，通过DefaultsqlSessionFactory开启sqlSession：

在初始化sqlSesion时，会使用Configuration类创建一个全新的Executor，作为DefaultsqlSession构造函数的参数，创建Executor代码如下所示：

sqlSession创建完毕后，根据Statment的不同类型，会进入sqlSession的不同方法中，如果是Select语句的话，最后会执行到sqlSession的selectList，代码如下所示：

sqlSession把具体的查询职责委托给了Executor。如果只开启了一级缓存的话，首先会进入BaseExecutor的query方法。代码如下所示：

在上述代码中，会先根据传入的参数生成CacheKey，进入该方法查看CacheKey是如何生成的，代码如下所示：

在上述的代码中，将MappedStatement的ID、sql的offset、sql的limit、sql本身以及sql中的参数传入了CacheKey这个类，最终构成CacheKey。以下是这个类的内部结构：

<span >private <span >int multiplIEr;
<span >private <span >int hashcode;
<span >private <span >long checksum;
<span >private <span >int count;
<span >private List