MyBatis(十三)缓存

一级缓存介绍

默认情况下，MyBatis只启用了本地的会话缓存，它仅仅对一个会话中的数据进行缓存。这也就是大家常说的MyBatis一级缓存，一级缓存的作用域是SqlSession。

MyBatis一级缓存的运行过程是这样的：执行SQL语句的过程中，首次执行它时从数据库获取的所有数据会被存储在一段高速缓存中，今后执行这条语句时就会从高速缓存中读取结果，而不是再次查询数据库。MyBatis提供了默认下基于Java HashMap的缓存实现。

重点是要明白：MyBatis执行SQL语句之后，这条语句的执行结果被缓存，以后再执行这条语句的时候，会直接从缓存中拿结果，而不是再次执行SQL。但是一旦执行新增或更新或删除操作，缓存就会被清除。下面将分情况来验证一下。

第1种情况：同个session进行两次相同查询

public class Test
{
    public static void main(String[] args) throws Exception
    {
        InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");

        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        SqlSession session = sqlSessionFactory.openSession();

        Person p1 = session.selectOne("cn.mybatis.mydemo.mapper.PersonMapper.selectPersonById", 1);

        Person p2 = session.selectOne("cn.mybatis.mydemo.mapper.PersonMapper.selectPersonById", 1);
        
        session.commit();
        
        session.close();
    }
}

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

==> Preparing: select * from t_person where id = ?

==> Parameters: 1(Integer)

<== Total: 1

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

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

第2种情况：同个session进行两次不同的查询。

public class Test
{
    public static void main(String[] args) throws Exception
    {
        InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");

        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        SqlSession session = sqlSessionFactory.openSession();

        Person p1 = session.selectOne("cn.mybatis.mydemo.mapper.PersonMapper.selectPersonById", 1);

        Person p2 = session.selectOne("cn.mybatis.mydemo.mapper.PersonMapper.selectPersonById", 2);
        
        session.commit();
        
        session.close();
    }
}

结论：MyBatis进行两次数据库查询。

==> Preparing: select * from t_person where id = ?

==> Parameters: 1(Integer)

<== Total: 1

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

==> Preparing: select * from t_person where id = ?

==> Parameters: 2(Integer)

<== Total: 1

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

第3种情况：不同session，进行相同查询。

public class Test
{
    public static void main(String[] args) throws Exception
    {
        InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");

        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        SqlSession session1 = sqlSessionFactory.openSession();

        Person p1 = session1.selectOne("cn.mybatis.mydemo.mapper.PersonMapper.selectPersonById", 1);

        SqlSession session2 = sqlSessionFactory.openSession();
        Person p2 = session2.selectOne("cn.mybatis.mydemo.mapper.PersonMapper.selectPersonById", 2);

        session1.commit();
        session2.commit();

        session1.close();
        session2.close();
    }
}

结论：MyBatis进行两次数据库查询。

==> Preparing: select * from t_person where id = ?

==> Parameters: 1(Integer)

<== Total: 1

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

==> Preparing: select * from t_person where id = ?

==> Parameters: 2(Integer)

<== Total: 1

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

第4种情况：同个session，查询之后更新数据，再次查询相同的语句。

public class Test
{
    public static void main(String[] args) throws Exception
    {
        InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");

        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        SqlSession session = sqlSessionFactory.openSession();

        Person p = null;
        
        p = session.selectOne("cn.mybatis.mydemo.mapper.PersonMapper.selectPersonById", 1);

        p.setAge(30);

        session.update("cn.mybatis.mydemo.mapper.PersonMapper.updatePerson", p);

        p = session.selectOne("cn.mybatis.mydemo.mapper.PersonMapper.selectPersonById", 1);

        session.commit();

        session.close();

    }
}

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

==> Preparing: select * from t_person where id = ?

==> Parameters: 1(Integer)

<== Total: 1

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

==> Preparing: update t_person set age = ? where ID = ?

==> Parameters: 30(Integer), 1(Integer)

<== Updates: 1

==> Preparing: sselect * from t_person where id = ?

==> Parameters: 1(Integer)

<== Total: 1

User{id=1, name='kit', age=30, birthday=Sun Oct 12 23:20:13 CST 2010}

小结

很明显，以上各种情况验证了一级缓存的概念，在同个SqlSession中，查询语句相同的sql会被缓存，但是一旦执行新增或更新或删除操作，缓存就会被清除。

二级缓存介绍

缓存，这个伟大的创新，无处不在，而且还喜欢分级，往往以多级缓存的形式出现。mybatis的缓存如出一辙，也划分为一级缓存和二级缓存。紧跟MyBatis一级缓存介绍，本文开启MyBatis二级缓存介绍。

1、CPU的二级缓存

缓存无处不在，其最根本的起源是CPU的多级缓存，如下所示：

CPU-Cache.jpg

对比一下CPU的二级缓存，更有助于学习MyBatis二级缓存。

二级缓存是CPU性能表现的关键之一，在CPU核心不变化的情况下，增加二级缓存容量能使性能大幅度提高。而同一核心的CPU高低端之分往往也是在二级缓存上有差异，由此可见二级缓存对于CPU的重要性。

备注：随着CPU制造工艺的发展，二级缓存也能轻易的集成在CPU内核中，容量也在逐年提升。现在再用集成在CPU内部与否来定义一、二级缓存，已不确切。而且随着二级缓存被集成入CPU内核中，以往二级缓存与CPU大差距分频的情况也被改变，此时其以相同于主频的速度工作，可以为CPU提供更高的传输速度。

2、MyBatis二级缓存出现的原因

之所以称之为"二级缓存"，是相对于"一级缓存"而言的。既然有了一级缓存，那么为什么要提供二级缓存呢？我们知道，在一级缓存中，不同session进行相同SQL查询的时候，是查询两次数据库的。显然这是一种浪费，既然SQL查询相同，就没有必要再次查库了，直接利用缓存数据即可，这种思想就是MyBatis二级缓存的初衷。

另外，Spring和MyBatis整合时，每次查询之后都要进行关闭sqlsession，关闭之后数据被清空。所以MyBatis和Spring整合之后，一级缓存是没有意义的。如果开启二级缓存，关闭sqlsession后，会把该sqlsession一级缓存中的数据添加到mapper namespace的二级缓存中。这样，缓存在sqlsession关闭之后依然存在。

3、MyBatis二级缓存的设置

默认情况下，MyBatis只启用了本地的会话缓存，它仅仅对一个会话中的数据进行缓存，见：MyBatis一级缓存介绍。要启用全局的二级缓存，只需要在SQL映射文件中添加一行：

二级缓存是Mapper级别的缓存，多个SqlSession去操作同一个Mapper的sql语句，多个SqlSession可以共用二级缓存，二级缓存是跨SqlSession的。

上面这个简单语句的效果如下:

映射语句文件中的所有 select 语句的结果将会被缓存。

映射语句文件中的所有 insert、update 和 delete 语句会刷新缓存。

缓存会使用最近最少使用算法（LRU, Least Recently Used）算法来清除不需要的缓存。

缓存不会定时进行刷新（也就是说，没有刷新间隔）。

缓存会保存列表或对象的1024个引用。

缓存会被视为读/写缓存，这意味着获取到的对象并不是共享的，可以安全地被调用者修改，而不干扰其他调用者或线程所做的潜在修改。

提示：缓存只作用于 cache 标签所在的映射文件中的语句。如果你混合使用 Java API 和 XML 映射文件，在共用接口中的语句将不会被默认缓存。你需要使用 @CacheNamespaceRef 注解指定缓存作用域。

这些属性可以通过 cache 元素的属性来修改。比如：

<cache
  eviction="FIFO"
  flushInterval="60000"
  size="512"
  readOnly="true"/>

这个更高级的配置创建了一个 FIFO 缓存，每隔 60 秒刷新，最多可以存储结果对象或列表的 512 个引用，而且返回的对象被认为是只读的，因此对它们进行修改可能会在不同线程中的调用者产生冲突。

可用的清除策略有：

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

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

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

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

默认的清除策略是 LRU。

flushInterval（刷新间隔）属性可以被设置为任意的正整数，设置的值应该是一个以毫秒为单位的合理时间量。 默认情况是不设置，也就是没有刷新间隔，缓存仅仅会在调用语句时刷新。

size（引用数目）属性可以被设置为任意正整数，要注意欲缓存对象的大小和运行环境中可用的内存资源。默认值是 1024。

readOnly（只读）属性可以被设置为 true 或 false。只读的缓存会给所有调用者返回缓存对象的相同实例。 因此这些对象不能被修改。这就提供了可观的性能提升。而可读写的缓存会（通过序列化）返回缓存对象的拷贝。 速度上会慢一些，但是更安全，因此默认值是 false。

提示：二级缓存是事务性的。这意味着，当 SqlSession 完成并提交时，或是完成并回滚，但没有执行 flushCache=true 的 insert/delete/update 语句时，缓存会获得更新。

4、MyBatis 使用自定义缓存

除了上述自定义缓存的方式，你也可以通过实现自己的缓存，或为其他第三方缓存方案创建适配器，来完全覆盖缓存行为。

这个示例展示了如何使用一个自定义的缓存实现。type 属性指定的类必须实现 org.mybatis.cache.Cache 接口，且提供一个接受 String 参数作为 id 的构造器。 这个接口是 MyBatis 框架中许多复杂的接口之一，但是行为却非常简单，代码如下所示：

public interface Cache {
  String getId();
  int getSize();
  void putObject(Object key, Object value);
  Object getObject(Object key);
  boolean hasKey(Object key);
  Object removeObject(Object key);
  void clear();
}

为了对你的缓存进行配置，只需要简单地在你的缓存实现类中添加公有的 JavaBean 属性，然后通过 cache 元素传递属性值，例如，下面的例子将在你的缓存实现类上调用一个名为 setCacheFile(String file) 的方法：

<cache type="cn.mybatis.mydemo.mycache.MyCustomCache">
  <property name="cacheFile" value="/tmp/my-custom-cache.tmp"/>
</cache>

你可以使用所有简单类型作为JavaBean 属性的类型，MyBatis会进行转换。你也可以使用占位符（如 ${cache.file}），以便替换成在配置文件属性中定义的值。

从版本 3.4.2 开始，MyBatis 已经支持在所有属性设置完毕之后，调用一个初始化方法。这样就可以在上面定义的MyCustomCache里面获取配置文件设置的cacheFile属性。如果想要使用这个特性，请在你的自定义缓存类里实现 org.apache.ibatis.builder.InitializingObject 接口。

public interface InitializingObject {
  void initialize() throws Exception;
}

提示：上文中对缓存的配置（如清除策略、可读或可读写等），不能应用于自定义缓存。

请注意，缓存的配置和缓存实例会被绑定到 SQL 映射文件的命名空间中。 因此，同一命名空间中的所有语句和缓存将通过命名空间绑定在一起。 每条语句可以自定义与缓存交互的方式，或将它们完全排除于缓存之外，这可以通过在每条语句上使用两个简单属性来达成。 默认情况下，语句会这样来配置：

<select ... flushCache="false" useCache="true"/><!--select查询的结果会使用缓存-->
<insert ... flushCache="true"/><!--insert插入操作会清空缓存-->
<update ... flushCache="true"/>
<delete ... flushCache="true"/>

鉴于这是默认行为，显然你永远不应该以这样的方式显式配置一条语句。但如果你想改变默认的行为，只需要设置 flushCache 和 useCache 属性。比如，某些情况下你可能希望特定 select 语句的结果排除于缓存之外，或希望一条 select 语句清空缓存。类似地，你可能希望某些 update 语句执行时不要刷新缓存。

4、MyBatis二级缓存的复用：cache-ref

对某一命名空间的语句，只会使用该命名空间的缓存进行缓存或刷新。但你可能会想要在多个命名空间中共享相同的缓存配置和实例。要实现这种需求，你可以使用 cache-ref 元素来引用另一个缓存。

总结

一级缓存

Mybatis对缓存提供支持，但是在没有配置的默认情况下，它只开启一级缓存，一级缓存只是相对于同一个SqlSession而言。

在参数和SQL完全一样的情况下，我们使用同一个SqlSession对象调用一个Mapper方法，往往只执行一次SQL，因为使用SelSession第一次查询后，MyBatis会将其放在缓存中，以后再查询的时候，如果没有声明需要刷新，并且缓存没有超时的情况下，SqlSession都会取出当前缓存的数据，而不会再次发送SQL到数据库。

1.png

使用一级缓存，还有几个问题我们要注意一下。

（1）一级缓存的生命周期有多长？

a、MyBatis在开启一个数据库会话时，会创建一个新的SqlSession对象，SqlSession对象中会有一个新的Executor对象。Executor对象中持有一个新的PerpetualCache对象；当会话结束时，SqlSession对象及其内部的Executor对象还有PerpetualCache对象也一并释放掉。

b、如果SqlSession调用了close()方法，会释放掉一级缓存PerpetualCache对象，一级缓存将不可用。

c、如果SqlSession调用了clearCache()，会清空PerpetualCache对象中的数据，但是该对象仍可使用。

d、SqlSession中执行了任何一个update操作(update()、delete()、insert()) ，都会清空PerpetualCache对象的数据，但是该对象可以继续使用

（2）怎么判断某两次查询是完全相同的查询？

mybatis认为，对于两次查询，如果以下条件都完全一样，那么就认为它们是完全相同的两次查询。

a、传入的statementId

b、查询时要求的结果集中的结果范围

c、这次查询所产生的最终要传递给JDBC java.sql.Preparedstatement的Sql语句字符串（boundSql.getSql() ）

d、传递给java.sql.Statement要设置的参数值

二级缓存：

MyBatis的二级缓存是Application级别的缓存，它可以提高对数据库查询的效率，以提高应用的性能。

MyBatis的缓存机制整体设计以及二级缓存的工作模式

2.png

SqlSessionFactory层面上的二级缓存默认是不开启的，二级缓存的开启需要进行配置，实现二级缓存的时候，MyBatis要求返回的POJO必须是可序列化的。也就是要求实现Serializable接口，配置方法很简单，只需要在映射XML文件配置就可以开启缓存了，如果我们配置了二级缓存就意味着：

（1）映射语句文件中的所有select语句将会被缓存。

（2）映射语句文件中的所有insert、update和delete语句会刷新缓存。

（3）缓存会使用默认的Least Recently Used（LRU，最近最少使用的）算法来收回。

（4）根据时间表，比如No Flush Interval,（CNFI没有刷新间隔），缓存不会以任何时间顺序来刷新。

（5）缓存会存储列表集合或对象(无论查询方法返回什么)的1024个引用

（6）缓存会被视为是read/write(可读/可写)的缓存，意味着对象检索不是共享的，而且可以安全的被调用者修改，不干扰其他调用者或线程所做的潜在修改。