一文详解mybatis二级缓存执行流程

//XMLmapperBuilder
private void configurationElement(XNode context) {
  try {
    // 获取<mapper>标签的namespace值，也就是命名空间
    String namespace = context.getStringAttribute("namespace");
    // 命名空间不能为空
    if (namespace == null || namespace.isEmpty()) {
      throw new BuilderException("Mapper's namespace cannot be empty");
    }
    // MapperBuilderAssistant:构建MappedStatement对象的构建助手，设置当前的命名空间为namespace的值
    builderAssistant.setCurrentNamespace(namespace);
    ......
        
    // 解析<cache>子标签,这里生成二级缓存
    cacheElement(context.evalNode("cache"));

    ......
  } catch (Exception e) {
    throw new BuilderException("Error parsing Mapper XML. The XML location is '" + resource + "'. Cause: " + e, e);
  }
}

//XMLmapperBuilder
private void cacheElement(XNode context) {
  if (context != null) {
    // 解析<cache>标签type属性的值，在这可以自定义type的值，比如redisCache,如果没有指定默认就是PERPETUAL
    String type = context.getStringAttribute("type", "PERPETUAL");
    Class<? extends Cache> typeClass = typeAliasRegistry.resolveAlias(type);
    // 获取负责过期的eviction对象，默认策略为LRU
    String eviction = context.getStringAttribute("eviction", "LRU");
    Class<? extends Cache> evictionClass = typeAliasRegistry.resolveAlias(eviction);
    // 清空缓存的频率 0代表不清空
    Long flushInterval = context.getLongAttribute("flushInterval");
    // 缓存容器的大小
    Integer size = context.getIntAttribute("size");
    // 是否只读
    boolean readWrite = !context.getBooleanAttribute("readOnly", false);
    // 是否阻塞
    boolean blocking = context.getBooleanAttribute("blocking", false);
    // 获得Properties属性
    Properties props = context.getChildrenAsProperties();
    //builderAssistant是MapperBuilderAssistant，作用就是解耦建立MapperStatement，因为
    //MapperStatement对象创建复杂，所以用这个类来解耦创建
    builderAssistant.useNewCache(typeClass, evictionClass, flushInterval, size, readWrite, blocking, props);
  }
}

public class PerpetualCache implements Cache {

  private final String id;

  private final Map<Object, Object> cache = new HashMap<>();

//CachingExecutor
@Override
public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql)
    throws SQLException {
  // 获取二级缓存，是从MapperStatement里面获取的
  Cache cache = ms.getCache();
  if (cache != null) {
    // 刷新tcm的缓存 （存在缓存且flushCache为true时）
    flushCacheIfRequired(ms);
    if (ms.isUseCache() && resultHandler == null) {
      ensureNoOutParams(ms, boundSql);
      @SuppressWarnings("unchecked")
      // 从二级缓存中查询数据
      List<E> list = (List<E>) tcm.getObject(cache, key);
      // 如果二级缓存中没有查询到数据，则查询一级缓存及数据库
      if (list == null) {
        // 委托给BaseExecutor执行
        list = delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
        // 将查询结果 要存到二级缓存中（注意：此处只是存到map集合中，没有真正存到二级缓存中）
        tcm.putObject(cache, key, list); // issue #578 and #116
      }
      return list;
    }
  }
  // 如果没有开启二级缓存或开启了没查到二级缓存则委托给BaseExecutor执行下一步查询
  return delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
}

public class TransactionalCacheManager {

  // Cache 与 TransactionalCache 的映射关系表
  private final Map<Cache, TransactionalCache> transactionalCaches = new HashMap<>();
    
  public Object getObject(Cache cache, CacheKey key) {
    // 直接从TransactionalCache中获取缓存
    return getTransactionalCache(cache).getObject(key);
  }

  public void putObject(Cache cache, CacheKey key, Object value) {
    // 直接存入TransactionalCache的缓存中
    getTransactionalCache(cache).putObject(key, value);
  }
    
  private TransactionalCache getTransactionalCache(Cache cache) {
    // 从映射表中获取 TransactionalCache，下面代码等同于
    // transactionalCaches.computeIfAbsent(cache, TransactionalCache::new);
    return MapUtil.computeIfAbsent(transactionalCaches, cache, TransactionalCache::new);
  }

public class TransactionalCache implements Cache {
   /* 二级缓存 Cache 对象。
   */
  private final Cache delegate;
  /**
   * 提交时，清空 {@link #delegate}
   *
   * 初始时，该值为 false
   * 清理后{@link #clear()} 时，该值为 true ，表示持续处于清空状态
   */
  private boolean clearOnCommit;
  /**
   *  // 在事务被提交前，所有从数据库中查询的结果将缓存在此集合中
   */
  private final Map<Object, Object> entriesToAddOnCommit;
  /**
   *   在事务被提交前，当缓存未命中时，CacheKey 将会被存储在此集合中
   */
  private final Set<Object> entriesMissedInCache;
  
  public Object getObject(Object key) {
    // issue #116
    // 查询的时候是直接从delegate（就是MapperSatement的二级缓存对象）中去查询的
    Object object = delegate.getObject(key);
    // 如果不存在，则添加到 entriesMissedInCache 中
    if (object == null) {
      // 缓存未命中，则将 key 存入到 entriesMissedInCache 中
      entriesMissedInCache.add(key);
    }
    // issue #146
    // 如果 clearOnCommit 为 true ，表示处于持续清空状态，则返回 null
    if (clearOnCommit) {
      return null;
    } else {
      // 返回 value
      return object;
    }
  }

//TransactionalCache
public void putObject(Object key, Object object) {
  // 将键值对存入到 entriesToAddOnCommit 这个Map中中，而非真实的缓存对象 delegate 中
  entriesToAddOnCommit.put(key, object);
}

public void commit() {
  // 如果 clearOnCommit 为 true ，则清空 delegate 缓存
  if (clearOnCommit) {
    delegate.clear();
  }
  // 将 entriesToAddOnCommit、entriesMissedInCache 刷入 delegate(cache) 中
  flushPendingEntries();
  // 重置
  reset();
}

private void flushPendingEntries() {
    // 将 entriesToAddOnCommit 中的内容转存到 delegate 中
    for (Map.Entry<Object, Object> entry : entriesToAddOnCommit.entrySet()) {
      // 在这里真正的将entriesToAddOnCommit的对象逐个添加到delegate中，只有这时，二级缓存才真正的生效
      delegate.putObject(entry.getKey(), entry.getValue());
    }
    // 将 entriesMissedInCache 刷入 delegate 中
    for (Object entry : entriesMissedInCache) {
      if (!entriesToAddOnCommit.containsKey(entry)) {
        delegate.putObject(entry, null);
      }
    }
  }