一 ehcache API:java
1: Using the CacheManager
1.1全部ehcache的使用, 都是從 CacheManager. 開始的.
有多種方法建立CacheManager實例:linux
- CacheManager.getInstance()
或者:windows
- CacheManager manager = new CacheManager();
- String[] cacheNames = manager.getCacheNames();
若是須要從指定配置文件建立 CacheManager:緩存
- Create two CacheManagers, each with a different configuration, and list the caches in each.
- CacheManager manager1 = new CacheManager("src/config/ehcache1.xml");
- CacheManager manager2 = new CacheManager("src/config/ehcache2.xml");
- String[] cacheNamesForManager1 = manager1.getCacheNames();
- String[] cacheNamesForManager2 = manager2.getCacheNames();
1.2 Adding and Removing Caches Programmatically
手動建立一個cache, 而不是經過配置文件:ide
- CacheManager singletonManager = CacheManager.create();
- singletonManager.addCache("testCache");
- Cache test = singletonManager.getCache("testCache");
或者:測試
- public void testCreatCacheByProgram()
- {
- CacheManager singletonManager = CacheManager.create();
- Cache memoryOnlyCache = new Cache("testCache", 5000, false, false, 5, 2);
- singletonManager.addCache(memoryOnlyCache);
- Cache testCache = singletonManager.getCache("testCache");
- assertNotNull(testCache);
- }
手動移除一個cache:spa
- CacheManager singletonManager = CacheManager.create();
- singletonManager.removeCache("sampleCache1");
1.3 Shutdown the CacheManager
ehcache應該在使用後關閉, 最佳實踐是在code中顯式調用:線程
- CacheManager.getInstance().shutdown();
2 Using Caches
好比我有這樣一個cache:debug
- <cache name="sampleCache1" maxElementsInMemory="10000"
- maxElementsOnDisk="1000" eternal="false" overflowToDisk="true"
- diskSpoolBufferSizeMB="20" timeToIdleSeconds="300"
- timeToLiveSeconds="600" memoryStoreEvictionPolicy="LFU" />
2.1 Obtaining a reference to a Cache
得到該cache的引用:code
- String cacheName = "sampleCache1";
- CacheManager manager = new CacheManager("src/ehcache1.xml");
- Cache cache = manager.getCache(cacheName);
2.2 Performing CRUD operations
下面的代碼演示了ehcache的增刪改查:
- public void testCRUD()
- {
- String cacheName = "sampleCache1";
- CacheManager manager = new CacheManager("src/ehcache1.xml");
- Cache cache = manager.getCache(cacheName);
-
- Element element = new Element("key1", "value1");
- cache.put(element);
-
- cache.put(new Element("key1", "value2"));
-
- element = cache.get("key1");
- Serializable value = element.getValue();
-
- element = cache.get("key1");
- assertNotNull(element);
- Object valueObj = element.getObjectValue();
- assertNotNull(valueObj);
-
- assertNotNull(cache.get("key1"));
- cache.remove("key1");
- assertNull(cache.get("key1"));
-
- }
2.3 Disk Persistence on demand
- public void testDiskPersistence()
- {
- String cacheName = "sampleCache1";
- CacheManager manager = new CacheManager("src/ehcache1.xml");
- Cache cache = manager.getCache(cacheName);
- for (int i = 0; i < 50000; i++)
- {
- Element element = new Element("key" + i, "myvalue" + i);
- cache.put(element);
- }
- cache.flush();
- Log.debug("java.io.tmpdir = " + System.getProperty("java.io.tmpdir"));
- }
備註: 持久化到硬盤的路徑由虛擬機參數"java.io.tmpdir"決定.
例如, 在windows中, 會在此路徑下
C:\Documents and Settings\li\Local Settings\Temp
在linux中, 一般會在: /tmp 下
2.4 Obtaining Cache Sizes
如下代碼演示如何得到cache個數:
- public void testCachesizes()
- {
- long count = 5;
- String cacheName = "sampleCache1";
- CacheManager manager = new CacheManager("src/ehcache1.xml");
- Cache cache = manager.getCache(cacheName);
- for (int i = 0; i < count; i++)
- {
- Element element = new Element("key" + i, "myvalue" + i);
- cache.put(element);
- }
-
- int elementsInCache = cache.getSize();
- assertTrue(elementsInCache == 5);
-
- long elementsInMemory = cache.getMemoryStoreSize();
-
- long elementsInDiskStore = cache.getDiskStoreSize();
- assertTrue(elementsInMemory + elementsInDiskStore == count);
- }
3: Registering CacheStatistics in an MBeanServer
ehCache 提供jmx支持:
- CacheManager manager = new CacheManager();
- MBeanServer mBeanServer = ManagementFactory.getPlatformMBeanServer();
- ManagementService.registerMBeans(manager, mBeanServer, false, false, false, true);
把該程序打包, 而後:
- java -Dcom.sun.management.jmxremote -jar 程序名.jar
再到javahome/bin中運行jconsole.exe, 即可監控cache.
4. 用戶能夠自定義處理cacheEventHandler, 處理諸如元素放入cache的各類事件(放入,移除,過時等事件)
只需三步:
4.1 在cache配置中, 增長cacheEventListenerFactory節點.
- <cache name="Test" maxElementsInMemory="1" eternal="false"
- overflowToDisk="true" timeToIdleSeconds="1" timeToLiveSeconds="2"
- diskPersistent="false" diskExpiryThreadIntervalSeconds="1"
- memoryStoreEvictionPolicy="LFU">
- <cacheEventListenerFactory class="co.ehcache.EventFactory" />
- </cache>
4.2: 編寫EventFactory, 繼承CacheEventListenerFactory:
- public class EventFactory extends CacheEventListenerFactory
- {
- @Override
- public CacheEventListener createCacheEventListener(Properties properties)
- {
-
- return new CacheEvent();
- }
-
- }
4.3 編寫 class: CacheEvent, 實現 CacheEventListener 接口:
- public class CacheEvent implements CacheEventListener
- {
-
- public void dispose()
- {
- log("in dispose");
- }
-
- public void notifyElementEvicted(Ehcache cache, Element element)
- {
-
- log("in notifyElementEvicted" + element);
- }
-
- public void notifyElementExpired(Ehcache cache, Element element)
- {
-
- log("in notifyElementExpired" + element);
- }
-
- public void notifyElementPut(Ehcache cache, Element element) throws CacheException
- {
-
- log("in notifyElementPut" + element);
- }
-
- public void notifyElementRemoved(Ehcache cache, Element element) throws CacheException
- {
-
- log("in notifyElementRemoved" + element);
- }
-
- public void notifyElementUpdated(Ehcache cache, Element element) throws CacheException
- {
-
- log("in notifyElementUpdated" + element);
- }
-
- public void notifyRemoveAll(Ehcache cache)
- {
-
- log("in notifyRemoveAll");
- }
-
- public Object clone() throws CloneNotSupportedException
- {
- return super.clone();
- }
-
- private void log(String s)
- {
- Log.debug(s);
- }
- }
如今能夠編寫測試代碼:
- public void testEventListener()
- {
- String key = "person";
- Person person = new Person("lcl", 100);
- MyCacheManager.getInstance().put("Test", key, person);
- Person p = (Person) MyCacheManager.getInstance().get("Test", key);
-
- try
- {
- Thread.sleep(10000);
- }
- catch (InterruptedException e)
- {
-
- e.printStackTrace();
- }
-
- assertNull(MyCacheManager.getInstance().get("Test", key));
- }
根據配置, 該緩存對象生命期只有2分鐘, 在Thread.sleep(10000)期間, 該緩存元素將過時被銷燬, 在銷燬前, 觸發notifyElementExpired事件.
二 Ehcache配置文件
以以下配置爲例說明:
- <cache name="CACHE_FUNC"
- maxElementsInMemory="2"
- eternal="false"
- timeToIdleSeconds="10"
- timeToLiveSeconds="20"
- overflowToDisk="true"
- diskPersistent="true"
- 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()方法。 更多說明可看ehcache自帶的ehcache.xml的註釋說明.