Spring Boot整合EhCache的步骤详解

2023-08-01 22:29:04 279

本文讲解SpringBoot与EhCache的整合。

1EhCache简介

EhCache是一个纯Java的进程内缓存框架，具有快速、精干等特点，是Hibernate中默认CacheProvider。Ehcache是一种广泛使用的开源Java分布式缓存。主要面向通用缓存，JavaEE和轻量级容器。它具有内存和磁盘存储，缓存加载器，缓存扩展，缓存异常处理程序，一个gzip缓存servlet过滤器，支持REST和SOAPapi等特点。

2SpringBoot整合EhCache步骤2.1创建项目，导入依赖



4.0.0
com.yiidian
ch03_10_springboot_ehcache
1.0-SNAPSHOT



org.springframework.boot
spring-boot-starter-parent
2.1.11.RELEASE




org.springframework.boot
spring-boot-starter-web



org.springframework.boot
spring-boot-starter-test
2.1.6.RELEASE
test




org.springframework.boot
spring-boot-starter-cache
2.1.11.RELEASE



net.sf.ehcache
ehcache
2.10.6

2.2配置ehcache.xml

在resources目录下建立ehcache.xml，内容如下：

参数说明

name缓存名称
maxElementsInMemory缓存最大个数
eternal对象是否永久有效，一但设置了，timeout将不起作用
timeToIdleSeconds设置对象在失效前的允许闲置时间（单位：秒）。仅当eternal=false对象不是永久有效时使用，可选属性，默认值是0，也就是可闲置时间无穷大
timeToLiveSeconds设置对象在失效前允许存活时间（单位：秒）。最大时间介于创建时间和失效时间之间。仅当eternal=false对象不是永久有效时使用，默认是0.，也就是对象存活时间无穷大

overflowToDisk当内存中对象数量达到maxElementsInMemory时，Ehcache将会对象写到磁盘中
diskSpoolBufferSizeMB这个参数设置DiskStore（磁盘缓存）的缓存区大小。默认是30MB。每个Cache都应该有自己的一个缓冲区
maxElementsOnDisk硬盘最大缓存个数
diskPersistent是否缓存虚拟机重启期数据
diskExpiryThreadIntervalSeconds磁盘失效线程运行时间间隔，默认是120秒。
memoryStoreEvictionPolicy当达到maxElementsInMemory限制时，Ehcache将会根据指定的策略去清理内存。默认策略是LRU（最近最少使用）。你可以设置为FIFO（先进先出）或是LFU（较少使用）
clearOnFlush内存数量最大时是否清除

2.3编写application.yml

#配置EhCache的配置
spring:
cache:
ehcache:
config:ehcache.xml#读取ehcache.xml配置

2.4编写引导类

packagecom.yiidian;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
importorg.springframework.boot.web.servlet.FilterRegistrationBean;
importorg.springframework.boot.web.servlet.ServletListenerRegistrationBean;
importorg.springframework.boot.web.servlet.ServletRegistrationBean;
importorg.springframework.cache.annotation.EnableCaching;
importorg.springframework.context.annotation.Bean;
/**
*SpringBoot引导类
*一点教程网-www.yiidian.com
*/
@SpringBootApplication
@EnableCaching//开启缓存
publicclassMyBootApplication{
publicstaticvoidmain(String[]args){
SpringApplication.run(MyBootApplication.class,args);
}
}

引导类中需要添加@EnableCaching注解，开启缓存功能

2.5编写Service类

packagecom.yiidian.service;
importcom.yiidian.domain.Customer;
importorg.springframework.cache.annotation.Cacheable;
importorg.springframework.stereotype.Service;
/**
*业务层
*一点教程网-www.yiidian.com
*/
@Service
publicclassCustomerService{
@Cacheable(value="customer",key="#id")
publicCustomerfindById(Integerid){
System.out.println("执行了UserService获取User");
Customercustomer=newCustomer();
customer.setId(1);
customer.setName("小明");
customer.setGender("男");
customer.setTelephone("13244445555");
returncustomer;
}
}

@Cacheable的属性：

value：对应ehcache.xml的缓存配置名称（name属性值）
key：给缓存值起个key，便于Spring内部检索不同的缓存数据。#id这个语法代表把方法形参作为key。

2.6编写测试类

packagecom.yiidian.test;

importcom.yiidian.MyBootApplication;
importcom.yiidian.service.CustomerService;
importorg.junit.Test;
importorg.junit.runner.RunWith;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.boot.test.context.SpringBootTest;
importorg.springframework.test.context.junit4.SpringJUnit4ClassRunner;

/**
*SpringBoot整合EhCache
*一点教程网-www.yiidian.com
*/
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes=MyBootApplication.class)
publicclassEhCacheDemo{
@Autowired
privateCustomerServicecustomerService;

@Test
publicvoidtest1(){
//查询第一次
System.out.println(customerService.findById(1));
//查询第二次
System.out.println(customerService.findById(1));
}
}

2.7运行测试

从结果可以看出，第一次调用Service的时候，到Service内部获取数据。但是第二次调用Service时已经不需要从Service获取数据，证明第一次查询的时候已经把Customer对象缓存到EhCache中。

3EhCache常用注解@Cacheable：主要针对方法配置，能够根据方法的请求参数对其进行缓存@CacheConfig：统一配置本类的缓存注解的属性@CachePut：保证方法被调用，又希望结果被缓存。与@Cacheable区别在于是否每次都调用方法，常用于更新@CacheEvict：清空缓存@Cacheable/@CachePut/@CacheEvict主要的参数:value：缓存的名称，在spring配置文件中定义，必须指定至少一个

例如：

@Cacheable(value=”mycache”)或者

@Cacheable(value={”cache1”,”cache2”}

key：缓存的key，可以为空，如果指定要按照SpEL表达式编写，

如果不指定，则缺省按照方法的所有参数进行组合

例如：

@Cacheable(value=”testcache”,key=”#id”)

condition：缓存的条件，可以为空，使用SpEL编写，返回true或者false，

只有为true才进行缓存/清除缓存

例如：@Cacheable(value=”testcache”,condition=”#userName.length()>2”)

unless否定缓存。当条件结果为TRUE时，就不会缓存。

@Cacheable(value=”testcache”,unless=”#userName.length()>2”)

allEntries

(@CacheEvict)：是否清空所有缓存内容，缺省为false，如果指定为true，

则方法调用后将立即清空所有缓存

例如：

@CachEvict(value=”testcache”,allEntries=true)

beforeInvocation

(@CacheEvict)：是否在方法执行前就清空，缺省为false，如果指定为true，

则在方法还没有执行的时候就清空缓存，缺省情况下，如果方法

执行抛出异常，则不会清空缓存

例如：

@CachEvict(value=”testcache”，beforeInvocation=true)

3.1@Cacheable

@Cacheable注解会先查询是否已经有缓存，有会使用缓存，没有则会执行方法并缓存。

@Cacheable(value="customer",key="targetClass+methodName+#p0")
publicListqueryAll(Customercust){
returncustomerDao.findAllByUid(cust);
}

3.2@CacheConfig

当我们需要缓存的地方越来越多，你可以使用@CacheConfig(cacheNames={"myCache"})注解来统一指定value的值，这时可省略value，如果你在你的方法依旧写上了value，那么依然以方法的value值为准。

使用方法如下：

@CacheConfig(cacheNames={"myCache"})
publicclassUserServiceImplimplementsUserService{
@Override
@Cacheable(key="targetClass+methodName+#p0")//此处没写value
publicListfindUsers(intnum){
returnuserDao.findUsers(num);
}
.....
}

3.3@CachePut

@CachePut注解的作用主要针对方法配置，能够根据方法的请求参数对其结果进行缓存，和@Cacheable不同的是，它每次都会触发真实方法的调用。简单来说就是用户更新缓存数据。但需要注意的是该注解的value和key必须与要更新的缓存相同，也就是与@Cacheable相同。示例：

@CachePut(value="customer",key="targetClass+#p0")
publicCustomerupdata(Customercust){
Customercustomer=customerDao.findAllById(cust.getId());
customer.updata(cust);
returncustomer;
}

@Cacheable(value="customer",key="targetClass+#p0")//清空缓存
publicCustomersave(Customercust){
customerDao.save(cust);
returncust;
}

3.4@CacheEvict

@CachEvict的作用主要针对方法配置，能够根据一定的条件对缓存进行清空。

@Cacheable(value="customer",key="#p0.id")
publicCustomersave(Customercust){
customerDao.save(cust);
returnjob;
}

//清除一条缓存，key为要清空的数据
@CacheEvict(value="customer",key="#id")
publicvoiddelect(intid){
customerDao.deleteAllById(id);
}

//方法调用后清空所有缓存
@CacheEvict(value="customerCache",allEntries=true)
publicvoiddelectAll(){
customerDao.deleteAll();
}

//方法调用前清空所有缓存
@CacheEvict(value="customerCache",beforeInvocation=true)
publicvoiddelectAll(){
customerDao.deleteAll();
}

总结

以上所述是小编给大家介绍的SpringBoot整合EhCache的步骤详解，希望对大家有所帮助！

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

Spring Boot整合EhCache的步骤详解

热门推荐

随机推荐