通过源码分析MyBatis的缓存

柔情只为你懂 2022-03-14 11:12 265阅读 0赞

## 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进行两次相同查询：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>@Test</code> 
     </div> 
     <div> 
      <code>public</code> 
      <code>void</code> 
      <code>test() { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>SqlSession sqlSession = sqlSessionFactory.openSession();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>try</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>User user = (User)sqlSession.selectOne(</code> 
      <code>"org.format.mybatis.cache.UserMapper.getById"</code> 
      <code>, </code> 
      <code>1</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>log.debug(user);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>User user2 = (User)sqlSession.selectOne(</code> 
      <code>"org.format.mybatis.cache.UserMapper.getById"</code> 
      <code>, </code> 
      <code>1</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>log.debug(user2);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>} </code> 
      <code>finally</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>sqlSession.close();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

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

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>==&gt; Preparing: select * from USERS WHERE ID = ? </code> 
     </div> 
     <div> 
      <code>==&gt; Parameters: </code> 
      <code>1</code> 
      <code>(Integer)</code> 
     </div> 
     <div> 
      <code>&lt;== Total: </code> 
      <code>1</code> 
     </div> 
     <div> 
      <code>User{id=</code> 
      <code>1</code> 
      <code>, name=</code> 
      <code>'format'</code> 
      <code>, age=</code> 
      <code>23</code> 
      <code>, birthday=Sun Oct </code> 
      <code>12</code> 
      <code>23</code> 
      <code>:</code> 
      <code>20</code> 
      <code>:</code> 
      <code>13</code> 
      <code>CST </code> 
      <code>2014</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>User{id=</code> 
      <code>1</code> 
      <code>, name=</code> 
      <code>'format'</code> 
      <code>, age=</code> 
      <code>23</code> 
      <code>, birthday=Sun Oct </code> 
      <code>12</code> 
      <code>23</code> 
      <code>:</code> 
      <code>20</code> 
      <code>:</code> 
      <code>13</code> 
      <code>CST </code> 
      <code>2014</code> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

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

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>@Test</code> 
     </div> 
     <div> 
      <code>public</code> 
      <code>void</code> 
      <code>test() { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>SqlSession sqlSession = sqlSessionFactory.openSession();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>try</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>User user = (User)sqlSession.selectOne(</code> 
      <code>"org.format.mybatis.cache.UserMapper.getById"</code> 
      <code>, </code> 
      <code>1</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>log.debug(user);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>User user2 = (User)sqlSession.selectOne(</code> 
      <code>"org.format.mybatis.cache.UserMapper.getById"</code> 
      <code>, </code> 
      <code>2</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>log.debug(user2);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>} </code> 
      <code>finally</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>sqlSession.close();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

MyBatis进行两次数据库查询：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>==&gt; Preparing: select * from USERS WHERE ID = ? </code> 
     </div> 
     <div> 
      <code>==&gt; Parameters: </code> 
      <code>1</code> 
      <code>(Integer)</code> 
     </div> 
     <div> 
      <code>&lt;== Total: </code> 
      <code>1</code> 
     </div> 
     <div> 
      <code>User{id=</code> 
      <code>1</code> 
      <code>, name=</code> 
      <code>'format'</code> 
      <code>, age=</code> 
      <code>23</code> 
      <code>, birthday=Sun Oct </code> 
      <code>12</code> 
      <code>23</code> 
      <code>:</code> 
      <code>20</code> 
      <code>:</code> 
      <code>13</code> 
      <code>CST </code> 
      <code>2014</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>==&gt; Preparing: select * from USERS WHERE ID = ? </code> 
     </div> 
     <div> 
      <code>==&gt; Parameters: </code> 
      <code>2</code> 
      <code>(Integer)</code> 
     </div> 
     <div> 
      <code>&lt;== Total: </code> 
      <code>1</code> 
     </div> 
     <div> 
      <code>User{id=</code> 
      <code>2</code> 
      <code>, name=</code> 
      <code>'FFF'</code> 
      <code>, age=</code> 
      <code>50</code> 
      <code>, birthday=Sat Dec </code> 
      <code>06</code> 
      <code>17</code> 
      <code>:</code> 
      <code>12</code> 
      <code>:</code> 
      <code>01</code> 
      <code>CST </code> 
      <code>2014</code> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

不同session，进行相同查询：

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

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>==&gt; Preparing: select * from USERS WHERE ID = ? </code> 
     </div> 
     <div> 
      <code>==&gt; Parameters: </code> 
      <code>1</code> 
      <code>(Integer)</code> 
     </div> 
     <div> 
      <code>&lt;== Total: </code> 
      <code>1</code> 
     </div> 
     <div> 
      <code>User{id=</code> 
      <code>1</code> 
      <code>, name=</code> 
      <code>'format'</code> 
      <code>, age=</code> 
      <code>23</code> 
      <code>, birthday=Sun Oct </code> 
      <code>12</code> 
      <code>23</code> 
      <code>:</code> 
      <code>20</code> 
      <code>:</code> 
      <code>13</code> 
      <code>CST </code> 
      <code>2014</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>==&gt; Preparing: select * from USERS WHERE ID = ? </code> 
     </div> 
     <div> 
      <code>==&gt; Parameters: </code> 
      <code>1</code> 
      <code>(Integer)</code> 
     </div> 
     <div> 
      <code>&lt;== Total: </code> 
      <code>1</code> 
     </div> 
     <div> 
      <code>User{id=</code> 
      <code>1</code> 
      <code>, name=</code> 
      <code>'format'</code> 
      <code>, age=</code> 
      <code>23</code> 
      <code>, birthday=Sun Oct </code> 
      <code>12</code> 
      <code>23</code> 
      <code>:</code> 
      <code>20</code> 
      <code>:</code> 
      <code>13</code> 
      <code>CST </code> 
      <code>2014</code> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

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

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

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>==&gt; Preparing: select * from USERS WHERE ID = ? </code> 
     </div> 
     <div> 
      <code>==&gt; Parameters: </code> 
      <code>1</code> 
      <code>(Integer)</code> 
     </div> 
     <div> 
      <code>&lt;== Total: </code> 
      <code>1</code> 
     </div> 
     <div> 
      <code>User{id=</code> 
      <code>1</code> 
      <code>, name=</code> 
      <code>'format'</code> 
      <code>, age=</code> 
      <code>23</code> 
      <code>, birthday=Sun Oct </code> 
      <code>12</code> 
      <code>23</code> 
      <code>:</code> 
      <code>20</code> 
      <code>:</code> 
      <code>13</code> 
      <code>CST </code> 
      <code>2014</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>==&gt; Preparing: update USERS SET NAME = ? , AGE = ? , BIRTHDAY = ? where ID = ? </code> 
     </div> 
     <div> 
      <code>==&gt; Parameters: format(String), </code> 
      <code>23</code> 
      <code>(Integer), </code> 
      <code>2014</code> 
      <code>-</code> 
      <code>10</code> 
      <code>-</code> 
      <code>12</code> 
      <code>23</code> 
      <code>:</code> 
      <code>20</code> 
      <code>:</code> 
      <code>13.0</code> 
      <code>(Timestamp), </code> 
      <code>1</code> 
      <code>(Integer)</code> 
     </div> 
     <div> 
      <code>&lt;== Updates: </code> 
      <code>1</code> 
     </div> 
     <div> 
      <code>==&gt; Preparing: select * from USERS WHERE ID = ? </code> 
     </div> 
     <div> 
      <code>==&gt; Parameters: </code> 
      <code>1</code> 
      <code>(Integer)</code> 
     </div> 
     <div> 
      <code>&lt;== Total: </code> 
      <code>1</code> 
     </div> 
     <div> 
      <code>User{id=</code> 
      <code>1</code> 
      <code>, name=</code> 
      <code>'format'</code> 
      <code>, age=</code> 
      <code>23</code> 
      <code>, birthday=Sun Oct </code> 
      <code>12</code> 
      <code>23</code> 
      <code>:</code> 
      <code>20</code> 
      <code>:</code> 
      <code>13</code> 
      <code>CST </code> 
      <code>2014</code> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

很明显，结果验证了一级缓存的概念，**在同个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,这些实现类都使用了[装饰者设计模式][Link 1]

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

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

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>&lt;E&gt; List&lt;E&gt; selectList(String statement, Object parameter, RowBounds rowBounds) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>try</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>MappedStatement ms = configuration.getMappedStatement(statement);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>List&lt;E&gt; result = executor.query(ms, wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>return</code> 
      <code>result;</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>} </code> 
      <code>catch</code> 
      <code>(Exception e) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>throw</code> 
      <code>ExceptionFactory.wrapException(</code> 
      <code>"Error querying database. Cause: "</code> 
      <code>+ e, e);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>} </code> 
      <code>finally</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>ErrorContext.instance().reset();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

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

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

DefaultSqlSession的构造过程（DefaultSqlSessionFactory内部）：

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

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

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

带着这个问题，我们继续走下去（CachingExecutor的query方法）：

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

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

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

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

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

我们看下DefaultSqlSession的update方法：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>int</code> 
      <code>update(String statement, Object parameter) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>try</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>dirty = </code> 
      <code>true</code> 
      <code>;</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>MappedStatement ms = configuration.getMappedStatement(statement);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>return</code> 
      <code>executor.update(ms, wrapCollection(parameter));</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>} </code> 
      <code>catch</code> 
      <code>(Exception e) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>throw</code> 
      <code>ExceptionFactory.wrapException(</code> 
      <code>"Error updating database. Cause: "</code> 
      <code>+ e, e);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>} </code> 
      <code>finally</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>ErrorContext.instance().reset();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

很明显，这里调用了CachingExecutor的update方法：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>int</code> 
      <code>update(MappedStatement ms, Object parameterObject) </code> 
      <code>throws</code> 
      <code>SQLException { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>flushCacheIfRequired(ms);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>return</code> 
      <code>delegate.update(ms, parameterObject);</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

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

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>int</code> 
      <code>update(MappedStatement ms, Object parameter) </code> 
      <code>throws</code> 
      <code>SQLException { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>ErrorContext.instance().resource(ms.getResource()).activity(</code> 
      <code>"executing an update"</code> 
      <code>).object(ms.getId());</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>if</code> 
      <code>(closed) </code> 
      <code>throw</code> 
      <code>new</code> 
      <code>ExecutorException(</code> 
      <code>"Executor was closed."</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>clearLocalCache();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>return</code> 
      <code>doUpdate(ms, parameter);</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

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

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>void</code> 
      <code>clearLocalCache() { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>if</code> 
      <code>(!closed) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>localCache.clear();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>localOutputParameterCache.clear();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

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

## 二级缓存 ##

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

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

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

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

org.apache.ibatis.mapping.MappedStatement：

MappedStatement类在Mybatis框架中用于表示XML文件中一个sql语句节点，即一个<select />、<update />或者<insert />标签。Mybatis框架在初始化阶段会对XML配置文件进行读取，将其中的sql语句节点对象化为一个个MappedStatement对象。

### 配置 ###

二级缓存跟一级缓存不同，一级缓存不需要配置任何东西，且默认打开。 二级缓存就需要配置一些东西。

本文就说下最简单的配置，在mapper文件上加上这句配置即可：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;</code> 
      <code>cache</code> 
      <code>/&gt;</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

其实二级缓存跟3个配置有关：

1.  mybatis全局配置文件中的setting中的cacheEnabled需要为true(默认为true，不设置也行)
2.  mapper配置文件中需要加入<cache>节点
3.  mapper配置文件中的select节点需要加上属性useCache需要为true(默认为true，不设置也行)

### 测试 ###

不同SqlSession，查询相同语句，第一次查询之后commit SqlSession：

MyBatis仅进行了一次数据库查询：

不同SqlSession，查询相同语句，第一次查询之后close SqlSession：

MyBatis仅进行了一次数据库查询：

不同SqlSesson，查询相同语句。 第一次查询之后SqlSession不提交：

MyBatis执行了两次数据库查询：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>==&gt; Preparing: select * from USERS WHERE ID = ? </code> 
     </div> 
     <div> 
      <code>==&gt; Parameters: </code> 
      <code>1</code> 
      <code>(Integer)</code> 
     </div> 
     <div> 
      <code>&lt;== Total: </code> 
      <code>1</code> 
     </div> 
     <div> 
      <code>User{id=</code> 
      <code>1</code> 
      <code>, name=</code> 
      <code>'format'</code> 
      <code>, age=</code> 
      <code>23</code> 
      <code>, birthday=Sun Oct </code> 
      <code>12</code> 
      <code>23</code> 
      <code>:</code> 
      <code>20</code> 
      <code>:</code> 
      <code>13</code> 
      <code>CST </code> 
      <code>2014</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>==&gt; Preparing: select * from USERS WHERE ID = ? </code> 
     </div> 
     <div> 
      <code>==&gt; Parameters: </code> 
      <code>1</code> 
      <code>(Integer)</code> 
     </div> 
     <div> 
      <code>&lt;== Total: </code> 
      <code>1</code> 
     </div> 
     <div> 
      <code>User{id=</code> 
      <code>1</code> 
      <code>, name=</code> 
      <code>'format'</code> 
      <code>, age=</code> 
      <code>23</code> 
      <code>, birthday=Sun Oct </code> 
      <code>12</code> 
      <code>23</code> 
      <code>:</code> 
      <code>20</code> 
      <code>:</code> 
      <code>13</code> 
      <code>CST </code> 
      <code>2014</code> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

### 源码分析 ###

我们从在mapper文件中加入的<cache/>中开始分析源码，关于MyBatis的SQL解析请参考另外一篇博客[Mybatis解析动态sql原理分析][Mybatis_sql]。接下来我们看下这个cache的解析：

XMLMappedBuilder（解析每个mapper配置文件的解析类，每一个mapper配置都会实例化一个XMLMapperBuilder类）的解析方法：

我们看到了解析cache的那段代码：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>private</code> 
      <code>void</code> 
      <code>cacheElement(XNode context) </code> 
      <code>throws</code> 
      <code>Exception { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>if</code> 
      <code>(context != </code> 
      <code>null</code> 
      <code>) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String type = context.getStringAttribute(</code> 
      <code>"type"</code> 
      <code>, </code> 
      <code>"PERPETUAL"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>Class&lt;? </code> 
      <code>extends</code> 
      <code>Cache&gt; typeClass = typeAliasRegistry.resolveAlias(type);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String eviction = context.getStringAttribute(</code> 
      <code>"eviction"</code> 
      <code>, </code> 
      <code>"LRU"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>Class&lt;? </code> 
      <code>extends</code> 
      <code>Cache&gt; evictionClass = typeAliasRegistry.resolveAlias(eviction);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>Long flushInterval = context.getLongAttribute(</code> 
      <code>"flushInterval"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>Integer size = context.getIntAttribute(</code> 
      <code>"size"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>boolean</code> 
      <code>readWrite = !context.getBooleanAttribute(</code> 
      <code>"readOnly"</code> 
      <code>, </code> 
      <code>false</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>Properties props = context.getChildrenAsProperties();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>builderAssistant.useNewCache(typeClass, evictionClass, flushInterval, size, readWrite, props);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

解析完cache标签之后会使用builderAssistant的userNewCache方法，这里的builderAssistant是一个MapperBuilderAssistant类型的帮助类，每个XMLMappedBuilder构造的时候都会实例化这个属性，MapperBuilderAssistant类内部有个Cache类型的currentCache属性，这个属性也就是mapper配置文件中cache节点所代表的值：

ok，现在mapper配置文件中的cache节点被解析到了XMLMapperBuilder实例中的builderAssistant属性中的currentCache值里。

接下来XMLMapperBuilder会解析select节点，解析select节点的时候使用XMLStatementBuilder进行解析(也包括其他insert，update，delete节点)：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> 
    <div>
      14 
    </div> 
    <div>
      15 
    </div> 
    <div>
      16 
    </div> 
    <div>
      17 
    </div> 
    <div>
      18 
    </div> 
    <div>
      19 
    </div> 
    <div>
      20 
    </div> 
    <div>
      21 
    </div> 
    <div>
      22 
    </div> 
    <div>
      23 
    </div> 
    <div>
      24 
    </div> 
    <div>
      25 
    </div> 
    <div>
      26 
    </div> 
    <div>
      27 
    </div> 
    <div>
      28 
    </div> 
    <div>
      29 
    </div> 
    <div>
      30 
    </div> 
    <div>
      31 
    </div> 
    <div>
      32 
    </div> 
    <div>
      33 
    </div> 
    <div>
      34 
    </div> 
    <div>
      35 
    </div> 
    <div>
      36 
    </div> 
    <div>
      37 
    </div> 
    <div>
      38 
    </div> 
    <div>
      39 
    </div> 
    <div>
      40 
    </div> 
    <div>
      41 
    </div> 
    <div>
      42 
    </div> 
    <div>
      43 
    </div> 
    <div>
      44 
    </div> 
    <div>
      45 
    </div> 
    <div>
      46 
    </div> 
    <div>
      47 
    </div> 
    <div>
      48 
    </div> 
    <div>
      49 
    </div> 
    <div>
      50 
    </div> 
    <div>
      51 
    </div> 
    <div>
      52 
    </div> 
    <div>
      53 
    </div> 
    <div>
      54 
    </div> 
    <div>
      55 
    </div> 
    <div>
      56 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>void</code> 
      <code>parseStatementNode() { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String id = context.getStringAttribute(</code> 
      <code>"id"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String databaseId = context.getStringAttribute(</code> 
      <code>"databaseId"</code> 
      <code>);</code> 
     </div> 
     <div> 
     </div> 
     <div> 
      <code> </code> 
      <code>if</code> 
      <code>(!databaseIdMatchesCurrent(id, databaseId, </code> 
      <code>this</code> 
      <code>.requiredDatabaseId)) </code> 
      <code>return</code> 
      <code>;</code> 
     </div> 
     <div> 
     </div> 
     <div> 
      <code> </code> 
      <code>Integer fetchSize = context.getIntAttribute(</code> 
      <code>"fetchSize"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>Integer timeout = context.getIntAttribute(</code> 
      <code>"timeout"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String parameterMap = context.getStringAttribute(</code> 
      <code>"parameterMap"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String parameterType = context.getStringAttribute(</code> 
      <code>"parameterType"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>Class&lt;?&gt; parameterTypeClass = resolveClass(parameterType);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String resultMap = context.getStringAttribute(</code> 
      <code>"resultMap"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String resultType = context.getStringAttribute(</code> 
      <code>"resultType"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String lang = context.getStringAttribute(</code> 
      <code>"lang"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>LanguageDriver langDriver = getLanguageDriver(lang);</code> 
     </div> 
     <div> 
     </div> 
     <div> 
      <code> </code> 
      <code>Class&lt;?&gt; resultTypeClass = resolveClass(resultType);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String resultSetType = context.getStringAttribute(</code> 
      <code>"resultSetType"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>StatementType statementType = StatementType.valueOf(context.getStringAttribute(</code> 
      <code>"statementType"</code> 
      <code>, StatementType.PREPARED.toString()));</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>ResultSetType resultSetTypeEnum = resolveResultSetType(resultSetType);</code> 
     </div> 
     <div> 
     </div> 
     <div> 
      <code> </code> 
      <code>String nodeName = context.getNode().getNodeName();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>SqlCommandType sqlCommandType = SqlCommandType.valueOf(nodeName.toUpperCase(Locale.ENGLISH));</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>boolean</code> 
      <code>isSelect = sqlCommandType == SqlCommandType.SELECT;</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>boolean</code> 
      <code>flushCache = context.getBooleanAttribute(</code> 
      <code>"flushCache"</code> 
      <code>, !isSelect);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>boolean</code> 
      <code>useCache = context.getBooleanAttribute(</code> 
      <code>"useCache"</code> 
      <code>, isSelect);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>boolean</code> 
      <code>resultOrdered = context.getBooleanAttribute(</code> 
      <code>"resultOrdered"</code> 
      <code>, </code> 
      <code>false</code> 
      <code>);</code> 
     </div> 
     <div> 
     </div> 
     <div> 
      <code> </code> 
      <code>// Include Fragments before parsing</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>XMLIncludeTransformer includeParser = </code> 
      <code>new</code> 
      <code>XMLIncludeTransformer(configuration, builderAssistant);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>includeParser.applyIncludes(context.getNode());</code> 
     </div> 
     <div> 
     </div> 
     <div> 
      <code> </code> 
      <code>// Parse selectKey after includes and remove them.</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>processSelectKeyNodes(id, parameterTypeClass, langDriver);</code> 
     </div> 
     <div> 
     </div> 
     <div> 
      <code> </code> 
      <code>// Parse the SQL (pre: &lt;selectKey&gt; and &lt;include&gt; were parsed and removed)</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>SqlSource sqlSource = langDriver.createSqlSource(configuration, context, parameterTypeClass);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String resultSets = context.getStringAttribute(</code> 
      <code>"resultSets"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String keyProperty = context.getStringAttribute(</code> 
      <code>"keyProperty"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String keyColumn = context.getStringAttribute(</code> 
      <code>"keyColumn"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>KeyGenerator keyGenerator;</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>String keyStatementId = id + SelectKeyGenerator.SELECT_KEY_SUFFIX;</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>keyStatementId = builderAssistant.applyCurrentNamespace(keyStatementId, </code> 
      <code>true</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>if</code> 
      <code>(configuration.hasKeyGenerator(keyStatementId)) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>keyGenerator = configuration.getKeyGenerator(keyStatementId);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>} </code> 
      <code>else</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>keyGenerator = context.getBooleanAttribute(</code> 
      <code>"useGeneratedKeys"</code> 
      <code>,</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>configuration.isUseGeneratedKeys() &amp;&amp; SqlCommandType.INSERT.equals(sqlCommandType))</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>? </code> 
      <code>new</code> 
      <code>Jdbc3KeyGenerator() : </code> 
      <code>new</code> 
      <code>NoKeyGenerator();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>}</code> 
     </div> 
     <div> 
     </div> 
     <div> 
      <code> </code> 
      <code>builderAssistant.addMappedStatement(id, sqlSource, statementType, sqlCommandType,</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>fetchSize, timeout, parameterMap, parameterTypeClass, resultMap, resultTypeClass,</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>resultSetTypeEnum, flushCache, useCache, resultOrdered, </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>keyGenerator, keyProperty, keyColumn, databaseId, langDriver, resultSets);</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

这段代码前面都是解析一些标签的属性，我们看到了最后一行使用builderAssistant添加MappedStatement，其中builderAssistant属性是构造XMLStatementBuilder的时候通过XMLMappedBuilder传入的，我们继续看builderAssistant的addMappedStatement方法：

进入setStatementCache：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>private</code> 
      <code>void</code> 
      <code>setStatementCache(</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>boolean</code> 
      <code>isSelect,</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>boolean</code> 
      <code>flushCache,</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>boolean</code> 
      <code>useCache,</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>Cache cache,</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>MappedStatement.Builder statementBuilder) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>flushCache = valueOrDefault(flushCache, !isSelect);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>useCache = valueOrDefault(useCache, isSelect);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>statementBuilder.flushCacheRequired(flushCache);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>statementBuilder.useCache(useCache);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>statementBuilder.cache(cache);</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

最终mapper配置文件中的<cache/>被设置到了XMLMapperBuilder的builderAssistant属性中，XMLMapperBuilder中使用XMLStatementBuilder遍历CRUD节点，遍历CRUD节点的时候将这个cache节点设置到这些CRUD节点中，这个cache就是所谓的二级缓存！

接下来我们回过头来看查询的源码，CachingExecutor的query方法：

进入TransactionalCacheManager的putObject方法：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>void</code> 
      <code>putObject(Cache cache, CacheKey key, Object value) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>getTransactionalCache(cache).putObject(key, value);</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
     <div> 
     </div> 
     <div> 
      <code>private</code> 
      <code>TransactionalCache getTransactionalCache(Cache cache) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>TransactionalCache txCache = transactionalCaches.get(cache);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>if</code> 
      <code>(txCache == </code> 
      <code>null</code> 
      <code>) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>txCache = </code> 
      <code>new</code> 
      <code>TransactionalCache(cache);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>transactionalCaches.put(cache, txCache);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>}</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>return</code> 
      <code>txCache;</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

TransactionalCache的putObject方法：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>void</code> 
      <code>putObject(Object key, Object object) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>entriesToRemoveOnCommit.remove(key);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>entriesToAddOnCommit.put(key, </code> 
      <code>new</code> 
      <code>AddEntry(delegate, key, object));</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

我们看到，数据被加入到了entriesToAddOnCommit中，这个entriesToAddOnCommit是什么东西呢，它是TransactionalCache的一个Map属性：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>private</code> 
      <code>Map&lt;Object, AddEntry&gt; entriesToAddOnCommit;</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

AddEntry是TransactionalCache内部的一个类：

好了，现在我们发现使用二级缓存之后：查询数据的话，先从二级缓存中拿数据，如果没有的话，去一级缓存中拿，一级缓存也没有的话再查询数据库。有了数据之后在丢到TransactionalCache这个对象的entriesToAddOnCommit属性中。

**接下来我们来验证为什么SqlSession commit或close之后，二级缓存才会生效这个问题。**

DefaultSqlSession的commit方法：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>void</code> 
      <code>commit(</code> 
      <code>boolean</code> 
      <code>force) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>try</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>executor.commit(isCommitOrRollbackRequired(force));</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>dirty = </code> 
      <code>false</code> 
      <code>;</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>} </code> 
      <code>catch</code> 
      <code>(Exception e) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>throw</code> 
      <code>ExceptionFactory.wrapException(</code> 
      <code>"Error committing transaction. Cause: "</code> 
      <code>+ e, e);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>} </code> 
      <code>finally</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>ErrorContext.instance().reset();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

CachingExecutor的commit方法：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>void</code> 
      <code>commit(</code> 
      <code>boolean</code> 
      <code>required) </code> 
      <code>throws</code> 
      <code>SQLException { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>delegate.commit(required);</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>tcm.commit();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>dirty = </code> 
      <code>false</code> 
      <code>;</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

tcm.commit即 TransactionalCacheManager的commit方法：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>void</code> 
      <code>commit() { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>for</code> 
      <code>(TransactionalCache txCache : transactionalCaches.values()) { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>txCache.commit();</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

TransactionalCache的commit方法：

发现调用了AddEntry的commit方法：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>public</code> 
      <code>void</code> 
      <code>commit() { </code> 
     </div> 
     <div> 
      <code> </code> 
      <code>cache.putObject(key, value);</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

发现了！ AddEntry的commit方法会把数据丢到cache中，也就是丢到二级缓存中！

关于为何调用close方法后，二级缓存才会生效，因为close方法内部会调用commit方法。本文就不具体说了。 读者有兴趣的话看一看源码就知道为什么了。

## 其他 ##

### Cache接口简介 ###

org.apache.ibatis.cache.Cache是MyBatis的缓存接口，想要实现自定义的缓存需要实现这个接口。

MyBatis中关于Cache接口的实现类也使用了装饰者[设计模式][Link 2]。

我们看下它的一些实现类

简单说明：

LRU – 最近最少使用的:移除最长时间不被使用的对象。

FIFO – 先进先出:按对象进入缓存的顺序来移除它们。

SOFT – 软引用:移除基于垃圾回收器状态和软引用规则的对象。

WEAK – 弱引用:更积极地移除基于垃圾收集器状态和弱引用规则的对象。

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;</code> 
      <code>cache</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>eviction</code> 
      <code>=</code> 
      <code>"FIFO"</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>flushInterval</code> 
      <code>=</code> 
      <code>"60000"</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>size</code> 
      <code>=</code> 
      <code>"512"</code> 
     </div> 
     <div> 
      <code> </code> 
      <code>readOnly</code> 
      <code>=</code> 
      <code>"true"</code> 
      <code>/&gt;</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

可以通过cache节点的eviction属性设置，也可以设置其他的属性。

### cache-ref节点 ###

mapper配置文件中还可以加入cache-ref节点，它有个属性namespace。

如果每个mapper文件都是用cache-ref，且namespace都一样，那么就代表着真正意义上的全局缓存。

如果只用了cache节点，那仅代表这个这个mapper内部的查询被缓存了，其他mapper文件的不起作用，这并不是所谓的全局缓存。

## 总结 ##

总体来说，MyBatis的源码看起来还是比较轻松的，本文从实践和源码方面深入分析了MyBatis的缓存原理，希望对读者有帮助

欢迎学Java和大数据的朋友们加入java架构交流： 855835163  
加群链接：[jq.qq.com/?\_wv=1027&a…][jq.qq.com_wv_1027_a]  
群内提供免费的架构资料还有：Java工程化、高性能及分布式、高性能、深入浅出。高架构。性能调优、Spring，MyBatis，Netty源码分析和大数据等多个知识点高级进阶干货的免费直播讲解 可以进来一起学习交流哦

[Link 1]: https://link.juejin.im?target=http%3A%2F%2Fzh.wikipedia.org%2Fwiki%2F%25E4%25BF%25AE%25E9%25A5%25B0%25E6%25A8%25A1%25E5%25BC%258F
[Mybatis_sql]: https://link.juejin.im?target=http%3A%2F%2Fwww.cnblogs.com%2Ffangjian0423%2Fp%2Fmybaits-dynamic-sql-analysis.html
[Link 2]: https://link.juejin.im?target=http%3A%2F%2Fwww.amazon.cn%2Fgp%2Fproduct%2FB001130JN8%2Fref%3Das_li_qf_sp_asin_il_tl%3Fie%3DUTF8%26amp%3Btag%3Dimportnew-23%26amp%3BlinkCode%3Das2%26amp%3Bcamp%3D536%26amp%3Bcreative%3D3200%26amp%3BcreativeASIN%3DB001130JN8
[jq.qq.com_wv_1027_a]: https://link.juejin.im?target=https%3A%2F%2Fjq.qq.com%2F%3F_wv%3D1027%26amp%3Bk%3D5dPqXGI