COM技术初探(一)
一、COM是一个更好的C++
1、COM 是什么
Don Box 说"COM IS LOVE"。COM 的全称是 ComponentObject Model 组件对象模型。
2、从 C++ 到DLL 再到 COM
2.1 C++
如某一软件厂商发布一个类库(CMath四则运算),此时类库的可执行代码将成为客户应用中不可分割的一部分。假设此类库的所产生的机器码在目标可执行文件中占有4MB的空间。当三个应用程序都使用CMath库时,那么每个可执行文件都包含4MB的类库代码(见图1.1)。当三个应用程序共同运行时,他们将会占用12MB的虚拟内存。问题还远不于此。一旦类库厂商发现CMath类库有一个缺陷后,发布一个新的类库,此时需要要求所有运用此类库的应用程序。此外别无他法了。
图1.1 CMath 的三个客户
2.2 DLL
解决上面问题的一个技术是将CMath类做成动态链接库(DLL ,Dynamic Link Library)的形式封装起来 。
在使用这项技术的时候,CMath的所有方法都将被加到 CMath dll 的引出表(export list)中,而且链接器将会产生一个引入库(import library)。这个库暴露了CMath的方法成员的符号 。当客户链接引入库时,有一些存根会被引入到可执行文件中,它在运行时通知装载器动态装载 CMath Dll。
当 CMath 位于dll中时,他的运行模型见图1.2
图1.2 CMath引入库
2.3 COM
"简单地把C++类定义从dll中引出来"这种方案并不能提供合理的二进制组件结构。因为C++类那既是接口也是实现。这里需要把接口从实现中分离出来才能提供二进制组件结构。此时需要有二个C++类,一个作为接口类另一个作为实现类。让我们开始COM之旅吧。
二、COM基础
1、 COM基本知识
1.1返回值HRESULT
COM要求所有的方法都会返回一个HRESULT类型的错误号。HRESULT 其实就一个类型定义:
typedef LONG HRESULT;
有关HRESULT的定义见 winerror.h 文件
我们一般下面的宏来判断方法是否成功:
#defineSUCCEEDED(hr)(long(hr)>=0)
#defineFAILED(hr)(long(hr)<0)
1.2 初识 IDL
每个标准的COM组件都需要一个接口定义文件,文件的扩展名为IDL。让我们看IUnknow接口的定义文件是怎样的。
[
local,
object,
uuid(00000000-0000-0000-C000-000000000046),
pointer_default(unique)
]
interface IUnknown
{
typedef [unique] IUnknown *LPUNKNOWN;
cpp_quote("//")
cpp_quote("// IID_IUnknown andall other system IIDs are provided in UUID.LIB")
cpp_quote("// Link that libraryin with your proxies, clients and servers")
cpp_quote("//")
HRESULT QueryInterface(
[in] REFIID riid,
[out, iid_is(riid)] void **ppvObject);
ULONG AddRef();
ULONG Release();
}
[local]属性禁止产生网络代码。
[object]属性是表明定义的是一个COM接口,而不是DEC风格的接口。
[uuid]属性给接口一个GUID。
[unique]属性表明null(空)指针为一个合法的参数值。
[pointer_defaul]属性所有的内嵌指针指定一个默认指针属性
typedef[unique] IUnknown *LPUNKNOWN;这是一个类型定义
cpp_quote这个比较有趣,这是一个在idl文件写注解的方法。这些注解将保存到***.h和***_i.c文件中
[in]表示这个参数是入参
[out]表示这个参数是出参
[iid_is(riid)]表示这个参数需要前一个的riid 参数。
注意:所有具有out属性的参数都需要是指针类型。
1.3IUnkown接口
在整个例子除了IUnkown这个东西,其他应该不会感到陌生吧!COM要求(最基本的要求)所有的接口都需要从IUnknown接口直接或间接继承,所以IUnknown接口有"万恶之源"之称。
IUnkown接口定义了三个方法。
HRESULT QueryInterface([in] REFIIDriid,[out] void **ppv);
ULONG AddRef();
ULONG Release();
其中 AddReft() 和Release()负责对象引用计数用的,而 QueryInterface()方法是用于查询所实现接口用的。每当COM组件被引用一次就应调用一次AddRef()方法。而当客户端在释放COM组件的某个接口时就需要调用Release()方法。
这里所讲的请在下面的例子仔细体会。
2、一个比较简单的COM
此例子共有四个文件组成:
文件名 |
说明 |
Interface.h |
接口类定义文件 |
Math.h和Math.cpp |
实现类文件 |
Simple.cpp 主函数文件 |
这里用来当作COM的客户端 |
#ifndef INTERFACE_H
#define INTERFACE_H
#include <unknwn.h>
//{7C8027EA-A4ED-467c-B17E-1B51CE74AF57}
static const GUID IID_ISimpleMath =
{ 0x7c8027ea, 0xa4ed, 0x467c, {0xb1, 0x7e, 0x1b, 0x51, 0xce, 0x74, 0xaf, 0x57 } };
//{CA3B37EA-E44A-49b8-9729-6E9222CAE84F}
static const GUID IID_IAdvancedMath=
{ 0xca3b37ea, 0xe44a, 0x49b8, {0x97, 0x29, 0x6e, 0x92, 0x22, 0xca, 0xe8, 0x4f } };
interface ISimpleMath : publicIUnknown
{
public:
virtualint Add(int nOp1, int nOp2) = 0;
virtualint Subtract(int nOp1, int nOp2) = 0;
virtualint Multiply(int nOp1, int nOp2) = 0;
virtualint Divide(int nOp1, int nOp2) = 0;
};
interface IAdvancedMath : publicIUnknown
{
public:
virtualint Factorial(int nOp1) = 0;
virtualint Fabonacci(int nOp1) = 0;
};
#endif
此文件首先 #include <unknwn.h> 将 IUnknown 接口定义文件包括进来。
接下来定义了两个接口,GUID(Globally Unique Identifier全局唯一标识符)它能保证时间及空间上的唯一。
ISmipleMath接口里定义了四个方法,而IAdvancedMath接口里定义了二个方法。这些方法都是虚函数,而整个 ISmipleMath 与 IAdvancedMath 抽象类就作为二进制的接口。
2.2math.h文件
#include "interface.h"
class CMath : public ISimpleMath,
public IAdvancedMath
{
private:
ULONGm_cRef;
private:
intcalcFactorial(int nOp);
intcalcFabonacci(int nOp);
public:
//IUnknownMethod
STDMETHOD(QueryInterface)(REFIIDriid, void **ppv);
STDMETHOD_(ULONG,AddRef)();
STDMETHOD_(ULONG,Release)();
// ISimpleMath Method
intAdd(int nOp1, int nOp2);
intSubtract(int nOp1, int nOp2);
intMultiply(int nOp1, int nOp2);
intDivide(int nOp1, int nOp2);
// IAdvancedMath Method
intFactorial(int nOp);
intFabonacci(int nOp);
};
此类为实现类,他实现了ISmipleMath和IAdvancedMath两个接口类(当然也可以只实现一个接口类)。
请注意:m_cRef 是用来对象计数用的。当 m_cRef 为0组件对象应该自动删除。
2.3math.cpp文件
#include "interface.h"
#include "math.h"
STDMETHODIMPCMath::QueryInterface(REFIID riid, void **ppv)
{// 这里这是实现dynamic_cast的功能,但由于dynamic_cast与编译器相关。
if(riid== IID_ISimpleMath)
*ppv= static_cast(this);
elseif(riid == IID_IAdvancedMath)
*ppv= static_cast(this);
elseif(riid == IID_IUnknown)
*ppv= static_cast(this);
else{
*ppv= 0;
returnE_NOINTERFACE;
}
reinterpret_cast(*ppv)->AddRef(); //这里要这样是因为引用计数是针对组件的
returnS_OK;
}
STDMETHODIMP_(ULONG) CMath::AddRef()
{
return++m_cRef;
}
STDMETHODIMP_(ULONG)CMath::Release()
{
ULONGres = --m_cRef; // 使用临时变量把修改后的引用计数值缓存起来
if(res== 0) // 因为在对象已经销毁后再引用这个对象的数据将是非法的
deletethis;
returnres;
}
int CMath::Add(int nOp1, int nOp2)
{
returnnOp1+nOp2;
}
int CMath::Subtract(int nOp1, intnOp2)
{
returnnOp1 - nOp2;
}
int CMath::Multiply(int nOp1, intnOp2)
{
returnnOp1 * nOp2;
}
int CMath::Divide(int nOp1, intnOp2)
{
returnnOp1 / nOp2;
}
int CMath::calcFactorial(int nOp)
{
if(nOp<= 1)
return1;
returnnOp * calcFactorial(nOp - 1);
}
int CMath::Factorial(int nOp)
{
returncalcFactorial(nOp);
}
int CMath::calcFabonacci(int nOp)
{
if(nOp<= 1)
return1;
returncalcFabonacci(nOp - 1) + calcFabonacci(nOp - 2);
}
int CMath::Fabonacci(int nOp)
{
returncalcFabonacci(nOp);
}
CMath::CMath()
{
m_cRef=0;
}
此文件是CMath类定义文件。
2.4simple.cpp文件
#include "math.h"
#include <iostream>
using namespace std;
int main(int argc, char* argv[])
{
ISimpleMath*pSimpleMath = NULL;//声明接口指针
IAdvancedMath*pAdvMath = NULL;
//创建对象实例,我们暂时这样创建对象实例,COM有创建对象实例的机制
CMath*pMath = new CMath;
//查询对象实现的接口ISimpleMath
pMath->QueryInterface(IID_ISimpleMath,(void **)&pSimpleMath);
if(pSimpleMath)
cout<< "10 + 4 = " << pSimpleMath->Add(10, 4) <<endl;
//查询对象实现的接口IAdvancedMath
pSimpleMath->QueryInterface(IID_IAdvancedMath,(void **)&pAdvMath);
if(pAdvMath)
cout<< "10 Fabonacci is " << pAdvMath->Fabonacci(10)<< endl;
pAdvMath->Release();
pSimpleMath->Release();
return0;
}
此文件相当于客户端的代码,首先创建一个CMath对象,再根据此对象去查询所需要的接口,如果正确得到所需接口指针,再调用接口的方法,最后再将接口的释放掉。
2.5Math组件的二进制结构图
图1.3 Math组件二进制结构图
2.6 小结
此例子从严格意义上来并不是真正的COM组件(他不是dll),但他已符合COM的最小要求(实现IUnknown接口)。接下来我们来做一COM dll(但还不用ATL)。
COM技术初探(二)
一、纯手工创建一个COM组件
1、从建工程到实现注册
在这一过程中我们将完成三个步骤:创建dll的入口函数,定义接口文件,实现注册功能
1.1创建一个类型为win32 dll工程
创建一个名为MathCOM的win32 dll工程。
在向导的第二步选择"Asmiple dll project"选项。当然如果你选择一个空的工程,那你自己完成DllMain定义吧。
1.2 定义接口文件
生成一个名为MathCOM.idl的接口文件。并将此文件加入到刚才创建的那个工程里。
//MathCOM.idl文件
// MathCOM.idl : IDL source forMathCOM.dll
//
// This file will be processed bythe MIDL tool to
// produce the type library(MathCOM.tlb) and marshalling code.
import "oaidl.idl";
import "ocidl.idl";
[
uuid(FAEAE6B7-67BE-42a4-A318-3256781E945A),
helpstring("ISimpleMathInterface"),
object,
pointer_default(unique)
]
interfaceISimpleMath : IUnknown
{
HRESULTAdd([in]int nOp1,[in]int nOp2,[out,retval]int * pret);
HRESULTSubtract([in]int nOp1,[in]int nOp2,[out,retval]int * pret);
HRESULTMultiply([in]int nOp1,[in]int nOp2,[out,retval] int * pret);
HRESULTDivide([in]int nOp1,[in]int nOp2,[out,retval]int * pret);
};
[
uuid(01147C39-9DA0-4f7f-B525-D129745AAD1E),
helpstring("IAdvancedMathInterface"),
object,
pointer_default(unique)
]
interfaceIAdvancedMath : IUnknown
{
HRESULTFactorial([in]int nOp1,[out,retval]int * pret);
HRESULTFabonacci([in]int nOp1,[out,retval]int * pret);
};
[
uuid(CA3B37EA-E44A-49b8-9729-6E9222CAE844),
version(1.0),
helpstring("MATHCOM1.0 Type Library")
]
library MATHCOMLib
{
importlib("stdole32.tlb");
importlib("stdole2.tlb");
[
uuid(3BCFE27E