本文的目的是为刚刚接触COM的程序员提供编程指南,并帮助他们理解COM的基本概念。内容包括COM规范简介,重要的COM术语以及如何重用现有的COM组件。本文不包括如何编写自己的COM对象和接口。
COM即组件对象模型,是Component Object Model 取前三个字母的缩写,这三个字母在当今Windows的世界中随处可见。随时涌现出来的大把大把的新技术都以COM为基础。各种文档中也充斥着诸如COM对象、接口、服务器之类的术语。因此,对于一个程序员来说,不仅要掌握使用COM的方法,而且还要彻底熟悉COM的所有一切。
本文由浅入深描述COM的内在运行机制,教你如何使用第三方提供的COM对象(以Windows 外壳组件Shell为例)。读完本文后,你就能掌握如何使用Windows操作系统中内建的组件和第三方提供的COM对象。
本文假设你精通C++语言。在例子代码中使用了一点MFC和ATL,如果你不熟悉MFC和ATL也没关系,本文会对这些代码进行完全透彻的解释。本文包括以下几个部分:
HRESULT CoCreateInstance (REFCLSID rclsid,LPUNKNOWN pUnkOuter,DWORD dwClsContext,REFIID riid,LPVOID* ppv );
以下是参数解释:
rclsid:coclass的CLSID,例如,可以传递CLSID_ShellLink创建一个COM对象来建立快捷方式。
pUnkOuter:这个参数只用于COM对象的聚合,利用它向现有的coclass添加新方法。参数值为null表示不使用聚合。
dwClsContext:表示所使用COM服务器的种类。本文使用的是最简单的COM服务器,一个进程内(in-process)DLL,
所以传递的参数值为CLSCTX_INPROC_SERVER。注意这里不要随意使用CLSCTX_ALL(在ATL中,它是个缺省值),
因为在没有安装DCOM的Windows95系统上会导致失败。
riid:请求接口的IID。例如,可以传递IID_IShellLink获得IShellLink接口指针。
ppv:接口指针的地址。COM库通过这个参数返回请求的接口。
当你调用CoCreateInstance()时,它负责在注册表中查找COM服务器的位置,将服务器加载到内存,并创建你所请求的coclass实例。以下是一个调用的例子,创建一个CLSID_ShellLink对象的实例并请求指向这个对象IShellLink接口指针。
HRESULT hr;
IShellLink* pISL;hr = CoCreateInstance ( CLSID_ShellLink, // coclass 的CLSID NULL, // 不是用聚合CLSCTX_INPROC_SERVER, // 服务器类型IID_IShellLink, // 接口的IID (void**) &pISL ); // 指向接口的指针if ( SUCCEEDED ( hr ) ){// 用pISL调用方法}else{// 不能创建COM对象,hr 为出错代码}
首先声明一个接受CoCreateInstance()返回值的HRESULT和IShellLink指针。调用CoCreateInstance()来创建新的COM对象。如果hr接受到一个表示成功的代码,则SUCCEEDED宏返回TRUE,否则返回FALSE。FAILED是一个与SUCCEEDED对应的宏用来检查失败代码。
删除COM对象
前面说过,你不用释放COM对象,只要告诉它们你已经用完对象。IUnknown是每一个COM对象必须实现的接口,它有一个方法,Release()。调用这个方法通知COM对象你不再需要对象。一旦调用了这个方法之后,就不能再次使用这个接口,因为这个COM对象可能从此就从内存中消失了。
如果你的应用程序使用许多不同的COM对象,因此在用完某个接口后调用Release()就显得非常重要。如果你不释放接口,这个COM对象(包含代码的DLLs)将保留在内存中,这会增加不必要的开销。如果你的应用程序要长时间运行,就应该在应用程序处于空闲期间调用CoFreeUnusedLibraries() API。这个API将卸载任何没有明显引用的COM服务器,因此这也降低了应用程序使用的内存开销。
继续用上面的例子来说明如何使用Release():
// 像上面一样创建COM 对象, 然后if ( SUCCEEDED ( hr ) ){// 用pISL调用方法// 通知COM 对象不再使用它pISL->Release();}
接下来将详细讨论IUnknown接口。
基本接口——IUnknown
每一个COM接口都派生于IUnknown。这个名字有点误导人,其中没有未知(Unknown)接口的意思。它的原意是如果有一个指向某COM对象的IUnknown指针,就不用知道潜在的对象是什么,因为每个COM对象都实现IUnknown。
IUnknown 有三个方法:
HRESULT IUnknown::QueryInterface (REFIID iid,void** ppv );
以下是参数解释:
iid:所请求的接口的IID。
ppv:接口指针的地址,QueryInterface()通过这个参数在成功时返回这个接口。
让我们继续外壳链接的例子。它实现了IShellLink 和IPersistFile接口。如果你已经有一个IShellLink指针,pISL,可以从COM对象请求IPersistFile接口:
HRESULT hr;
IPersistFile* pIPF;
hr = pISL->QueryInterface ( IID_IPersistFile, (void**) &pIPF );
然后使用SUCCEEDED宏检查hr的值以确定QueryInterface()的调用情况,如果成功的话你就可以象使用其它接口指针那样使用新的接口指针,pIPF。但必须记住调用pIPF->Release()通知COM对象已经用完这个接口。
仔细做好串处理
这一部分将花点时间来讨论如何在COM代码中处理串。如果你熟悉Unicode 和ANSI,并知道如何对它们进行转换的话,你就可以跳过这一部分,否则还是读一下这一部分的内容。
不管什么时候,只要COM方法返回一个串,这个串都是Unicode串(这里指的是写入COM规范的所有方法)。Unicode是一种字符编码集,类似ASCII,但用两个字节表示一个字符。如果你想更好地控制或操作串的话,应该将它转换成TCHAR类型串。
TCHAR和以_t开头的函数(如_tcscpy())被设计用来让你用相同的源代码处理Unicode和ANSI串。在大多数情况下编写的代码都是用来处理ANSI串和ANSI WindowsAPIs,所以在下文中,除非另外说明,我所说的字符/串都是指TCHAR类型。你应该熟练掌握TCHAR类型,尤其是当你阅读其他人写的有关代码时,要特别注意TCHAR类型。
当你从某个COM方法返回得到一个Unicode串时,可以用下列几种方法之一将它转换成char类型串:
1.
调用 WideCharToMultiByte() API;
2.
调用CRT 函数wcstombs();
3.
使用CString 构造器或赋值操作(仅用于MFC );
4.
使用ATL 串转换宏;
WideCharToMultiByte()
你可以用WideCharToMultiByte()将一个Unicode串转换成一个ANSI串。此函数的原型如下:
int WideCharToMultiByte (UINT CodePage,DWORD dwFlags,LPCWSTR lpWideCharStr,int cchWideChar,LPSTR lpMultiByteStr,int cbMultiByte,LPCSTR lpDefaultChar,LPBOOL lpUsedDefaultChar );
以下是参数解释:
CodePage:Unicode字符转换成的代码页。你可以传递CP_ACP来使用当前的ANSI代码页。代码页是256个字符集。字符0——127与ANSI编码一样。字符128——255与ANSI字符不同,它可以包含图形字符或者读音符号。每一种语言或地区都有其自己的代码页,所以使用正确的代码页对于正确地显示重音字符很重要。
dwFlags:dwFlags 确定Windows如何处理“复合” Unicode字符,它是一种后面带读音符号的字符。
如è就是一个复合字符。如果这些字符在CodePage参数指定的代码页中,不会出什么事。
否则,Windows必须对之进行转换。传递WC_COMPOSITECHECK使得这个API检查非映射复合字符。
传递WC_SEPCHARS使得Windows将字符分为两段,即字符加读音,如e`。
传递WC_DISCARDNS使得Windows丢弃读音符号。
传递WC_DEFAULTCHAR使得Windows用lpDefaultChar参数中说明的缺省字符替代复合字符。
缺省行为是WC_SEPCHARS。
lpWideCharStr 要转换的Unicode串。
cchWideChar lpWideCharStr在Unicode 字符中的长度。通常传递-1,表示这个串是以0x00结尾。
lpMultiByteStr 接受转换的串的字符缓冲 cbMultiByte lpMultiByteStr的字节大小。
lpDefaultChar 可选——当dwFlags包含WC_COMPOSITECHECK | WC_DEFAULTCHAR并且某个Unicode字符不能被映射到同等的ANSI串时所传递的一个单字符ANSI串,包含被插入的“缺省”字符。可以传递NULL,让API使用系统缺省字符(一种写法是一个问号)。
lpUsedDefaultChar 可选——指向BOOL类型的一个指针,设置它来表示是否缺省字符曾被插入ANSI串。可以传递NULL来忽略这个参数。
我自己都有点晕菜了……!,万事开头难啊……,不搞清楚这些东西就很难搞清楚COM的串处理。何况文档中列出的比实际应用的要复杂得 多。下面就给出了如何使用这个API的例子:
// 假设已经有了一个Unicode 串 wszSomeString...
char szANSIString [MAX_PATH];WideCharToMultiByte ( CP_ACP, // ANSI 代码页WC_COMPOSITECHECK, // 检查重音字符wszSomeString, // 原Unicode 串-1, // -1 意思是串以0x00结尾szANSIString, // 目的char字符串sizeof(szANSIString), // 缓冲大小NULL, // 肥缺省字符串NULL ); // 忽略这个参数
调用这个函数后,szANSIString将包含Unicode串的ANSI版本。调用这个函数后,szANSIString将包含Unicode串的ANSI版本。
wcstombs()
这个CRT函数wcstombs()是个简化版,但它终结了WideCharToMultiByte()的调用,所以最终结果是一样的。其原型如下:
size_t wcstombs (char* mbstr,const wchar_t* wcstr,size_t count );
以下是参数解释:
mbstr:接受结果ANSI串的字符(char)缓冲。
wcstr:要转换的Unicode串。
count:mbstr参数所指的缓冲大小。
wcstombs()在它对WideCharToMultiByte()的调用中使用WC_COMPOSITECHECK | WC_SEPCHARS标志。用wcstombs()转换前面例子中的Unicode串,结果一样:
wcstombs ( szANSIString, wszSomeString, sizeof(szANSIString) );
CString
MFC中的CString包含有构造函数和接受Unicode串的赋值操作,所以你可以用CString来实现转换。例如:
// 假设有一个Unicode串wszSomeString...CString str1 ( wszSomeString ); // 用构造器转换
CString str2;str2 = wszSomeString; // 用赋值操作转换
ATL宏
ATL有一组很方便的宏用于串的转换。W2A()用于将Unicode串转换为ANSI串(记忆方法是“wide to ANSI”——宽字符到ANSI)。实际上使用OLE2A()更精确,“OLE”表示的意思是COM串或者OLE串。下面是使用这些宏的例子:
#include
char szANSIString [MAX_PATH];
USES_CONVERSION; // 声明这个宏要使用的局部变量lstrcpy ( szANSIString, OLE2A(wszSomeString) );
}
OLE2A()宏“返回”转换的串的指针,但转换的串被存储在某个临时栈变量中,所以要用lstrcpy()来获得自己的拷贝。其它的几个宏是W2T()(Unicode 到 TCHAR)以及W2CT()(Unicode到常量TCHAR串)。
有个宏是OLE2CA()(Unicode到常量char串),可以被用到上面的例子中,OLE2CA()实际上是个更正宏,因为lstrcpy()的第二个参数是一个常量char*,关于这个问题本文将在以后作详细讨论。
另一方面,如果你不想做以上复杂的串处理,尽管让它还保持为Unicode串,如果编写的是控制台应用程序,输出/显示Unicode串时应该用全程变量std::wcout,如:
wcout <
但是要记住&#xff0c;std::wcout只认Unicode&#xff0c;所以你要是“正常”串的话&#xff0c;还得用std::cout输出/显示。对于Unicode串文字量&#xff0c;要使用前缀L标示&#xff0c;如&#xff1a;
wcout <
如果保持串为Unicode&#xff0c;编程时有两个限制&#xff1a;
必须使用wcsXXX() Unicode串处理函数&#xff0c;如wcslen()&#xff1b;
在Windows 9x环境中不能在Windows API中传递Unicode串。要想编写能在9x和NT上都能运行的应用&#xff0c;必须使用TCHAR类型&#xff0c;详情请参 考MSDN&#xff1b;
用例子代码总结上述内容
下面用两个例子演示本文所讲的COM概念。代码中还包含了本文的例子工程。
使用单接口COM对象
第一个例子展示的是单接口COM对象。这可能是你碰到得最简单的例子。它使用外壳中的活动桌面组件对象类&#xff08;CLSID_ActiveDesktop&#xff09;来获得当前桌面墙纸的文件名。请确认系统中安装了活动桌面&#xff08;Active Desktop&#xff09;。 以下是编程步骤&#xff1a;
WCHAR wszWallpaper [MAX_PATH];
CString strPath;
HRESULT hr;
IActiveDesktop* pIAD;// 1. 初始化COM库&#xff08;让Windows加载DLLs&#xff09;。通常是在程序的InitInstance()中调用// CoInitialize ( NULL )或其它启动代码。MFC程序使用AfxOleInit()。CoInitialize ( NULL );// 2. 使用外壳提供的活动桌面组件对象类创建COM对象。// 第四个参数通知COM需要什么接口(这里是IActiveDesktop).hr &#61; CoCreateInstance ( CLSID_ActiveDesktop,NULL,CLSCTX_INPROC_SERVER,IID_IActiveDesktop,(void**) &pIAD );if ( SUCCEEDED(hr) ){// 3. 如果COM对象被创建成功&#xff0c;则调用这个对象的GetWallpaper() 方法。hr &#61; pIAD->GetWallpaper ( wszWallpaper, MAX_PATH, 0 );if ( SUCCEEDED(hr) ){// 4. 如果 GetWallpaper() 成功&#xff0c;则输出它返回的文件名字。// 注意这里使用wcout 来显示Unicode 串wszWallpaper. wcout 是// Unicode 专用&#xff0c;功能与cout.相同。wcout <
在这个例子中&#xff0c;输出/显示Unicode 串 wszWallpaper用的是std::wcout。
使用多接口的COM对象
第二个例子展示了如何使用一个提供单接口的COM对象QueryInterface()函数。其中的代码用外壳的Shell Link组件对象类创建我们在第一个例子中获得的墙纸文件的快捷方式 。以下是编程步骤&#xff1a;
CString sWallpaper &#61; wszWallpaper; // 将墙纸路径转换为ANSI
IShellLink* pISL;
IPersistFile* pIPF;// 1. 初始化COM库(让Windows 加载DLLs). 通常在InitInstance()中调用// CoInitialize ( NULL )或其它启动代码。MFC 程序使用AfxOleInit() 。CoInitialize ( NULL );// 2. 使用外壳提供的Shell Link组件对象类创建COM对象。.// 第四个参数通知COM 需要什么接口(这里是IShellLink)。hr &#61; CoCreateInstance ( CLSID_ShellLink,NULL,CLSCTX_INPROC_SERVER,IID_IShellLink,(void**) &pISL );if ( SUCCEEDED(hr) ){// 3. 设置快捷方式目标(墙纸文件)的路径。hr &#61; pISL->SetPath ( sWallpaper );if ( SUCCEEDED(hr) ){// 4. 获取这个对象的第二个接口(IPersistFile)。hr &#61; pISL->QueryInterface ( IID_IPersistFile, (void**) &pIPF );if ( SUCCEEDED(hr) ){// 5. 调用Save() 方法保存某个文件得快捷方式。第一个参数是// Unicode 串。hr &#61; pIPF->Save ( L"C:\\wallpaper.lnk", FALSE );// 6a. 释放IPersistFile 接口。pIPF->Release();}}// 6. 释放IShellLink 接口。pISL->Release();}// 输出错误信息部分这里省略。// 7. 收回COM 库。MFC 程序不用这一步&#xff0c;它自动完成。CoUninitialize();
处理HRESULT
这一部分准备用SUCCEEDED 和 FAILED宏进行一些简单的出错处理。主要是深入研究从COM方法返回的HRESULT&#xff0c;以便达到完全理解和熟练应用。
HRESULT是个32位符号整数&#xff0c;其非负值表示成功&#xff0c;负值表示失败。HRESULT有三个域&#xff1a;程度位&#xff08;表示成功或失败&#xff09;&#xff0c;功能码和状态码。功能码表示HRESULT来自什么组件或程序。微软给不同的组件多赋予功能码&#xff0c;如&#xff1a;COM、任务调度程序等都有功能码。功能码是个16位的值&#xff0c;仅此而已&#xff0c;没有其它内在含义&#xff1b;它在数字和意义之间是随意关联的&#xff1b;类似GetLastError()返回的值。
如果你在winerror.h头文件中查找错误代码&#xff0c;会看到许多按照[功能]_[程度]_[描述]命名规范列出的HRESULT值&#xff0c;由组件返回的通用的HRESULT&#xff08;类似E_OUTOFMEMORY&#xff09;在名字中没有功能码。如 &#xff1a;
REGDB_E_READREGDB&#xff1a;
功能码 &#61; REGDB, 指“注册表数据库&#xff08;registry database&#xff09;”&#xff1b;
程度 &#61; E 意思是错误&#xff08;error&#xff09;&#xff1b;
描述 &#61; READREGDB 是对错误的描述&#xff08;意思是不能读注册表数据库&#xff09;。 S_OK: 没有功能码——通用&#xff08;generic&#xff09;
HRESULT&#xff1b;
程度&#61;S&#xff1b;表示成功&#xff08;success&#xff09;&#xff1b;
OK 是状态描述表示一切都好&#xff08;everything&#39;&#39;s OK&#xff09;。
&#xff08;待续&#xff09;