通过源码分析MyBatis的缓存

MyBatis缓存介绍

MyBatis支持声明式数据缓存(declarative data caching)。当一条SQL语句被标记为“可缓存”后,首次执行它时从数据库获取的所有数据会被存储在一段高速缓存中,今后执行这条语句时就会从高速缓存中读取结果,而不是再次命中数据库。MyBatis提供了默认下基于Java HashMap的缓存实现,以及用于与OSCache、Ehcache、Hazelcast和Memcached连接的默认连接器。MyBatis还提供API供其他缓存实现使用。

重点的那句话就是:MyBatis执行SQL语句之后,这条语句就是被缓存,以后再执行这条语句的时候,会直接从缓存中拿结果,而不是再次执行SQL

这也就是大家常说的MyBatis一级缓存,一级缓存的作用域scope是SqlSession。

MyBatis同时还提供了一种全局作用域global scope的缓存,这也叫做二级缓存,也称作全局缓存。

一级缓存

测试

同个session进行两次相同查询:

@Test

public void test() {

    SqlSession sqlSession = sqlSessionFactory.openSession();

    try {

        User user = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

        log.debug(user);

        User user2 = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

        log.debug(user2);

    } finally {

        sqlSession.close();

    }

}

MyBatis只进行1次数据库查询:

==>  Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==      Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

同个session进行两次不同的查询:

@Test

public void test() {

    SqlSession sqlSession = sqlSessionFactory.openSession();

    try {

        User user = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

        log.debug(user);

        User user2 = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 2);

        log.debug(user2);

    } finally {

        sqlSession.close();

    }

}

MyBatis进行两次数据库查询:

==>  Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==      Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

==>  Preparing: select * from USERS WHERE ID = ?

==> Parameters: 2(Integer)

<==      Total: 1

User{id=2, name='FFF', age=50, birthday=Sat Dec 06 17:12:01 CST 2014}

不同session,进行相同查询:

@Test

public void test() {

    SqlSession sqlSession = sqlSessionFactory.openSession();

    SqlSession sqlSession2 = sqlSessionFactory.openSession();

    try {

        User user = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

        log.debug(user);

        User user2 = (User)sqlSession2.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

        log.debug(user2);

    } finally {

        sqlSession.close();

        sqlSession2.close();

    }

}

MyBatis进行了两次数据库查询:

==>  Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==      Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

==>  Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==      Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

同个session,查询之后更新数据,再次查询相同的语句:

@Test

public void test() {

    SqlSession sqlSession = sqlSessionFactory.openSession();

    try {

        User user = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

        log.debug(user);

        user.setAge(100);

        sqlSession.update("org.format.mybatis.cache.UserMapper.update", user);

        User user2 = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

        log.debug(user2);

        sqlSession.commit();

    } finally {

        sqlSession.close();

    }

}

更新操作之后缓存会被清除:

==>  Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==      Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

==>  Preparing: update USERS SET NAME = ? , AGE = ? , BIRTHDAY = ? where ID = ?

==> Parameters: format(String), 23(Integer), 2014-10-12 23:20:13.0(Timestamp), 1(Integer)

<==    Updates: 1

==>  Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==      Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

很明显,结果验证了一级缓存的概念,在同个SqlSession中,查询语句相同的sql会被缓存,但是一旦执行新增或更新或删除操作,缓存就会被清除

源码分析

在分析MyBatis的一级缓存之前,我们先简单看下MyBatis中几个重要的类和接口:

org.apache.ibatis.session.Configuration类:MyBatis全局配置信息类

org.apache.ibatis.session.SqlSessionFactory接口:操作SqlSession的工厂接口,具体的实现类是DefaultSqlSessionFactory

org.apache.ibatis.session.SqlSession接口:执行sql,管理事务的接口,具体的实现类是DefaultSqlSession

org.apache.ibatis.executor.Executor接口:sql执行器,SqlSession执行sql最终是通过该接口实现的,常用的实现类有SimpleExecutor和CachingExecutor

一级缓存的作用域是SqlSession,那么我们就先看一下SqlSession的select过程:

这是DefaultSqlSession(SqlSession接口实现类,MyBatis默认使用这个类)的selectList源码(我们例子上使用的是selectOne方法,调用selectOne方法最终会执行selectList方法):

public List selectList(String statement, Object parameter, RowBounds rowBounds) {

    try {

      MappedStatement ms = configuration.getMappedStatement(statement);

      List result = executor.query(ms, wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER);

      return result;

    } catch (Exception e) {

      throw ExceptionFactory.wrapException("Error querying database.  Cause: " + e, e);

    } finally {

      ErrorContext.instance().reset();

    }

}

我们看到SqlSession最终会调用Executor接口的方法。

接下来我们看下DefaultSqlSession中的executor接口属性具体是哪个实现类。

DefaultSqlSession的构造过程(DefaultSqlSessionFactory内部):

private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {

    Transaction tx = null;

    try {

      final Environment environment = configuration.getEnvironment();

      final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);

      tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);

      final Executor executor = configuration.newExecutor(tx, execType, autoCommit);

      return new DefaultSqlSession(configuration, executor);

    } catch (Exception e) {

      closeTransaction(tx); // may have fetched a connection so lets call close()

      throw ExceptionFactory.wrapException("Error opening session.  Cause: " + e, e);

    } finally {

      ErrorContext.instance().reset();

    }

}

我们看到DefaultSqlSessionFactory构造DefaultSqlSession的时候,Executor接口的实现类是由Configuration构造的:

public Executor newExecutor(Transaction transaction, ExecutorType executorType, boolean autoCommit) {

    executorType = executorType == null ? defaultExecutorType : executorType;

    executorType = executorType == null ? ExecutorType.SIMPLE : executorType;

    Executor executor;

    if (ExecutorType.BATCH == executorType) {

      executor = new BatchExecutor(this, transaction);

    } else if (ExecutorType.REUSE == executorType) {

      executor = new ReuseExecutor(this, transaction);

    } else {

      executor = new SimpleExecutor(this, transaction);

    }

    if (cacheEnabled) {

      executor = new CachingExecutor(executor, autoCommit);

    }

    executor = (Executor) interceptorChain.pluginAll(executor);

    return executor;

}

Executor根据ExecutorType的不同而创建,最常用的是SimpleExecutor,本文的例子也是创建这个实现类。 最后我们发现如果cacheEnabled这个属性为true的话,那么executor会被包一层装饰器,这个装饰器是CachingExecutor。其中cacheEnabled这个属性是mybatis总配置文件中settings节点中cacheEnabled子节点的值,默认就是true,也就是说我们在mybatis总配置文件中不配cacheEnabled的话,它也是默认为打开的。

现在,问题就剩下一个了,CachingExecutor执行sql的时候到底做了什么?

带着这个问题,我们继续走下去(CachingExecutor的query方法):

public List query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {

    Cache cache = ms.getCache();

    if (cache != null) {

      flushCacheIfRequired(ms);

      if (ms.isUseCache() && resultHandler == null) {

        ensureNoOutParams(ms, parameterObject, boundSql);

        if (!dirty) {

          cache.getReadWriteLock().readLock().lock();

          try {

            @SuppressWarnings("unchecked")

            List cachedList = (List) cache.getObject(key);

            if (cachedList != null) return cachedList;

          } finally {

            cache.getReadWriteLock().readLock().unlock();

          }

        }

        List list = delegate. query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);

        tcm.putObject(cache, key, list); // issue #578. Query must be not synchronized to prevent deadlocks

        return list;

      }

    }

    return delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);

}

其中Cache cache = ms.getCache();这句代码中,这个cache实际上就是个二级缓存,由于我们没有开启二级缓存(二级缓存的内容下面会分析),因此这里执行了最后一句话。这里的delegate也就是SimpleExecutor,SimpleExecutor没有Override父类的query方法,因此最终执行了SimpleExecutor的父类BaseExecutor的query方法。

所以一级缓存最重要的代码就是BaseExecutor的query方法!

通过源码分析MyBatis的缓存_第1张图片

BaseExecutor的属性localCache是个PerpetualCache类型的实例,PerpetualCache类是实现了MyBatis的Cache缓存接口的实现类之一,内部有个Map类型的属性用来存储缓存数据。 这个localCache的类型在BaseExecutor内部是写死的。 这个localCache就是一级缓存!

接下来我们看下为何执行新增或更新或删除操作,一级缓存就会被清除这个问题。

首先MyBatis处理新增或删除的时候,最终都是调用update方法,也就是说新增或者删除操作在MyBatis眼里都是一个更新操作。

我们看下DefaultSqlSession的update方法:

public int update(String statement, Object parameter) {

    try {

      dirty = true;

      MappedStatement ms = configuration.getMappedStatement(statement);

      return executor.update(ms, wrapCollection(parameter));

    } catch (Exception e) {

      throw ExceptionFactory.wrapException("Error updating database.  Cause: " + e, e);

    } finally {

      ErrorContext.instance().reset();

    }

}

很明显,这里调用了CachingExecutor的update方法:

public int update(MappedStatement ms, Object parameterObject) throws SQLException {

    flushCacheIfRequired(ms);

    return delegate.update(ms, parameterObject);

}

这里的flushCacheIfRequired方法清除的是二级缓存,我们之后会分析。 CachingExecutor委托给了(之前已经分析过)SimpleExecutor的update方法,SimpleExecutor没有Override父类BaseExecutor的update方法,因此我们看BaseExecutor的update方法:

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

    clearLocalCache();

    return doUpdate(ms, parameter);

}

我们看到了关键的一句代码: clearLocalCache(); 进去看看:

public void clearLocalCache() {

    if (!closed) {

      localCache.clear();

      localOutputParameterCache.clear();

    }

}

没错,就是这条,sqlsession没有关闭的话,进行新增、删除、修改操作的话就是清除一级缓存,也就是SqlSession的缓存。

二级缓存

二级缓存的作用域是全局,换句话说,二级缓存已经脱离SqlSession的控制了。

在测试二级缓存之前,我先把结论说一下:

二级缓存的作用域是全局的,二级缓存在SqlSession关闭或提交之后才会生效。

在分析MyBatis的二级缓存之前,我们先简单看下MyBatis中一个关于二级缓存的类(其他相关的类和接口之前已经分析过):

org.apache.ibatis.mapping.MappedStatement:

MappedStatement类在Mybatis框架中用于表示XML文件中一个sql语句节点,即一个