12.MyBatis 学习 源码分析 学习记录 二级缓存 (三)

本章节的主要是 二级缓存 的 源码分析 学习
示例代码

        User byUserId = sqlSession1.selectOne("com.wenhao.mybatisstudydemo.mapper.UserMapper.findByUserId", 1L);
        System.out.println("第一次查询" + byUserId);
        SqlSession sqlSession2 = build.openSession();
        //UserMapper mapper1 = sqlSession2.getMapper(UserMapper.class);
        //User byUserId1 = mapper1.findByUserId(1L);
        User byUserId1 = sqlSession2.selectOne("com.wenhao.mybatisstudydemo.mapper.UserMapper.findByUserId", 1L);
        System.out.println("第二次查询" + byUserId1);

<!DOCTYPE mapper  PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.wenhao.mybatisstudydemo.mapper.UserMapper">
    <select id="findByUserId" parameterType="java.lang.Long" resultType="com.wenhao.mybatisstudydemo.enity.User">
        select * from user where id =#{id}
    </select>
    <cache eviction="LRU" type="com.wenhao.mybatisstudydemo.cache.MybatisRedisCache"/>
</mapper>

Setting autocommit to false on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@35b74c5c]
==>  Preparing: select * from user where id =? 
==> Parameters: 1(Long)
<==    Columns: id, username, password
<==        Row: 1, qeqweqweqw, E10ADC3949BA59ABBE56E057F20F883E
<==      Total: 1
第一次查询User(id=1, username=qeqweqweqw, password=E10ADC3949BA59ABBE56E057F20F883E)
Cache Hit Ratio [com.wenhao.mybatisstudydemo.mapper.UserMapper]: 0.0
Opening JDBC Connection
Created connection 939199469.
Setting autocommit to false on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@37fb0bed]
==>  Preparing: select * from user where id =? 
==> Parameters: 1(Long)
<==    Columns: id, username, password
<==        Row: 1, qeqweqweqw, E10ADC3949BA59ABBE56E057F20F883E
<==      Total: 1
第二次查询User(id=1, username=qeqweqweqw, password=E10ADC3949BA59ABBE56E057F20F883E)

可以看到即使配置redis 缓存 但是 并没有生效
来debug 源码进一步分析下 这是什么原因导致的

1执行查询

public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql)
      throws SQLException {
    //获取二级缓存
    Cache cache = ms.getCache();
    if (cache != null) {
      flushCacheIfRequired(ms);
      if (ms.isUseCache() && resultHandler == null) {
        ensureNoOutParams(ms, boundSql);
        @SuppressWarnings("unchecked")
        //查询二级缓存 第一次查询 缓存中 不存在
        List<E> list = (List<E>) tcm.getObject(cache, key);
        if (list == null) {
          list = delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
          tcm.putObject(cache, key, list); // issue #578 and #116
        }
        return list;
      }
    }

//查询缓存 首次查询时 缓存为空

@Override
  public Object getObject(Object key) {
    // issue #116
    // delegate 对象为我们自定义缓存实现 此时会调用到 MybatisRedisCache 中的 getObject 方法到redis中查询
    Object object = delegate.getObject(key);
    if (object == null) {
      entriesMissedInCache.add(key);
    }
    // issue #146
    if (clearOnCommit) {
      return null;
    } else {
      return object;
    }
  }

//redis 中查询为空  直接返回空
public Object getObject(Object key) {
        Object value = SerializeUtil.unserialize(redisClient.get(SerializeUtil.serialize(key.toString())));
        logger.debug(">>>>>>>>>>>>>>>>>>>>>>>>getObject:" + key + "=" + value);
        return value;
    }

 @Override
  public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql)
      throws SQLException {
    Cache cache = ms.getCache();
    if (cache != null) {
      flushCacheIfRequired(ms);
      if (ms.isUseCache() && resultHandler == null) {
        ensureNoOutParams(ms, boundSql);
        @SuppressWarnings("unchecked")
        List<E> list = (List<E>) tcm.getObject(cache, key);
        //此时二级缓存中 查询为空
        if (list == null) {
          // 进行数据库中查询 并放入当前sqlsesion中的一级缓存中
          list = delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
          //放入二级缓存中
          tcm.putObject(cache, key, list); // issue #578 and #116
        }
        return list;
      }
    }
    return delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

@Override
  public void putObject(Object key, Object object) {
    //可以看到 此步的操作是把 查询到的数据放入到  entriesToAddOnCommit map集合中的
    entriesToAddOnCommit.put(key, object);
  }

上述的 entriesToAddOnCommit 是在 TransactionalCache 中，而TransactionalCache 是在 TransactionalCacheManager，TransactionalCacheManager是构建 sqlSession 时 生成的

@Override
  public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql)
      throws SQLException {
    Cache cache = ms.getCache();
    if (cache != null) {
      flushCacheIfRequired(ms);
      if (ms.isUseCache() && resultHandler == null) {
        ensureNoOutParams(ms, boundSql);
        @SuppressWarnings("unchecked")
        List<E> list = (List<E>) tcm.getObject(cache, key);
        if (list == null) {
          list = delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
          tcm.putObject(cache, key, list); // issue #578 and #116
        }
        //将结果进行返回 
        return list;
      }
    }
    return delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

可以看到 虽然开启了二级缓存 但是 第一查询后 虽然将数据进行了缓存但是redis中并没有进行缓存
这个问题可以看 sqlsession中 事务提交的源码

// sqlSession1 关闭连接
sqlSession1.close();

@Override
  public void close() {
    try {
      //由执行器调用关闭方法 其中会检查是否需要回滚
      executor.close(isCommitOrRollbackRequired(false));
      closeCursors();
      dirty = false;
    } finally {
      ErrorContext.instance().reset();
    }
  }

@Override
  public void close(boolean forceRollback) {
    try {
      //issues #499, #524 and #573
      if (forceRollback) {
        tcm.rollback();
      } else {
        // 此处的 TransactionalCacheManager 会做一个事务提交的操作
        tcm.commit();
      }
    } finally {
      delegate.close(forceRollback);
    }
  }

public void commit() {
    //遍历 TransactionalCache 取出 txCache 进行下一步操作
    for (TransactionalCache txCache : transactionalCaches.values()) {
      txCache.commit();
    }
  }

public void commit() {
    if (clearOnCommit) {
      delegate.clear();
    }
    //刷新操作
    flushPendingEntries();
    reset();
  }

private void flushPendingEntries() {
    for (Map.Entry<Object, Object> entry : entriesToAddOnCommit.entrySet()) {
      // 这里可以看见 最终才会将 entriesToAddOnCommit 数据 进行 放入到我们的redis中 这个 delegate 为我们的自定义缓存实现 也就是MybatisRedisCache 
      delegate.putObject(entry.getKey(), entry.getValue());
    }
    for (Object entry : entriesMissedInCache) {
      if (!entriesToAddOnCommit.containsKey(entry)) {
        delegate.putObject(entry, null);
      }
    }
  }

通过上述就明白了 为啥配置了 二级缓存 但是 没有生效的原因 就是需要将TransactionalCache 中的entriesToAddOnCommit 做一个事务提交才会写入到 redis中