用ATL建立轻量级的COM对象（二）

起步篇

在本文的第一部分，我们简要介绍了ATL的一些背景知识以及ATL所面向的开发技术和环境。在这一部分 将开始走进ATL，讲述ATL编程的基本方法、原则和必须要注意的问题。

理解ATL最容易的方法是考察它对客户端编程的支持。对于COM编程新手而言，一个棘手的主要问题之一是正确管理接口指针的引用计数。COM的引用计数法则是没有运行时强制 性的，也就是说每一个客户端必须保证对对象的承诺。

有经验的COM编程者常常习惯于使用文档中（如《Inside OLE》）提出的标准模式。调用某个函数或方法，返回接口指针，在某个时间范围内使用这个接口指针，然后释放它。下面是使用这种模式的代码例子：

01.void f(void) {
02.IUnknown *pUnk = 0;
03.// 调用
04.HRESULT hr = GetSomeObject(&pUnk);
05.if (SUCCEEDED(hr)) {
06.// 使用
07.UseSomeObject(pUnk);
08.// 释放
09.pUnk->Release();
10.}
11.}

 这个模式在COM程序员心中是如此根深蒂固，以至于他们常常不写实际使用指针的语句，而是先在代码块末尾敲入Release语句。这很像C程序员使用switch语句时的条件反射一样，先敲入break再说。

其实调用Release实在不是什么可怕的负担，但是，客户端程序员面临两个相当严重的问题。第一个问题与获得多接口指针有关。如果某个函数需要在做任何实际工作之前获得三个接口指针，也就是说在第一个使用指针的语句之前必须要由三个调用语句。在书写代码时，这常常意味着程序员需要写许多嵌套条件语句，如：

01.void f(void) {
02.IUnknown *rgpUnk[3];
03.HRESULT hr = GetObject(rgpUnk);
04.if (SUCCEEDED(hr)) {
05.hr = GetObject(rgpUnk + 1);
06.if (SUCCEEDED(hr)) {
07.hr = GetObject(rgpUnk + 2);
08.if (SUCCEEDED(hr)) {
09.UseObjects(rgpUnk[0], rgpUnk[1],
10.rgpUnk[2]);
11.rgpUnk[2]->Release();
12.}
13.rgpUnk[1]->Release();
14.}
15.rgpUnk[0]->Release();
16.}
17.}

 像这样的语句常常促使程序员将TAB键设置成一个或两个空格，甚至情愿使用大一点的显示器。但事情并不总是按你想象的那样，由于种种原因项目团队中的COM组件编程人员往往得不到 所想的硬件支持，而且在公司确定关于TAB键的使用标准之前，程序员常常求助于使用有很大争议但仍然有效的“GOTO”语句：

01.void f(void) {
02.IUnknown *rgpUnk[3];
03.ZeroMemory(rgpUnk, sizeof(rgpUnk));
04.if (FAILED(GetObject(rgpUnk)))
05.goto cleanup;
06.if (FAILED(GetObject(rgpUnk+1)))
07.goto cleanup;
08.if (FAILED(GetObject(rgpUnk+2)))
09.goto cleanup;
10.
11.UseObjects(rgpUnk[0], rgpUnk[1], rgpUnk[2]);
12.
13.cleanup:
14.if (rgpUnk[0]) rgpUnk[0]->Release();
15.if (rgpUnk[1]) rgpUnk[1]->Release();
16.if (rgpUnk[2]) rgpUnk[2]->Release();
17.}

这样的代码虽然不那么专业，但至少减少了屏幕的水平滚动。

使用以上这些代码段潜在着更加棘手的问题，那就是在碰到C++异常时。如果函数UseObjects丢出异常，则释放指针的代码被完全屏蔽掉了。 解决这个问题的一个方法是使用Win32的结构化异常处理（SEH）进行终结操作：

01.void f(void) {
02.IUnknown *rgpUnk[3];
03.ZeroMemory(rgpUnk, sizeof(rgpUnk));
04.__try {
05.if (FAILED(GetObject(rgpUnk))) leave;
06.if (FAILED(GetObject(rgpUnk+1))) leave;
07.if (FAILED(GetObject(rgpUnk+2))) leave;
08.
09.UseObjects(rgpUnk[0], rgpUnk[1], rgpUnk[2]);
10.} __finally {
11.if (rgpUnk[0]) rgpUnk[0]->Release();
12.if (rgpUnk[1]) rgpUnk[1]->Release();
13.if (rgpUnk[2]) rgpUnk[2]->Release();
14.}

可惜Win32 SHE在C++中的表现并不如想象得那么好。较好的方法是使用内建的C++异常处理模型，同时停止使用没有加工过的指针。标准C++库有一个类：auto_ptr，在其析构函数中定 死了一个操作指针的delete调用（即使在出现异常时也能保证调用）。与之类似，ATL有一个COM智能指针，CComPtr，它的析构函数会正确调用Release。

CComPtr类实现客户端基本的COM引用计数模型。CComPtr有一个数据成员，它是一个未经过任何加工的COM接口指针。其类型被作为模板参数传递：

1.CComPtr unk;
2.CComPtr cf;

 缺省的构造函数将这个原始指针数据成员初始化为NULL。智能指针也有构造函数，它的参数要么是原始指针，要么是相同类型的智能参数。不论哪种情况，智能指针都调用AddRef控制引用。CComPtr的赋值操作符 既可以处理原始指针，也可以处理智能指针，并且在调用新分配指针的AddRef之前自动释放保存的指针。最重要的是，CComPtr的析构函数释放保存的接口（如果非空）。请看下列代码：

01.void f(IUnknown *pUnk1, IUnknown *pUnk2) {
02.// 如果非空，构造函数调用pUnk1的AddRef
03.CComPtr unk1(pUnk1);
04.// 如果非空，构造函数调用unk1.p的AddRef
05.CComPtr unk2 = unk1;
06.// 如果非空，operator= 调用unk1.p的Release并且
07.//如果非空，调用unk2.p的AddRef
08.unk1 = unk2;
09.//如果非空，析构函数释放unk1 和 unk2
10.}

 除了正确实现COM的AddRef 和 Release规则之外，CComPtr还允许实现原始和智能指针的透明操作，参见附表二所示。也就是说下面的代码按照你所想象的方式运行：

01.void f(IUnknown *pUnkCO) {
02.
03.CComPtr cf;
04.
05.HRESULT hr;
06.
07.// 使用操作符 & 获得对 &cf.p 的存取
08.hr = pUnkCO->QueryInterface(IID_IClassFactory,(void**)&cf);
09.if (FAILED(hr)) throw hr;
10.
11.CComPtr unk;
12.
13.// 操作符 -> 获得对cf.p的存取
14.// 操作符 & 获得对 &unk.p的存取
15.hr = cf->CreateInstance(0, IID_IUnknown, (void**)&unk);
16.
17.if (FAILED(hr)) throw hr;
18.
19.// 操作符 IUnknown * 返回 unk.p
20.UseObject(unk);
21.
22.// 析构函数释放unk.p 和 cf.p
23.}

 除了缺乏对Release的显式调用外，这段代码像是纯粹的COM代码。有了CComPtr类的武装，前面所遇到的麻烦问题顿时变得简单了：

1.void f(void) {
2.CComPtr rgpUnk[3];
3.if (FAILED(GetObject(&rgpUnk[0]))) return;
4.if (FAILED(GetObject(&rgpUnk[1]))) return;
5.if (FAILED(GetObject(&rgpUnk[2]))) return;
6.UseObjects(rgpUnk[0], rgpUnk[1], rgpUnk[2]);
7.
8.}

由于CComPtr对操作符重载用法的扩展，使得代码的编译和运行无懈可击。

假定模板类知道它所操纵的指针类型，你可能会问：那为什么智能指针不能在它的功能操作符或构造函数中自动调用QueryInterface，从而更有效地包装IUnknown呢？在Visual C++ 5.0出来以前，没有办法将某个接口的GUID与它的本身的C++类型关联起来——Visual C++ 5.0用私有的declspec将某个IID与一个接口定义绑定在一起。因为ATL的设计 考虑到了它要与大量不同的C++编译器一起工作，它需要用与编译器无关的手段提供GUID。下面我们来探讨另一个类——CComQIPtr类。

CComQIPtr与CComPtr关系很密切（实际上，它只增加了两个成员函数）。CComQIPtr必须要两个模板参数：一个是被操纵的指针类型 ，另一个是对应于这个指针类型的GUID。例如，下列代码声明了操纵IDataObject 和IPersist接口的智能指针：

1.CComQIPtr do;
2.CComQIPtr p;

 CComQIPtr的优点是它有重载的构造函数和赋值操作符。同类版本（例如，接受相同类型的接口）仅仅AddRef右边的赋值/初始化操作。这实际上就是CComPtr的功能。异类版本（接受类型不一致的接口）正确调用QueryInterface来决定是否这个对象确实支持所请求的接口：

01.void f(IPersist *pPersist) {
02.CComQIPtr p;
03.// 同类赋值 - AddRef''s
04.p = pPersist;
05.
06.CComQIPtr do;
07.// 异类赋值 - QueryInterface''s
08.do = pPersist;
09.}

 在第二种赋值语句中，因为pPersist是非IDataObject *类型，但它是派生于IUnknown的接口指针，CComQIPtr通过pPersist调用QueryInterface来试图获得这个对象的IDataObject接口指针。如果QueryInterface调用成功，则此智能指针将含有作为结果的原始IDataObject指针。如果QueryInterface调用失败，则do.p将被置为null。如果QueryInterface返回的HRESULT值很重要，但又没有办法从赋值操作获得其值时，则必须显式调用QueryInterface。

既然有了CComQIPtr，那为什么还要CComPtr呢？由几个理由：首先，ATL最初的发布版本只支持CComPtr，所以它就一直合法地保留下来了。其二（也是最重要的理由），由于重载的构造函数和赋值操作，对IUnknown使用CComQIPtr是非法的。因为所有COM接口的类型定义都必须与IUnknown兼容。

1.CComPtr unk;

从功能上将它等同于

1.CComQIPtr unk;

前者正确。后者是错误的用法。如果你这样写了，C++编译器将提醒你改正。

将CComPtr作为首选的另外一个理由可能是一些开发人员相信静悄悄地调用QueryInterface，没有警告，削弱了C++系统的类型。毕竟，C++在没有进行强制类型转换的情况下不允许对类型不一致的原始指针 进行赋值操作，所以为什么要用智能指针的道理也在这，幸运的是开发人员可以选择最能满足需要的指针类型。

许多开发人员将智能指针看成是对过于的复杂编程任务的简化。我最初也是这么认为的。但只要留意它们使用COM智能指针的方法。就会逐渐认识到它们引入的潜在危险与它们解决的问题一样多

于这一点，我用一个现成的使用原始指针的函数为例：

1.void f(void) {
2.IFoo *pFoo = 0;
3.HRESULT hr = GetSomeObject(&pFoo);
4.if (SUCCEEDED(hr)) {
5.UseSomeObject(pFoo);
6.pFoo->Release();
7.}
8.}

将它自然而然转换到使用CComPtr。

1.void f(void) {
2.CComPtr pFoo = 0;
3.HRESULT hr = GetSomeObject(&pFoo);
4.if (SUCCEEDED(hr)) {
5.UseSomeObject(pFoo);
6.pFoo->Release();
7.}
8.}

 注意CComPtr 和 CComQIPtr输出所有受控接口成员，包括AddRef和Release。可惜当客户端通过操作符->的结果调用Release时，智能指针很健忘 ，会二次调用构造函数中的Release。显然这是错误的，编译器和链接器也欣然接受了这个代码。如果你运气好的话，调试器会很快捕获到这个错误。

使用ATL智能指针的另一个要引起注意的风险是类型强制转换操作符对原始指针提供的访问。如果隐式强制转换操作符的使用存在争议。当 ANSI/ISO C++ 委员会在决定采用某个C++串类时，他们明确禁止隐式类型转换。而是要求必须显式使用c_str函数在需要常量char *（const char *）的地方传递标准C++串。ATL提供了一种隐含式的类型转换操作符顺利地解决了这个问题。通常，这个转换操作符可以根据你的喜好来使用，允许你将智能指针传递到需要用原始指针的函数。

1.void f(IUnknown *pUnk) {
2.CComPtr unk = pUnk;
3.// 隐式调用操作符IUnknown *()
4.CoLockObjectExternal(unk, TRUE, TRUE);
5.}

这段代码能正确运行，但是下面的代码也不会产生警告信息，编译正常通过：

1.HRESULT CFoo::Clone(IUnknown **ppUnk) {
2.CComPtr unk;
3.CoCreateInstance(CLSID_Foo, 0, CLSCTX_ALL,
4.IID_IUnknown, (void **) &unk);
5.// 隐式调用操作符IUnknown *()
6.*ppUnk = unk;
7.return S_OK;
8.}

 在这种情况下，智能指针（unk）对原始值针**ppUnk的赋值触发了与前面代码段相同的强制类型转换。在第一个例子中，不需要用AddRef。在第二个例子中，必须要用AddRef。

有关使用智能指针的更详细一般信息，请参见Scott Meyer的《More Effective C++》（Addison-Wesley, 1995年出版）。国内目前还没有这本书的中译本或影印本。有关COM智能指针的更多特定信息，请参见Don Box的一篇关于智能指针的专题文章http://www.develop.com/dbox/cxx/SmartPointer.htm。 （待续）

http://www.vckbase.com/index.php/wv/179.html