美团二面：为什么不推荐使用 MyBatis 二级缓存？大部分人都答不上来！

Dear 丶 2024-04-29 19:26 8阅读 0赞

为了增加查询的性能，MyBatis 提供了二级缓存架构，分为一级缓存和二级缓存。

这两级缓存最大的区别就是：一级缓存是会话级别的，只要出了这个 SqlSession，缓存就没用了。而二级缓存可以跨会话，多个会话可以使用相同的缓存！

一级缓存使用简单，默认就开启。二级缓存需要手动开启，相对复杂，而且要注意的事项也多，否则可能有隐患。

### **一级缓存** ###

#### **应用场景** ####

订单表与会员表是存在一对多的关系，为了尽可能减少 join 查询，进行了分阶段查询。即先查询出订单表，再根据 member\_id 字段查询出会员表，最后进行数据整合。而如果订单表中存在重复的 member\_id，就会出现很多重复查询。

针对这种情况，MyBatis 通过一级缓存来解决：在同一次查询会话（SqlSession）中如果出现相同的语句及参数，就会从缓存中取出，不再走数据库查询。

一级缓存只能作用于查询会话中，所以也叫做会话缓存。

#### **生效的条件** ####

一级缓存要生效，必须满足以下条件条件：

*  必须是相同的会话
 *  必须是同一个 mapper，即同一个 namespace
 *  必须是相同的 statement，即同一个 mapper 中的同一个方法
 *  必须是相同的 SQL 和参数
 *  查询语句中间没有执行 session.clearCache() 方法
 *  查询语句中间没有执行 insert/update/delete 方法（无论变动记录是否与缓存数据有无关系）

#### **与 SpringBoot 集成时一级缓存不生效原因** ####

![图片][7d7912ab76209efcbc4986ef8fc7b17e.png]

因为一级缓存是会话级别的，要生效的话，必须要在同一个 SqlSession 中。但是与 SpringBoot 集成的 MyBatis，默认每次执行 SQL 语句时，都会创建一个新的 SqlSession！所以一级缓存才没有生效。

当调用 mapper 的方法时，最终会执行到 SqlSessionUtils 的 getSqlSession 方法，在这个方法中会尝试在事务管理器中获取 SqlSession，如果没有开启事务，那么就会 new 一个 DefaultSqlSession。

![图片][6c18829eaafbbf9b45107774eb221140.png]

所以说，即便在同一个方法中，通过同一个 mapper 连续调用两次相同的查询方法，也不会触发一级缓存。

#### **解决与 SpringBoot 集成时一级缓存不生效问题** ####

Spring Boot 基础就不介绍了，推荐看这个实战项目：

> https://github.com/javastacks/spring-boot-best-practice

在上面的代码中也看到了，MyBatis 在查询时，会先从事务管理器中尝试获取 SqlSession，取不到才会去创建新的 SqlSession。所以可以猜测只要将方法开启事务，那么一级缓存就会生效。

插播一条：如果你近期准备面试跳槽，建议在[Java面试库][Java]小程序在线刷题，涵盖 2000+ 道 Java 面试题，几乎覆盖了所有主流技术面试题。

加上 @Transactional 注解，看下效果：

![图片][51dd4d711ce1a19f7f64d125a6654d25.png]

没错，的确生效了。在代码中可以看到，从事务管理器中，获取到了 SqlSession：

再看看源码中是什么时候将 SqlSession 设置到事务管理器中的。

SqlSessionUtils 中，在获取到 SqlSession 后，会调用 registerSessionHolder 方法注册 SessionHolder 到事务管理器：

![图片][8132070c50b02bfec039cef1060cf52f.png]

具体是在 TransactionSynchronizationManager 的 bindResource 方法中操作的，将 SessionHolder 保存到线程本地变量 (ThreadLocal) resources 中，这是每个线程独享的：

![图片][0e0499fd09a35d9e31fd97060189496d.png]

然后在下次查询时，就可以从这里取出此 SqlSession，使用同一个 SqlSession 查询，一级缓存就生效了。

所以基本原理就是：如果当前线程存在事物，并且存在相关会话，就从 ThreadLocal 中取出。如果没有事务，就重新创建一个 SqlSession 并存储到 ThreadLocal 当中，共下次查询使用。

至于缓存查询数据的地方，是在 BaseExecutor 中的 queryFromDatabase 方法中。执行 doQuery 从数据库中查询数据后，会立马缓存到 localCache(PerpetualCache类型) 中：

![图片][d5d3edd0c6cd8aba5f5b7f56b28ab6af.png]

### **二级缓存** ###

#### **应用场景** ####

业务系统中存在很多的静态数据如，字典表、菜单表、权限表等，这些数据的特性是不会轻易修改但又是查询的热点数据。

一级缓存针对的是同一个会话当中相同 SQL，并不适合热点数据的缓存场景。

为了解决这个问题引入了二级缓存，它脱离于会话之外，多个会话可以使用相同的缓存。

看一个例子：

@RestController
    @RequestMapping("item")
    public class ItemController {
    
        @Autowired
        private ItemMapper itemMapper;
    
        @GetMapping("/{id}")
        public void getById(@PathVariable("id") Long id) {
            System.out.println("==================== begin ====================");
            Item item = itemMapper.selectById(id);
            System.out.println(JSON.toJSONString(item));
        }
    
    }

当发送两次 get 请求时（两个不同的会话），通过日志可以发现第二次查询使用的是缓存。

![图片][274ce2c51f6255c6bf3d3b0e2e2943e0.png]

#### **开启的方法** ####

二级缓存需要手动来开启，MyBatis 默认没有开启二级缓存。

**1）在 yaml 中配置 cache-enabled 为 true**

mybatis-plus:
      configuration:
        cache-enabled: true

**2）Mapper 接口上添加 @CacheNamespace 注解**

![图片][8019fd815c5dc582e601ef4bb1b8d5d0.png]

**3）实体类实现 Serializable 接口**

![图片][daef5510fd0b55a443029ef4923e0120.png]

#### **生效的条件** ####

*  当会话提交或关闭之后才会填充二级缓存
 *  必须是同一个 mapper，即同一个命名空间
 *  必须是相同的 statement，即同一个 mapper 中的同一个方法
 *  必须是相同的 SQL 语句和参数
 *  如果 readWrite=true（默认就是true），实体对像必须实现 Serializable 接口

#### **缓存清除条件** ####

*  只有修改会话提交之后，才会执行清空操作
 *  xml 中配置的 update 不能清空 @CacheNamespace 中的缓存数据
 *  任何一种增删改操作都会清空整个 namespace 中的缓存

#### **源码中是如何填充二级缓存的？** ####

在生效条件中提到了，二级缓存必须要在会话提交或关闭之后，才能生效！

在查询到结果后，会调用 SqlSession 的 commit 方法进行提交（如果开启事务的话，提交 SqlSession 走的不是这里了，但最终填充二级缓存的地方是一样的）：

![图片][f00a17bf26ad2a329cb3ed42fb99f46c.png]

在此方法中，最终会调用到 TransactionalCache 的 flushPendingEntries 方法中填充二级缓存：

![图片][1ccae3d4e6c348dd7f6eba827a7c606e.png]

SpringBoot 集成 MyBatis 的话，如果没有开启事务，每次执行查询，都会创建新的 SqlSession，所以即使是在同一个方法中进行查询操作，那也是跨会话的。

如果你近期准备面试跳槽，建议在[Java面试库][Java]小程序在线刷题，涵盖 2000+ 道 Java 面试题，几乎覆盖了所有主流技术面试题。

#### **查询时如何使用二级缓存？** ####

在查询的时候，最终会调用 MybatisCachingExecutor 的 query 方法，里面会从 TransactionalCacheManager 中尝试根据 key 获取二级缓存的内容。

可以看到，这个 key 很长，由 mapper、调用的查询方法、SQL 等信息拼接而成，这也是为什么想要二级缓存生效，必须满足前面所说的条件。

如果能在二级缓存中查询到，就直接返回了，不需要访问数据库。

![图片][1afa6c90d6a6c8bc6cb185d434300c74.png]

具体的调用层数实在太多，用到了装饰者模式，最终是在 PerpetualCache 中获取缓存的：

![图片][8edb68095fd41215d6278d2c34bfffb0.png]

打印日志是在 LoggingCache 中：

![图片][f91b74cbdfd2581c7b1b3bbcfddb12af.png]

#### **为什么 MyBatis 默认不开启二级缓存？** ####

答案就是，不推荐使用二级缓存！

二级缓存虽然能带来一定的好处，但是有很大的隐藏危害！

它的缓存是以 namespace(mapper) 为单位的，不同 namespace 下的操作互不影响。且 insert/update/delete 操作会清空所在 namespace 下的全部缓存。

那么问题就出来了，假设现在有 ItemMapper 以及 XxxMapper，在 XxxMapper 中做了表关联查询，且做了二级缓存。此时在 ItemMapper 中将 item 信息给删了，由于不同 namespace 下的操作互不影响，XxxMapper 的二级缓存不会变，那之后再次通过 XxxMapper 查询的数据就不对了，非常危险。

来看一个例子：

@Mapper
    @Repository
    @CacheNamespace
    public interface XxxMapper {
    
        @Select("select i.id itemId,i.name itemName,p.amount,p.unit_price unitPrice " +
                "from item i JOIN payment p on i.id = p.item_id where i.id = #{id}")
        List<PaymentVO> getPaymentVO(Long id);
    
    }
    
    @Autowired
    private XxxMapper xxxMapper;
    
    @Test
    void test() {
     System.out.println("==================== 查询PaymentVO ====================");
     List<PaymentVO> voList = xxxMapper.getPaymentVO(1L);
     System.out.println(JSON.toJSONString(voList.get(0)));
     System.out.println("====================  更新item表的name ==================== ");
     Item item = itemMapper.selectById(1);
     item.setName("java并发编程");
     itemMapper.updateById(item);
     System.out.println("====================  重新查询PaymentVO ==================== ");
     List<PaymentVO> voList2 = xxxMapper.getPaymentVO(1L);
     System.out.println(JSON.toJSONString(voList2.get(0)));
    }

上面的代码，test() 方法中前后两次调用了 xxxMapper.getPaymentVO 方法，因为没有加 @Transactional 注解，所以前后两次查询，是两个不同的会话，第一次查询完后，SqlSession 会自动 commit，所以二级缓存能够生效；

然后在中间进行了 Item 表的更新操作，修改了下名称；

由于 itemMapper 与 xxxMapper 不是同一个命名空间，所以 itemMapper 执行的更新操作不会影响到 xxxMapper 的二级缓存；

再次调用 xxxMapper.getPaymentVO，发现取出的值是走缓存的，itemName 还是老的。但实际上 itemName 在上面已经被改了！

执行日志如下：

![图片][61645f7da941d6660c480067777fc49b.png]

所以说，二级缓存的隐藏危害是比较大的，当有表关联时，一个不注意就会出问题，不建议使用。

[7d7912ab76209efcbc4986ef8fc7b17e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/e14b3af8f5da48cfa97d5a9eb31993e0.png
[6c18829eaafbbf9b45107774eb221140.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/e042df35d5b540d4b1f9349ccc0c7564.png
[Java]: https://mp.weixin.qq.com/s/PpXGpgRZVqmOo2C3NGrM9Q
[51dd4d711ce1a19f7f64d125a6654d25.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/3ec5dff0c2c64a678df5d7df82099507.png
[8132070c50b02bfec039cef1060cf52f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/2f3bbe66ec5a465abb45363efdc8d95a.png
[0e0499fd09a35d9e31fd97060189496d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/3545bf17cd12464f9da81d00f2ca3544.png
[d5d3edd0c6cd8aba5f5b7f56b28ab6af.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/e796739daec04c789a752d6360143380.png
[274ce2c51f6255c6bf3d3b0e2e2943e0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/6ce195406f3043fd941563ec9e55e6dc.png
[8019fd815c5dc582e601ef4bb1b8d5d0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/688f704023554a678a682119584d83d4.png
[daef5510fd0b55a443029ef4923e0120.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/24706aa62dda4a21bf0f58e80292bfdc.png
[f00a17bf26ad2a329cb3ed42fb99f46c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/1827f524648b4873b44fde75b24658bc.png
[1ccae3d4e6c348dd7f6eba827a7c606e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/5787b576f1be4de9838bc5dbddec2317.png
[1afa6c90d6a6c8bc6cb185d434300c74.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/6ec1ce5de8c344beb982955c52144562.png
[8edb68095fd41215d6278d2c34bfffb0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/6d581621ebb342a2b8bb3293a7433345.png
[f91b74cbdfd2581c7b1b3bbcfddb12af.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/170b585db0c748d88f315247c5af201f.png
[61645f7da941d6660c480067777fc49b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/128e385cb0bb410f84032a2ab7ab3c9f.png