Mybatis源码学习笔记之Mybatis一级缓存

最新推荐文章于 2026-06-29 15:53:13 发布

原创最新推荐文章于 2026-06-29 15:53:13 发布 · 201 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#缓存 #java #开发语言 #mybatis

Java 专栏收录该内容

18 篇文章

订阅专栏

本文详细解读了一级缓存的工作原理，包括其命中条件（SQL、参数、会话一致等）、CachKey的生成逻辑，以及清空缓存的多种情况。深入到源码层面，展示了如何在MyBatis中管理和使用缓存，对于提高查询效率至关重要。

总述

一级缓存其实就是会话级的缓存，默认开启(可通过配置flushCache= true关闭)，指的是在同一会话内如果有两次相同的查询（Sql和参数均相同），那么第二次就会命中缓存。

命中条件

一级缓存命中条件之一是CacheKey相同：
(1)SQL及参数相同
(2)同一个会话
(3)相同的MapperStatement ID
(4)查询结果集的分页信息

为了方便理解，这里贴出Cachkey的生成代码（源码位置：org.apache.ibatis.executor.BaseExecutor）

  @Override
  public CacheKey createCacheKey(MappedStatement ms, Object parameterObject, RowBounds rowBounds, BoundSql boundSql) {
    if (closed) {
      throw new ExecutorException("Executor was closed.");
    }
    CacheKey cacheKey = new CacheKey();
    cacheKey.update(ms.getId());
    cacheKey.update(rowBounds.getOffset());
    cacheKey.update(rowBounds.getLimit());
    cacheKey.update(boundSql.getSql());
    List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
    TypeHandlerRegistry typeHandlerRegistry = ms.getConfiguration().getTypeHandlerRegistry();
    // mimic DefaultParameterHandler logic
    for (ParameterMapping parameterMapping : parameterMappings) {
      if (parameterMapping.getMode() != ParameterMode.OUT) {
        Object value;
        String propertyName = parameterMapping.getProperty();
        if (boundSql.hasAdditionalParameter(propertyName)) {
          value = boundSql.getAdditionalParameter(propertyName);
        } else if (parameterObject == null) {
          value = null;
        } else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
          value = parameterObject;
        } else {
          MetaObject metaObject = configuration.newMetaObject(parameterObject);
          value = metaObject.getValue(propertyName);
        }
        cacheKey.update(value);
      }
    }
    if (configuration.getEnvironment() != null) {
      // issue #176
      cacheKey.update(configuration.getEnvironment().getId());
    }
    return cacheKey;
  }

清空条件

(1)手动调用clearCache
(2)执行提交回滚
(3)执行update
(4)配置flushCache=true
(5)缓存作用域为Statement

源码解析

源码位置：org.apache.ibatis.executor.BaseExecutor

@SuppressWarnings("unchecked")
  @Override
  public <E> List<E> 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 (closed) {
      throw new ExecutorException("Executor was closed.");
    }
    if (queryStack == 0 && ms.isFlushCacheRequired()) { //判断flushCache参数是否开启
      clearLocalCache();
    }
    List<E> list;
    try {
      queryStack++;
      list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;//查询缓存
      if (list != null) { //有缓存读缓存
        handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
      } else { //无缓存走查询数据库
        list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
      }
    } finally {
      queryStack--;
    }
    if (queryStack == 0) {
      for (DeferredLoad deferredLoad : deferredLoads) {
        deferredLoad.load();
      }
      // issue #601
      deferredLoads.clear();
      if (configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) {
        // issue #482
        clearLocalCache();
      }
    }
    return list;
  }

这里贴出无缓存mybatis（需要查询数据库同时设置缓存）情形的处理。

private <E> List<E> queryFromDatabase(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    List<E> 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;
  }