5.Mybatis 缓存详解

5.1 一级缓存

一级缓存(也叫本地缓存)，默认会开启，并且不能控制。想要关闭一级缓存可以在select标签上配置flushCache=“true”；一级缓存存在于 SqlSession 的生命周期中，在同一个 SqlSession 中查询时， MyBatis 会把执行的方法和参数通过算法生成缓存的键值，将键值和查询结果存入一个 Map对象中。如果同一个 SqlSession 中执行的方法和参数完全一致，那么通过算法会生成相同的键值，当 Map 缓存对象中己经存在该键值时，则会返回缓存中的对象;任何的 **INSERT 、UPDATE 、 DELETE 操作都会清空一级缓存；

一级缓存的执行过程：

每个SqlSession中持有了Executor，每个Executor中有一个LocalCache。当用户发起查询时，MyBatis根据当前执行的语句生成MappedStatement，在Local Cache进行查询，如果缓存命中的话，直接返回结果给用户，如果缓存没有命中的话，查询数据库，结果写入Local Cache，最后返回结果给用户。具体实现类的类关系图如下图所示。

5.3.1 一级缓存的测试

下面举两个例子来说明一级缓存

案例一： 在同一个SqlSession 查询两次id = 1的客户

测试代码如下：

@Test
    public void selectUserById(){
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try{
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            // 查询id = 1 的用户
            UserInfo userInfo = mapper.selectUserById(1L);

            System.out.println("userInfo=="+userInfo);
            // 查询id = 1 的用户
            UserInfo userInfo2 = mapper.selectUserById(1L);
            System.out.println("userInfo2=="+userInfo);
        }finally{
            sqlSession.close();
        }
    }

下面是执行的日志:

[org.apache.ibatis.transaction.jdbc.JdbcTransaction]-Setting autocommit to false on JDBC Connection [com.mysql.jdbc.JDBC4Connection@57f23557]
[com.xa02.mapper.UserMapper.selectUserById]-==>  Preparing: SELECT id,user_name,sex,birthday,address FROM t_user where id = ? 
[com.xa02.mapper.UserMapper.selectUserById]-==> Parameters: 1(Long)
[com.xa02.mapper.UserMapper.selectUserById]-<==      Total: 1

上面只执行了一次sql查询数据库，第二次查询走的是一级缓存。

案例二： 在同一个SqlSession 查询两次id = 1的客户的中间对客户进行更新

代码如下：

  @Test
    public void selectUserById(){
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try{
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            // 查询id = 1 的用户
            UserInfo userInfo = mapper.selectUserById(1L);

            System.out.println("userInfo=="+userInfo);

            //更新id = 1的用户
            UserInfo ui = new UserInfo();
            ui.setId(1L);
            ui.setUserName("wanghan");
            mapper.updateUser(ui);
            // 查询id = 1 的用户
            UserInfo userInfo2 = mapper.selectUserById(1L);
            System.out.println("userInfo2=="+userInfo);
        }finally{
            sqlSession.close();
        }
    }

测试日志：

[com.xa02.mapper.UserMapper.selectUserById]-==>  Preparing: SELECT id,user_name,sex,birthday,address FROM t_user where id = ? 
[com.xa02.mapper.UserMapper.selectUserById]-==> Parameters: 1(Long)
[com.xa02.mapper.UserMapper.selectUserById]-<==      Total: 1
userInfo==UserInfo{id=1, userName='zhangsan', sex='0', birthday=Tue Nov 17 15:07:08 CST 2020, address='上海市', orderInfoList=null}
[com.xa02.mapper.UserMapper.updateUser]-==>  Preparing: update t_user SET user_name = ? where id = ? 
[com.xa02.mapper.UserMapper.updateUser]-==> Parameters: wanghan(String), 1(Long)
[com.xa02.mapper.UserMapper.updateUser]-<==    Updates: 1
[com.xa02.mapper.UserMapper.selectUserById]-==>  Preparing: SELECT id,user_name,sex,birthday,address FROM t_user where id = ? 
[com.xa02.mapper.UserMapper.selectUserById]-==> Parameters: 1(Long)
[com.xa02.mapper.UserMapper.selectUserById]-<==      Total: 1
userInfo2==UserInfo{id=1, userName='zhangsan', sex='0', birthday=Tue Nov 17 15:07:08 CST 2020, address='上海市', orderInfoList=null}

说明：

1. 第一次发起查询用户id为1的用户信息，先去找缓存中是否有id为1的用户信息，如果没有，从数据库查询用户信息，将查询到的用户信息存储到一级缓存中。

2. 如果中间sqlSession去执行commit操作（执行插入、更新、删除），清空SqlSession中的一级缓存，这样做的目的为了让缓存中存储的是最新的信息，避免脏读。

3.第二次发起查询用户id为1的用户信息，先去找缓存中是否有id为1的用户信息，缓存中有，直接从缓存中获取用户信息。

注意:

如果不想让selectUserById 方法使用以及缓存，可以对该方法做如下修改：

    
        SELECT
           id,user_name,sex,birthday,address
        FROM
            t_user  where id = #{id}
    

在原来的方法上加上 flushCache = true,会在查询数据前清空一级缓存，因此该方法每次都会从数据库查询，

一级缓存的使用条件：

1. 必须是相同的SQL和参数

2. 必须是相同的会话

3. 必须是相同的namespace 即同一个mapper

4. 必须是相同的statement 即同一个mapper 接口中的同一个方法

5. 查询语句中间没有执行session.clearCache() 方法

6. 查询语句中间没有执行 insert update delete 方法（无论变动记录是否与 缓存数据有无关系）

5.3.2 一级缓存源码分析

一级缓存的逻辑最终调用BaseExecutor执行器里面。当会话接收到一个查询请求时，会交给执行器的query方法执行，通过CacheKey的hashCode+checkNum + statementId + sql+ 参数等参数组成一个缓存key, 基于这个key去PerpetualCache 中查找对应的缓存值，如果有主直接返回。没有就会查询数据库，然后在填充缓存。

调试方法的Mapper.xml 如下：

        SELECT
           id,user_name,sex,birthday,address
        FROM
            t_user
        
            
               and  user_name = #{userName}
            
            
                and  sex = #{sex}
            
            
                and birthday = #{birthday}
            
            
                and address = #{address}
            
        
    

>mapper.mapper.selectList(UserInfo)

>org.apache.ibatis.session.defaults.DefaultSqlSession#selectList()

//statement: com.xa02.mapper.UserMapper.selectUserById
// parameter : 1
  @Override
  public  List selectList(String statement, Object parameter) {
    return this.selectList(statement, parameter, RowBounds.DEFAULT);
  }

  @Override
  public  List selectList(String statement, Object parameter, RowBounds rowBounds) {
    try {
      MappedStatement ms = configuration.getMappedStatement(statement);
      return executor.query(ms, wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER);
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error querying database.  Cause: " + e, e);
    } finally {
      ErrorContext.instance().reset();
    }
  }

此时的执行器 是CacheExecutor,用的是装饰器模式

即 executor = CacheingExecutor(SimpleExecutor)

>org.apache.ibatis.executor.CachingExecutor#query()

  @Override
  public  List query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
    BoundSql boundSql = ms.getBoundSql(parameterObject);
    // 创建缓存的key
    CacheKey key = createCacheKey(ms, parameterObject, rowBounds, boundSql);
    return query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }
  

此方法由两个任务

1.创建cachekey

2.从数据库中查询数据，并存储到缓存中

创建cachekey

CacheKey 类中的属性：

public class CacheKey implements Cloneable, Serializable {
  public static final CacheKey NULL_CACHE_KEY = new NullCacheKey();

  private static final int DEFAULT_MULTIPLYER = 37;
  private static final int DEFAULT_HASHCODE = 17;

  private final int multiplier;
  private int hashcode;//CacheKey 的hashCode,初始值是17
  private long checksum;//校验和
  private int count;
  // 8/21/2017 - Sonarlint flags this as needing to be marked transient.  While true if content is not serializable, this is not always true and thus should not be marked transient.
  private List