C#中COM操作(一)---实例化

 杜思波技术大讨论2009

 

    用C#做WinForm程序,时间长了难免会遇到和COM组件打交道的地方,用什么方式创建COM对象也成了我们必须面对的一个问题.据我所知道的创建COM对象的方法一共有以下几种:

1 使用.NET包装COM组件

    这是最简单的就是导入COM组件所在的DLL,让IDE生成.NET一个IL包装加到项目中,这样原来COM里面所有实现了IDispatch,Dual的COM类型及其相关类型就可以直接在.NET程序里面使用,比如以前在2003时代,想要写自己的基于IE的浏览器,就得手动加入与IWebBrowser2接口相关的DLL,这种方式是大家最常用的,也是最傻瓜化的,因此也没什么可解释的.

    但是这种方式有个至命的缺点---不是所有的COM对象都能用这种方式导出.正如前面所说的,只有实现了IDispatch,Dual类型的接口才支持被导出,而且面对不同版本的COM或许会生成不一样的导出DLL,比如说A机器上写代码时导入了一个Jet2.6版本的包装DLL,代码编译了拿到B机器上去运行,但是B机器上的Jet版本是2.8的,就可能会出现运行时错误.

 

2 用反射动态创建

    包括使用Type.GetTypeFromCLSID和Type.GetFromProgID两种方法获取COM对象的Type再创建.这种方式也好理解,就是说使用这两个方法之前,必须得知道COM对象的GUID或ProgID,好在这也不是什么难事,一般我们要使一个COM对象,多多少少都了解一些这个COM对象的GUID或ProgID信息.用这种方获取到了一个Type对象后,就可以用.NET里面通用的反射创建对象的方法来做了.

 

这里给出一个创建JetEngine 的COM对象的代码实例:

 

 1 public object GetActiveXObject(Guid clsid)
 2 {
 3     Type t = Type.GetTypeFromCLSID(clsid);
 4     if (t == null) return null;
 5 
 6     return Activator.CreateInstance(t);
 7 }
 8 
 9 Guid g = new Guid("DE88C160-FF2C-11D1-BB6F-00C04FAE22DA"); // JetEngine
10 object jet = GetActiveXObject(g);

是不是觉得最后调用GetActiveXObject(g)的地方和IE里面Javascript里面用new ActiveXOjbect创建COM对象的方法很相像?

3 声明CoCreateInstance外部函数,用这个函数去创建相应的COM实例

    M$在2005里面包装的WebBrowser控件内部就是用这个函数去创建的, 使用这种方式创建COM,就跟在C++里面不什么两样了.有一点需要说明的是,一般我们在代码中引入外部方法的时候,方法的参数和返回值的类型不一定是唯一的一种,只要在逻辑上相互能转化,一般都可以使用.

比如说如下几种声明都是正确的:  

 

 

 1 [return: MarshalAs(UnmanagedType.Interface)]
 2 [DllImport("ole32.dll", ExactSpelling=true, PreserveSig=false)]
 3 public static extern object CoCreateInstance([In] ref Guid clsid, 
 4     [MarshalAs(UnmanagedType.Interface)] object punkOuter, int context, [In] ref Guid iid);
 5   
 6 [DllImport("ole32.dll", ExactSpelling=true, PreserveSig=false)]
 7 public static extern IntPtr CoCreateInstance([In] ref Guid clsid, 
 8     IntPtr punkOuter, int context, [In] ref Guid iid); 
 9 
10 [DllImport("ole32.dll", ExactSpelling=true)]
11 public static extern int CoCreateInstance([In] ref Guid clsid, 
12     IntPtr punkOuter, int context, [In] ref Guid iid, [Out] out IntPtr pVoid); 
13 
14 [DllImport("ole32.dll", ExactSpelling=true)]
15 public static extern int CoCreateInstance([In] ref Guid clsid, 
16     [MarshalAs(UnmanagedType.Interface)] object punkOuter, int context, 
17     [In] ref Guid iid, [MarshalAs(UnmanagedType.Interface), Out] out object pVoid); 

 

 

 甚至于当你有里面对应的接口类型的声明的时候,完全可以把上面的object或IntPtr换成相应的接口类型,前提是你的接口类型的声明一定要正确.读者中用C++做过COM的一定对这种方式记忆犹新吧,只不过这里不再需要什么CoInitialize和CoUninitialize,.NET内部自己帮你搞定了.顺便提一下,上面例子中的object与IntPtr声明是相通的,我们可以用Marshal.GetObjectForIUnknown和Marshal.GetIUnknownForObject这两个方法在object和IntPtr之间互转,前题当然是这两种方式所指向的都是COM对象才行.这种方式提供的传入参数最多,创建对象也最灵活.

 

3.直接声明空成员的类

    可能很多程序员对于这个不太理解这是什么意思，没关系咱还是"用代码来说话".

 

 1 [ComImport, Guid("DE88C160-FF2C-11D1-BB6F-00C04FAE22DA")]
 2 public class JetEngineClass
 3 {
 4 }
 5 
 6 [ComImport, CoClass(typeof(JetEngineClass)), Guid("9F63D980-FF25-11D1-BB6F-00C04FAE22DA")]
 7 public interface IJetEngine
 8 {
 9     void CompactDatabase(
10         [In, MarshalAs(UnmanagedType.BStr)] string SourceConnection, 
11         [In, MarshalAs(UnmanagedType.BStr)] string Destconnection
12         );
13     void RefreshCache([In, MarshalAs(UnmanagedType.Interface)] object Connection);
14 }
15 
16 JetEngineClass engine = new JetEngineClass();
17 IJetEngine iengine = engine as IJetEngine;
18 // iengine即是所要用的接口的引用

 

 大家看到了上面声明的JetEngineClass类只有一个单单的类声明，但是没有一个成员声明，但是和一般的类声明有些不一样的是这个类多了两个特性(Attribute)，把这个类和COM对象联系在一起的就是这两个特性了，其中一个是ComImportAttribute，这个特性指明了所作用的类是从COM对象中来的，GuidAttribute指明了COM对象的GUID，也就是说明了创建这个COM需用到的GUID。有了这两个特性以后，这个类就不是一个普通的类了，当我们使用new去创建实例的时候，CLR看到了声明的这两特性就知道要创建的是一个COM对象，根据提供的GUID也就能创建出指定的COM对象，并和new返回的对象实例关联在一起了。

 

    终上4种方法我们可以看出来，第一种方式只对特定的COM对象有效，不具有通用性；第二种方式只需要知道COM对象的CLSID或PROGID就可以了，是我们在.NET里平时比较常用的创建COM对象的方法；第三种方式需要自己声明一个外部方法，而且需要传入若干的参数，还需要知道COM对象模型，是单线程呢还是多线程,进程内呢还是进程外,两个字"麻烦"。对CoCreateInstance这个方法不是很熟悉的人来说，用起来就不那么顺手了；第四种方式用起来最像是.NET的方式，也最简单省事，和其它.NET对象的创建方式最为接近。四种方法各有各有好处，我觉得简单的COM对象，用第二种和第四种是最好的（我个人来说最喜欢第四种）又不生成额外的程序集；要是COM对象相关的比较多，比如说Excel之类的COM对象，我建议还是用导入类型库包装吧，虽然是有可能出现版本问题，但这种应该很容易要求目标机器上运行的COM版和开发的时候一致的，更何况版本问题也不是100%出现，只是很少一部分会出这样的问题。最不推荐的就是第三种方式了，这种方式在我看来唯一用到的地方就是使用IntPtr作为COM对象和接口的指针的时候，或者是想要在创建COM对象的时候,对参数作最灵活的控制的时候. 因为其它三种方式既不能返回IntPtr指针(其实也可以通过前面提到的的Marshal类的方法把.NET包装的COM对象转成指针),也不能提供与直接调用CoCreateInstance函数提供最全面的参数相匹配的方式。

 

    最后提个小问题

1 读者有兴趣的话可以去看看这几种方式（不包括第三种）生成的COM对象的引用的类型是否是一致的，也就是用GetType得到的Type是否是一致的

2 大家猜猜这段代码运行后,iengine的类型会是什么(GetType的结果), 会和engine的类型一样吗?

 

1 JetEngineClass engine = new JetEngineClass();
2 IJetEngine iengine = engine as IJetEngine;
3 // iengine即是所要用的接口的引用
4 
5 IntPtr p = Marshal.GetIUnknownForObject(engine);
6 iengine = Marshal.GetObjectForIUnknown(p) as IJetEngine;

 

我这里就不给出结果了，留给读者自行去验证吧。另外如果大家还发现.NET中有其它的创建COM对象的方式也尽指教一二,本人将不甚感激.