ESBasic 可复用的.NET类库（12） －－ 对象管理器 IObjectManager

1.缘起：

我们经常需要对一些动态对象进行管理，最常见的例子就是在线用户管理。当一个用户成功登陆到服务器后，我们就需要将其管理起来；当他退出后，就不再需要再管理他了。这就是所谓动态对象的含义，这些对象并不是一直需要被管理，只有当其被激活后，才需要被管理。它们总是在“激活”状态和“非激活”状态之间不断地切换。
我设计了对象管理器ESBasic.ObjectManagement.Managers.IObjectManager来管理类似的动态对象。这个类是ESBasic提供的众多对象管理容器中的非常简单的一个，无论是功能还是实现。
对象管理器的形象示意图如下：





2.适用场合：

如果你的系统有类似以下的需求，就可以使用IObjectManager：
（1）将要被管理的每个动态对象都有唯一的ID。
（2）对象经常要被添加到管理器中和经常要从管理器中移除。
（3）管理器在多线程的环境下被使用。


3．设计思想与实现

IObjectManager的接口定义如下：
public interface IObjectManager<TPKey, TObject>
{
event CbGeneric<TObject> ObjectRegistered;
event CbGeneric<TObject> ObjectUnregistered;

int Count { get; }

/// <summary>
/// Add 如果已经存在同ID的对象，则用新对象替换旧对象。
/// </summary>
void Add(TPKey key, TObject obj);

void Remove(TPKey id);
void Clear();
bool Contains(TPKey id);

/// <summary>
/// Get 如果不存在，则返回default（TObject）。
/// </summary>
TObject Get(TPKey id);

IList<TObject> GetAll();
IList<TPKey> GetKeyList();
IList<TPKey> GetKeyListByObj(TObject obj);
}
这个接口相当简单，就像是一个IDictionary的加强版。是的，你确实可以这样理解，把IObjectManager当作一个更好用的字典。而且ObjectManager的实现也的确是使用IDictionary来的。
但是它与IDictionary的区别――也是它更好用的地方在于：
（1）它是多线程安全的，可以再多线程的环境下被使用。与IDictionary相比，这应该是最大的一个易用点。
（2）Add方法采用的是覆盖原则――如果同Key的对象已经存在，则用新对象覆盖旧的对象。当然，如果你不想直接覆盖，再调用Add方法之前可以先调用Contains方法检测一下。
（3）当调用Remove方法从管理器中移除一个不存在的对象时，并不会抛出异常，而是直接返回。
（4）GetKeyList方法返回的是键值的拷贝，这样在对返回列表做foreach遍历时，即使内部字典中的元素发生了增加/删除也不会影响遍历操作。
（5）当内部集合的元素发生增加/删除时，以事件（ObjectRegistered事件和ObjectUnregistered事件）的方式通知外部。

4. 使用时的注意事项

IObjectManager的两个泛型参数都是没有泛型约束的，也就是说TObject可以是值类型。当TObject是值类型时，如果使用一个不存在的ID去调用Get方法，则不会返回null，因为值类型不可能为null，这时将返回default(TObject)。而这样的结果也许并不是你所期望的。

所以，如果你的TObject为值类型，又不想出现上面的情况，那么在调用Get方法之前有必要先调用Contains方法确认一下对象是否真的存在――这就像在使用IDictionary一样。



5.扩展

对象管理器IObjectManager暂时没有任何扩展。



注：ESBasic源码可到http://esbasic.codeplex.com/下载。
ESBasic讨论QQ群：37677395
ESBasic开源前言