| 订阅 | 在线投稿
分享
 
 
 

COM组件设计与应用之实现多接口

来源:互联网  宽屏版  评论
2008-06-01 02:00:32

一、前言

咱们用 ATL 写了一个简单的 COM 组件,之所以说简单,是因为在组件中,只实现了一个自定义(custom)的接口 IFun。当然假如想偷懒的话,我们可以把 200 个函数都加到这一个接口中, 果真如此的话,恐怕就没有人喜欢使用我们这个组件了。

一个组件既然可以提供多个接口,那么我们在设计的时候,就应该按照函数的功能进行分类,把不同功能分类的函数用多个接口表现出来。这样可以有如下的一些好处:1、一个接口中的函数个数有限、功能集中,使用者轻易学习、记忆和调用。一个接口到底提供多少个函数合适那?答案是:假如你是黑猩猩,那么一个接口最多3个函数,假如你是人,那么一个接口最好不要超过7个函数。(注1)

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

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

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

二、接口结构

COM组件设计与应用之实现多接口

图一、组件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)

]

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)后,自己看吧。

 
一、前言    咱们用 ATL 写了一个简单的 COM 组件,之所以说简单,是因为在组件中,只实现了一个自定义(custom)的接口 IFun。当然假如想偷懒的话,我们可以把 200 个函数都加到这一个接口中, 果真如此的话,恐怕就没有人喜欢使用我们这个组件了。 一个组件既然可以提供多个接口,那么我们在设计的时候,就应该按照函数的功能进行分类,把不同功能分类的函数用多个接口表现出来。这样可以有如下的一些好处:1、一个接口中的函数个数有限、功能集中,使用者轻易学习、记忆和调用。一个接口到底提供多少个函数合适那?答案是:假如你是黑猩猩,那么一个接口最多3个函数,假如你是人,那么一个接口最好不要超过7个函数。(注1) 2、轻易维护。至少你肉眼搜索的时候也方便一些呀。 3、轻易升级。当我们给组件增加函数的时候,不要修改已经发表的接口,而是提供一个新的接口来完成功能扩展。(注2) 本回书着落在------如何实现一个组件,多个接口。   二、接口结构 [url=http://www.wangchao.net.cn/bbsdetail_1785158.html][img]http://image.wangchao.net.cn/it/1323424484888.jpg[/img][/url] 图一、组件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) ] 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)后,自己看吧。
󰈣󰈤
 
 
 
>>返回首页<<
 
 热帖排行
 
 
 
静静地坐在废墟上,四周的荒凉一望无际,忽然觉得,凄凉也很美
©2005- 王朝网络 版权所有