文档章节

ehcache常用API整理

~少司命~
 ~少司命~
发布于 2013/03/05 17:13
字数 1610
阅读 152
收藏 6
点赞 0
评论 0


一 ehcache API:


1: Using the CacheManager

1.1所有ehcache的使用, 都是从 CacheManager. 开始的.
有多种方法创建CacheManager实例:
Java代码   收藏代码
  1. //Create a singleton CacheManager using defaults, then list caches.  
  2. CacheManager.getInstance()  
 


或者:

Java代码   收藏代码
  1. //Create a CacheManager instance using defaults, then list caches.  
  2. CacheManager manager = new CacheManager();  
  3. String[] cacheNames = manager.getCacheNames();  
 



如果需要从指定配置文件创建 CacheManager:

Java代码   收藏代码
  1. Create two CacheManagers, each with a different configuration, and list the caches in each.  
  2. CacheManager manager1 = new CacheManager("src/config/ehcache1.xml");  
  3. CacheManager manager2 = new CacheManager("src/config/ehcache2.xml");  
  4. String[] cacheNamesForManager1 = manager1.getCacheNames();  
  5. String[] cacheNamesForManager2 = manager2.getCacheNames();  
 



1.2 Adding and Removing Caches Programmatically
手动创建一个cache, 而不是通过配置文件:

Java代码   收藏代码
  1. //creates a cache called testCache, which  
  2. //will be configured using defaultCache from the configuration  
  3. CacheManager singletonManager = CacheManager.create();  
  4. singletonManager.addCache("testCache");  
  5. Cache test = singletonManager.getCache("testCache");  
 

或者:

Java代码   收藏代码
  1. //Create a Cache and add it to the CacheManager, then use it. Note that Caches are not usable until they have  
  2. //been added to a CacheManager.  
  3.     public void testCreatCacheByProgram()  
  4.     {  
  5.         CacheManager singletonManager = CacheManager.create();  
  6.         Cache memoryOnlyCache = new Cache("testCache"5000falsefalse52);  
  7.         singletonManager.addCache(memoryOnlyCache);  
  8.         Cache testCache = singletonManager.getCache("testCache");  
  9.         assertNotNull(testCache);         
  10.     }  
 

   
手动移除一个cache:

Java代码   收藏代码
  1. //Remove cache called sampleCache1  
  2. CacheManager singletonManager = CacheManager.create();  
  3. singletonManager.removeCache("sampleCache1");  
 


1.3 Shutdown the CacheManager
ehcache应该在使用后关闭, 最佳实践是在code中显式调用:

Java代码   收藏代码
  1. //Shutdown the singleton CacheManager  
  2. CacheManager.getInstance().shutdown();  

 2 Using Caches
比如我有这样一个cache:

Xml代码   收藏代码
  1. <cache name="sampleCache1" maxElementsInMemory="10000"  
  2.     maxElementsOnDisk="1000" eternal="false" overflowToDisk="true"  
  3.     diskSpoolBufferSizeMB="20" timeToIdleSeconds="300"  
  4.     timeToLiveSeconds="600" memoryStoreEvictionPolicy="LFU" />  
 


       
2.1 Obtaining a reference to a Cache
获得该cache的引用:

Java代码   收藏代码
  1. String cacheName = "sampleCache1";  
  2. CacheManager manager = new CacheManager("src/ehcache1.xml");  
  3. Cache cache = manager.getCache(cacheName);  

 
2.2 Performing CRUD operations
下面的代码演示了ehcache的增删改查:

Java代码   收藏代码
  1. public void testCRUD()  
  2. {  
  3.     String cacheName = "sampleCache1";  
  4.     CacheManager manager = new CacheManager("src/ehcache1.xml");  
  5.     Cache cache = manager.getCache(cacheName);  
  6.     //Put an element into a cache  
  7.     Element element = new Element("key1""value1");  
  8.     cache.put(element);  
  9.     //This updates the entry for "key1"  
  10.     cache.put(new Element("key1""value2"));  
  11.     //Get a Serializable value from an element in a cache with a key of "key1".  
  12.     element = cache.get("key1");  
  13.     Serializable value = element.getValue();  
  14.     //Get a NonSerializable value from an element in a cache with a key of "key1".  
  15.     element = cache.get("key1");  
  16.     assertNotNull(element);  
  17.     Object valueObj = element.getObjectValue();  
  18.     assertNotNull(valueObj);  
  19.     //Remove an element from a cache with a key of "key1".  
  20.     assertNotNull(cache.get("key1"));  
  21.     cache.remove("key1");  
  22.     assertNull(cache.get("key1"));  
  23.      
  24. }  

    
2.3    Disk Persistence on demand

Java代码   收藏代码
  1. //sampleCache1 has a persistent diskStore. We wish to ensure that the data //and index are written immediately.  
  2.         public void testDiskPersistence()  
  3.     {  
  4.         String cacheName = "sampleCache1";  
  5.         CacheManager manager = new CacheManager("src/ehcache1.xml");  
  6.         Cache cache = manager.getCache(cacheName);  
  7.         for (int i = 0; i < 50000; i++)  
  8.         {  
  9.             Element element = new Element("key" + i, "myvalue" + i);  
  10.             cache.put(element);  
  11.         }  
  12.         cache.flush();  
  13.         Log.debug("java.io.tmpdir = " + System.getProperty("java.io.tmpdir"));  
  14.     }  
 


备注: 持久化到硬盘的路径由虚拟机参数"java.io.tmpdir"决定.
例如, 在windows中, 会在此路径下
C:\Documents and Settings\li\Local Settings\Temp
在linux中, 通常会在: /tmp 下

2.4  Obtaining Cache Sizes
以下代码演示如何获得cache个数:

Java代码   收藏代码
  1. public void testCachesizes()  
  2. {  
  3.     long count = 5;  
  4.     String cacheName = "sampleCache1";  
  5.     CacheManager manager = new CacheManager("src/ehcache1.xml");  
  6.     Cache cache = manager.getCache(cacheName);  
  7.     for (int i = 0; i < count; i++)  
  8.     {  
  9.         Element element = new Element("key" + i, "myvalue" + i);  
  10.         cache.put(element);  
  11.     }  
  12.     //Get the number of elements currently in the Cache.  
  13.     int elementsInCache = cache.getSize();  
  14.     assertTrue(elementsInCache == 5);  
  15.     //Cache cache = manager.getCache("sampleCache1");  
  16.     long elementsInMemory = cache.getMemoryStoreSize();  
  17.     //Get the number of elements currently in the DiskStore.  
  18.     long elementsInDiskStore = cache.getDiskStoreSize();  
  19.     assertTrue(elementsInMemory + elementsInDiskStore == count);     
  20. }  
 


3: Registering CacheStatistics in an MBeanServer
ehCache 提供jmx支持:

Java代码   收藏代码
  1. CacheManager manager = new CacheManager();  
  2. MBeanServer mBeanServer = ManagementFactory.getPlatformMBeanServer();  
  3. ManagementService.registerMBeans(manager, mBeanServer, falsefalsefalsetrue);  
 


把该程序打包, 然后:

Java代码   收藏代码
  1. java -Dcom.sun.management.jmxremote -jar 程序名.jar  

 
再到javahome/bin中运行jconsole.exe, 便可监控cache.

4. 用户可以自定义处理cacheEventHandler, 处理诸如元素放入cache的各种事件(放入,移除,过期等事件)
只需三步:
4.1 在cache配置中, 增加cacheEventListenerFactory节点.

Java代码   收藏代码
  1. <cache name="Test" maxElementsInMemory="1" eternal="false"  
  2.     overflowToDisk="true" timeToIdleSeconds="1" timeToLiveSeconds="2"  
  3.     diskPersistent="false" diskExpiryThreadIntervalSeconds="1"  
  4.     memoryStoreEvictionPolicy="LFU">  
  5.     <cacheEventListenerFactory class="co.ehcache.EventFactory" />  
  6. </cache>  

 

4.2: 编写EventFactory, 继承CacheEventListenerFactory:

Java代码   收藏代码
  1. public class EventFactory extends CacheEventListenerFactory   
  2. {  
  3.     @Override  
  4.     public CacheEventListener createCacheEventListener(Properties properties)  
  5.     {  
  6.         // TODO Auto-generated method stub  
  7.         return new CacheEvent();  
  8.     }  
  9.   
  10. }  

 


4.3  编写 class: CacheEvent, 实现 CacheEventListener 接口:

Java代码   收藏代码
  1. public class CacheEvent implements CacheEventListener   
  2. {  
  3.   
  4.     public void dispose()  
  5.     {  
  6.         log("in dispose");  
  7.     }  
  8.   
  9.     public void notifyElementEvicted(Ehcache cache, Element element)  
  10.     {  
  11.         // TODO Auto-generated method stub  
  12.         log("in notifyElementEvicted" + element);  
  13.     }  
  14.   
  15.     public void notifyElementExpired(Ehcache cache, Element element)  
  16.     {  
  17.         // TODO Auto-generated method stub  
  18.         log("in notifyElementExpired" + element);  
  19.     }  
  20.   
  21.     public void notifyElementPut(Ehcache cache, Element element) throws CacheException  
  22.     {  
  23.         // TODO Auto-generated method stub  
  24.         log("in notifyElementPut" + element);  
  25.     }  
  26.   
  27.     public void notifyElementRemoved(Ehcache cache, Element element) throws CacheException  
  28.     {  
  29.         // TODO Auto-generated method stub  
  30.         log("in notifyElementRemoved" + element);  
  31.     }  
  32.   
  33.     public void notifyElementUpdated(Ehcache cache, Element element) throws CacheException  
  34.     {  
  35.         // TODO Auto-generated method stub  
  36.         log("in notifyElementUpdated" + element);  
  37.     }  
  38.   
  39.     public void notifyRemoveAll(Ehcache cache)  
  40.     {  
  41.         // TODO Auto-generated method stub  
  42.         log("in notifyRemoveAll");  
  43.     }  
  44.      
  45.     public Object clone() throws CloneNotSupportedException  
  46.     {  
  47.         return super.clone();  
  48.     }     
  49.      
  50.     private void log(String s)  
  51.     {  
  52.         Log.debug(s);  
  53.     }  
  54. }  
 

现在可以编写测试代码:

Java代码   收藏代码
  1. public void testEventListener()  
  2. {  
  3.     String key = "person";  
  4.     Person person = new Person("lcl"100);  
  5.     MyCacheManager.getInstance().put("Test", key, person);  
  6.     Person p = (Person) MyCacheManager.getInstance().get("Test", key);  
  7.   
  8.     try  
  9.     {  
  10.         Thread.sleep(10000);  
  11.     }  
  12.     catch (InterruptedException e)  
  13.     {  
  14.         // TODO Auto-generated catch block  
  15.         e.printStackTrace();  
  16.     }  
  17.   
  18.     assertNull(MyCacheManager.getInstance().get("Test", key));  
  19. }  

 

   
    根据配置, 该缓存对象生命期只有2分钟, 在Thread.sleep(10000)期间, 该缓存元素将过期被销毁, 在销毁前, 触发notifyElementExpired事件.
   
二 Ehcache配置文件
 以如下配置为例说明:

Xml代码   收藏代码
  1. <cache name="CACHE_FUNC"   
  2. maxElementsInMemory="2"   
  3. eternal="false"   
  4. timeToIdleSeconds="10"   
  5. timeToLiveSeconds="20"  
  6. overflowToDisk="true"   
  7. diskPersistent="true"   
  8. diskExpiryThreadIntervalSeconds="120"  />  

 

maxElementsInMemory :cache 中最多可以存放的元素的数量。如果放入cache中的元素超过这个数值,有两种情况:
1. 若overflowToDisk的属性值为true,会将cache中多出的元素放入磁盘文件中。
2. 若overflowToDisk的属性值为false,会根据memoryStoreEvictionPolicy的策略替换cache中原有的元素。

eternal :是否永驻内存。如果值是true,cache中的元素将一直保存在内存中,不会因为时间超时而丢失,所以在这个值为true的时候,timeToIdleSeconds和timeToLiveSeconds两个属性的值就不起作用了。


 3. timeToIdleSeconds :访问这个cache中元素的最大间隔时间。如果超过这个时间没有访问这个cache中的某个元素,那么这个元素将被从cache中清除。


4. timeToLiveSeconds : cache中元素的生存时间。意思是从cache中的某个元素从创建到消亡的时间,从创建开始计时,当超过这个时间,这个元素将被从cache中清除。


5. overflowToDisk :溢出是否写入磁盘。系统会根据标签<diskStore path="java.io.tmpdir"/> 中path的值查找对应的属性值,如果系统的java.io.tmpdir的值是 D:\temp,写入磁盘的文件就会放在这个文件夹下。文件的名称是cache的名称,后缀名的data。如:CACHE_FUNC.data。


6. diskExpiryThreadIntervalSeconds  :磁盘缓存的清理线程运行间隔.


7. memoryStoreEvictionPolicy :内存存储与释放策略。有三个值:
LRU -least recently used
LFU -least frequently used
FIFO-first in first out, the oldest element by creation time


diskPersistent : 是否持久化磁盘缓存。当这个属性的值为true时,系统在初始化的时候会在磁盘中查找文件名为cache名称,后缀名为index的的文件,如 CACHE_FUNC.index 。这个文件中存放了已经持久化在磁盘中的cache的index,找到后把cache加载到内存。要想把cache真正持久化到磁盘,写程序时必须注意, 在是用net.sf.ehcache.Cache的void put (Element element)方法后要使用void flush()方法。

本文转载自:http://lcllcl987.iteye.com/blog/222693

共有 人打赏支持
~少司命~
粉丝 3
博文 59
码字总数 8323
作品 0
昌平
高级程序员
hechuan/jad-cache

jad-cache 此项目是对是Spring3中缓存模块的扩展,除了沿用原来的Spring缓存注解之外,还增加了对MemCache、EhCache、redis的实现,并且提供了一些新新的功能,本项目具有以下特点: 1.提供统...

hechuan ⋅ 2017/03/24 ⋅ 0

进程内缓存框架EhCache

进程内缓存框架 EhCache Author: Poechant Blog: blog.CSDN.net/Poechant Email: zhongchao.ustc#gmail.com (#->@) Date: February 27th, 2012 1. What the hell is EhCache? EhCache 是一个......

晨曦之光 ⋅ 2012/04/24 ⋅ 0

BigMemory系列文章--4.Ehcache重要类和常用API

转载请注明出处哈:http://carlosfu.iteye.com/blog/2237511 一、Ehcache三个重要的类 1. CacheManager: 管理Cache 2. Cache: 管理K-V缓存对象 3. Element: K-V缓存对象 下面这张图形象表现三...

付磊-起扬 ⋅ 2015/08/23 ⋅ 0

缓存技术 oscache、ehcache使用之ehcache

1、ehcache简介: 首先对于ehcache做个简单介绍: EhCache 是一个纯Java的进程内缓存框架,具有快速、精干等特点,是Hibernate中默认的CacheProvider。 下图是 Ehcache 在应用程序中的位置:...

jackson_open ⋅ 2014/02/14 ⋅ 0

【EhCache】Java缓存框架使用EhCache结合Spring AOP

一.Ehcache简介 EhCache是一个纯Java的进程内缓存框架,具有如下特点: 1. 快速简单,非常容易和应用集成。 2.支持多种缓存策略 。 3. 缓存数据有两级:内存和磁盘,因此无需担心容量问题 。...

磊神Ray ⋅ 2012/08/07 ⋅ 7

j2ee应用快速开发手架--thinker

thinker(像一个思想者一样去写代码) 介绍 工作中的积累,搭建的j2ee应用快速开发手架,重点在代码重构,一些常用功能的演示,工具,插件等的整理 github gitoschina 个人博客:http://www.rg...

stroller ⋅ 2014/04/25 ⋅ 0

j2ee应用快速开发手架--thinker

thinker(像一个思想者一样去写代码) 介绍 工作中的积累,搭建的j2ee应用快速开发手架,重点在代码重构,一些常用功能的演示,工具,插件等的整理 github gitoschina 个人博客:http://www.rg...

guess ⋅ 2014/04/25 ⋅ 6

vakinge/jeesuite-libs

黄金位置放个小广告→欢迎加交流群:230192763 (不限于讨论该框架热爱技术就行) 简介 jeesuite-libs是整理的近几年封装的一些基础组件包,计划陆续整理成一个java后台服务开发套件,包括缓...

vakinge ⋅ 2016/12/14 ⋅ 0

Jav ORM框架--Darks ORM

Darks ORM框架是多年前开发的一个Java web ORM框架,现在整理更新后发布。Darks ORM框架综合了hibernate及mybatis的特点,同时也加入了很多新元素。它可以像hibernate一样通过简单易用的API...

小编辑 ⋅ 2014/09/12 ⋅ 0

Ehcache 3.0.0.m3 发布,Java 缓存框架

Ehcache 3.0.0.m3 发布,此版本包含以下改进: XA Transactions 支持 所有 tiers 在序列化统一视图 大量改进和 bug 修复 更多内容请看:https://github.com/ehcache/ehcache3/releases EhCa...

淡漠悠然 ⋅ 2015/09/18 ⋅ 4

没有更多内容

加载失败,请刷新页面

加载更多

下一页

JEPLUS主从功能配置之主从布局的设置——JEPLUS软件快速开发平台

JEPLUS主从功能配置之主从布局的设置 主从功能配置成功之后就需要根据业务需求来调整主从功能的数据显示方式,不同的主从数据的显示可以达到不同的主从数据显示效果,今天这篇笔记就讲解一下...

JEPLUS ⋅ 2分钟前 ⋅ 0

如何利用极光推送的新功能玩转世界杯营销

四年一次的世界杯已经于6月14日开赛!对于app的运营人员而言,这场远在俄罗斯的绿茵征战绝不仅仅牵动着球迷们的心,更拨动着众多互联网企业运营人员的神经。在这场营销大战中,push显然是app...

极光推送 ⋅ 5分钟前 ⋅ 0

Spring Cloud构建微服务架构-Hystrix依赖隔离

依赖隔离 “舱壁模式”对于熟悉Docker的读者一定不陌生,Docker通过“舱壁模式”实现进程的隔离,使得容器与容器之间不会互相影响。而Hystrix则使用该模式实现线程池的隔离,它会为每一个Hys...

itcloud ⋅ 8分钟前 ⋅ 0

SpringCloud 微服务 (八) 统一配置中心 Config Server&Client

壹 Spring Cloud Config 统一配置中心,方便维护配置文件,对一些公司对数据库密码等敏感的信息,对普通开发人员不公开,放在运维人员手上,对配置作一个隔离作用,另外项目线上的配置改动都要重新...

___大侠 ⋅ 11分钟前 ⋅ 0

echarts轮播地图并结合鼠标浮动点击

直接上代码 timeId=setInterval(function () { if(count<11){ myChart.dispatchAction({ type: 'downplay', ......

莫西摩西 ⋅ 14分钟前 ⋅ 0

基于 HTML5 的工业互联网 3D 可视化应用

工业企业中生产线处于高速运转,由工业设备所产生、采集和处理的数据量远大于企业中计算机和人工产生的数据,生产线的高速运转则对数据的实时性要求也更高。破解这些大数据就是企业在新一轮制...

xhload3d ⋅ 17分钟前 ⋅ 0

Nging启动与停止bat

start_nginx.bat @echo off  f:  cd F:\server\nginx-1.13.6  echo "nginx is starting on port 80"  start "" "nginx.exe"  exit   stop_nginx.bat @echo off::windows ......

Jay丶 ⋅ 18分钟前 ⋅ 0

SuRF: 一个优化的 Fast Succinct Tries

作者:唐刘 在前一篇文章中,我简单介绍了 Succinct Data Structure,这里我们继续介绍 SuRF。 Fast Succinct Tries SuRF 的核心数据结构就是 Fast Succinct Tries(FST),一种空间节省,支...

TiDB ⋅ 23分钟前 ⋅ 0

Kubernetes(六) - Secret和私有仓库认证

对一个公司来说安全也是最为重要的因为可能一旦出现安全问题可能这个公司就完了,所以对密码管理是一个长久不变的话题,Kubernetes对密码管理提供了Secret组件进行管理,最终映射成环境变量,文件...

喵了_个咪 ⋅ 24分钟前 ⋅ 0

DevOps的三大原则

DevOps的出现有其必然性。在软件开发生命周期中,遇到了两次瓶颈。第一次瓶颈是在需求阶段和开发阶段之间,针对不断变化的需求,对软件开发者提出了高要求,后来出现了敏捷方法论,强调适应需...

inidcard ⋅ 24分钟前 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部