COM中集合和枚举器的关系非常类似于STL中的容器和迭代器的关系。
如果一个COM对象可以被称为一个“集合”,那么很显然,该对象内部肯定是一些类型相同的数据的集合,当我们要将内部这些数据“暴露”给客户端使用时,如果直接照搬STL的模式,提供一个iterator型别,那么会造成服务器端的数据封装得太弱,数据易被客户端破坏。鉴于此,COM提供了枚举器供客户使用——客户通过集合的接口,取得枚举器的接口,使用枚举器访问数据;除开枚举器接口以外,一般的集合对象还要提供get__Item方法暴露自身数据。
假设ICollection接口支持枚举器IEnumSth,那么通过如下代码得到枚举器接口,枚举内部元素:
HRESULT hRes ;
IEnumSth pSth ;
hRes = ICollection->get__NewEnum( (IUnknown**) &pSth ) ;
我们的程序中并没有提供IEnumSth的声明,COM规定了,凡是IEnumXXX类型的接口,都需要用有如下四个方法:Next,Skip,Reset,Clone。很明显,get__NewEnum()方法的作用就是构造出一个对象(下面称其为枚举器对象),该对象实现了上面所列的4个方法,然后将该对象的接口指针返回给客户端即可。
ATL提供了一个枚举器对象的通用实现模板,极大的方便了我们的工作。该枚举器对象模板的设计思想是“基于策略”的,让我们首先来看看要实现该模板,需要有哪些策略:
1、 枚举器接口的名字——也就是上面例子中的IEnumSth
2、 枚举器接口的IID——也就是__uuidof(IEnumSth)
3、 被枚举的数据的类型——也就是上面例子中的Sth(可以是VARIANT,BSTR等)
4、 复制策略——这个策略最复杂,它完成的功能是将“集合”对象内部的数据Copy到客户提供的缓冲区的功能
5、 数据存放形式——“集合”对象内数据存放的数据结构(数组、STL容器等)
6、 线程模型
ATL提供的模板类其声明如下:
template <class Base, const IID* piid, class T, class Copy, class CollType, class ThreadModel = CComObjectThreadModel>
class ATL_NO_VTABLE CComEnumOnSTL
该类正好具有6个模板参数,其每个参数与上面所列的相应的策略对应,因此,应用该类前,先仔细考虑这6个模板参数的值,然后将其组合起来,即可得到自己所需要的枚举器对象——与ATL中其他的对象一样,该对象也需要用CComObject< >::CreateInstance的形式来建立其实例,而非直接new CComObject< >。
NB:对于以上6个模板参数,一般而言IID = __uuidof(Name)这个等式是成立的,所以真正正交的策略类不过5个而已。不过由于__uuidof运算符是Visual C++编译器对标准C++的扩展,所以ATL并没有在此处省略掉IID这个策略类。不过在ATL的其他很多地方,都有对于__uuidof运算符的使用——在COM的世界里,抛开MS是不可能的…………。
使用CComEnumOnSTL的步骤如下:
1、 确定哪个STL容器是需要枚举的
2、 在客户端需要枚举器接口的时候选用适当的模板参数,typedef出一个特定的枚举器对象
3、 CComObject< >::CreateInstance()产生枚举器实例
4、 对产生的枚举器实例调用Init()方法
5、 返回指针和结果信息给客户
整个过程说简单也不算简单,特别是一些步骤很容易被遗忘,ATL开发小组在随MSDN提供的ATL Sample中,提供了一个名为:ATLCollections的工程,该工程内有一个名为Reuse的文件夹,其中的3个文件其代码都是具有很强的复用性的,在VCUE_Collection.h文件中,ATL开发小组给我们提供了CreateSTLEnumerator()函数,封装了整个枚举器对象的创建过程,该函数是这样的:
template <class EnumType, class CollType>
HRESULT CreateSTLEnumerator(IUnknown** ppUnk, IUnknown* pUnkForRelease, CollType& collection)
{
if (ppUnk == NULL)
return E_POINTER;