mybatis二级缓存架构原理

Posted 2023-04-05 xujingyiss

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

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

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

一级缓存

应用场景

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

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

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

生效的条件

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

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

与springboot集成时一级缓存不生效原因

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

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

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

解决与springboot集成时一级缓存不生效问题

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

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

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

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

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

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

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

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

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

二级缓存

应用场景

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

一级缓存针对的是同一个会话当中相同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 请求时（两个不同的会话），通过日志可以发现第二次查询使用的是缓存 

开启的方法

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

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

mybatis-plus:
  configuration:
    cache-enabled: true

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

3）实体类实现 Serializable 接口

生效的条件

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

缓存清除条件

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

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

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

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

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

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

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

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

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

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

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

打印日志是在 LoggingCache 中：

为什么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 在上面已经被改了！

执行日志如下：

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

MyBatis从入门到放弃七：二级缓存原理分析

前言

        说起mybatis的一级缓存和二级缓存我特意问了几个身边的朋友他们平时会不会用，结果没有一个人平时业务场景中用。 好吧，那我暂且用来学习源码吧。一级缓存我个人认为也确实有些鸡肋，mybatis默认开启一级缓存，支持在同一个会话（sqlsession）同一个statement执行两次，则第二次会默认会使用第一次创建的缓存对象。

         二级缓存前一篇粗略介绍了下，默认使用内存对象【PerpetualCache】内部维护一个HashMap对象来存储。那么先来看几张图片【图片来自一位朋友，文章最后参考连接我会挂出作者博客】

 

MyBatis缓存设计及二级缓存工作模式

        从上面三张图中我们得出结论，一级缓存是sqlsession级别、二级缓存是Mapper级别。mybatis定义了【Cache】接口，支持自定义缓存，同时还支持集成第三方缓存库，现在为了更细粒度的控制缓存，更多的集成【ehcache】、【redis】。

        那么mybatis的二级缓存主要是在Executor对象上来做文章，当mybatis发现你在mybatis.xml配置文件中设置了cacheEnabled=true时，mybatis在创建sqlsession时创建Executor对象，同时会对Executor加上装饰者【CacheExecutor】。CacheExecutor对于查询请求，会判断application级别的二级缓存是否有缓存结果，如果有查询结果则直接返回，如果没有再交给查询器Executor实现类，也就是【SimpleExecutor】来执行查询。再就是缓存结果，返回给用户。

       贴出SmpleExecutor源码：

/**
 *    Copyright 2009-2016 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.executor;

import org.apache.ibatis.cursor.Cursor;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.logging.Log;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.transaction.Transaction;

import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Collections;
import java.util.List;

/**
 * @author Clinton Begin
 */
public class SimpleExecutor extends BaseExecutor {

  public SimpleExecutor(Configuration configuration, Transaction transaction) {
    super(configuration, transaction);
  }

  @Override
  public int doUpdate(MappedStatement ms, Object parameter) throws SQLException {
    Statement stmt = null;
    try {
      Configuration configuration = ms.getConfiguration();
      StatementHandler handler = configuration.newStatementHandler(this, ms, parameter, RowBounds.DEFAULT, null, null);
      stmt = prepareStatement(handler, ms.getStatementLog());
      return handler.update(stmt);
    } finally {
      closeStatement(stmt);
    }
  }

  @Override
  public <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
    Statement stmt = null;
    try {
      Configuration configuration = ms.getConfiguration();
      StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameter, rowBounds, resultHandler, boundSql);
      stmt = prepareStatement(handler, ms.getStatementLog());
      return handler.<E>query(stmt, resultHandler);
    } finally {
      closeStatement(stmt);
    }
  }

  @Override
  protected <E> Cursor<E> doQueryCursor(MappedStatement ms, Object parameter, RowBounds rowBounds, BoundSql boundSql) throws SQLException {
    Configuration configuration = ms.getConfiguration();
    StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameter, rowBounds, null, boundSql);
    Statement stmt = prepareStatement(handler, ms.getStatementLog());
    return handler.<E>queryCursor(stmt);
  }

  @Override
  public List<BatchResult> doFlushStatements(boolean isRollback) throws SQLException {
    return Collections.emptyList();
  }

  private Statement prepareStatement(StatementHandler handler, Log statementLog) throws SQLException {
    Statement stmt;
    Connection connection = getConnection(statementLog);
    stmt = handler.prepare(connection, transaction.getTimeout());
    handler.parameterize(stmt);
    return stmt;
  }

}

　　那么，缓存起来的数据怎么过期呢，这也是我这篇文章重点关心的。一般流量不大的站点，数据由后台维护，使用二级缓存足够了。先来看全局配置文件，配置只关心一点：cacheEnabled=true。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <!--开启二级缓存-->
        <setting name="cacheEnabled" value="true"/>
    </settings>
    <typeAliases>
        <typeAlias alias="User" type="com.autohome.model.User" />
    </typeAliases>

    <mappers>
        <mapper resource="mapper/UserMapper.xml" />
    </mappers>

</configuration>

      Mapper.xml

      这里配置Cache对象。这里的eviction参数提到几个算法策略：

     LRU：（Least Recently Used）,最近最少使用算法，即如果缓存中容量已经满了，会将缓存中最近做少被使用的缓存记录清除掉，然后添加新的记录；

     FIFO：（First in first out）,先进先出算法，如果缓存中的容量已经满了，那么会将最先进入缓存中的数据清除掉；

     Scheduled：指定时间间隔清空算法，该算法会以指定的某一个时间间隔将Cache缓存中的数据清空；

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--命名空间和接口保持一致-->
<mapper namespace="com.autohome.dao.UserMapper">

    <!--
    eviction LRU
    flushInterval缓存时间，以毫秒为单位
    size缓存大小
    readOnly如果为false的话，缓存对象必须是可序列化的-->
    <cache eviction="LRU"
           type="org.apache.ibatis.cache.impl.PerpetualCache"
           flushInterval="120000"
           size="1024"
           readOnly="true"/>

    <select id="listAllUser" resultType="User">
        select * from t_userinfo
    </select>


</mapper>

 

配图看demo

   第一次查询是36条数据，我配置缓存是2分钟。然后再insert一条，你再刷新页面数据不变。等两分钟。。。。

 

总结

       OK，所谓的存在即合理吧，适合不适合取决于你的业务场景。mybatis也提供了接口以便扩展。小流量、数据量小使用mybatis二级缓存足以。

 

参考

      http://blog.csdn.net/luanlouis/article/details/41408341