COM组件设计与应用(十)
IDispatch 接口 for vc.net
作者:杨老师
一、前言
终于写到了第十回,我也一直期盼着写这回的内容耶,为啥呢?因为自动化(automation)是非常常用、非常有用、非常精彩的一个 COM 功能。由于 WORD、EXCEL 等 OFFICE 软件提供了“宏”的功能,就连我们使用的VC开发环境也提供了“宏”功能,更由于 HTML、ASP、JSP 等都要依靠脚本(Script)的支持,更体现出了自动化接口的重要性。
如果你使用 vc6.0 的开发环境,请阅读前一回。
如果你使用 vc.net 2003,请继续......
二、IDispatch接口
如果是编译型语言,那么我们可以让编译器在编译的时候装载类型库,也就是装载接口的描述。在第七回文章当中,我们分别使用了 #include 方法和 #import 方法来实现的。装载了类型库后,编译器就知道应该如何编译接口函数的调用了---这叫“前绑定”。但是,如果想在脚本语言中使用组件,问题就大了,因为脚本语言是解释执行的,它执行的时候不会知道具体的函数地址,怎么办?自动化接口就为此诞生了---“后绑定”。
自动化组件,其实就是实现了 IDispatch 接口的组件。IDispatch 接口有4个函数,解释语言的执行器就通过这仅有的4个函数来执行组件所提供的功能。IDispatch 接口用 IDL 形式说明如下:(注1)
[ object, uuid(00020400-0000-0000-C000-000000000046), // IDispatch 接口的 IID = IID_IDispatch pointer_default(unique) ] interface IDispatch : IUnknown { typedef [unique] IDispatch * LPDISPATCH; // 转定义 IDispatch * 为 LPDISPATCH HRESULT GetTypeInfoCount([out] UINT * pctinfo); // 有关类型库的这两个函数,咱们以后再说 HRESULT GetTypeInfo([in] UINT iTInfo,[in] LCID lcid,[out] ITypeInfo ** ppTInfo); HRESULT GetIDsOfNames( // 根据函数名字,取得函数序号(DISPID) [in] REFIID riid, [in, size_is(cNames)] LPOLESTR * rgszNames, [in] UINT cNames, [in] LCID lcid, [out, size_is(cNames)] DISPID * rgDispId ); [local] // 本地版函数 HRESULT Invoke( // 根据函数序号,解释执行函数功能 [in] DISPID dispIdMember, [in] REFIID riid, [in] LCID lcid, [in] WORD wFlags, [in, out] DISPPARAMS * pDispParams, [out] VARIANT * pVarResult, [out] EXCEPINFO * pExcepInfo, [out] UINT * puArgErr ); [call_as(Invoke)] // 远程版函数 HRESULT RemoteInvoke( [in] DISPID dispIdMember, [in] REFIID riid, [in] LCID lcid, [in] DWORD dwFlags, [in] DISPPARAMS * pDispParams, [out] VARIANT * pVarResult, [out] EXCEPINFO * pExcepInfo, [out] UINT * pArgErr, [in] UINT cVarRef, [in, size_is(cVarRef)] UINT * rgVarRefIdx, [in, out, size_is(cVarRef)] VARIANTARG * rgVarRef ); }以上 IDispatch 接口函数的讲解,我们留到后回中进行介绍。如何在组件程序中实现这些函数那?还好,还好,就象 IUnknown 一样,MFC 和 ATL 都帮我们已经完成了。本回我们着重介绍组件的编写,下回则介绍组件的调用方法。
三、用 MFC 实现自动化组件
我写的这整个系列文章---《COM 组件设计与应用》,多是用 ATL 写组件程序,但由于自动化非常有用,在后续的文章中,还要给大家介绍组件的“事件”功能,还要介绍如何在 MFC 的程序中象 WORD 一样支持“宏”的功能。这些都要用到 MFC,所以就给读者唠一唠啦:-)
3-1:建立一个解决方案
3-2:建立一个 MFC DLL 项目,项目名称为“Simple7”
![](https://i-blog.csdnimg.cn/blog_migrate/17377e04f775959e6d79f3de32972eeb.png)
3-3:一定要选择附加功能中的“自动化”,切记!切记!
![](https://i-blog.csdnimg.cn/blog_migrate/a9b7e567e494b811d58f1046334582c5.png)
3-4:添加新类
![](https://i-blog.csdnimg.cn/blog_migrate/86c31f283fccd7acaf77aaa82883beaa.png)
3-5:在新建类中支持自动化
![](https://i-blog.csdnimg.cn/blog_migrate/7d1e3cc4a5762bd4c2744ebf7e930f54.png)
类名 你随便写个类名子啦
基类 一定要从 CComTarget 派生呀,只有它才提供了 IDispatch 的支持
自动化 - 无 表示不支持自动化,你要选择了它,那就白干啦
自动化 - 自动化 支持自动化,但不能被直接实例化。后面在讲解多个 IDispatch 的时候就用到它了,现在先不要着急。
自动化 - 可按类型ID创建 一定要选择这个项目,这样我们在后面的调用中,VB就能够CreateObject(),VC就能够CreateDispatch()对组件对象实例化了。注意一点,这个 ID 其实就是组件的 ProgID 啦。
3-6:选择接口,添加函数
![](https://i-blog.csdnimg.cn/blog_migrate/8d375d8ad715f54bb75d4462ae96ce68.png)
3-7:添加函数。我们要写一个整数加法函数Add()。
![](https://i-blog.csdnimg.cn/blog_migrate/880a7c82881c1336862b66d5014bad61.png)
3-8:再增加一个转换字符串大小写的函数 Upper()。
![](https://i-blog.csdnimg.cn/blog_migrate/2d13ceec0c23dadd1a30b247dd9d3f5e.png)
3-9:好了,下面开始输入程序代码:
LONG CDispSimple::Add(LONG n1, LONG n2) { AFX_MANAGE_STATE(AfxGetStaticModuleState()); return n1 + n2; } BSTR CDispSimple::Upper(LPCTSTR str) { AFX_MANAGE_STATE(AfxGetStaticModuleState()); CString strResult(str); strResult.MakeUpper(); return strResult.AllocSysString(); }3-10:编译注册
如果上面的操作由于疏忽而发生了错误,那么你可以手工进行改正。
其一、你可以打开 IDL 文件进行修改,修改时要特别小心函数的声明中,有一个[id(n)] 的函数序号,可不要乱了;
其二、同步修改 H/CPP 中的函数声明和函数体;
其三、在CPP文件中,根据情况也要修改 BEGIN_DISPATCH_MAP/END_DISPATCH_MAP()函数影射宏。
正确编译后,vc.net 2003 比 vc6.0 要聪明多了,它会自动注册组件。如果复制到其它计算机上,你也需要手工执行 regsvr32.exe 进行注册。
四、用 ATL 实现双接口组件(操作方法和步骤,请参考 《 COM 组件设计与应用(六)》)
4-1:建立一个 ATL 项目,项目名称为“Simple8”
4-2:选择 DLL 类型、非属性方式、不要选择任何附加选项
4-3:添加新类,选择ATL 的简单对象
4-4:输入简称和选项,选项按默认进行,也就是双重接口方式(注2)
![](https://i-blog.csdnimg.cn/blog_migrate/3379f7b1575278d15cc7ad901dd83a87.png)
![](https://i-blog.csdnimg.cn/blog_migrate/5246777c129487ff27a1b4bae107db60.png)
4-5:增加函数。选择接口、鼠标右键菜单、添加方法...
Add([in] VARIANT v1, [in] VARIANT v2, [out, retval] VARIANT * pVal);
Upper([in] BSTR str, [out,retval] BSTR * pVal);
关于Add()函数,你依然可以使用 Add([in] long n1, [in] long n2, [out,retval] long * pVal) 方式。但这次我们没有使用 long ,而是使用了 VARIANT 做参数和返回值。这里我先卖个关子,往下看,就知道使用 VARIANT 的精彩之处了。
4-6:完成代码
STDMETHODIMP CDispSimple::Add(VARIANT v1, VARIANT v2, VARIANT *pVal) { ::VariantInit( pVal ); // 永远初始化返回值是个好习惯 CComVariant v_1( v1 ); CComVariant v_2( v2 ); if((v1.vt & VT_I4) && (v2.vt & VT_I4) ) // 如果都是整数类型 { // 这里比较没有使用 == ,而使用了运算符 & ,你知道这是为什么吗? v_1.ChangeType( VT_I4 ); // 转换为整数 v_2.ChangeType( VT_I4 ); // 转换为整数 pVal->vt = VT_I4; pVal->lVal = v_1.lVal + v_2.lVal; // 加法 } else { v_1.ChangeType( VT_BSTR ); // 转换为字符串 v_2.ChangeType( VT_BSTR ); // 转换为字符串 CComBSTR bstr( v_1.bstrVal ); bstr.AppendBSTR( v_2.bstrVal ); // 字符串连接 pVal->vt = VT_BSTR; pVal->bstrVal = bstr.Detach(); } return S_OK; } STDMETHODIMP CDispSimple::Upper(BSTR str, BSTR *pVal) { *pVal = NULL; // 永远初始化返回值是个好习惯 CComBSTR s(str); s.ToUpper(); // 转换为大写 *pVal = s.Copy(); return S_OK; }刚才卖的关子,现在开始揭密了......加法函数Add()不使用long类型,而使用VARIANT的好处是:函数内部动态判断参数类型,如果是整数则进行整数加法,如果是字符串,则进行字符串加法(字符串加法就是字符串连接哈)。也就是说,如果参数是VARIANT,那么我们就可以实现函数的可变参数类型呀。怪怪个咙,真爽!
五、脚本中调用举例
打开“记事本”程序,输入脚本程序,保存为 xxx.vbs 文件。然后在资源管理器里就可以双击运行啦。
![](https://i-blog.csdnimg.cn/blog_migrate/9550a48847a11a7f622fcf5e912c9702.png)
如果你有能力,也可以用 JScript 书写上面的程序,然后保存为 xxx.js 文件,同样也可以在资源管理器里运行。另外需要说明的一点是,脚本程序文件的图标(win 2000下)是
![](https://i-blog.csdnimg.cn/blog_migrate/f9720e237ae947db45f031d44dc2de3f.png)
![](https://i-blog.csdnimg.cn/blog_migrate/866e593a65912585ab144094d9931b19.png)
六、WORD 中使用举例
6-1:录制一段宏程序
![](https://i-blog.csdnimg.cn/blog_migrate/f79e5708e99e2bdc211fb14ab0f90d92.png)
![](https://i-blog.csdnimg.cn/blog_migrate/66539de265926a522fe138b7daf72a0b.png)
6-2:选择“键盘”,当然你也可以把这个“宏”程序放到“工具栏”上去。这里我们随便指定一个快捷键,比如Ctrl+Z
![](https://i-blog.csdnimg.cn/blog_migrate/bf3180a74870f26524b5f52b8da463cd.png)
6-3:开始录制了,下面你随便输入点什么东东。然后点“停止”
![](https://i-blog.csdnimg.cn/blog_migrate/90548abc87c574a509e0eb4e9b5556dc.png)
6-4:接下来,我们执行菜单,选择这个刚刚录制的宏,然后编辑它
![](https://i-blog.csdnimg.cn/blog_migrate/4e27811ce611425896c9bf8ed06214ca.png)
6-5:点“编辑”按钮,输入下面的程序:
![](https://i-blog.csdnimg.cn/blog_migrate/b4f996a8a55ecb66e94ccdd1f5be80a8.png)
不做解释了,你如果会一点点 VB ,就能看懂这个东东哈。然后保存关闭 VBA 的编辑器(注4)。
6-6:执行啦,执行啦,看看有什么效果呀......
![](https://i-blog.csdnimg.cn/blog_migrate/642c354baa65c21b908add9922960369.png)
然后按快捷键Ctrl+Z
![](https://i-blog.csdnimg.cn/blog_migrate/e604cf0caef11c50d33490434a58e256.png)
你已经扩展了 MS WORD 的功能啦,嘿啦啦啦啦,嘿啦啦啦,天空出彩霞呀......我们只是举了一个简单的例子,其实这个例子并没有什么实际应用的意义,因为人家 WORD 本身就有大小写转换功能。但通过这个小例子,你可以体会出自动化组件的功能了,有够厉害吧?!
七、小结
没小结!嘿嘿......上当喽:-)
注1:以后我们描述接口函数,都采用 IDL 的形式了。
注2:双接口,是支持 IDispatch 接口的一种特殊接口方式,后面马上就要讲啦
注3:VBA 是专门开发 Office 的一种语言---Visual Basic for Application