1.缘起:
假设我们的用户管理系统要求用户的ID和Name都必须是唯一的,并且用户的ID和Name一经确定就不能被修改。而且管理系统经常需要根据ID来查找Name,也经常需要根据Name来查找ID。根据这样的需求,我们可以考虑使用一个Dictionary来将ID和Name缓存起来,通常ID作为Key,Name作为Value。这样便可实现通过ID查询Name的快速查找,但是,通过Name查找ID就不是那么快了,因为涉及到对Dictionary的Values做遍历的操作。那么,有可能使得通过Name查找ID的速度与通过ID查找Name的速度一样快吗?
于是,我设计了ESBasic.ObjectManagement.Cache.IBidirectionalMapping(双向映射)来解决这个问题。
双向映射的形象示意图如下:
2.适用场合:
如果满足以下的条件,则可以使用双向映射:
(1)Key是唯一的,Value也是唯一的。
(2)需要对Key和Value做缓存。
(3)经常需要根据Key来查找Value。
(4)经常需要根据Value来查找Key。
3.设计思想与实现
IBidirectionalMapping接口定义如下:
/// IBidirectionalMapping 双向映射。即Key和Value都是唯一的,在这种情况下使用IBidirectionalMapping可提升依据Value查找Key的速度。
/// 该接口的实现必须是线程安全的。2008.08.20
/// </summary>
public interface IBidirectionalMapping<T1, T2>
{
int Count { get; }
/// <summary>
/// Add 添加映射对。如果已经有相同的key/value存在,则会覆盖。
/// </summary>
void Add(T1 t1, T2 t2);
void RemoveByT1(T1 t1);
void RemoveByT2(T2 t2);
T1 GetT1(T2 t2);
T2 GetT2(T1 t1);
bool ContainsT1(T1 t1);
bool ContainsT2(T2 t2);
/// <summary>
/// GetAllT1ListCopy 返回T1类型元素列表的拷贝。
/// </summary>
IList<T1> GetAllT1ListCopy();
/// <summary>
/// GetAllT2ListCopy 返回T2类型元素列表的拷贝。
/// </summary>
IList<T2> GetAllT2ListCopy();
}
该接口使用了两个泛型参数,根据上面的描述,一个泛型参数表示Key的类型,另一个泛型参数表示Vlaue的类型。由于,在双向映射中,Key和Value是对称的,所以我没有使用TKey和TValue来命名它们,而是使用T1和T2。
在实现BidirectionalMapping时,我们使用两个Dictionary来完成双向映射的功能。一个Dictionary以T1为Key,T2为Value;另一个刚好反过来。
在实现的具体过程中,要注意以下几点:
(1)为了允许在多线程的环境中使用双向映射,所以BidirectionalMapping必须在对内部Dictionary操作的时候进行加锁控制。
(2)在实现Add方法添加一个“映射对”的时候,必须判断当前是否已经存在了相同的值,如果存在,则先删除旧的映射对,再添加新的映射对。
(3)要注意一个细节,GetAllT1ListCopy和GetAllT2ListCopy的实现都使用了lock,这是因为在拷贝的时候会对其Keys或Values进行foreach遍历,而在对Dictionary中的元素进行foreach遍历的时候,如果同时向其中添加或删除元素,则foreach操作是会抛出异常的。
4. 使用时的注意事项
BidirectionalMapping提升了通过Name查找ID的速度,这是通过使用了更大的内存来做到的,是典型的“空间换时间”的例子。所以,对于巨大规模的映射对的缓存,要注意内存的使用问题。
另外,映射对中的两个元素的类型不一定非是ID或Name这样的简单对象,实际上,非常复杂的对象也可以缓存在双向映射中,只要其GetHashCode方法实现的恰当就不会有任何问题。
5.扩展
双向映射BidirectionalMapping暂时没有任何扩展。
注: ESBasic已经开源,点击这里下载源码。
ESBasic开源前言