Mybatis一级缓存原理

记录是一种精神，是加深理解最好的方式之一。

最近看了下Mybatis的源码，了解Mybatis一级缓存的实现方式，在这里把他记下来
曹金桂 cao_jingui@163.com(如有遗漏之处还请指教)
时间：2016年10月6日14:00

一级缓存概念

   当我们使用Mybatis进行数据库的操作时候，会创建一个SqlSession来进行一次数据库的会话，会话结束则关闭SqlSession对象。那么一个SqlSession的生命周期即对应于Mybatis的一次会话。在Mybatis的一次会话中，我们很有可能多次查询完全相同的sql语句，如果不采取措施的话，每一次查询都查询一次数据库。而一次会话时间一般都是极短的，相同Sql的查询结果极有可能完全相同。由于查询数据库代价是比较大的，这会导致系统的资源浪费。

   为了解决这个问题，Mybatis对每一次会话都添加了缓存操作。这个缓存的作用域为一次会话中。缓存随着会话(SqlSession)的创建而产生，随着会话结束而释放。对一次会话的查询操作，总是先查看缓存中是否存在查询结果，如果存在则直接取缓存中的结果，不存在则查询数据库。这样的话，一次会话中的完全相同的查询则只会查询一次，节省了系统资源。

一级缓存的实现

   我们知道，对SqlSession的操作mybatis内部都是通过Executor来执行的。Executor的生命周期和SqlSession是一致的。Mybatis在Executor中创建了本地缓存(一级缓存)。如下图：

   下面我们对照着Mybatis的源码看下具体的实现，先看一级缓存对象的创建。我们知道所有的Mybatis提供的三个Executor实现类都继承了BaseExecutor。在Executor创建(SimpleExecutor)时候会调用父类的初始化方法。先看BaseExecurot的构造方法。

protected BaseExecutor(Configuration configuration, Transaction transaction) {
    this.configuration = configuration;
    this.transaction = transaction;
    this.deferredLoads = new ConcurrentLinkedQueue<DeferredLoad>();
    this.closed = false;
    this.wrapperExecutor = this;
    //mybatis一级缓存，在创建SqlSession->Executor时候动态创建，随着sqlSession销毁而销毁
    this.localCache = new PerpetualCache("LocalCache");
    this.localOutputParameterCache = new PerpetualCache("LocalOutputParameterCache");
}

   我们可以看到一级缓存的实现很简单，不能像二级缓存那样设置淘汰规则过期时间等等，采用PerpetualCache作为实现类，底层使用HashMap存储(源码略)。
   缓存只对我们的查询有效，对数据库写和更新删除是无效的，我们继续看下Executor中是怎么使用缓存的。具体为Executor接口的query方法实现.

//SqlSession.selectList会调用此方法（一级缓存操作，总是先查询一级缓存，缓存中不存在再查询数据库）
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.");
    }
    //先清一级缓存，再查询，但仅仅查询堆栈为0才清，为了处理递归调用
    if (queryStack == 0 && ms.isFlushCacheRequired()) {
        clearLocalCache();
    }
    List<E> list;
    try {
        //加一，这样递归调用到上面的时候就不会再清局部缓存了
        queryStack++;
        list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;
        if (list != null) { //如果查到localCache缓存，处理localOutputParameterCache
            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();
        }
        deferredLoads.clear(); //清空延迟加载队列
        if (configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) {
            clearLocalCache(); 
        }
    }
    return list;
}

   通过源码可以看到，Executor在执行数据库查询的时候总是先查看缓存中是否存在，若不存在则查询数据库。

一级缓存生命周期

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

一级缓存注意事项

1. MyBatis对会话（Session）级别的一级缓存设计的比较简单，就简单地使用了HashMap来维护，并没有对HashMap的容量和大小进行限制。
   *a.  一般而言SqlSession的生存时间很短。一般情况下使用一个SqlSession对象执行的操作不会太多，执行完就会消亡；
   b.  对于某一个SqlSession对象而言，只要执行update操作（update、insert、delete），都会将这个SqlSession对象中对应的一级缓存清空掉，所以一般情况下不会出现缓存过大，影响JVM内存空间的问题；
   c.  可以手动地释放掉SqlSession对象中的缓存。*
2. 一级缓存是一个粗粒度的缓存，没有更新缓存和缓存过期的概念
   *1、对于数据变化频率很大，并且需要高时效准确性的数据要求，我们使用SqlSession查询的时候，要控制好SqlSession的生存时间，SqlSession的生存时间越长，它其中缓存的数据有可能就越旧，从而造成和真实数据库的误差；同时对于这种情况，用户也可以手动地适时清空SqlSession中的缓存；
   2、对于只执行、并且频繁执行大范围的select操作的SqlSession对象，SqlSession对象的生存时间不应过长。*

如何禁用一级缓存

我们知道，mybatis的一级缓存是内部实现的一个特性，用户不能配置，默认情况下框架自动支持缓存。那万一业务场景下需要禁用一级缓存怎么操作呢？我们可以使用Mybatis的插件开发来做。

@Intercepts({@Signature(type = Executor.class, method = "query",
        args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})})
// 禁用Mybatis一级缓存拦截器
public class CloseLocalCacheInterceptor implements Interceptor {
    public Object intercept(Invocation invocation) throws Throwable {
        if (invocation.getTarget() instanceof Executor) {
            Executor executor = (Executor) invocation.getTarget();
            executor.clearLocalCache();
        }
        return invocation.proceed();
    }
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
    public void setProperties(Properties properties) {
    }
}