ATL中的集合和枚举

ATL中的集合和枚举 一

cool - 转载 ( 2004-11-22 11:55:00 ) 类别： VC/MFC

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; *ppUnk = NULL; CComObject<EnumType>* pEnum = NULL; HRESULT hr = CComObject<EnumType>::CreateInstance(&pEnum); if (FAILED(hr)) return hr; hr = pEnum->Init(pUnkForRelease, collection); if (SUCCEEDED(hr)) hr = pEnum->QueryInterface(ppUnk); if (FAILED(hr)) delete pEnum; return hr; }  CreateSTLEnumerator()函数封装了创建CComEnumOnSTL样式的枚举器所必需的初始化和错误处理代码，我们可以这样使用该函数来完成get__NewEnum()方法： typedef CComEnumOnSTL<IEnumVARIANT, &IID_IEnumVARIANT, VARIANT, _Copy<VARIANT>, std::vector<CComVariant> > VarVarEnum; std::vector<CComVariant> m_vec; STDMETHOD(get__NewEnum)(IUnknown** ppUnk) { return CreateSTLEnumerator<VarVarEnum>(ppUnk, this, m_vec); } 整个get__NewEnum就一条语句： return CreateSTLEnumerator<VarVarEnum>(ppUnk, this, m_vec); 显得干净利落。 让我们来看一个例子： 该例子的功能很简单，我们的COM组件内部有一个std::vector<VARIANT>，我需要将该vector内的数据以枚举器的形式暴露给客户端。该例子的实作步骤如下（编程环境为VS2002，也就是VC7+ATL7）： 1、 建立一个新的名为ATLEnum1的解决方案，在其下添加一个新的类型为ATL项目名为ATLEnum1的项目，在项目属性设置中，取消其“属性化”选择，勾上“允许合并proxy/stub代码的复选框，点完成建立项目。 2、 切换到“类视图”，按照如下所示给该工程添加一个模板为ATL简单对象名为ATLEnum的类： 图 ATLEnum-01 图 ATLEnum-02 VC对于添加的类的默认属性设置是支持双接口的，我们将其改为自定义接口，免去IDispatch接口实现的诸多麻烦。 3、 我们假设vector是全局性的，并且在ATLEnum类的构造函数中被初始化。打开ATLEnum.h文件，添加头文件包含： #include <vector> 添加vector<VARIANT>声明： std::vector<VARIANT> test_vec ; 改写CATLEnum构造函数如下： CATLEnum() { if ( test_vec.empty() ) { VARIANT var ; VariantInit( &var ) ; var.vt = VT_I4 ; var.llVal = 1 ; test_vec.push_back( var ) ; var.llVal = 2 ; test_vec.push_back( var ) ; } } 使得CATLEnum在构造时可以初始化vector。 4、 按照下图说明给CATLEnum添加一个名为GetEnum()的方法，用来向客户端提供枚举器： 图 ATLEnum-03 图 ATLEnum-04 5、 从MSDN附带的ATL Sample中找到ATLCollections工程，copy其中的Reuse文件夹到我们的ATLEnum1工程的文件夹中。打开ATLEnum.cpp，添加包含文件： #include "../Reuse/VCUE_Collection.h" 列出文章最开始所列出的策略类： typedef std::vector< VARIANT > ContainerType; typedef VARIANT ExposedType; typedef IEnumVARIANT EnumeratorInterface; typedef _Copy<VARIANT> CopyType; 根据以上的策略类，定义出枚举器对象： typedef CComEnumOnSTL< EnumeratorInterface, &__uuidof(EnumeratorInterface),  ExposedType,CopyType, ContainerType >  EnumeratorType; 此处typedef出来的EnumeratorType就是我们所需要的枚举器类。 改写GetEnum()方法的代码如下： STDMETHODIMP CATLEnum::GetEnum(IUnknown** ppUnk) { return VCUE::CreateSTLEnumerator<EnumeratorType>(ppUnk, this, test_vec); } 6、 整个服务器的编码工作已经完成了！我们只是简单的写了5个typedef语句，然后调用了ATL小组提供的一个函数，就完成了我们所需要的提供枚举器的功能。 Client测试 Server端编码完成，下面我们编写一个Client端的程序对写好的Server进行测试。 出于简单起见，该Client端代码并没有实现过多的功能，仅仅是取得了枚举器的接口，并测试了枚举器的Next()方法而已。 整个Client端代码如下： #include "stdafx.h" #include <iostream> #import "../ATLEnum1/debug/ATLEnum1.dll" no_namespace static const ULONG nBatchSize = 5 ; int main() { CoInitialize(NULL); IATLEnum* pATLEnum ; HRESULT hRes = / ::CoCreateInstance(__uuidof(ATLEnum), NULL, CLSCTX_ALL, __uuidof(IATLEnum), (LPVOID*) &pATLEnum) ; IEnumVARIANT* pEnumVar ; hRes = pATLEnum->GetEnum( (IUnknown**) &pEnumVar ) ; ULONG nReturned = 0 ; VARIANT arrVar[nBatchSize] = { 0 } ; pEnumVar->Next(nBatchSize, &arrVar[0], &nReturned) ; pEnumVar->Release() ; pATLEnum->Release() ; CoUninitialize(); return 0; } 执行完pEnumVar->Next(nBatchSize, &arrVar[0], &nReturned) ;这一条语句，可以从调试窗口看到如下结果： 图 ATLEnum - 05 变量nReturned = 2说明该枚举器取回了2个数据，展开arrVar数组的显示，可以看到枚举器接口正确地实现了Next()方法，将两个VARIANT数据传递给了客户端代码。