详解springboot整合ehcache实现缓存机制

网友投稿 253 2023-02-21


详解springboot整合ehcache实现缓存机制

EhCache 是一个纯java的进程内缓存框架,具有快速、精干等特点,是Hibernate中默认的CacheProvider。

ehcache提供了多种缓存策略,主要分为内存和磁盘两级,所以无需担心容量问题。

spring-boot是一个快速的集成框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。

由于spring-boot无需任何样板化的配置文件,所以spring-boot集成一些其他框架时会有略微的不同。

1.spring-boot是一个通过maven管理的jar包的框架,集成ehcache需要的依赖如下

org.springframework

spring-context-support

net.sf.ehcache

ehcache

2.8.3

具体pom.xml文件如下

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

4.0.0

com.lclc.boot

boot-cache

0.0.1-SNAPSHOT

org.springframework.boot

spring-boot-starter-parent

1.1.3.RELEASE

org.springframework.boot

spring-boot-starter-web

org.springframework.boot

spring-boot-starter-data-jpa

org.springframework.boot

spring-boot-starter-thymeleaf

mysql

mysql-connector-java

com.google.guava

guava

17.0

org.springframework

spring-context-support

net.sf.ehcache

ehcache

2.8.3

org.springframework.boot

spring-boot-maven-plugin

spring-snapshots

http://repo.spring.io/snapshot

true

spring-milestones

http://repo.spring.io/milestone

spring-snapshots

http://repo.spring.io/snapshot

spring-milestones

http://repo.spring.io/milestone

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

4.0.0

com.lclc.boot

boot-cache

0.0.1-SNAPSHOT

org.springframework.boot

spring-boot-starter-parent

1.1.3.RELEASE

org.springframework.boot

spring-boot-starter-web

org.springframework.boot

spring-boot-starter-data-jpa

org.springframework.boot

spring-boot-starter-thymeleaf

mysql

mysql-connector-java

com.google.guava

guava

17.0

org.springframework

spring-context-support

net.sf.ehcache

ehcache

2.8.3

org.springframework.boot

spring-boot-maven-plugin

spring-snapshots

http://repo.spring.io/snapshot

true

spring-milestones

http://repo.spring.io/milestone

spring-snapshots

http://repo.spring.io/snapshot

spring-milestones

http://repo.spring.io/milestone

2.使用ehcache,我们需要一个ehcache.xml来定义一些cache的属性。

updateCheck="false">

timeToIdleSeconds="0" timeToLiveSeconds="600" memoryStoreEvictionPolicy="LRU" />

timeToIdleSeconds="0" timeToLiveSeconds="300" memoryStoreEvictionPolicy="LRU" />

updateCheck="false">

timeToIdleSeconds="0" timeToLiveSeconds="600" memoryStoreEvictionPolicy="LRU" />

timeToIdleSeconds="0" timeToLiveSeconds="300" memoryStoreEvictionPolicy="LRU" />

timeToIdleSeconds="0" timeToLiveSeconds="600" memoryStoreEvictionPolicy="LRU" />

timeToIdleSeconds="0" timeToLiveSeconds="300" memoryStoreEvictionPolicy="LRU" />

timeToIdleSeconds="0" timeToLiveSeconds="300" memoryStoreEvictionPolicy="LRU" />

解释下这个xml文件中的标签。

(1).diskStore: 为缓存路径,ehcache分为内存和磁盘两级,此属性定义磁盘的缓存位置。参数解释如下:

user.home – 用户主目录

user.dir  – 用户当前工作目录

java.io.tmpdir – 默认临时文件路径

(2).defaultCache:默认缓存策略,当ehcache找不到定义的缓存时,则使用这个缓存策略。只能定义一个。

(3).cache:自定缓存策略,为自定义的缓存策略。参数解释如下:

cache元素的属性:   

name:缓存名称                  

maxElementsInMemory:内存中最大缓存对象数                  

maxElementsOnDisk:硬盘中最大缓存对象数,若是0表示无穷大                  

eternal:true表示对象永不过期,此时会忽略timeToIdleSeconds和timeToLiveSeconds属性,默认为false                

overflowToDisk:true表示当内存缓存的对象数目达到了maxElementsInMemory界限后,会把溢出的对象写到硬盘缓存中。注意:如果缓存的对象要写入到硬盘中的话,则该对象必须实现了Serializable接口才行。                  

diskSpoolBufferSizeMB:磁盘缓存区大小,默认为30MB。每个Cache都应该有自己的一个缓存区。               

diskPersistent:是否缓存虚拟机重启期数据                  

diskExpiryThreadIntervalSeconds:磁盘失效线程运行时间间隔,默认为120秒     

timeToIdleSeconds: 设定允许对象处于空闲状态的最长时间,以秒为单位。当对象自从最近一次被访问后,如果处于空闲状态的时间超过了timeToIdleSeconds属性值,这个对象就会过期,EHCache将把它从缓存中清空。只有当eternal属性为false,该属性才有效。如果该属性值为0,则表示对象可以无限期地处于空闲状态                  

timeToLiveSeconds:设定对象允许存在于缓存中的最长时间,以秒为单位。当对象自从被存放到缓存中后,如果处于缓存中的时间超过了 timeToLiveSeconds属性值,这个对象就会过期,EHCache将把它从缓存中清除。只有当eternal属性为false,该属性才有效。如果该属性值为0,则表示对象可以无限期地存在于缓存中。timeToLiveSeconds必须大于timeToIdleSeconds属性,才有意义     

memoryStoreEvictionPolicy:当达到maxElementsInMemory限制时,Ehcache将会根据指定的策略去清理内存。可选策略有:LRU(最近最少使用,默认策略)、FIFO(先进先出)、LFU(最少访问次数)。

SpringBoot支持很多种缓存方式:redis、guava、ehcahe、jcache等等。

说明下redis和ehcache的区别:

Redis:属于独立的运行程序,需要单独安装后,使用Java中的Jedis来操纵。因为它是独立,所以如果你写个单元测试程序,放一些数据在Redis中,然后又写一个程序去拿数据,那么是可以拿到这个数据的。,

ehcache:与Redis明显不同,它与java程序是绑在一起的,java程序活着,它就活着。譬如,写一个独立程序放数据,再写一个独立程序拿数据,那么是拿不到数据的。只能在独立程序中才能拿到数据。

3.将ehcache的管理器暴露给spring的上下文容器,

@Configuration

// 标注启动了缓存

@EnableCaching

public class CacheConfiguration {

/*

* ehcache 主要的管理器

*/

@Bean(name = "appEhCacheCacheManager")

public EhCacheCacheManager ehCacheCacheManager(EhCacheManagerFactoryBean bean){

return new EhCacheCacheManager (bean.getObject ());

}

/*

* 据shared与否的设置,Spring分别通过CacheManager.create()或new CacheManager()方式来创建一个ehcache基地.

*/

@Bean

public EhCacheManagerFactoryBean ehCacheManagerFactoryBean(){

EhCacheManagerFactoryBean cacheManagerFactoryBean = new EhCacheManagerFactoryBean ();

cacheManagerFactoryBean.setConfigLocation (new ClassPathResource ("conf/ehcache-app.xml"));

cacheManagerFactoryBean.setShared (true);

return cacheManagerFactoryBean;

}

}

@Configuration:为spring-boot注解,主要标注此为配置类,优UnVxlPn先扫描。

@Bean:向spring容器中加入bean。

至此所有的配置都做好了,通过spring-boot进行集成框架就是这么简单。

4.使用ehcache

使用ehcache主要通过spring的缓存机制,上面我们将spring的缓存机制使用了ehcache进行实现,所以使用方面就完全使用spring缓存机制就行了。

具体牵扯到几个注解:

@Cacheable:负责将方法的返回值加入到缓存中,参数3

@CacheEvict:负责清除缓存,参数4

参数解释:

value:缓存位置名称,不能为空,如果使用EHCache,就是ehcache.xml中声明的cache的name

key:缓存的key,默认为空,既表示使用方法的参数类型及参数值作为key,支持SpEL

condition:触发条件,只有满足条件的情况才会加入缓存,默认为空,既表示全部都加入缓存,支持SpEL

allEntries:CacheEvict参数,true表示清除value中的全部缓存,默认为false

不多说,直接上代码:

@Service

public class CacheDemoServiceImpl implements CacheDemoService {

/**

* 缓存的key

*/

public static final String THING_ALL_KEY = "\"thing_all\"";

/**

* value属性表示使用哪个缓存策略,缓存策略在ehcache.xml

*/

public static final String DEMO_CACHE_NAME = "demo";

@CacheEvict(value = DEMO_CACHE_NAME,key = THING_ALL_KEY)

@Override

public void create(Thing thing){

Long id = getNextId ();

thing.setId (id);

data.put (id, thing);

}

@Cacheable(value = DEMO_CACHE_NAME,key = "#thing.getId()+'thing'")

@Override

public Thing findById(Long id){

System.err.println ("没有走缓存!" + id);

return data.get (id);

}

@Cacheable(value = DEMO_CACHE_NAME,key = THING_ALL_KEY)

@Override

public List findAll(){

return Lists.newArrayList (data.values ());

}

@Override

@CachePut(value = DEMO_CACHE_NAME,key = "#thing.getId()+'thing'")

@CacheEvict(value = DEMO_CACHE_NAME,key = THING_ALL_KEY)

public Thing update(Thing thing){

System.out.println (thing);

data.put (thing.getId (), thing);

return thing;

}

@CacheEvict(value = DEMO_CACHE_NAME)

@Override

public void delete(Long id){

data.remove (id);

}

}

5.只需要通过注解在service层方法上打注解便可以使用缓存,在find**上存入缓存,在delete**,update**上清除缓存。

Cache注解详解

@CacheConfig:主要用于配置该类中会用到的一些共用的缓存配置。在这里@CacheConfig(cacheNames = "users"):配置了该数据访问对象中返回的内容将存储于名为users的缓存对象中,我们也可以不使用该注解,直接通过@Cacheable自己配置缓存集的名字来定义。

@Cacheable:配置了findByName函数的返回值将被加入缓存。同时在查询时,会先从缓存中获取,若不存在才再发起对数据库的访问。该注解主要有下面几个参数:

value、cacheNames:两个等同的参数(cacheNames为Spring 4新增,作为value的别名),用于指定缓存存储的集合名。由于Spring 4中新增了@CacheConfig,因此在Spring 3中原本必须有的value属性,也成为非必需项了

key:缓存对象存储在Map集合中的key值,非必需,缺省按照函数的所有参数组合作为key值,若自己配置需使用SpEL表达式,比如:@Cacheable(key = "#p0"):使用函数第一个参数作为缓存的key值,更多关于SpEL表达式的详细内容可参考官方文档

condition:缓存对象的条件,非必需,也需使用SpEL表达式,只有满足表达式条件的内容才会被缓存,比如:@Cacheable(key = "#p0", condition = "#p0.length() < 3"),表示只有当第一个参数的长度小于3的时候才会被缓存,若做此配置上面的AAA用户就不会被缓存,读者可自行实验尝试。

unless:另外一个缓存条件参数,非必需,需使用SpEL表达式。它不同于condition参数的地方在于它的判断时机,该条件是在函数被调用之后才做判断的,所以它可以通过对result进行判断。

keyGenerator:用于指定key生成器,非必需。若需要指定一个自定义的key生成器,我们需要去实现org.springframework.cache.interceptor.KeyGenerator接口,并使用该参数来指定。需要注意的是:该参数与key是互斥的

cacheManager:用于指定使用哪个缓存管理器,非必需。只有当有多个时才需要使用

cacheResolver:用于指定使用那个缓存解析器,非必需。需通过org.springframework.cache.interceptor.CacheResolver接口来实现自己的缓存解析器,并用该参数指定。

除了这里用到的两个注解之外,还有下面几个核心注解:

@CachePut:配置于函数上,能够根据参数定义条件来进行缓存,它与@Cacheable不同的是,它每次都会真是调用函数,所以主要用于数据新增和修改操作上。它的参数与@Cacheable类似,具体功能可参考上面对@Cacheable参数的解析

@CacheEvict:配置于函数上,通常用在删除方法上,用来从缓存中移除相应数据。除了同@Cacheable一样的参数之外,它还有下面两个参数:

allEntries:非必需,默认为false。当为true时,会移除所有数据

beforeInvocation:非必需,默认为false,会在调用方法之后移除数据。当为true时,会在调用方法之前移除数据。


版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:微信小程序调用微信登陆获取openid及java做为服务端示例
下一篇:API接口管理 论文(API实例)
相关文章

 发表评论

暂时没有评论,来抢沙发吧~