Java工程师 MyBatis缓存

概述

MyBatis缓存的使用非常重要。缓存可以有效地提高应用程序的性能，减少数据库访问次数，加快数据读取速度。MyBatis提供了多种缓存机制，包括本地缓存、二级缓存和自定义缓存。

合理地配置和使用缓存可以有效地减少数据库压力，并提升系统的整体性能和响应速度。在使用MyBatis的缓存时，需要根据实际业务场景和需求来进行合理的配置和管理。

一级缓存（本地缓存）

一级缓存（Local Cache）是基于每个SqlSession会话的，它在会话开始时被创建，会话结束时被销毁。它默认是开启的，它主要用来减少同一个会话期间对数据库的多次访问。

代码举例

（1）在下面的例子中验证一级缓存，第二次查询id为3的monster直接从一级缓存中取数据而不再去数据库中查询

@Test
public void level1CacheTest() {
    // 查询id为3的monster
    Monster monster = monsterMapper.getMonsterById(3);
    System.out.println("monster=" + monster);
    
    // 查询id为8的monster
    monsterMapper.getMonsterById(8);

    System.out.println("###### 一级缓存默认是打开的,当再次查询相同的id时,不会再发出sql ######");
    Monster monster2 = monsterMapper.getMonsterById(3);
    System.out.println("monster2=" + monster2);
    ...
}

注意下图的红色框框住的是二级日志信息，命中率为0.0

（2）在下面的例子中一级缓存手动清空sqlSession.clearCache(); 之后第三次查询会发送SQL到数据库

一级缓存失效分析： 关闭 sqlSession 会话或者手动清空一级缓存后, 再次查询，会到数据库查询

@Test
public void level1CacheTest() {
    // 查询id为3的monster
    Monster monster = monsterMapper.getMonsterById(3);
    System.out.println("monster=" + monster);
    // 查询id为8的monster
    monsterMapper.getMonsterById(8);

    // 手动清除一级缓存
    sqlSession.clearCache();

    System.out.println("###### 手动清除一级缓存,当再次查询相同的id时,会再次发出sql ######");
    Monster monster2 = monsterMapper.getMonsterById(3);
    System.out.println("monster2=" + monster2);
    ...
}

一级缓存Debug

二级缓存

二级缓存（Global Cache）是基于命名空间的，可以被多个SqlSession共享。它需要明确地配置来启用。二级缓存的作用域更广，生命周期也更长，它可以跨会话、跨事务进行数据缓存。

开启二级缓存

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
		PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
		"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
	<!-- 不使用别称 使用类名全称(全包名) -->
	<settings>
        <!--
            1、全局性地开启或关闭二级缓存和三方缓存
            2、默认就是true 一般不需要做显示配置
        -->
		<setting name="cacheEnabled" value="true" />
        ...
    </settings>
</configuration>

在对应的 XxxMapper.xml 中设置二级缓存的策略

<mapper namespace="com.bigbigmeng.aurora_sync.infra.dal.dao.UserDao">
	<!-- 
		【在对应的 XxxMapper.xml 中设置二级缓存的策略】
		(1) eviction="FIFO" : 缓存策略 先进先出
		(2) flushInterval="30000": 每30000毫秒 刷新一次 和数据库保持一致
		(3) size:二级缓存设置最大保持的360个对象 超过了就启用fifo策略处理 默认1024
		(4) readOnly: 只读，为了提高效率
	-->
	<cache eviction="FIFO" flushInterval="30000" size="360" readOnly="true"/>
	...
</mapper>

代码测试

//测试二级缓存的使用
@Test
public void level2CacheTest() {
    //查询id=3的monster
    Monster monster = monsterMapper.getMonsterById(3);
    System.out.println("monster=" + monster);

    //关闭sqlSession
    if (sqlSession != null) {
        sqlSession.close();
    }

    //重新获取sqlSession
    sqlSession = MyBatisUtils.getSqlSession();
    //重新获取了monsterMapper
    monsterMapper = sqlSession.getMapper(MonsterMapper.class);
    //再次查询id=3的monster
    System.out.println("###### 虽然前面关闭了sqlSession,因为配置二级缓存, " +
            "当你再次查询相同的id时, 依然不会再发出sql, 而是从二级缓存获取数据 ######");
    Monster monster2 = monsterMapper.getMonsterById(3);
    System.out.println("monster2=" + monster2);

    Monster monster3 = monsterMapper.getMonsterById(3);
    System.out.println("monster3=" + monster3);

    if (sqlSession != null) {
        sqlSession.close();
    }
}

Mybatis 缓存执行顺序

二级缓存 -> 一级缓存 -> 数据库 这个结论可以从上面的例子中得出，由于二级缓存最优先访问，所以命中率才会从第一次的0.0 到第二次的0.5 再到第三次的0.666666

EhCache三方缓存

添加依赖

<!-- 20240420 EHCache三方缓存 -->
<dependency>
    <groupId>net.sf.ehcache</groupId>
    <artifactId>ehcache-core</artifactId>
    <version>2.6.11</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
</dependency>
<dependency>
    <groupId>org.mybatis.caches</groupId>
    <artifactId>mybatis-ehcache</artifactId>
    <version>1.2.1</version>
</dependency>

mybatis-config.xml 仍然打开二级缓存

<!-- 使全局的映射器启用或禁用缓存 -->
<setting name="cacheEnabled" value="true" />

aurora-sync-infra-dal\src\main\resources目录下添加配置文件ehcache.xml

<?xml version="1.0" encoding="UTF-8"?>
<ehcache>
    <!--
       diskStore：为缓存路径，ehcache分为内存和磁盘两级，此属性定义磁盘的缓存位置。参数解释如下：
       user.home – 用户主目录
       user.dir  – 用户当前工作目录
       java.io.tmpdir – 默认临时文件路径
     -->
    <diskStore path="java.io.tmpdir/Tmp_EhCache"/>
    <!--
       defaultCache：默认缓存策略，当ehcache找不到定义的缓存时，则使用这个缓存策略。只能定义一个。
     -->
    <!--
      name:缓存名称。
      maxElementsInMemory:缓存最大数目
      maxElementsOnDisk：硬盘最大缓存个数。
      eternal:对象是否永久有效，一但设置了，timeout将不起作用。
      overflowToDisk:是否保存到磁盘，当系统宕机时
      timeToIdleSeconds:设置对象在失效前的允许闲置时间（单位：秒）。仅当eternal=false对象不是永久有效时使用，可选属性，默认值是0，也就是可闲置时间无穷大。
      timeToLiveSeconds:设置对象在失效前允许存活时间（单位：秒）。最大时间介于创建时间和失效时间之间。仅当eternal=false对象不是永久有效时使用，默认是0.，也就是对象存活时间无穷大。
      diskPersistent：是否缓存虚拟机重启期数据 Whether the disk store persists between restarts of the Virtual Machine. The default value is false.
      diskSpoolBufferSizeMB：这个参数设置DiskStore（磁盘缓存）的缓存区大小。默认是30MB。每个Cache都应该有自己的一个缓冲区。
      diskExpiryThreadIntervalSeconds：磁盘失效线程运行时间间隔，默认是120秒。
      memoryStoreEvictionPolicy：当达到maxElementsInMemory限制时，Ehcache将会根据指定的策略去清理内存。默认策略是LRU（最近最少使用）。你可以设置为FIFO（先进先出）或是LFU（较少使用）。
      clearOnFlush：内存数量最大时是否清除。
      memoryStoreEvictionPolicy:可选策略(清除策略)有：LRU（最近最少使用，默认策略）、FIFO（先进先出）、LFU（最少访问次数）。
      FIFO，first in first out，这个是大家最熟的，先进先出。
      LFU， Less Frequently Used，就是上面例子中使用的策略，直白一点就是讲一直以来最少被使用的。如上面所讲，缓存的元素有一个hit属性，hit值最小的将会被清出缓存。
      LRU，Least Recently Used，最近最少使用的，缓存的元素有一个时间戳，当缓存容量满了，而又需要腾出地方来缓存新的元素的时候，那么现有缓存元素中时间戳离当前时间最远的元素将被清出缓存。
   -->
    <defaultCache
            eternal="false"
            maxElementsInMemory="10000"
            overflowToDisk="false"
            diskPersistent="false"
            timeToIdleSeconds="1800"
            timeToLiveSeconds="259200"
            memoryStoreEvictionPolicy="LRU"/>

</ehcache>

在 XxxMapper.xml 中启用 EhCache ，当然原来 MyBatis 自带的缓存配置就注销了

<mapper namespace="com.bigbigmeng.aurora_sync.infra.dal.dao.UserDao">
	<!-- 
		【在对应的 XxxMapper.xml 中设置二级缓存的策略】
		(1) eviction="FIFO" : 缓存策略 先进先出
		(2) flushInterval="30000": 每30000毫秒 刷新一次 和数据库保持一致
		(3) size:二级缓存设置最大保持的360个对象 超过了就启用fifo策略处理 默认1024
		(4) readOnly: 只读，为了提高效率
	<cache eviction="FIFO" flushInterval="30000" size="360" readOnly="true"/> -->
    
	<cache type="org.mybatis.caches.ehcache.EhcacheCache"/>
	...
</mapper>

代码测试

//测试ehCache级缓存
@Test
public void ehCacheTest() {
    //查询id=3的monster
    Monster monster = monsterMapper.getMonsterById(3);
    //会发出SQL, 到db查询
    System.out.println("monster=" + monster);

    //关闭sqlSession, 一级缓存[数据]失效.=> 将数据放入到二级缓存 (ehcache)
    if (sqlSession != null) {
        sqlSession.close();
    }

    //重新获取sqlSession
    sqlSession = MyBatisUtils.getSqlSession();
    //重新获取了monsterMapper
    monsterMapper = sqlSession.getMapper(MonsterMapper.class);
    //再次查询id=3的monster
    System.out.println("###### 虽然前面关闭了sqlSession,因为配置二级缓存(ehcache), " +
            "当你再次查询相同的id时, 不会再发出sql, 而是从二级缓存(ehcache)获取数据 ######");
    Monster monster2 = monsterMapper.getMonsterById(3);
    System.out.println("monster2=" + monster2);

    //再次查询id=3的monster, 仍然到二级缓存(ehcache), 获取数据, 不会发出sql
    Monster monster3 = monsterMapper.getMonsterById(3);
    System.out.println("monster3=" + monster3);

    if (sqlSession != null) {
        sqlSession.close();
    }
}

完结撒花~