Spring Boot集成EhCache缓存

在Java项目中，许多情况下需要用到缓存。笔者接触过的缓存框架有EhCache、Redis、MongoDB，可是由于搞不清楚其中的区别，曾经面试过一些公司被问到EhCache和Redis的区别是什么？为什么项目中用到了EhCache二级缓存，却又用到了Redis，其中的区别是什么？当时由于技术储备有限，未能正确回答出这些问题，工作机会也失之交臂。最近一段时间仔细研究了EhCache，这篇文章将从应用的层面讲讲如何在Spring Boot中使用EhCache。

一、使用说明

在一个Spring Boot项目中，引入EhCache依赖，然后在主启动类里面加上@EnableCaching开启缓存机制，然后配置EhCache配置文件，就可以使用EhCache缓存了。

二、引入配置依赖

第一在Maven的pom.xml中加入EhCache依赖:

<!– EhCache –><!–开启 cache 缓存–>

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-cache</artifactId>

</dependency>

<!– ehcache 缓存 –>

<dependency>

<groupId>net.sf.ehcache</groupId>

<artifactId>ehcache</artifactId>

</dependency>

然后在src/main/resources里面新增加入ehcache.xml,文件，指定缓存空间interfaces，内容如下:

<cache

eternal=”false”

maxElementsInMemory=”100″

overflowToDisk=”false”

diskPersistent=”false”

timeToIdleSeconds=”0″

timeToLiveSeconds=”300″ memoryStoreEvictionPolicy=”LRU” />

指定磁盘缓存位置:

<!– diskStore：为缓存路径，ehcache分为内存和磁盘两级，此属性定义磁盘的缓存位置。参数解释如下： user.home – 用户主目录 user.dir – 用户当前工作目录 java.io.tmpdir – 默认临时文件路径 –><diskStore path=”
java.io.tmpdir/Tmp_EhCache”/>

<defaultCache eternal=”false”

maxElementsInMemory=”1000″

overflowToDisk=”false”

diskPersistent=”false”

timeToIdleSeconds=”0″

timeToLiveSeconds=”600″ memoryStoreEvictionPolicy=”LRU” />

完整的代码如下:

<?xml version=”1.0″ encoding=”UTF-8″?>

<ehcache xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xsi:noNamespaceSchemaLocation=”ehcache.xsd” updateCheck=”false”>

<!– diskStore：为缓存路径，ehcache分为内存和磁盘两级，此属性定义磁盘的缓存位置。参数解释如下： user.home – 用户主目录 user.dir – 用户当前工作目录 java.io.tmpdir – 默认临时文件路径 –> <diskStore path=”
java.io.tmpdir/Tmp_EhCache”/>

<defaultCache eternal=”false” maxElementsInMemory=”1000″ overflowToDisk=”false” diskPersistent=”false” timeToIdleSeconds=”0″ timeToLiveSeconds=”600″ memoryStoreEvictionPolicy=”LRU” />

<!– 这里的 users 缓存空间是为了下面的 demo 做准备 –>

<cache eternal=”false” maxElementsInMemory=”100″ overflowToDisk=”false” diskPersistent=”false” timeToIdleSeconds=”0″ timeToLiveSeconds=”300″ memoryStoreEvictionPolicy=”LRU” />

其中ehcache.xsd需要在src/main/resources新建文件，内容如下:

然后在Spring Boot主启动类加上开启缓存:

三、业务实现

新建hx_sys_interface_config表，表结构如下:

新建SysInterfaceConfig实体类,代码如下:

新增MyBatis，DAO层
SysInterfaceConfigMapper.java:

其MyBatis XML映射文件
SysInterfaceConfigMapper.xml增删改查代码如下：

四、引入EhCache缓存

编写
SysInterfaceConfigServiceImpl.java在Service层加入缓存标志:

新增方法，@CacheEvict加入缓存空间interfaces(前面ehcache.xml中配置的缓存空间):

删除方法，从缓存空间@CacheEvic去掉缓存键:

//删除用户数据

@CacheEvict(value = DEMO_CACHE_NAME,key = “'interface_'+#id”)//这是清除缓存

@Override

public void delInterfaceConfig(String id)

{

sysInterfaceConfigMapper.delInterfaceConfig(id);

}

更新用户数据，重新设置缓存@CachePut:

//更新用户数据

@CachePut(value = DEMO_CACHE_NAME,key = “'interface_'+#sysInterfaceConfig.getId()”)@Override

public void updateInterfaceConfig(SysInterfaceConfig sysInterfaceConfig)

{

sysInterfaceConfigMapper.updateInterfaceConfig(sysInterfaceConfig);

}

从缓存中取出数据,@Cacheable,从缓存空间缓存键取出数据:

@Cacheable(value=DEMO_CACHE_NAME,key=”'interface_'+#id”)

@Override

public SysInterfaceConfig findInterfaceConfig(String id)

{

return sysInterfaceConfigMapper.findInterfaceConfig(id);

}

五、测试EhCache缓存

开启SQL打印，在application.yml中开启DAO层SQL打印:

编写Controller层:

测试插入缓存数据:

测试查询缓存数据:

测试更新缓存数据:

测试删除缓存数据:

在Swagger UI界面中:

点击testInsert:

查看控制台的SQL语句:

: ==> Preparing: INSERT INTO hx_sys_interface_config(ID,APP_CODE,`NAME`,APP_NUM,URL,APP_TEST,END_DATE,STATUS,REMARK1,REMARK2) VALUES(?,?,?,?,?,?,?,?,?,?)

2019-11-05 18:20:43.727 DEBUG 21356 — [nio-8480-exec-8]
c.o.c.m.t.S.insertInterfaceConfig : ==> Parameters: 3(String), htest(String), 接口:4(String), 004(String), www.baidu.com(String), www.baidu.com?i=4(String), 2019-11-05 18:20:43.679(Timestamp), 1(String), remark1(String), remark2(String)

2019-11-05 18:20:43.770 DEBUG 21356 — [nio-8480-exec-8] c.o.c.m.t.S.insertInterfaceConfig : <== Updates: 1

Swagger界面点击testSelect:

控制台SQL打印:

2019-11-05 18:23:20.311 DEBUG 21356 — [nio-8480-exec-7] c.o.c.m.t.S.findInterfaceConfig : ==> Preparing: SELECT * FROM hx_sys_interface_config WHERE ID=?

2019-11-05 18:23:20.312 DEBUG 21356 — [nio-8480-exec-7] c.o.c.m.t.S.findInterfaceConfig : ==> Parameters: 3(String)

2019-11-05 18:23:20.338 DEBUG 21356 — [nio-8480-exec-7] c.o.c.m.t.S.findInterfaceConfig : <== Total: 1

id:3,name:接口:4,appNum:004,endDate:2019-11-05 18:20:44

再在Swagger界面点击testSelect:

可以看到控制台没有打印SQL，没有查询数据库，说明走了缓存，从缓存中取数据:

查看界面结果，从缓存中取数据:

在Swagger界面点击testUpdate,更新缓存:

控制台更新了数据:

: ==> Preparing: UPDATE hx_sys_interface_config SET APP_CODE=?,`NAME`=?,APP_NUM=?,URL=?,APP_TEST=?, END_DATE=?,STATUS=?,REMARK1=?,REMARK2=? WHERE ID=?

2019-11-05 18:27:49.148 DEBUG 21356 — [nio-8480-exec-6]
c.o.c.m.t.S.updateInterfaceConfig : ==> Parameters: htest(String), 更新后接口(String), 更新后编号(String), www.baidu.com(String), www.baidu.com?i=4(String), 2019-11-05 18:27:49.096(Timestamp), 1(String), remark1(String), remark2(String), 3(String)

2019-11-05 18:27:49.191 DEBUG 21356 — [nio-8480-exec-6] c.o.c.m.t.S.updateInterfaceConfig : <== Updates: 1

在Swagger UI点击testSelect:

查询，控制台没有打印SQL语句，查询成功，从缓存中取出数据,成功

这篇文档简单的说明了Spring Boot集成EhCache的使用方法，后续还会更新。