详解spring boot集成ehcache 2.x 用于hibernate二级缓存

2024-02-21 18:30:03 45

本文将介绍如何在springboot中集成ehcache作为hibernate的二级缓存。各个框架版本如下

springboot：1.4.3.RELEASE
springframework:4.3.5.RELEASE
hibernate：5.0.1.Final（spring-boot-starter-data-jpa默认依赖）
ehcache：2.10.3

项目依赖


org.springframework.boot
spring-boot-starter-data-jpa



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



org.hibernate
hibernate-ehcache


net.sf.ehcache
ehcache-core





net.sf.ehcache
ehcache
2.10.3

Ehcache简介

ehcache是一个纯Java的缓存框架，既可以当做一个通用缓存使用，也可以作为将其作为hibernate的二级缓存使用。缓存数据可选择如下三种存储方案

MemoryStore–On-heapmemoryusedtoholdcacheelements.ThistierissubjecttoJavagarbagecollection.
OffHeapStore–ProvidesoverflowcapacitytotheMemoryStore.LimitedinsizeonlybyavailableRAM.NotsubjecttoJavagarbagecollection(GC).AvailableonlywithTerracottaBigMemoryproducts.
DiskStore–Backsupin-memorycacheelementsandprovidesoverflowcapacitytotheothertiers.

hibernate二级缓存配置

hibernate的二级缓存支持entity和query层面的缓存，org.hibernate.cache.spi.RegionFactory各类可插拔的缓存提供商与hibernate的集成。

#打开hibernate统计信息
spring.jpa.properties.hibernate.generate_statistics=true

#打开二级缓存
spring.jpa.properties.hibernate.cache.use_second_level_cache=true

#打开查询缓存
spring.jpa.properties.hibernate.cache.use_query_cache=true

#指定缓存provider
spring.jpa.properties.hibernate.cache.region.factory_class=org.hibernate.cache.ehcache.SingletonEhCacheRegionFactory

#配置shared-cache-mode
spring.jpa.properties.javax.persistence.sharedCache.mode=ENABLE_SELECTIVE

关于hibernate缓存相关的所有配置可参考hibernate5.0官方文档#缓存

ehcache配置文件

ehcache2.x配置文件样板参考官方网站提供的ehcache.xml。本例中使用的配置文件如下所示

ehcache事件监听

在ehcache中，有两大类事件，一是cacheManager相关的事件，如cache的init/added等；二是cahche相关的事件，如cacheput/expire等。在ehcache中，默认没有这两类事件的监听器，需要自主实现监听器以及监听器工厂类，然后配置到ehcache.xml中，方可生效。

上述ehcache.xml配置中，给自定义cache都配置了cacheEventListenerFactory，用于监听缓存事件。同时也配置了cacheManagerFactory实现类。具体实现代码如下

CacheManagerEventListener简单实现

packagecom.yangyi.base.ehcache;

importnet.sf.ehcache.CacheException;
importnet.sf.ehcache.CacheManager;
importnet.sf.ehcache.Status;
importnet.sf.ehcache.event.CacheManagerEventListener;
importorg.slf4j.Logger;
importorg.slf4j.LoggerFactory;

/**
*ehcachecustomercacheManagerEventListener
*Createdbyyangjinfengon2017/1/5.
*/
publicclassCustomerCacheManagerEventListenerimplementsCacheManagerEventListener{

privateLoggerlogger=LoggerFactory.getLogger(getClass());

privatefinalCacheManagercacheManager;

publicCustomerCacheManagerEventListener(CacheManagercacheManager){
this.cacheManager=cacheManager;
}

@Override
publicvoidinit()throwsCacheException{
logger.info("initehcache...");
}

@Override
publicStatusgetStatus(){
returnnull;
}

@Override
publicvoiddispose()throwsCacheException{
logger.info("ehcachedispose...");
}

@Override
publicvoidnotifyCacheAdded(Strings){
logger.info("cacheAdded...{}",s);
logger.info(cacheManager.getCache(s).toString());
}

@Override
publicvoidnotifyCacheRemoved(Strings){

}
}

CacheManagerEventListenerFactory的简单实现

packagecom.yangyi.base.ehcache;

importnet.sf.ehcache.CacheManager;
importnet.sf.ehcache.event.CacheManagerEventListener;
importnet.sf.ehcache.event.CacheManagerEventListenerFactory;

importjava.util.Properties;

/**
*Createdbyyangjinfengon2017/1/5.
*/
publicclassCustomerCacheManagerEventListenerFactoryextendsCacheManagerEventListenerFactory{
@Override
publicCacheManagerEventListenercreateCacheManagerEventListener(CacheManagercacheManager,Propertiesproperties){
returnnewCustomerCacheManagerEventListener(cacheManager);
}
}

CacheEventListener的简单实现

packagecom.yangyi.base.ehcache;

importnet.sf.ehcache.CacheException;
importnet.sf.ehcache.Ehcache;
importnet.sf.ehcache.Element;
importnet.sf.ehcache.event.CacheEventListener;
importorg.slf4j.Logger;
importorg.slf4j.LoggerFactory;

/**
*Createdbyyangjinfengon2017/1/5.
*/
publicclassCustomerCacheEventListenerimplementsCacheEventListener{

privateLoggerlogger=LoggerFactory.getLogger(getClass());

@Override
publicvoidnotifyElementRemoved(Ehcacheehcache,Elementelement)throwsCacheException{
logger.info("cacheremoved.key={},value={}",element.getObjectKey(),element.getObjectValue());
}

@Override
publicvoidnotifyElementPut(Ehcacheehcache,Elementelement)throwsCacheException{
logger.info("cacheput.key={},value={}",element.getObjectKey(),element.getObjectValue());
}

@Override
publicvoidnotifyElementUpdated(Ehcacheehcache,Elementelement)throwsCacheException{
logger.info("cacheupdated.key={},value={}",element.getObjectKey(),element.getObjectValue());
}

@Override
publicvoidnotifyElementExpired(Ehcacheehcache,Elementelement){
logger.info("cacheexpired.key={},value={}",element.getObjectKey(),element.getObjectValue());
}

@Override
publicvoidnotifyElementEvicted(Ehcacheehcache,Elementelement){
logger.info("cacheevicted.key={},value={}",element.getObjectKey(),element.getObjectValue());
}

@Override
publicvoidnotifyRemoveAll(Ehcacheehcache){
logger.info("allelementsremoved.cachename={}",ehcache.getName());
}

@Override
publicObjectclone()throwsCloneNotSupportedException{
thrownewCloneNotSupportedException();
}

@Override
publicvoiddispose(){
logger.info("cachedispose.");
}
}

CacheEventListenerFactory的简单实现

packagecom.yangyi.base.ehcache;

importnet.sf.ehcache.event.CacheEventListener;
importnet.sf.ehcache.event.CacheEventListenerFactory;

importjava.util.Properties;

/**
*Createdbyyangjinfengon2017/1/5.
*/
publicclassCustomerCacheEventListenerFactoryextendsCacheEventListenerFactory{
@Override
publicCacheEventListenercreateCacheEventListener(Propertiesproperties){
returnnewCustomerCacheEventListener();
}
}

完成上述事件监听器的实现和配置后，我们可以启动应用，查看下相应事件监听器中输出的log，以验证是否生效

2017-01-0710:27:07.810INFO4264---[main]com.yangyi.Application:StartingApplicationonyangjinfeng-pcwithPID4264(E:\JavaWorkSpace\spring-boot-ehcache3-hibernate5-jcache\target\classesstartedbyyangjinfenginE:\JavaWorkSpace\spring-boot-ehcache3-hibernate5-jcache)
2017-01-0710:27:07.810INFO4264---[main]com.yangyi.Application:Noactiveprofileset,fallingbacktodefaultprofiles:default
2017-01-0710:27:07.865INFO4264---[main]ationConfigEmbeddedWebApplicationContext:Refreshingorg.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@2ef3eef9:startupdate[SatJan0710:27:07CST2017];rootofcontexthierarchy
2017-01-0710:27:09.155INFO4264---[main]trationDelegate$BeanPostProcessorChecker:Bean'org.springframework.transaction.annotation.ProxyTransactionManagementConfiguration'oftype[classorg.springframework.transaction.annotation.ProxyTransactionManagementConfiguration$$EnhancerBySpringCGLIB$$6eb4eae9]isnoteligibleforgettingprocessedbyallBeanPostProcessors(forexample:noteligibleforauto-proxying)
2017-01-0710:27:09.191INFO4264---[main]trationDelegate$BeanPostProcessorChecker:Bean'org.springframework.cache.annotation.ProxyCachingConfiguration'oftype[classorg.springframework.cache.annotation.ProxyCachingConfiguration$$EnhancerBySpringCGLIB$$b7c72107]isnoteligibleforgettingprocessedbyallBeanPostProcessors(forexample:noteligibleforauto-proxying)
2017-01-0710:27:09.206INFO4264---[main]trationDelegate$BeanPostProcessorChecker:Bean'org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration'oftype[classorg.springframework.boot.autoconfigure.cache.CacheAutoConfiguration$$EnhancerBySpringCGLIB$$ac3ae5ab]isnoteligibleforgettingprocessedbyallBeanPostProcessors(forexample:noteligibleforauto-proxying)
2017-01-0710:27:09.285INFO4264---[main]trationDelegate$BeanPostProcessorChecker:Bean'spring.cache-org.springframework.boot.autoconfigure.cache.CacheProperties'oftype[classorg.springframework.boot.autoconfigure.cache.CacheProperties]isnoteligibleforgettingprocessedbyallBeanPostProcessors(forexample:noteligibleforauto-proxying)
2017-01-0710:27:09.291INFO4264---[main]trationDelegate$BeanPostProcessorChecker:Bean'org.springframework.boot.autoconfigure.cache.CacheManagerCustomizers'oftype[classorg.springframework.boot.autoconfigure.cache.CacheManagerCustomizers]isnoteligibleforgettingprocessedbyallBeanPostProcessors(forexample:noteligibleforauto-proxying)
2017-01-0710:27:09.293INFO4264---[main]trationDelegate$BeanPostProcessorChecker:Bean'org.springframework.boot.autoconfigure.cache.EhCacheCacheConfiguration'oftype[classorg.springframework.boot.autoconfigure.cache.EhCacheCacheConfiguration$$EnhancerBySpringCGLIB$$46d9b2a9]isnoteligibleforgettingprocessedbyallBeanPostProcessors(forexample:noteligibleforauto-proxying)
2017-01-0710:27:09.418INFO4264---[main].y.b.e.CustomerCacheManagerEventListener:initehcache...
2017-01-0710:27:09.487INFO4264---[main].y.b.e.CustomerCacheManagerEventListener:cacheAdded...org.hibernate.cache.spi.UpdateTimestampsCache
2017-01-0710:27:09.487INFO4264---[main].y.b.e.CustomerCacheManagerEventListener:[name=org.hibernate.cache.spi.UpdateTimestampsCachestatus=STATUS_ALIVEeternal=trueoverflowToDisk=truemaxEntriesLocalHeap=5000maxEntriesLocalDisk=0memoryStoreEvictionPolicy=LRUtimeToLiveSeconds=0timeToIdleSeconds=0persistence=LOCALTEMPSWAPdiskExpiryThreadIntervalSeconds=120cacheEventListeners:com.yangyi.base.ehcache.CustomerCacheEventListener;orderedCacheEventListeners:maxBytesLocalHeap=0overflowToOffHeap=falsemaxBytesLocalOffHeap=0maxBytesLocalDisk=0pinned=false]
2017-01-0710:27:09.487INFO4264---[main].y.b.e.CustomerCacheManagerEventListener:cacheAdded...org.hibernate.cache.internal.StandardQueryCache
2017-01-0710:27:09.487INFO4264---[main].y.b.e.CustomerCacheManagerEventListener:[name=org.hibernate.cache.internal.StandardQueryCachestatus=STATUS_ALIVEeternal=falseoverflowToDisk=truemaxEntriesLocalHeap=5maxEntriesLocalDisk=0memoryStoreEvictionPolicy=LRUtimeToLiveSeconds=120timeToIdleSeconds=0persistence=LOCALTEMPSWAPdiskExpiryThreadIntervalSeconds=120cacheEventListeners:com.yangyi.base.ehcache.CustomerCacheEventListener;orderedCacheEventListeners:maxBytesLocalHeap=0overflowToOffHeap=falsemaxBytesLocalOffHeap=0maxBytesLocalDisk=0pinned=false]
2017-01-0710:27:09.503INFO4264---[main].y.b.e.CustomerCacheManagerEventListener:cacheAdded...entityCache
2017-01-0710:27:09.503INFO4264---[main].y.b.e.CustomerCacheManagerEventListener:[name=entityCachestatus=STATUS_ALIVEeternal=falseoverflowToDisk=truemaxEntriesLocalHeap=1000maxEntriesLocalDisk=10000memoryStoreEvictionPolicy=LFUtimeToLiveSeconds=20timeToIdleSeconds=10persistence=LOCALTEMPSWAPdiskExpiryThreadIntervalSeconds=120cacheEventListeners:com.yangyi.base.ehcache.CustomerCacheEventListener;orderedCacheEventListeners:maxBytesLocalHeap=0overflowToOffHeap=falsemaxBytesLocalOffHeap=0maxBytesLocalDisk=0pinned=false]
2017-01-0710:27:09.503INFO4264---[main]trationDelegate$BeanPostProcessorChecker:Bean'ehCacheCacheManager'oftype[classnet.sf.ehcache.CacheManager]isnoteligibleforgettingprocessedbyallBeanPostProcessors(forexample:noteligibleforauto-proxying)
2017-01-0710:27:09.503INFO4264---[main]trationDelegate$BeanPostProcessorChecker:Bean'cacheManager'oftype[classorg.springframework.cache.ehcache.EhCacheCacheManager]isnoteligibleforgettingprocessedbyallBeanPostProcessors(forexample:noteligibleforauto-proxying)
2017-01-0710:27:09.503INFO4264---[main]trationDelegate$BeanPostProcessorChecker:Bean'cacheAutoConfigurationValidator'oftype[classorg.springframework.boot.autoconfigure.cache.CacheAutoConfiguration$CacheManagerValidator]isnoteligibleforgettingprocessedbyallBeanPostProcessors(forexample:noteligibleforauto-proxying)
2017-01-0710:27:09.829INFO4264---[main]s.b.c.e.t.TomcatEmbeddedServletContainer:Tomcatinitializedwithport(s):8080(http)
2017-01-0710:27:09.839INFO4264---[main]o.apache.catalina.core.StandardService:StartingserviceTomcat
2017-01-0710:27:09.839INFO4264---[main]org.apache.catalina.core.StandardEngine:StartingServletEngine:ApacheTomcat/8.5.6
2017-01-0710:27:09.924INFO4264---[ost-startStop-1]o.a.c.c.C.[Tomcat].[localhost].[/]:InitializingSpringembeddedWebApplicationContext
2017-01-0710:27:09.924INFO4264---[ost-startStop-1]o.s.web.context.ContextLoader:RootWebApplicationContext:initializationcompletedin2061ms

2017-01-0710:32:41.876INFO4264---[nio-8080-exec-1]c.y.b.e.CustomerCacheEventListener:cacheput.key=com.yangyi.entity.User#1,value=org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy$Item@1c13194d
2017-01-0710:32:41.877INFO4264---[nio-8080-exec-1]c.y.b.e.CustomerCacheEventListener:cacheput.key=com.yangyi.entity.Authority#1,value=org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy$Item@2accc177
2017-01-0710:32:41.878INFO4264---[nio-8080-exec-1]c.y.b.e.CustomerCacheEventListener:cacheput.key=com.yangyi.entity.Authority#2,value=org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy$Item@2b3b9c7e
2017-01-0710:32:41.879INFO4264---[nio-8080-exec-1]c.y.b.e.CustomerCacheEventListener:cacheput.key=com.yangyi.entity.Authority#3,value=org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy$Item@4c31e58c

注解方式使用二级缓存

要使用entitycache，需要在entity上配上相应的注解方可生效。javax.persistence.Cacheable注解标记该entity使用二级缓存，org.hibernate.annotations.Cache注解指定缓存策略，以及存放到哪个缓存区域。

有关缓存策略详细信息可参考hibernate5.0官方文档#缓存

packagecom.yangyi.entity;

importorg.hibernate.annotations.Cache;
importorg.hibernate.annotations.CacheConcurrencyStrategy;
importjavax.persistence.Cacheable;
importjavax.persistence.Entity;
importjavax.persistence.JoinTable;

@Entity
@Table(name="users")
@Cacheable
@Cache(usage=CacheConcurrencyStrategy.READ_WRITE,region="entityCache")
publicclassUserimplementsSerializable{

}

最后，我们需要在springboot应用层面打开cache功能，使用org.springframework.cache.annotation.EnableCaching注解

packagecom.yangyi;

importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
importorg.springframework.cache.annotation.EnableCaching;

@SpringBootApplication
@EnableCaching
publicclassApplication{

publicstaticvoidmain(String[]args){
SpringApplication.run(Application.class,args);
}
}

完整代码

完整代码示例见github

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

详解spring boot集成ehcache 2.x 用于hibernate二级缓存

热门推荐

随机推荐