Mybatis源码分析-一级缓存【BaseExecutor】

本文主题：

Executor执行体系回顾
为什么要有一级缓存？
一级缓存、二级缓存有什么区别？
一级缓存属于通用逻辑，那么结构上它是如何设计的？
一级缓存是用什么实现的？
一级缓存命中条件有哪些？
一级缓存有哪些清空场景？
Spring和Mybatis整合一级缓存失效？
一级缓存的注意事项

Executor执行体系

Executor执行体系.png

这是从SqlSession到Executor实现的执行体系图，从图中可以看出，一级缓存是在抽象类BaseExecutor实现的

为什么要有一级缓存？

框架自身方面

一级缓存能够帮助Mybatis解决【结果集映射】的循环引用。假设张三有一张银行卡，那么就会形成一种对象结构，用户持有银行卡，银行卡归属于张三，这就是一种循环引用（或者理解为互相引用），mybatis在查询用户的时候查询到了张三，发现张三持有银行卡，则触发了对张三银行卡的查询；查到了张三的银行卡数据后，发现银行卡有一个归属者信息，那又需要查询用户表，查到了张三，再查银行卡，再查张三。。。。。
Mybatis为了解决这种循环应用的结果映射，借助了一级缓存。具体的细节，会在后面的结果集解析中再去分析，这里不再赘述

业务代码方面

在程序员生涯中，大家一定遇到过类似的代码。

  public void test(){
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    Long[] ids = {1,1,10,5,10};
    for(Long id : ids){
      //查询用户   如果没有mybatis一级缓存，那么 id=1、id =10分别都会查询两次数据库
      User user = userMapper.selectById(id);    
      //执行针对该user的某业务逻辑
      this.doSomeThing(user);
    }
  }

上述代码中，id=1、id=10其实没有必要查询两次数据库，这时候如果自己来解决，那可能需要这样来做

public void test(){
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        Integer[] ids = {1,1,10,5,10};
        Map<Integer,User> userMap = new HashMap<Integer,User>();
        for(Integer id : ids){
            User user;
            if(userMap.containsKey(id)) {
                user = userMap.get(id);
            }else{
                //查询用户
                user = userMapper.selectById(id);
                userMap.put(id,user);
            }

            //执行针对该user的某业务逻辑
            this.doSomeThing(user);
        }
    }

Mybatis的一级缓存，就可以解决这个场景的问题，即便第一种场景的代码，也不用担心id=1和id=10查询了两次的数据库

一级缓存、二级缓存有什么区别？

一级缓存：会话级缓存，生命周期是整个会话SqlSession，非常短暂，不能直接关闭，不能跨线程使用
二级缓存：应用级缓存，生命周期是整个应用，可以跨线程使用

一级缓存属于通用逻辑，那么结构上它是如何设计的？

在Mybatis中，sql是由Executor来执行的，Executor有3个实现类，如果在每一个实现类中都写一遍这样的代码那就太过冗余了，因此抽象出了一个BaseExecutor类，用来处理一级缓存的相关逻辑

image.png

我们都是调用query、update两个方法，query会调用子类实现doQuery，update会调用子类实现doUpdate

一级缓存是用什么实现的？

image.png

可以看到一级缓存是使用PerpetualCache实现的，而PerpetualCache内部的真正实现，就是一个HashMap。而PerpetualCache实现Cache接口，Cache接口的定义也非常简单，核心接口就是放入、获取、移除和清空缓存

一级缓存命中条件有哪些？

image.png

从上图的createCacheKey方法，我们可以看到一级缓存CacheKey的组成，因此可以推断出一级缓存的命中条件：
1、同一个SqlSession会话。不是同一个会话，就不是同一个localCache，这点很重要！！！
2、StatementId相同。com.test.UserMapper.selectById
3、分页参数RowBounds相同。limit 1
4、SQL语句相同。select id from user where id = ?
5、SQL查询参数相同。 id =1
6、环境相同。environmentId=development 通常不会跨环境开发，可以忽略

一级缓存有哪些清空场景？

image.png

BaseExecutor中有一个clearLocalCache方法用于清理一级缓存，那么找到调用这个方法的地方，也就找到了清空一级缓存的场景。如上图所示，可以发现修改、查询、提交、回滚，都可能会清空一级缓存，下面具体来看一下每一个场景是如何清空的

查询：

 @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.");
    }

    //mapper.xml的sql块上配置了flushCache=true，前置清空
    if (queryStack == 0 && ms.isFlushCacheRequired()) {
      clearLocalCache();
    }
    List<E> list;
    try {
      queryStack++;
      list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;
      if (list != null) {
        handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
      } else {
        //从数据库中查询，查询到结果放入localCache
        list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
      }
    } finally {
      queryStack--;
    }
    if (queryStack == 0) {
      for (DeferredLoad deferredLoad : deferredLoads) {
        deferredLoad.load();
      }
      // issue #601
      deferredLoads.clear();
      //mapper.xml的sql块上配置了一级缓存作用域statementType="STATEMENT"，后置清空
      if (configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) {
        clearLocalCache();
      }
    }
    return list;
  }

增删改操作update：

  @Override
  public int update(MappedStatement ms, Object parameter) throws SQLException {
    ErrorContext.instance().resource(ms.getResource()).activity("executing an update").object(ms.getId());
    if (closed) {
      throw new ExecutorException("Executor was closed.");
    }
    //执行sql前清空一级缓存
    clearLocalCache();
    return doUpdate(ms, parameter);
  }

提交：

  @Override
  public void commit(boolean required) throws SQLException {
    if (closed) {
      throw new ExecutorException("Cannot commit, transaction is already closed");
    }
    //提交前清空
    clearLocalCache();
    flushStatements();
    if (required) {
      transaction.commit();
    }
  }

回滚：

  @Override
  public void rollback(boolean required) throws SQLException {
    if (!closed) {
      try {
        //回滚前清空
        clearLocalCache();
        flushStatements(true);
      } finally {
        if (required) {
          transaction.rollback();
        }
      }
    }
  }

清空一级缓存场景总结：
1、执行查询时的清空，若配置了flushCache="true" ->前置清空; 若配置了statementType="STATEMENT" ->后置清空
2、执行增删改（update）操作
3、提交会话
4、回滚会话

Spring和Mybatis整合一级缓存失效？

Spring和Mybatis整合后，很多人发现一级缓存不能命中，这是因为Spring是通过SqlSessionTemplate保证了每次sql调用都会重新生成一个SqlSession会话，而一级缓存是会话级缓存，会话都不同了，自然不能命中。那么如何才能命中一级缓存呢？加一个事务注解@Transactional就可以了，因为在同一个事务方法中，如果Spring还去使用不同的SqlSession会话，那么就无法保证事务原子性。

一级缓存的注意事项

一级缓存的清空是清理掉会话中的全部缓存，它底层是调用了PerpetualCache的clear方法，也就是HashMap.clear。因此不存在指定sql清空的场景，比如会话中执行了查询用户、查询角色两个sql，我们无法只清空一级缓存中的用户数据，只能全部清空。