在 C# 中创建 COM 对象 (把 C# 类公布到 COM )

时间:2022-08-30 17:15:24

所谓在 c# 中创建 com 对象,实际上就是向 com 公开用 c# 编写的组件对象接口。这个 c# 类及其成员必须遵循下列规则才能对 com 可见:

1> 类必须是公共的。
2> 属性、方法和事件必须是公共的。
3> 属性和方法必须在类接口上声明。
4> 事件必须在事件接口中声明。

其他没有在这些接口中声明的类的公共成员对于 com 是不可见的,但它们对于其他 .net framework 对象将是可见的。

若要向 com 公开属性和方法,必须在类接口上声明这些属性和方法,并用 dispid 属性予以标记,然后在类中实现它们。成员在接口中声明的顺序即是用于 com vtable 的顺序。

若要从类中公开事件,必须在事件接口上声明这些事件,并用 dispid 属性予以标记。该类不应实现此接口。(这里所指的事件实际上应该是事件处理函数,如果声明成字段,即一个变量,则这个事件不被 com 所见)

类实现类接口(它可以实现一个以上的接口,但第一个实现将作为默认类接口)。在此处实现向 com 公开的方法和属性。它们必须标记为是公共的,并且必须与类接口中的声明匹配。同时,在此处声明由类引发的事件。它们必须标记为是公共的,并且必须与事件接口中的声明匹配。

以下是一个把一个 c# 类公布到 com 的例子:

// 首先要添加以下引用,它提供了如 dispid 、guid 等属性的支持
using system.runtime.interopservices;

// 接口的声明,每个接口都需要使用 guid 属性进进标识
[guid("694c1820-04b6-4988-928f-fd858b95c880")] // guid 属性
public interface imycominterface
{
 [dispid(1)] // 接口中的每个方法和属性都需要用 dispid 属性标识
 void hello(string name, int nparam);
 [dispid(2)]
 bool hello2(string name);
 [dispid(3)]
 string name {get;set;}
}

// 为了便于在 com 客端 (vb 6.0 程序) 中使用这个自定义的事件参数类型
// 在这里为它声明了一个接口, 这个接口声明了若干属性以访问事件参
// 数类型中的成员
[guid("e65b4846-bbec-484f-85dc-088b407db9dc")]
public interface imyeventargs
{

 int nparam
 {
  get;
  set;
 }

 string strname
 {
  get;
  set;
 }
}

// 自定义的事件参数型,必须从 eventargs 从派生,这里还继承了
// 一个接口,目的是便于在 com 客户端中提前绑定事件参数类型对象
[guid("9815f614-83df-4b4f-8302-aba23365db84")]
[classinterface(classinterfacetype.none)]
public class myeventargs : eventargs, imyeventargs
{
 // 通常会定义一个带参数的构造函数,用以作为事件参数传递之用
 // 当然这个派生类中实现更多的成员也是可以的
 public myeventargs(string strparam, int nparam)
 {
  this.m_strparam = strparam;
  this.m_nparam   = nparam;
 }
 public string m_strparam;
 public int    m_nparam;

 public int nparam
 {
  get
  {
   return m_nparam;
  }
  set
  {
   m_nparam = value;
  }
 }

 public string strname
 {
  get
  {
   return m_strparam;
  }
  set
  {
   m_strparam = value;
  }
 }
}
 
// 声明一个代理事件类型,这是一个带参数的事件类型
public delegate void myeventhandler(object sender, eventargs e);
// 声明事件接口,事件接口除了要使用 guid 来标识外,还需要指定为 idispatch 类型
[guid("47c976e0-c208-4740-ac42-41212d3c34f0"),
interfacetype(cominterfacetype.interfaceisidispatch)]
public interface imyeventsinterface
{
 [dispid(1)]
 event myeventhandler myevent; // 在接口中声明一个事件(字段)
 // 注意,以这种方式声明的事件不能被 com 客户端(这里是一个 vb 6.0 程序)
 // 正确地处理, 实现了这个事件的组件不能被创建,可行的声明方法如下:
 [dispid(2)]
 void myevent2(object sender, eventargs e);
 // 也就是说声明一个方法,这个方法实际上就相应的是事件的处理函数
}

注意:由于事件接口是由订阅该事件的客户来实现,所以不应在声明组件类时将事件接口作为基类继承。

// 声明组件类,并在这里实现所有接口
[guid("9e5e5fb2-219d-4ee7-ab27-e4dbed8e123e"),
classinterface(classinterfacetype.none), // 禁止生成类接口,而使用显式声明的接口
comsourceinterfaces(typeof(imyeventsinterface))] // 将事件接口与组件类联系起来
public class mycoclass : imycominterface // 继承接口,以实现这个接口
{
 // 事件字段的声明应与事件接口中相应的事件声明保持一致,并加上 public
 public event myevent myevent;
 private string m_strname;

 // 这里实现所有在接口中声明的方法、属性以及激发事件
 public void hello(string name, int nparam)
 {
  myeventargs e = new myeventargs(name, nparam);
  firemyevent(e);
 }
 public bool hello2(string name)
 {
  myeventargs e = new myeventargs(name, 0);
  firemyevent(e);
 }

 // 通常会单独定义一个成员函数来激发事件
 firemyevent(myeventargs e)
 {
  if (myevent != null) //首先检查一下当前是否有客户端订阅这个消息
  {
   myevent(this , eventargs.empty);
  }
 }
 
 public string name
 {
  get
  {
   return m_strname;
  }
  set
  {
   // 当这个属性改变时,激发一个事件
   myeventargs e = new myeventargs(value, 0);
   firemyevent(e);
   m_strname = value;
  }
 }
}

注意:在创建 com 对象前,首先应将这个对象注册到 com interop,并生成相应的
组件类型库(*.tlb):
 打开项目的属性设置对话框-->配置属性-->生成-->为 com interop 注册 --> true
当然可以使用 regasm.exe 工具完成同样的注册过程。

此外,为了公开这个 com 对象,组件库必须有一个强名称(strong name),强名称的
创建方法如下:
 使用工具 sn.exe 就可以很容易地生成一个强名称,例如
           sn.exe -k database_com_key.snk
 然后打开项目中的 assemblyinfo.cs 文件,并在里面指定密钥文件即可。

////////////////////////////////////////////////////////////////////////////////下面介绍一下如何在 vb 6.0 程序中使用采用上述方法上创建的 com 对象了。

1> 首先,在工程中增加对相应的组件库(*.tlb文件) 和 common language runtime
   library (mscorlib.dll)的引用;
  
2> 然后,如果要响应组件对象所实现的事件,则需要在代码声明带事件组件对象变量,
   例如:
  
   在代码文件的开头加入以下声明语句:
   option explicit
   dim withevents mycomobject as mycoclass  // 声明一个事件源对象
  
   注意, vb 6.0 中不允许在 withevents 类型变量的同时使用 new 操作符来创建对象,
   所以要在程序的其它地方,在使用这个对象之前创建它。有两种创建对象的方法:
 set mycomobject = new mycomlib.mycoclass ' 常用于支持前期绑定的组件对象
或  set mycomobject = createobject("mycomlib.mycoclass")

3> 如果在工程中引用了组件库(*.tlb),借助前期绑定技术 vb 6.0 的 ide 可以轻易为事
   件源对象创建相应的事件处理函数。如果事件的参数是从 eventargs 派生出来的自定义
   类型,则由 ide 创建的事件处理函数的参数始终是 mscorlib.eventargs 类型,所以在
   使用前需要做一些转换工作,例如:

 dim myeventargs as mycomlib.myeventargs
 set myeventargs = e  'e 是事件响应函数的入口参数,类型为 mscorlib.eventargs

 注意:虽然经过上述转换以后,可以正确地访问自定义参数类型对象的成员,但是要想
 这个自定义的参数类型支持前期绑定,则必须也将这个自定义类公布到 com 。

    事实上如果只是想组件类中的一些成员公开到 com 并不需要如此繁琐。只需通过使用
    interface 声明一个接口,然后在组件类中实现它即可。但是如果想将组件类中所支持
    的事件公开到 com 则必须要使用 guid 来对事件接口件标识。