Openfire 的 Cache機制

Openfire 中多處用到了Cache 來存儲那些訪問較為頻繁的數據，例如userManager中的userCache，rosterManager 中的rosterCache。

以下為Openfire中Cache的實現機制：

1. Cache 接口：

interface Cache<K,V> extends java.util.Map<K,V>

提供了基本的Cache接口方法。

2. Cacheable 接口：

interface Cacheable extends java.io.Serializable
繼承了序列化接口，如果是自己定義的數據需要存儲在Cache中，則需要實現此接口中的getCacheSize()方法，否則會在Cache.put 時報如下的錯誤：

<span style="color:#FF0000;">java.io.NotSerializableException: at java.io.ObjectOutputStream.writeObject0(Unknown Source) at java.io.ObjectOutputStream.writeObject(Unknown Source) at org.jivesoftware.util.cache.DefaultCache.calculateSize(DefaultCache.java:583) at org.jivesoftware.util.cache.DefaultCache.put(DefaultCache.java:141) at org.jivesoftware.util.cache.CacheWrapper.put(CacheWrapper.java:129)</span>
3.CacheSizes：

一個提供計算對象大小的類。比較好用的是sizeOfMap()、sizeOfCollection()、sizeOfString() 方法，可在實現getCacheSize() 方法時直接調用。

4.DefaultCache：

Openfire中Cache接口的一個實現，其中保持了兩個鏈表lastAccessedList (用於被訪問的順序管理)，ageList (用於生命周期的管理)。

主要提供了以下方法：

put() 存儲一個指定鍵值對。計算數據的大小，超過Cache設置的最大size 90% 的數據將直接被丟掉；並將添加的數據加入到兩個鏈表中，並對Cache進行一次整理。 get() 根據Key查找一個數據。會先清除那些過期的數據，更新命中和 miss 的次數，並在查找到時將此數據從lastAccessedList 中移動到鏈表的頭部。 remove() 從Cache中移除一個鍵值對。更新Cache大小，並從鏈表中移除對應的數據。 clear() 清空整個Cache。包括鏈表，各個統計的值的大小。 size() 獲取Cache中數據個數。會先清理過期的數據。 isEmpty() 判斷是否為空。會先清理過期的數據。 values() 獲取所有數據，返回一個Collection。會先清理過期的數據。 containsKey() 判斷是否含有指定鍵。會先清理過期的數據。 putAll() 將一個map中的所有數據存儲到Cache中。 containsValue() 判斷是否含有指定值。會先清理過期的數據。 containsNullValue() 是否含有空值。 entrySet() 返回一個含有所有數據的Set。 keySet() 返回一個含有所有Key的Set。 getName/setName() 設置獲取名稱。 getCacheHits() 獲取命中的次數。 getCacheMisses() 獲取miss 的次數。 getCacheSize() 獲取當前Cache的大小。 getMaxCacheSize/setMaxCacheSize() 設置獲取Cache 的最大空間。 getMaxLifetime/setMaxLifetime() 設置獲取 Cache 數據的最大生命周期。 calculateSize() 計算指定數據的大小。 注：這里可以看出所有要存儲在Cache中的數據必須是Cacheable 或基礎數據類型的，如果不是這兩種，則需要能夠序列化以便衡量數據的大小。 deleteExpiredEntries() 清除過期的數據。針對ageList鏈表中的節點進行判斷。 cullCache() 在Cache太滿的情況下清除一些數據，釋放空間。

4.CacheFactoryStrategy 接口和 DefaultLocalCacheStrategy類：

CacheFactoryStrategy 接口主要定義了在集群模式下的Cache 管理方法。

DefaultLocalCacheStrategy 則為Openfire中使用的Cache 管理方法，並沒有實現集群功能。

最主要的方法可以看下createCache()。

5.CacheFactory 工廠類：

這里用到了java 設計模式中的工廠模式

在Openfire 甚至我們自己寫的插件中會用到各種各樣的Cache，CacheFactory則提供了一個統一的創建和使用Cache的平台。

這里重點看三個成員：

Map<String,Cache> caches = new ConcurrentHashMap<String,Cache>(); Map<String,String> cacheNames = new HashMap<String,String>(); Map<String,Long> cacheProps = new HashMap<String,Long>(); 第一個用來存儲所有創建的Cache

第二個用來存儲所有創建的Cache名稱

第三個用來存儲Cache的屬性

整個Factory 中的大部分方法都是圍繞這三個成員進行操作的。集群部分由於在strategy中未實現，暫不討論。

createCache方法直接調用strategy 的createCache() 來創建Cache。

6.Cache的使用：

如果我們需要在使用Cache來實現某些數據的緩存，則可以使用Openfire的Cache機制，在CacheFactory的 static{} 代碼塊中添加我們自己的 Cache。在需要的地方使用createCache()，需要注意的是對Cache的操作需要考慮線程的同步和互斥。

PS: 在java  編程中使用此Cache 機制也是很不錯的選擇，對代碼稍加修改就可到處使用。