ESBasic 可复用的.NET类库（13） －－ 分组对象管理器 IGroupingObjectManager

1.缘起：

    假设我们的订单系统需要管理所有未处理的订单，而客人经常需要查询属于自己的未处理的订单列表。另外，可能客服人员也需要根据订单ID迅速地找到对应的未处理订单。基于第一个需求，我们就可以将未处理的订单依据客人的帐号进行分组管理。

    我设计了ESBasic.ObjectManagement.Managers.IGroupingObjectManager分组对象管理器来完成对对象进行分组管理的功能。

      分组对象管理器的形象示意图如下：   

 

2.适用场合：

当你的需求覆盖以下条件时，就非常合适使用分组对象管理器：

（1）被管理的每个对象都有唯一的ID。

（2）   被管理的对象可以依据某个标志进行分组。

（3）   经常需要根据分组标志来查询符合该标志的对象列表。

（4）经常需要向管理器中增加/移除被分组的对象。

（5）经常需要根据对象ID快速查找对应的对象。

 

3．设计思想与实现

IGroupingObjectManager的接口定义如下：

     public interface IGroupingObjectManager<TGroupKey, TObjectKey, TObject> where TObject : IGroupingObject<TGroupKey ,TObjectKey>
    {
        /// <summary>
        /// Add 如果已经存在同ID的对象，则用新对象替换旧对象。
        /// </summary>        
        void Add(TObject obj);

        void Remove(TObjectKey objectID);

        /// <summary>
        /// Clear 清除所有对象与分组。
        /// </summary>
        void Clear();

        TObject Get(TObjectKey objectID);

        int TotalObjectCount { get;}

        /// <summary>
        /// GetCountOfGroup 获取某个分组中的对象的个数。
        /// </summary>        
        int GetCountOfGroup(TGroupKey groupID);

        /// <summary>
        /// GetAllObjectsCopy 获取管理器中的所有对象列表。
        /// </summary>        
        IList<TObject> GetAllObjectsCopy();

        /// <summary>
        /// GetGroupsCopy 获取所有的分组标志列表。
        /// </summary>       
        IList<TGroupKey> GetGroupsCopy();

        /// <summary>
        /// GetObjectsCopy 获取某个分组中的所有对象的列表。
        /// </summary>        
        IList<TObject> GetObjectsCopy(TGroupKey groupID);        
    }

 

这个接口包含有三个泛型参数：TGroupKey、 TObjectKey和 TObject。

TObject是被管理的对象的类型。

TObjectKey是被管理的对象的ID的类型。

TGroupKey是对被管理的对象进行分组的标志的类型。

另外，该接口的泛型参数还有一个约束，即TObject必须从IGroupingObject接口继承，以表明自己是一个可以被分组的对象。

IGroupingObject接口很简单，其定义如下：

    public interface IGroupingObject<TGroupKey,TObjectKey>
    {
        TObjectKey ID { get; }
        TGroupKey GroupID { get; }
    }

 

     观察这个接口告诉我们，只要一个对象有唯一的ID，并且有分组的标志，那么这个对象就可以被对象分组管理器进行管理了。

     关于GroupingObjectManager的实现要注意以下几点：

（1）GroupingObjectManager使用了两个字典集合：objectDictionary 、groupDictionary。objectDictionary用于存储所有被管理的对象。groupDictionary用于管理所有的分组，而且groupDictionary的Value又是另外一个字典，用于存储属于这一分组的所有对象。

（2）GroupingObjectManager的实现是线程安全的，所以可以在多线程的环境中使用。我们对其内部的两个字典集合都进行了加锁控制。

（3）Add方法采用的也是覆盖原则――如果同Key的对象已经存在，则用新对象覆盖旧的对象。

 

4. 使用时的注意事项

当调用Remove方法删除的是某个分组中的最后一个对象时，在该对象被删除后，对应的分组将也会被删除。所以，管理器中不会存在“空”的历史分组。也就是说，GetGroupsCopy方法返回的分组标志列表中的每个分组标志在管理器中对应的分组都包含至少一个被分组对象。

 

5.扩展

       分组对象管理器IGroupingObjectManager暂时没有任何扩展。

 

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