mybatis一级缓存(session cache)引发的问题

2021-09-25 09:08:56

问题回顾

最近项目功能单元测试中，出现了一个奇怪的bug。远程调试发现，程序进行了2次相同的查询，返回了实体类（ClassA）的2个对象：classAInstance1和classAInstance2，当修改classAInstance1.property1时，竟然classAInstance2.property1也被改了!!! 很快发现classAInstance1和classAInstance2地址是相同的，它们是同一个内存对象！

原因分析

经调试发现，mybatis返回的实体类的内存地址是相同的！于是猜测是mybatis缓存的原因，于是进行了下面的测试验证。

测试验证

经过单元测试验证，不开启事务的情况下，多次相同的查询，返回对象地址不相等, 代码略。
经过单元测试验证，在一个事务内，多次相同的查询，返回对象地址相等, 代码如下：

    
    @Resource
    private MybatisSessionCacheTestService mybatisSessionCacheTestService;

    @Test
    public void test_mybatis_sql_session_cache(){
        Long id = 100L;
        ClassA classAInstance1 = mybatisSessionCacheTestService.queryById(id);
        ClassA classAInstance2 = mybatisSessionCacheTestService.queryById(id);
        //assert mybatis cache is on
        Assert.assertTrue(classAInstance1 == classAInstance2);
    }

    @Service
    public class MybatisSessionCacheTestService {
        @Resource
        private ClassADAO classDAO;

        @Transactional //spring 事务注解
        public ClassA queryById(Long id){
            return classADAO.queryById(id);
        }
    }

解决方案

1.把查询提前到事务之前(之外)，这样只解决了个别问题，解决并不彻底。
2.在mybatis的mapper xml里配置每次清空缓存flushCache：

<select id="selectById" resultType="ClassA" flushCache="true">
...
</select>

附录：mybatis缓存介绍

一级缓存

即session缓存，作用域为 Session，当 Session flush 或 close 之后，该Session中的所有 Cache 就将清空，默认开启。

注意集成spring（使用mybatis-spring）时:

每次查询spring会重新创建SqlSession，所以一级缓存是不生效的。

而当开启事务时，spring会使用同一个SqlSession做查询，所以这个情况下一级缓存是生效的

二级缓存

即全局缓存，其作用域为 Mapper(Namespace)，默认关闭。

其他参考：

mybatis缓存 ，简单介绍了mybatis一级和二级缓存，独立使用mybatis(SqlSession)、以及集成spring(mybatis-spring)的情况下进行了测试
MyBatis学习总结(七)——Mybatis缓存 ，简单介绍了mybatis一级和二级缓存，独立使用mybatis(SqlSession)进行了测试
mybatis3 cache 官方文档

码农公寓