mybatis 使用第三方缓存 EHCache 的配置

Posted 2022-12-16 猎人在吃肉

1、说明

mybatis 有一级缓存和二级缓存。其中，一级缓存是内置的，默认开启的，无法更改；二级缓存默认是关闭的，需要进行各种配置，才能开启。由于mybatis 不是专业的缓存厂商，因此除了内置了一套二缓缓存外，还提供了一套之实现二级缓存的接口，便于专业的缓存厂商来实现。 EHCache 就是实现 mybatis 二级缓存的产品之一。

无论是mybatis 内置的二级缓存，还是第三方实现的二级缓存，除了缓存本身需要进行一定的配置外，一般来说， 开发者的业务代码不需要做任何变动。

下面是 mybatis 二级缓存 EHCache 的配置

2、EHCache 的配置

1）依赖

<!-- Mybatis EHCache整合包 -->
<dependency>
	<groupId>org.mybatis.caches</groupId>
	<artifactId>mybatis-ehcache</artifactId>
	<version>1.2.1</version>
</dependency>


<!-- slf4j日志门面的一个具体实现 -->
<dependency>
	<groupId>ch.qos.logback</groupId>
	<artifactId>logback-classic</artifactId>
	<version>1.2.3</version>
</dependency>

2）各个jar包的功能说明

jar包名称	作用
mybatis-ehcache	Mybatis 和 EHCache的整合包
ehcache	EHCache 核心包
slf4j-api	SLF4J 日志门面包
logback-classic	支持 SLF4J 门面接口的一个具体实现

3）创建EHCache的配置文件 ehcache.xml

<?xml version="1.0" encoding="utf-8" ?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xsi:noNamespaceSchemaLocation="../config/ehcache.xsd">

	<!-- 磁盘保存路径 -->
	<diskStore path="D:\\ehcache"/>
	
	<defaultCache
		maxElementsInMemory="1000"
		maxElementsOnDisk="10000000"
		eternal="false"
		overflowToDisk="true"
		timeToIdleSeconds="120"
		timeToLiveSeconds="120"
		diskExpiryThreadIntervalSeconds="120"
		memoryStoreEvictionPolicy="LRU">
	</defaultCache>
	
</ehcache>

4）指定二级缓存的类型

在 XxxMapper.xml 中，<cache /> 默认二级缓存是mybatis内置的，改成 EHCache 的二级缓存。

<cache type="org.mybatis.caches.ehcache.EhcacheCache"/>

5）加入logback日志

存在 SLF4J 时，作为简易日志的 log4j 将失效，此时我们需要借助 SLF4J 的具体实现 logback 来打印日志。
创建 logback 的配置文件 logback.xml。

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true">

	<!-- 指定日志输出的位置 -->
	<appender name="STDOUT"  class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<!-- 日志输出的格式 -->
			<!-- 按照顺序分别是：时间、日志级别、线程名称、打印日志的类、日志主体内容、换行 -
			->
			<pattern>[%dHH:mm:ss.SSS] [%-5level] [%thread] [%logger][%msg]%n</pattern>
		</encoder>
	</appender>


	<!-- 设置全局日志级别。日志级别按顺序分别是：DEBUG、INFO、WARN、ERROR -->
	<!-- 指定任何一个日志级别都只打印当前级别和后面级别的日志。 -->
	<root level="DEBUG">
		<!-- 指定打印日志的appender，这里通过“STDOUT”引用了前面配置的appender -->
		<appender-ref ref="STDOUT" />
	</root>

	<!-- 根据特殊需求指定局部日志级别 -->
	<logger name="com.test.myApp.mapper" level="DEBUG"/>
</configuration>

6） EHCache 配置参数说明

属性名	是否必须	作用
maxElementsInMemory	是	在内存中缓存的element的最大数目
maxElementsOnDisk	是	在磁盘上缓存的element的最大数目，若是0表示无穷大
eternal	是	设定缓存的elements是否永远不过期。 如果为 true，则缓存的数据始终有效， 如果为 false，那么还要根据timeToIdleSeconds、imeToLiveSeconds判断
overflowToDisk	是	设定当内存缓存溢出的时候是否将过期的element缓存到磁盘上
timeToIdleSeconds	否	当缓存在EhCache中的数据前后两次访问的时间超过 timeToIdleSeconds 的属性取值时， 这些数据便会删除。 默认值是0，也就是可闲置时间无穷大
timeToLiveSeconds	否	缓存element的有效生命期。默认是0，也就是element存活时间无穷大
diskSpoolBufferSizeMB	否	DiskStore(磁盘缓存)的缓存区大小。默认是30MB。每个Cache都应该有自己的一个缓冲区
diskPersistent	否	在VM重启的时候是否启用磁盘保存EhCache中的数据，默认是false。
diskExpiryThreadIntervalSeconds	否	磁盘缓存的清理线程运行间隔，默认是120秒。每个120s， 相应的线程会进行一次EhCache中数据的清理工作
memoryStoreEvictionPolicy	否	当内存缓存达到最大，有新的element加入的时候， 移除缓存中element的策略。 默认是LRU（最近最少使用），可选的有LFU（最不常使用）和FIFO（先进先出）