Openfire 中多處用到了Cache 來(lái)存儲(chǔ)那些訪問(wèn)較為頻繁的數(shù)據(jù)，例如userManager中的userCache，rosterManager 中的rosterCache。

以下為Openfire中Cache的實(shí)現(xiàn)機(jī)制：

1. Cache 接口：

?

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

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

2. Cacheable 接口：

?

interface Cacheable extends java.io.Serializable
繼承了序列化接口，如果是自己定義的數(shù)據(jù)需要存儲(chǔ)在Cache中，則需要實(shí)現(xiàn)此接口中的getCacheSize()方法，否則會(huì)在Cache.put 時(shí)報(bào)如下的錯(cuò)誤：

?

?

<span style="color: #FF0000;" mce_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：

?

一個(gè)提供計(jì)算對(duì)象大小的類(lèi)。比較好用的是sizeOfMap()、sizeOfCollection()、sizeOfString() 方法，可在實(shí)現(xiàn)getCacheSize() 方法時(shí)直接調(diào)用。

4.DefaultCache：

Openfire中Cache接口的一個(gè)實(shí)現(xiàn)，其中保持了兩個(gè)鏈表lastAccessedList (用于被訪問(wèn)的順序管理)，ageList (用于生命周期的管理)。

主要提供了以下方法：

?

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

?

4.CacheFactoryStrategy 接口和 DefaultLocalCacheStrategy類(lèi)：

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

DefaultLocalCacheStrategy 則為Openfire中使用的Cache 管理方法，并沒(méi)有實(shí)現(xiàn)集群功能。

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

5.CacheFactory 工廠類(lèi)：

這里用到了java 設(shè)計(jì)模式中的工廠模式

在Openfire 甚至我們自己寫(xiě)的插件中會(huì)用到各種各樣的Cache，CacheFactory則提供了一個(gè)統(tǒng)一的創(chuàng)建和使用Cache的平臺(tái)。

這里重點(diǎn)看三個(gè)成員：

?

Map<String,Cache> caches = new ConcurrentHashMap<String,Cache>(); Map<String,String> cacheNames = new HashMap<String,String>(); Map<String,Long> cacheProps = new HashMap<String,Long>(); 第一個(gè)用來(lái)存儲(chǔ)所有創(chuàng)建的Cache

?

第二個(gè)用來(lái)存儲(chǔ)所有創(chuàng)建的Cache名稱(chēng)

第三個(gè)用來(lái)存儲(chǔ)Cache的屬性

整個(gè)Factory 中的大部分方法都是圍繞這三個(gè)成員進(jìn)行操作的。集群部分由于在strategy中未實(shí)現(xiàn)，暫不討論。

createCache方法直接調(diào)用strategy 的createCache() 來(lái)創(chuàng)建Cache。

6.Cache的使用：

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

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

?

Openfire 的 Cache機(jī)制