以文本方式查看主题

-  计算机科学论坛  (http://bbs.xml.org.cn/index.asp)
--  『 C/C++编程思想 』  (http://bbs.xml.org.cn/list.asp?boardid=61)
----  COM 组件设计与应用(七、八)——编译、注册、调用;实现多接口  (http://bbs.xml.org.cn/dispbbs.asp?boardid=61&rootid=&id=54155)


--  作者:卷积内核
--  发布时间:10/22/2007 9:17:00 AM

--  COM 组件设计与应用(七、八)——编译、注册、调用;实现多接口
一、前言
  上两回中,咱们用 ATL 写了第一个 COM 组件程序,这回中,主要介绍编译、注册和调用方法。示例程序你已经下载了吗?如果还没有下载,vc6.0 的用户点这里,vc.net 的用户点这里。

  二、关于编译

  2-1 最小依赖

  “最小依赖”,表示编译器会把 ATL 中必须使用的一些函数静态连接到目标程序中。这样目标文件尺寸会稍大,但独立性更强,安装方便;反之系统执行的时候需要有 ATL.DLL 文件的支持。如何选择设置为“最小依赖”呢?答案是:删除预定义宏“_ATL_DLL”,操作方法见图一、图二。

按此在新窗口浏览图片
  图一、在vc6.0中,设置方法

按此在新窗口浏览图片
  图二、在 vc.net 2003中,设置方法

  2-2 CRT库

  如果在 ATL 组件程序中调用了 CRT 的运行时刻库函数,比如开平方 sqrt() ,那么编译的时候可能会报错“error LNK2001: unresolved external symbol _main”。怎么办?删除预定义宏“_ATL_MIN_CRT”!操作方法也见图一、图二。(vc.net 2003 中的这个项目属性叫“在 ATL 中最小使用 CRT”)

  2-3 MBCS/UNICODE

  这个不多说了,在预定义宏中,分别使用 _MBCS 或 _UNICODE。

  2-4 IDL 的编译

  COM 在设计初期,就定了一个目标:要能实现跨语言的调用。既然是跨语言的,那么组件的接口描述就必须在任何语言环境中都要能够认识。怎么办?用 .h 文件描述?------ C语言程序员笑了,真方便!BASIC 程序员哭了:-( 因此,微软使用了一个新的文件格式---IDL文件(接口定义描述语言)。IDL 是一个文本文件,它的语言语法比较简单,很象C。具体 IDL 文件的讲解,见下一回《COM 组件设计与应用(八)之添加新接口》。IDL 经过编译,生成二进制的等价类型库文件 TLB 提供给其它语言来使用。图三示意了 ATL COM 程序编译的过程:

按此在新窗口浏览图片
  图三、ATL 组件程序编译过程

  说明1:编译后,类型库以 TLB 文件形式单独存在,同时也保存在目标文件的资源中。因此,我们将来在 #import 引入类型库的时候,既可以指定 TLB 文件,也可以指定目标文件;

  说明2:我们作为 C/C++ 的程序员,还算是比较幸福的。因为 IDL 编译后,特意为我们提供了 C 语言形式的接口文件。

  说明3:IDL 编译后生成代理/存根源程序,有:dlldata.c、xxx_p.c、xxxps.def、xxxps.mak,我们可以用 NMAKE.EXE 再次编译来产生真正的代理/存根DLL目标文件(注1)。

  三、关于注册

  情况1:当我们使用 ATL 编写组件程序,注册不用我们来负责。编译成功后,IDE 会帮我们自动注册;

  情况2:当我们使用 MFC 编写组件程序,由于编译器不知道你写的是否是 COM 组件,所以它不会帮我们自动注册。这个时候,我们可以执行菜单“Tools\Register Control”来注册。

  情况3:当我们写一个具有 COM 功能的 EXE 程序时,注册的方法就是运行一次这个程序;

  情况4:当我们需要使用第三方提供的组件程序时,可以命令行运行“regsvr32.exe 文件名”来注册。顺便说一句,反注册的方法是“regsvr32.exe /u 文件名”;

  情况5:当我们需要在程序中(比如安装程序)需要执行注册,那么:

typedef HRESULT (WINAPI * FREG)();
TCHAR szWorkPath[ MAX_PATH ];
::GetCurrentDirectory( sizeof(szWorkPath), szWorkPath );  // 保存当前进程的工作目录
::SetCurrentDirectory( 组件目录 );  // 切换到组件的目录
HMODULE hDLL = ::LoadLibrary( 组件文件名 );  // 动态装载组件
if(hDLL)
{
  FREG lpfunc = (FREG)::GetProcAddress( hDLL, _T("DllRegisterServer") );  // 取得注册函数指针
  // 如果是反注册,可以取得"DllUnregisterServer"函数指针
  if ( lpfunc )  lpfunc();  // 执行注册。这里为了简单,没有判断返回值
  ::FreeLibrary(hDLL);
}
::SetCurrentDirectory(szWorkPath);  // 切换回原先的进程工作目录  上面的示例,在多数情况下可以简化掉切换工作目录的代码部分。但是,如果这个组件在装载的时候,它需要同时加载一些必须依赖的DLL时,有可能由于它自身程序的 BUG 导致无法正确定位。咳......还是让我们自己写的程序,来弥补它的错误吧......谁让咱们是好人呢 ,谁让咱们的水平比他高呢,谁让咱们在 vckbase 上是个“榜眼”呢......

  四、关于组件调用

  总的来说,调用组件程序大概有如下方法:

   #include 方法 IDL编译后,为方便C/C++程序员的使用,会产生xxx.h和xxx_i.c文件。我们真幸福,直接#include后就可以使用了
#import 方法 比较通用的方法,vc 会帮我们产生包装类,让我们的调用更方便
加载类型库包装类 方法 如果组件提供了 IDispatch 接口,用这个方法调用组件是最简单的啦。不过还没讲IDispatch,只能看以后的文章啦
加载ActiveX包装类 方法 ActiveX 还没介绍呢,以后再说啦


  下载示例程序后,请逐项浏览使用方法:

示例   方法
  简要说明

1 #include 完全用最基本的 API 方式调用组件,使大家熟悉调用原理
2 #include 大部分使用 API 方式,使用 CComBSTR 简化对字符串的使用
3 #include 展示智能指针 CComPtr<> 的使用方法
4 #include 展示智能指针 CComPtr<> 和 CComQIPtr<> 混合的使用方法
5 #include 展示智能指针 CComQIPtr<> 的使用方法
6 #include 展示智能指针的释放方法
7 #import vc 包装的智能指针 IxxxPtr、_bstr_t、_variant_t 的使用方法和异常处理
8 #import import 后的命名空间的使用方法

  示例程序中都写有注释,请读者仔细阅读并同时参考 MSDN 的函数说明。这里,我给大家介绍一下“智能指针”:

  对于操作原始的接口指针是比较麻烦的,需要我们自己控制引用记数、API 调用、异常处理。于是 ATL 提供了2个智能指针的模板包装类,CComPtr<> 和 CComQIPtr<>,这两个类都在 <atlbase.h> 中声明。CComQIPtr<> 包含了 CComPtr<>的所有功能,因此我们可以完全用 CComQIPtr<> 来使用智能接口指针,唯一要说明的一点就是:CComQIPtr<> 由于使用了运算符的重载功能,它会自动帮我们调用QueryInterface()函数,因此 CComQIPtr<> 唯一的缺点就是不能定义 IUnknown * 指针。

// 智能指针 smart pointer,按照匈牙利命名法,一般以 sp 开头来表示变量类型
   CComPtr < IUnknown > spUnk;  // 正确
   // 假设 IFun 是一个接口类型
   CComPtr < IFun > spFun;  // 正确
   CComQIPtr < IFun > spFun;  // 正确
   CComQIPtr < IFun, &IID_IFun > spFun;  // 正确
   CComQIPtr < IUnknown > spUnk;  // 错误!CComQIPtr不能定义IUnknown指针给智能指针赋值的方法:CComQIPtr < IFun > spFun;  // 调用构造函数,还没有赋值,被包装的内部接口指针为 NULL
   
   CComQIPtr < IFun > spFun( pOtherInterface );  // 调用构造函数,内部接口指针赋值为
   // 通过 pOtherInterface 这个普通接口指针调用QueryInterface()得到的IFun接口指针
   
   CComQIPtr < IFun > spFun( spOtherInterface ); // 调用构造函数,内部接口指针赋值为
   // 通过 spOtherInterface 这个只能接口指针调用QueryInterface()得到的IFun接口指针
   
   CComQIPtr < IFun > spFun ( pUnknown );  // 调用构造函数,由IUnknown的QueryInterface()得到IFun接口指针
   
   CComQIPtr < IFun > spFun = pOtherInterface;  // = 运算符重载,含义和上面一样
   spFun = spOtherInterface;  // 同上
   spFun = pUnknown;  // 同上
   
   pUnknown->QueryInterface( IID_IFun, &sp );  // 也可以通过QueryInterface赋值
   
   // 智能指针赋值后,可以用条件语句判断是否合法有效
   if ( spFun ){}    // 如果指针有效
   if ( NULL != spFun ){}  // 如果指针有效
   
   if ( !spFun ){}    // 如果指针无效
   if ( NULL == spFun ){}  // 如果指针无效智能指针调用函数的方法:spFun.CoCreateInstance(...);  // 等价与 API 函数::CoCreateInstance(...)
   spFun.QueryInterface(...);  // 等价与 API 函数::QueryInterface()

spFun->Add(...); // 调用内部接口指针的接口函数

    // 调用内部接口指针的QueryInterface()函数,其实效果和 spFun.QueryInterface(...) 一样
    spFun->QueryInterface(...); 
    
    spFun.Release(); // 释放内部的接口指针,同时内部指针赋值为 NULL
    spFun->Release(); // 错!!!一定不要这么使用。
    // 因为这个调用并不把内部指针清空,那么析构的时候会被再次释放(释放了两次)
咳......不说了,不说了,大家多看书,多看MSND,多看示例程序吧。 写累了:-(

五、小结

  敬请关注《COM 组件设计与应用(八)》------如何增加 ATL 组件中的第二个接口


--  作者:卷积内核
--  发布时间:10/22/2007 9:19:00 AM

--  
一、前言
  从第五回开始到第七回,咱们用 ATL 写了一个简单的 COM 组件,之所以说简单,是因为在组件中,只实现了一个自定义(custom)的接口 IFun。当然如果想偷懒的话,我们可以把 200 个函数都加到这一个接口中, 果真如此的话,恐怕就没有人喜欢使用我们这个组件了。一个组件既然可以提供多个接口,那么我们在设计的时候,就应该按照函数的功能进行分类,把不同功能分类的函数用多个接口表现出来。这样可以有如下的一些好处:

  1、一个接口中的函数个数有限、功能集中,使用者容易学习、记忆和调用。一个接口到底提供多少个函数合适那?答案是:如果你是黑猩猩,那么一个接口最多3个函数,如果你是人,那么一个接口最好不要超过7个函数。(注1)

  2、容易维护。至少你肉眼搜索的时候也方便一些呀。

  3、容易升级。当我们给组件增加函数的时候,不要修改已经发表的接口,而是提供一个新的接口来完成功能扩展。(注2)

  本回书着落在------如何实现一个组件,多个接口。

  二、接口结构

按此在新窗口浏览图片
  图一、组件A有2个自定义接口,组件B是A的升级

  某日,我们设计了组件A,它有2个自定义(custom)接口。IMathe 有函数Add()完成整数加法,IStr 有函数Cat()完成字符串连接。忽一日,我们升级组件A到B,欲增加一个函数 Mul() 完成整数的乘法。注意,由于我们已经发表了组件A,因此我们不能把这个函数安排到老接口 IMathe 中了。解决方法是再定义一个新接口 IMathe2,在新接口中增加 Mul() 函数并依旧保留 Add() 函数。这样,老用户不知道新接口 IMathe2 的存在,他仍然使用旧接口 IMathe;而新用户则可以抛弃 IMathe,直接使用 IMathe2 的新接口功能。看,多平顺的升级方式呀!

  三、实现

  3-1、首先用 ATL 实现一个自定义(custom)接口 IMathe 的COM组件,在接口中完成 Add()整数加法函数。注意!!!一定是自定义(custom)的接口(dual 双接口以后再介绍)。如果你不了解这个操作,请重新阅读“第五回”或“第六回”。

  3-2、查看 IDL 文件。完成上一个步骤后,打开IDL文件,内容如下:(名称及 UUID 会和你程序中的IDL有所不同)

1 import "oaidl.idl";
2 import "ocidl.idl";
3  [
4    object,
5    uuid(072EA6CA-7D08-4E7E-B2B7-B2FB0B875595),
  
6    helpstring("IMathe Interface"),
7    pointer_default(unique)
8  ]
9  interface IMathe : IUnknown
10  {
11    [helpstring("method Add")] HRESULT Add([in] long n1, [in] long n2, [out,retval] long *pnVal);
12  };
13 [
14  uuid(CD7672F7-C0B4-4090-A2F8-234C0062F42C),
15  version(1.0),
16  helpstring("Simple3 1.0 Type Library")
17 ]
18 library SIMPLE3Lib
19 {
20  importlib("stdole32.tlb");
21  importlib("stdole2.tlb");
22  [
23    uuid(C6F241E2-43F6-4449-A024-B7340553221E),
24    helpstring("Mathe Class")
25  ]
26  coclass Mathe
27  {
28    [default] interface IMathe;
29  };
30 }; 1-2 引入 IUnknown 和ATL已经定义的其它接口描述文件。import 类似与 C 语言中的 #include
3-12 一个接口的完整描述
4 object 表示本块描述的是一个接口。IDL文件是借用了PRC远程数据交换格式的说明方法
5 uuid(......) 接口的 IID,这个值是 ATL 自动生成的,可以手工修改或用 guidgen.exe 产生(注3)
6 在某些软件或工具中,能看到这个提示
7 定义接口函数中参数所使用指针的默认属性(注4)
9 接口叫 IMathe 派生自 IUnknown,于是 IMathe 接口的头三个函数一定就是QueryInterface,AddRef和Release
10-12 接口函数列表
13-30 类型库的完整描述(类型库的概念以后再说),下面所说明的行,是需要先了解的
18 #import 时候的默认命名空间
23 组件的 CLSID,CoCreateInstance()的第一个参数就是它
27-29 接口列表
28 [default]表示谁提供了IUnknown接口

  3-3、手工修改IDL文件,黑体字部分是手工输入的。完成后保存。 import "oaidl.idl";
import "ocidl.idl";
  [
    object,
    uuid(072EA6CA-7D08-4E7E-B2B7-B2FB0B875595),
  
    helpstring("IMathe Interface"),
    pointer_default(unique)
  ]
  interface IMathe : IUnknown
  {
    [helpstring("method Add")] HRESULT Add([in] long n1, [in] long n2, [out,retval] long *pnVal);
  };
  [  // 所谓手工输入,其实也是有技巧的:把上面的接口描述(IMathe)复制、粘贴下来,然后再改更方便哈
    object,
    uuid(072EA6CB-7D08-4E7E-B2B7-B2FB0B875595), // 手工或用工具产生的 IID
  
    helpstring("IStr Interface"),
    pointer_default(unique)
  ]
  interface IStr : IUnknown
  {
    // 目前还没有任何接口函数
  };
[
  uuid(CD7672F7-C0B4-4090-A2F8-234C0062F42C),
  version(1.0),
  helpstring("Simple3 1.0 Type Library")
]
library SIMPLE3Lib
{
  importlib("stdole32.tlb");
  importlib("stdole2.tlb");
  [
    uuid(C6F241E2-43F6-4449-A024-B7340553221E),
    helpstring("Mathe Class")
  ]
  coclass Mathe
  {
    [default] interface IMathe;
    interface IStr;  // 别忘了呦,这里还有一个那
  };
};  3-4、打开头文件(Mathe.h),手工增加类的派生关系和接口入口表 ,然后保存。class ATL_NO_VTABLE CMathe :
  public CComObjectRootEx <CComSingleThreadModel>,
  public CComCoClass <CMathe, &CLSID_Mathe>,
  public IMathe,  // 别忘了,这里加一个逗号
  public IStr  // 增加一个基类
{
public:
  CMathe()
  {
  }
DECLARE_REGISTRY_RESOURCEID(IDR_MATHE)
DECLARE_PROTECT_FINAL_CONSTRUCT()
BEGIN_COM_MAP(CMathe)  // 接口入口表。这里填写的接口,才能被QueryInterface()找到
  COM_INTERFACE_ENTRY(IMathe)
  COM_INTERFACE_ENTRY(IStr)
END_COM_MAP()  3-5、好了,一切就绪。接下来,就可以在 IStr 接口中增加函数了。示例程序中增加一个字符串连接功能的函数:

  HRESULT Cat([in] BSTR s1, [in] BSTR s2, [out,retval] BSTR *psVal); 如果你不知道如何做,请重新阅读前三回的内容。

  四、接口升级

  我们这个组件已经发行了,但忽然一天我们需要在 IMathe 接口上再增加一个函数......不行!绝对不能在 IMathe 上直接修改!怎么办?解决方法是------再增加一个接口,我们就叫 IMathe2 吧,如果以后还要增加函数,那么我们再增加一个接口叫 IMathe3......子子孙孙,无穷尽也。

  4-1、修改 IDL 文件,其实如果你理解了上面一小节的内容,再增加一个接口是很简单的事情了。import "oaidl.idl";
import "ocidl.idl";
  [
    object,
    uuid(072EA6CA-7D08-4E7E-B2B7-B2FB0B875595),
  
    helpstring("IMathe Interface"),
    pointer_default(unique)
  ]
  interface IMathe : IUnknown
  {
    [helpstring("method Add")] HRESULT Add([in] long n1, [in] long n2, [out,retval] long *pnVal);
  };
  [
    object,
    uuid(072EA6CB-7D08-4E7E-B2B7-B2FB0B875595),
  
    helpstring("IStr Interface"),
    pointer_default(unique)
  ]
  interface IStr : IUnknown
  {
    [helpstring("method Cat")] HRESULT Cat([in] BSTR s1, [in] BSTR s2, [out,retval] BSTR *psVal);
  };
  [
    object,
    uuid(072EA6CC-7D08-4E7E-B2B7-B2FB0B875595),
  
    helpstring("IMathe2 Interface"),
    pointer_default(unique)
  ]


--  作者:卷积内核
--  发布时间:10/22/2007 9:23:00 AM

--  
interface IMathe2 : IUnknown
{ // 下面这个Add()函数,只有IDL中的声明,而不用增加任何程序代码,因为这个函数早在 IMathe 中就已经实现了
  [helpstring("method Add")] HRESULT Add([in] long n1, [in] long n2, [out,retval] long *pnVal);
};

[
uuid(CD7672F7-C0B4-4090-A2F8-234C0062F42C),
version(1.0),
helpstring("Simple3 1.0 Type Library")
]
library SIMPLE3Lib
{
importlib("stdole32.tlb");
importlib("stdole2.tlb");

[
  uuid(C6F241E2-43F6-4449-A024-B7340553221E),
  helpstring("Mathe Class")
]
coclass Mathe
{
  [default] interface IMathe;
  interface IStr;
  interface IMathe2; // 别忘了,这里还有一行呢!
};
};

    4-2、打开头文件,增加派生关系和接口入口表
class ATL_NO_VTABLE CMathe :  
public CComObjectRootEx <CComSingleThreadModel>,
public CComCoClass <CMathe, &CLSID_Mathe>,
public IMathe,
public IStr, // 这里增加一个逗号
public IMathe2
{
public:
CMathe()
{
}

DECLARE_REGISTRY_RESOURCEID(IDR_MATHE)

DECLARE_PROTECT_FINAL_CONSTRUCT()

BEGIN_COM_MAP(CMathe)
COM_INTERFACE_ENTRY(IMathe)
COM_INTERFACE_ENTRY(IStr)
COM_INTERFACE_ENTRY(IMathe2)
END_COM_MAP()
  4-3、示例程序中,增加了一个整数乘法函数:

HRESULT Mul([in] long n1, [in] long n2, [out,retval] long *pnVal); 如果你不知道如何做,那就别学了:-( 都讲好几遍了,怎么还不掌握呢?知道狗熊是怎么死的吗?(注5)

  4-4、因为我们的组件升级了,于是也应该修改版本号了(这不是必须的,但最好修改一下)。打开注册表文件(.rgs) 把有关ProgID的版本 "Mathe.1" 修改为"Mathe.2"。另外如果你愿意,把IDL文件中的 version 和提示文字一并修改一下。这里就不再粘贴文件内容了,因为很简单,大家下载示例程序(注6)后,自己看吧。

五、小结
    为祖国的软件事业而奋斗!
    下回书介绍“自动化”--- IDispatch 接口,好玩的很!谢谢关注:-)

--------------------------------------------------------------------------------
注1: 黑猩猩的瞬时记忆量是3,人类的瞬时记忆量是7。科学家做过实验,当着面,把一块糖扣在3个碗的其中之一,黑猩猩能立刻准确找到,但如果超过3个碗,猩猩就晕了......如果给你看一串数字,然后立刻让你说出来,一般的人只会记得其中的7个。
注2:组件一经发表,就不要修改已有接口。这样软件的升级才能做到“鲁棒”性。
注3:guidgen.exe 工具,在《COM 组件设计与应用(二)》中已经介绍。
注4:组件函数对内存指针的处理,以后有专门的章回讨论。
注5:笨死的!
注6:示例程序有两部分,分别是vc6.0版本和vc.net 2003 版本。


W 3 C h i n a ( since 2003 ) 旗 下 站 点
苏ICP备05006046号《全国人大常委会关于维护互联网安全的决定》《计算机信息网络国际联网安全保护管理办法》
62.500ms