mybatis-3.4.6 缓存介绍

系列

• mybatis-3.4.6 配置介绍
• mybatis-3.4.6 顶层配置解析
• mybatis-3.4.6 子配置解析
• mybatis-3.4.6 mapper解析
• mybatis-3.4.6 SQL执行流程
• mybatis-3.4.6 SqlSession执行过程
• mybatis-3.4.6 缓存介绍
• mybatis-3.4.6 自增主键
• mybatis-3.4.6 foreach 自增主键
• mybatis-3.4.6 事务管理

开篇

• 这个系列是基于mybatis-3.4.6版本的源码解析，这篇文章主要是梳理mybatis的一级缓存和二级缓存。

• 核心主要是分析cache的使用范围以及对应的SQL执行对缓存的使用。

mybatis多级缓存

• 1、一级缓存: 基于PerpetualCache 的 HashMap本地缓存，其存储作用域为 Session，当 Session flush 或 close 之后，该Session中的所有 Cache 就将清空。

• 2、二级缓存与一级缓存其机制相同，默认也是采用 PerpetualCache，HashMap存储，不同在于其存储作用域为 Mapper(Namespace)，并且可自定义存储源，如 Ehcache。

• 3、对于缓存数据更新机制，当某一个作用域(一级缓存Session/二级缓存Namespaces)的进行了 C/U/D 操作后，默认该作用域下所有 select 中的缓存将被clear。

• 4、从Cache的层面来说，二级缓存在一级缓存之前生效。

mybatis一级缓存

public abstract class BaseExecutor implements Executor {
  // localCache作为mybatis的一级缓存
  protected PerpetualCache localCache;

  public  List query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    ErrorContext.instance().resource(ms.getResource()).activity("executing a query").object(ms.getId());

    if (queryStack == 0 && ms.isFlushCacheRequired()) {
      clearLocalCache();
    }

    List list;
    try {
      queryStack++;
      // 先从localCache查询
      list = resultHandler == null ? (List) localCache.getObject(key) : null;
      if (list != null) {
        // 如果已经存在则直接返回
        handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
      } else {
        // 缓存不存在就查询DB
        list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
      }
    } finally {
      queryStack--;
    }

    return list;
  }


  private  List queryFromDatabase(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    List list;
    localCache.putObject(key, EXECUTION_PLACEHOLDER);
    try {
      list = doQuery(ms, parameter, rowBounds, resultHandler, boundSql);
    } finally {
      localCache.removeObject(key);
    }
    // 保存到本地缓存
    localCache.putObject(key, list);
    if (ms.getStatementType() == StatementType.CALLABLE) {
      localOutputParameterCache.putObject(key, parameter);
    }
    return list;
  }
}

• mybatis一级缓存在SimpleExecutor级别的，BaseExecutor作为SimpleExecutor的父类。
• BaseExecutor的localCache用来进行缓存，先查询缓存后查询DB，查询完DB保存到localCache当中。

public class PerpetualCache implements Cache {
  private final String id;
  private Map cache = new HashMap();
}

• mybatis一级缓存是通过PerpetualCache来进行存储的。

mybatis二级缓存

public class CachingExecutor implements Executor {

  public  List query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql)
      throws SQLException {
    // 通过MappedStatement来进行查询
    Cache cache = ms.getCache();
    if (cache != null) {
      flushCacheIfRequired(ms);
      if (ms.isUseCache() && resultHandler == null) {
        ensureNoOutParams(ms, boundSql);
        @SuppressWarnings("unchecked")
        List list = (List) tcm.getObject(cache, key);
        // 缓存不存在的情况下由SimpleExecutor来执行query
        if (list == null) {
          list = delegate. query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
          tcm.putObject(cache, key, list); // issue #578 and #116
        }
        return list;
      }
    }
    // 缓存不允许的情况下由SimpleExecutor来执行query
    return delegate. query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }
}

• 二级缓存在CachingExecutor层被使用。
• 二级缓存是MappedStatement级别的，从MappedStatement当中查询Cache对象。
• 在允许使用二级缓存的场景下优先查询二级缓存，没有的情况下通过SimpleExecutor查询DB。
• 二级缓存是由TransactionalCache进行管理的。

public class TransactionalCache implements Cache {

  private static final Log log = LogFactory.getLog(TransactionalCache.class);

  private final Cache delegate;
  private boolean clearOnCommit;
  private final Map entriesToAddOnCommit;
  private final Set