Mybatis源码学习（四）一级缓存机制

一级缓存机制

1、什么是一级缓存？为什么使用一级缓存？

　　使用MyBatis开启一次和数据库的会话，MyBatis会创建出一个SqlSession对象表示一次数据库会话。

MyBatis会在表示会话的SqlSession对象中建立一个简单的缓存，将每次查询到的结果结果缓存起来，当下次查询的时候，如果判断先前有个完全一样的查询，会直接从缓存中直接将结果取出，返回给用户，不需要再进行一次数据库查询了。

　　对于会话（Session）级别的数据缓存，称之为一级数据缓存，简称一级缓存。

2、一级缓存的组织结构

　　当创建了一个SqlSession对象时，MyBatis会为这个SqlSession对象创建一个新的Executor执行器，而缓存信息就被维护在这个Executor执行器中，MyBatis将缓存和对缓存相关的操作封装成了Cache接口中。

　　PerpetualCache实现原理：其内部通过一个简单的HashMap<k,v>来实现的，没有其他的任何限制。每个永久缓存有一个ID来识别，只要ID相等就认为两个缓存相同。

3、生命周期

　　 1. MyBatis在开启一个数据库会话时，会创建一个新的SqlSession对象，SqlSession对象中会有一个新的Executor对象，该对象中持有一个新的PerpetualCache对象；当会话结束时，SqlSession对象及其内部的Executor对象还有PerpetualCache对象也一并释放掉。
　　 2. 如果SqlSession调用了close()方法，会释放掉一级缓存PerpetualCache对象，一级缓存将不可用；
　　 3. 如果SqlSession调用了clearCache()，会清空PerpetualCache对象中的数据，但是该对象仍可使用；
　　 4. SqlSession中执行了任何一个update操作(update()、delete()、insert())，都会清空PerpetualCache对象的数据，但是该对象可以继续使用；

4、一级缓存的工作流程：

　　对于某个查询，根据statementId,params,rowBounds来构建一个key值，根据这个key值去缓存Cache中取出对应的key值存储的缓存结果；判断缓存结果是否为空，即是否命中；如果命中，则直接将缓存结果返回；如果没命中：
　　（1） 去数据库中查询数据，得到查询结果；
　　（2） 将key和查询到的结果分别作为key,value对存储到Cache中；
　　（3） 将查询结果返回；

5、Cache接口的设计以及CacheKey的定义：

　　MyBatis定义了一个org.apache.ibatis.cache.Cache接口作为其Cache提供者的SPI(Service　Provider Interface) ，所有的MyBatis内部的Cache缓存，都应该实现这一接口。

　　MyBatis认为，对于两次查询，如果以下条件都完全一样，那么就认为它们是完全相同的两次查询：
　　1. 传入的 statementId
　　2. 查询时要求的结果集中的结果范围 （通过rowBounds.offset和rowBounds.limit表示）；
　　3. 这次查询所产生的最终要传递给JDBC的Sql语句字符串
　　4. 传递给java.sql.Statement要设置的参数值（最后sql需要的参数）

　　对于每次的查询请求，Executor都会根据传递的参数信息以及动态生成的SQL语句，将上面的条件根据一定的计算规则（用上述信息计算哈希码和校验值），创建一个对应的CacheKey对象。

　　CacheKey的构建被放置在Executor接口的实现类BaseExecutor中，构建CacheKey的过程实际上就是构造其hashCode的过程：校验码是所有对象哈希码的和，哈希码是key的hashCode * 拓展因子（默认37）+拓展count倍的对象hashCode值。（count为该key已经传递的信息数）。
　　

/*创建缓存Key，excutor中的方法*/
  @Override
  public CacheKey createCacheKey(MappedStatement ms, Object parameterObject, RowBounds rowBounds, BoundSql boundSql) {
    if (closed) {
      throw new ExecutorException("Executor was closed.");
    }
    CacheKey cacheKey = new CacheKey();
    //MyBatis 对于其 Key 的生成采取规则为：[mappedStementId + offset + limit + SQL + queryParams + environment]生成一个哈希码
    cacheKey.update(ms.getId());
    cacheKey.update(Integer.valueOf(rowBounds.getOffset()));
    cacheKey.update(Integer.valueOf(rowBounds.getLimit()));
    cacheKey.update(boundSql.getSql());
    List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
    TypeHandlerRegistry typeHandlerRegistry = ms.getConfiguration().getTypeHandlerRegistry();
    // mimic DefaultParameterHandler logic
    //模仿DefaultParameterHandler的逻辑,不再重复，请参考DefaultParameterHandler
    for (int i = 0; i < parameterMappings.size(); i++) {
      ParameterMapping parameterMapping = parameterMappings.get(i);
      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;
  }    

/* CacheKey中的方法*/
public void update(Object object) {
    if (object != null && object.getClass().isArray()) {
        //如果是数组，则循环调用doUpdate
      int length = Array.getLength(object);
      for (int i = 0; i < length; i++) {
        Object element = Array.get(object, i);
        doUpdate(element);
      }
    } else {
        //否则，doUpdate
      doUpdate(object);
    }
  }

private void doUpdate(Object object) {
    //计算hash值，校验码
    int baseHashCode = object == null ? 1 : object.hashCode();

    count++;
    checksum += baseHashCode;
    baseHashCode *= count;

    hashcode = multiplier * hashcode + baseHashCode;

    //同时将对象加入列表，这样万一两个CacheKey的hash码碰巧一样，再根据对象严格equals来区分
    updateList.add(object);
  }

6、一级缓存性能分析

　　对会话级的一级缓存设计的比较简单，没有对HashMap的容量和大小进行限制。

1）会不会出现HashMap太大，而导致 java.lang.OutOfMemoryError错误呢？
　　一般而言SqlSession的生存时间很短。只要执行update操作（update、insert、delete），都会将这个SqlSession对象中对应的一级缓存清空掉；可以手动地释放掉SqlSession对象中的缓存。
　　
2）一级缓存是一个粗粒度的缓存，没有更新缓存和缓存过期的概念。只负责存储。