ehcache 使用

​

一.介绍与应用场景

ehcache是一开源缓存工具，其许可证为Apache License, Version 2.0，非常友好的许可。在 sourceforge.net 上可找到它的最新版本。

缓存应用在多个领域并发挥作用，ehcache可应用于数据库访问缓存，安全认证缓存，web缓存，soap 和 RESTFul 服务缓存，应用程序持久对象缓存以及分布式缓存。

二.架设开发环境

无它，只需把ehcache的相关jar包放到classpath下，把配置文件ehcache.xml放在classpath下就可以进行应用开发了。下面是配置文件中默认配置的xml节点的内容

[xhtml] ​​view plain​​​​copy​​

1. <defaultCache     
2.         maxElementsInMemory="10000"     
3.         eternal="false"     
4.         timeToIdleSeconds="120"     
5.         timeToLiveSeconds="120"     
6.         overflowToDisk="true"     
7.         diskSpoolBufferSizeMB="30"     
8.         maxElementsOnDisk="10000000"     
9.         diskPersistent="false"     
10.         diskExpiryThreadIntervalSeconds="120"     
11.         memoryStoreEvictionPolicy="LRU"     
12.         />     
13. <defaultCache  
14.             maxElementsInMemory="10000"  
15.             eternal="false"  
16.             timeToIdleSeconds="120"  
17.             timeToLiveSeconds="120"  
18.             overflowToDisk="true"  
19.             diskSpoolBufferSizeMB="30"  
20.             maxElementsOnDisk="10000000"  
21.             diskPersistent="false"  
22.             diskExpiryThreadIntervalSeconds="120"  
23.             memoryStoreEvictionPolicy="LRU"  
24.             />  

原文件中有比较详尽的注释，在这里我简单翻译几个

1.必须要有的属性：

name: cache的名字，用来识别不同的cache，必须惟一。

maxElementsInMemory: 内存管理的缓存元素数量最大限值。

maxElementsOnDisk: 硬盘管理的缓存元素数量最大限值。默认值为0，就是没有限制。

eternal: 设定元素是否持久话。若设为true，则缓存元素不会过期。

overflowToDisk: 设定是否在内存填满的时候把数据转到磁盘上。

2.下面是一些可选属性：

timeToIdleSeconds： 设定元素在过期前空闲状态的时间，只对非持久性缓存对象有效。默认值为0,值为0意味着元素可以闲置至无限长时间。

timeToLiveSeconds: 设定元素从创建到过期的时间。其他与timeToIdleSeconds类似。

diskPersistent: 设定在虚拟机重启时是否进行磁盘存储，默认为false.(我的直觉，对于安全小型应用，宜设为true)。

diskExpiryThreadIntervalSeconds: 访问磁盘线程活动时间。

diskSpoolBufferSizeMB: 存入磁盘时的缓冲区大小，默认30MB,每个缓存都有自己的缓冲区。

memoryStoreEvictionPolicy: 元素逐出缓存规则。共有三种，Recently Used (LRU)最近最少使用，为默认。 First In First Out (FIFO)，先进先出。Less Frequently Used(specified as LFU)最少使用。

三.实例编写

继续以往的作风，用代码说话。代码中有良好的注释。（代码参考字官方文档）

1. 使用 CacheManager

Java代码

[java] ​​view plain​​​​copy​​

1. package tutorial;      
2. import java.io.File;      
3. import java.io.FileInputStream;      
4. import java.io.InputStream;      
5. import java.net.URL;      
6. import net.sf.ehcache.Cache;      
7. import net.sf.ehcache.CacheManager;      
8. /**  
9. * 使用 CacheManager  
10. * @author zhangyt  
11. *  
12. */     
13. public class UsingTheCacheManager {      
14.     public static void main(String[] args) throws Exception {      
15.         //1.      
16.         //创建CacheManager单例对象，使用默认配置      
17.          CacheManager.create();      
18.          String[] cacheNames1 = CacheManager.getInstance().getCacheNames();      
19.         //关闭      
20.          CacheManager.getInstance().shutdown();      
21.         //2.      
22.         //用默认配置创建对象可用此创建多例      
23.          CacheManager manager2 = new CacheManager();      
24.          String[] cacheNames2 = manager2.getCacheNames();      
25.          manager2.shutdown();      
26.         //3.加载配置的方式      
27.         //3.1 用默认配置加载在上面已经提到。即需要在classpath下放置ehcache.xml配置文件      
28.         //3.2 用指定配置文件路径的方式创建      
29.          CacheManager manager31 = new CacheManager("src/config/ehcache.xml");      
30.          manager31.shutdown();      
31.         //3.2 用classpath下的配置文件生成      
32.          URL url = UsingTheCacheManager.class.getClassLoader().getResource("config/ehcache.xml");      
33.          CacheManager manager32 = new CacheManager(url);      
34.          manager32.shutdown();      
35.         //3.3 通过输入流生成      
36.          InputStream fis = new FileInputStream(new File("src/config/ehcache.xml").getAbsolutePath());      
37.         try {      
38.              CacheManager manager33 = new CacheManager(fis);      
39.              manager33.shutdown();      
40.          } finally {      
41.              fis.close();      
42.          }      
43.         //4. 以编程的方式添加和删除cache      
44.          CacheManager singletonManager4 = CacheManager.create();      
45.         //4.1 用默认配置添加      
46.          singletonManager4.addCache("test41");      
47.          Cache test41 = singletonManager4.getCache("test41");      
48.          System.out.println(test41 != null);      
49.         //4.2 创建一个cache并添加到CacheManager      
50.          Cache memoryOnlyCache = new Cache("test42", 5000, false, false, 5, 2);      
51.          singletonManager4.addCache(memoryOnlyCache);      
52.          Cache test42 = singletonManager4.getCache("test42");      
53.         //4.3 删除cache      
54.          singletonManager4.removeCache("sampleCache1");      
55.          singletonManager4.shutdown();      
56.      }      
57. }   

2. 使用 Caches

Java代码 

2. import java.io.Serializable;      
3. import java.lang.management.ManagementFactory;      
4. import javax.management.MBeanServer;      
7. import net.sf.ehcache.Element;      
8. import net.sf.ehcache.management.ManagementService;      
10. * 使用 Caches  
14. public class UsingCaches {      
15.     public static void main(String[] args) {      
17.          CacheManager manager= CacheManager.getInstance();     
18.          manager.addCache("sampleCache1");  
19.         //1.取得Cache      
20.          Cache cache = manager.getCache("sampleCache1");      
21.         //2.执行 CRUD 操作      
22.         //2.1   增加元素      
23.          Element element1 = new Element("key1", "value1");      
24.          Element element2 = new Element("key2", "value2");      
25.          cache.put(element1);      
26.          cache.put(element2);      
27.         //2.2 更新元素      
28.          cache.put(new Element("key1", "value1u"));      
29.         //2.3 取值      
30.         //取得一个序列化了的值      
31.          Element element231 = cache.get("key1");      
32.          Serializable value231 = element231.getValue();      
33.          System.out.println(value231);      
34.         //取得一个不是序列化的值      
35.          Element element232 = cache.get("key1");      
36.          Object value232 = element232.getObjectValue();      
37.          System.out.println(value232);      
38.         //3.4 删除一个元素      
39.          cache.remove("key2");      
40.          System.out.println(cache.get("key2") == null);      
41.         //3. 强硬命令写入硬盘      
42.          cache.flush();      
43.         //4. 取得缓存的大小      
44.         //得到总的缓存数目      
45.         int elements = cache.getSize();      
46.          System.out.println(elements);      
47.         //得到在内存中的元素数量      
48.         long elementsInMemory = cache.getMemoryStoreSize();      
49.          System.out.println(elementsInMemory);      
50.         //得到硬盘中的缓存元素数量      
51.         long elementsInDisk = cache.getDiskStoreSize();      
52.          System.out.println(elementsInDisk);      
53.         /**  
54.           * 在官方文档中有cache.getHitCount();等相关方法，在这里已经找不到  
55.           * 应该是版本变迁的原因。  
56.           */     
57.         //5.高级主题 注册mbean 也许在以后的高级主题中会进一步阐述      
58.          CacheManager manager1 = new CacheManager();      
59.          MBeanServer mBeanServer = ManagementFactory.getPlatformMBeanServer();      
60.          ManagementService.registerMBeans(manager1, mBeanServer, false, false, false, true);      
61.          manager.shutdown();      
63. }     
64. package tutorial;  
65. import java.io.Serializable;  
66. import java.lang.management.ManagementFactory;  
67. import javax.management.MBeanServer;  
68. import net.sf.ehcache.Cache;  
69. import net.sf.ehcache.CacheManager;  
70. import net.sf.ehcache.Element;  
71. import net.sf.ehcache.management.ManagementService;  
72. /** 
73.  * 使用 Caches 
74.  * @author zhangyt 
75.  * 
76.  */  
77. public class UsingCaches {  
78.  public static void main(String[] args) {  
79.   CacheManager.create();  
80.   CacheManager manager= CacheManager.getInstance();  
81.   //1.取得Cache  
82.   Cache cache = manager.getCache("sampleCache1");  
83.   //2.执行 CRUD 操作  
84.   //2.1  增加元素  
85.   Element element1 = new Element("key1", "value1");  
86.   Element element2 = new Element("key2", "value2");  
87.   cache.put(element1);  
88.   cache.put(element2);  
89.   //2.2 更新元素  
90.   cache.put(new Element("key1", "value1u"));  
91.   //2.3 取值  
92.   //取得一个序列化了的值  
93.   Element element231 = cache.get("key1");  
94.   Serializable value231 = element231.getValue();  
95.   System.out.println(value231);  
96.   //取得一个不是序列化的值  
97.   Element element232 = cache.get("key1");  
98.   Object value232 = element232.getObjectValue();  
99.   System.out.println(value232);  
100.   //3.4 删除一个元素  
101.   cache.remove("key2");  
102.   System.out.println(cache.get("key2") == null);  
103.   //3. 强硬命令写入硬盘  
104.   cache.flush();  
105.   //4. 取得缓存的大小  
106.   //得到总的缓存数目  
107.   int elements = cache.getSize();  
108.   System.out.println(elements);  
109.   //得到在内存中的元素数量  
110.   long elementsInMemory = cache.getMemoryStoreSize();  
111.   System.out.println(elementsInMemory);  
112.   //得到硬盘中的缓存元素数量  
113.   long elementsInDisk = cache.getDiskStoreSize();  
114.   System.out.println(elementsInDisk);  
115.   /** 
116.    * 在官方文档中有cache.getHitCount();等相关方法，在这里已经找不到 
117.    * 应该是版本变迁的原因。 
118.    */  
119.   //5.高级主题 注册mbean 也许在以后的高级主题中会进一步阐述  
120.   CacheManager manager1 = new CacheManager();  
121.      MBeanServer mBeanServer = ManagementFactory.getPlatformMBeanServer();  
122.      ManagementService.registerMBeans(manager1, mBeanServer, false, false, false, true);  
123.   manager.shutdown();  
124.  }  
125. }  

看了以上的内容，相信对ehcache就可以进行一般的应用了