Mybatis缓存机制

MyBatis的缓存机制


在日常工作中，开发人员多数情况下是使用MyBatis的默认缓存配置，但是MyBatis缓存机制有一些不足之处，在使用中容易引起脏数据，形成一些潜在的隐患。

Mybatis的一级缓存


Mybatis的一级缓存是SqlSession级别的。一级缓存的作用域是一个SqlSession。Mybatis默认开启一级缓存。
在同一个SqlSession中，执行相同的查询SQL，第一次会去查询数据库，并写到缓存中；第二次直接从缓存中取。当执行SQL时两次查询中间发生了增删改操作，则SqlSession的缓存清空。

一级缓存示意图



一级缓存区域是根据SqlSession为单位划分的。
每次查询会先去缓存中找，如果找不到，再去数据库查询，然后把结果写到缓存中。Mybatis的内部缓存使用一个HashMap，key为hashcode+statementId+sql语句。Value为查询出来的结果集映射成的java对象。

SqlSession执行insert、update、delete等操作commit后会清空该SQLSession缓存。

Mybatis的一级缓存带来的脏数据问题

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

@Test

public 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的二级缓存


Mybatis的二级缓存是指mapper映射文件。二级缓存的作用域是同一个namespace下的mapper映射文件内容，多个SqlSession共享。Mybatis需要手动设置启动二级缓存。

在同一个namespace下的mapper文件中，执行相同的查询SQL，第一次会去查询数据库，并写到缓存中；第二次直接从缓存中取。当执行SQL时两次查询中间发生了增删改操作，则二级缓存清空。

使用二级缓存时，由于二级缓存的数据不一定都是存储到内存中，它的存储介质多种多样，所以需要给缓存的对象执行序列化。

二级缓存示意图



二级缓存作用域是同一个namespace下的mapper映射文件内容。

第一次调用mapper下的SQL去查询用户信息。查询到的信息会存到该mapper对应的二级缓存区域内。
第二次调用相同namespace下的mapper映射文件中相同的SQL去查询用户信息。会去对应的二级缓存内取结果。
如果调用相同namespace下的mapper映射文件中的增删改SQL，并执行了commit操作。此时会清空该namespace下的二级缓存。

如何开启二级缓存？

在核心配置文件SqlMapConfig.xml中加入以下内容（开启二级缓存总开关）：

<settings>

<!-- 打开延迟加载的开关 -->

<setting name="lazyLoadingEnabled" value="true"/>

<!-- 将积极加载改为消极加载，即延迟加载 -->

<setting name="aggressiveLazyLoading" value="false"/>

</settings>

在映射文件中，加入以下内容，开启二级缓存：

<cache/>

在<cache/>中可以自定义以下配置。

type：cache使用的类型，默认是PerpetualCache，这在一级缓存中提到过。

eviction： 定义回收的策略，常见的有FIFO，LRU。

flushInterval： 配置一定时间自动刷新缓存，单位是毫秒。

size： 最多缓存对象的个数。

readOnly： 是否只读，若配置可读写，则需要对应的实体类能够序列化。

blocking： 若缓存中找不到对应的key，是否会一直blocking，直到有对应的数据进入缓存。

实验1
测试二级缓存效果，不提交事务，sqlSession1查询完数据后，sqlSession2相同的查询是否会从缓存中获取数据。

@Test

public void testCacheWithoutCommitOrClose() 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("studentMapper2读取数据: " + studentMapper2.getStudentById(1));

}

执行结果



我们可以看到，当sqlsession1没有调用commit()方法时，二级缓存并没有起到作用。如果sqlsession1调用了commit()方法，那么二级缓存将起到作用。

实验2


验证MyBatis的二级缓存不适应用于映射文件中存在多表查询的情况。
通常我们会为每个单表创建单独的映射文件，由于MyBatis的二级缓存是基于namespace的，多表查询语句所在的namspace无法感应到其他namespace中的语句对多表查询中涉及的表进行的修改，引发脏数据问题。

@Test

public void testCacheWithDiffererntNamespace() throws Exception {

SqlSession sqlSession1 = factory.openSession(true);

SqlSession sqlSession2 = factory.openSession(true);

SqlSession sqlSession3 = factory.openSession(true);

StudentMapper studentMapper = sqlSession1.getMapper(StudentMapper.class);

StudentMapper studentMapper2 = sqlSession2.getMapper(StudentMapper.class);

ClassMapper classMapper = sqlSession3.getMapper(ClassMapper.class);

System.out.println("studentMapper读取数据: " + studentMapper.getStudentByIdWithClassInfo(1));

sqlSession1.close();

System.out.println("studentMapper2读取数据: " + studentMapper2.getStudentByIdWithClassInfo(1));

classMapper.updateClassName("特色一班",1);

sqlSession3.commit();

System.out.println("studentMapper2读取数据: " + studentMapper2.getStudentByIdWithClassInfo(1));

}

执行结果



在这个实验中，我们引入了两张新的表，一张class，一张classroom。class中保存了班级的id和班级名，classroom中保存了班级id和学生id。
我们在StudentMapper中增加了一个查询方法getStudentByIdWithClassInfo，用于查询学生所在的班级，涉及到多表查询。在ClassMapper中添加了updateClassName，根据班级id更新班级名的操作。
当sqlsession1的studentmapper查询数据后，二级缓存生效。保存在StudentMapper的namespace下的cache中。

当sqlSession3的classMapper的updateClassName方法对class表进行更新时，updateClassName不属于StudentMapper的namespace，所以StudentMapper下的cache没有感应到变化，没有刷新缓存。当StudentMapper中同样的查询再次发起时，从缓存中读取了脏数据。

上面的解决方法就是，使用Cache ref，让ClassMapper引用StudenMapper命名空间，这样两个映射文件对应的Sql操作都使用的是同一块缓存了。

不过这样做的后果是，缓存的粒度变粗了，多个Mapper namespace下的所有操作都会对缓存使用造成影响。

总结

MyBatis的二级缓存相对于一级缓存来说，实现了SqlSession之间缓存数据的共享，同时粒度更加的细，能够到namespace级别，通过Cache接口实现类不同的组合，对Cache的可控性也更强。

MyBatis在多表查询时，极大可能会出现脏数据，有设计上的缺陷，安全使用二级缓存的条件比较苛刻。

在分布式环境下，由于默认的MyBatis Cache实现都是基于本地的，分布式环境下必然会出现读取到脏数据，需要使用集中式缓存将MyBatis的Cache接口实现，有一定的开发成本，直接使用Redis,Memcached等分布式缓存可能成本更低，安全性也更高。

感谢：

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

代码：

https://github.com/kailuncen/mybatis-cache-demo