C#的接口基础教程之六 接口转换

C#中不仅支持.Net 平台，而且支持COM平台。为了支持 COM和.Net，C# 包含一种称为属性的独特语言特性。一个属性实际上就是一个 C# 类，它通过修饰源代码来提供元信息。属性使 C# 能够支持特定的技术，如 COM 和 .Net，而不会干扰语言规范本身。C# 提供将COM接口转换为 C#接口的属性类。另一些属性类将 COM类转换为C# 类。执行这些转换不需要任何 IDL 或类工厂。

现在部署的任何COM 组件都可以在接口转换中使用。通常情况下，所需的调整是完全自动进行的。

特别是，可以使用运行时可调用包装 (RCW) 从 .NET 框架访问 COM 组件。此包装将 COM 组件提供的 COM 接口转换为与 .NET 框架兼容的接口。对于 OLE 自动化接口，RCW 可以从类型库中自动生成；对于非 OLE 自动化接口，开发人员可以编写自定义 RCW，手动将 COM 接口提供的类型映射为与 .NET 框架兼容的类型。

使用ComImport引用COM组件
COM Interop 提供对现有 COM 组件的访问，而不需要修改原始组件。使用ComImport引用COM组件常包括下面 几个方面的问题：

1、创建 COM 对象。

2、确定 COM 接口是否由对象实现。

3、调用 COM 接口上的方法。

4、实现可由 COM 客户端调用的对象和接口。

创建 COM 类包装

要使 C# 代码引用COM 对象和接口，需要在 C# 中包含 COM 接口的定义。完成此操作的最简单方法是使用 TlbImp.exe（类型库导入程序），它是一个包括在 .NET 框架 SDK 中的命令行工具。TlbImp 将 COM 类型库转换为 .NET 框架元数据，从而有效地创建一个可以从任何托管语言调用的托管包装。用 TlbImp 创建的 .NET 框架元数据可以通过 /R 编译器选项包括在 C# 内部版本中。如果使用 Visual Studio 开发环境，则只需添加对 COM 类型库的引用，将为您自动完成此转换。

TlbImp 执行下列转换：

1、COM coclass 转换为具有无参数构造函数的 C# 类。

　2、COM 结构转换为具有公共字段的 C# 结构。

检查 TlbImp 输出的一种很好的方法是运行 .NET 框架 SDK 命令行工具 Ildasm.exe（Microsoft 中间语言反汇编程序）来查看转换结果。

虽然 TlbImp 是将 COM 定义转换为 C# 的首选方法，但也不是任何时候都可以使用它（例如，在没有 COM 定义的类型库时或者 TlbImp 无法处理类型库中的定义时，就不能使用该方法）。在这些情况下，另一种方法是使用 C# 属性在 C# 源代码中手动定义 COM 定义。创建 C# 源映射后，只需编译 C# 源代码就可产生托管包装。

执行 COM 映射需要理解的主要属性包括：

1、ComImport：它将类标记为在外部实现的 COM 类。

2、Guid：它用于为类或接口指定通用唯一标识符 (UUID)。

3、InterfaceType，它指定接口是从 IUnknown 还是从 IDispatch 派生。

4、PreserveSig，它指定是否应将本机返回值从 HRESULT 转换为 .NET 框架异常。

声明 COM coclass

COM coclass 在 C# 中表示为类。这些类必须具有与其关联的 ComImport 属性。下列限制适用于这些类：

1、类不能从任何其他类继承。

2、类不能实现任何接口。

4、类还必须具有为其设置全局唯一标识符 (GUID) 的 Guid 属性。

以下示例在 C# 中声明一个 coclass：
 
// 声明一个COM类 FilgraphManager
[ComImport, Guid("E436EBB3-524F-11CE-9F53-0020AF0BA770")] 
class FilgraphManager
{ }

C# 编译器将添加一个无参数构造函数，可以调用此构造函数来创建 COM coclass 的实例。

创建 COM 对象

COM coclass 在 C# 中表示为具有无参数构造函数的类。使用 new 运算符创建该类的实例等效于在 C# 中调用 CoCreateInstance。使用以上定义的类，就可以很容易地实例化此类：
 
class MainClass 
{
public static void Main() 
{
FilgraphManager filg = new FilgraphManager(); 
}
}

声明 COM 接口

COM 接口在 C# 中表示为具有 ComImport 和 Guid 属性的接口。它不能在其基接口列表中包含任何接口，而且必须按照方法在 COM 接口中出现的顺序声明接口成员函数。

在 C# 中声明的 COM 接口必须包含其基接口的所有成员的声明，IUnknown 和 IDispatch 的成员除外（.NET 框架将自动添加这些成员）。从 IDispatch 派生的 COM 接口必须用 InterfaceType 属性予以标记。
从 C# 代码调用 COM 接口方法时，公共语言运行库必须封送与 COM 对象之间传递的参数和返回值。对于每个 .NET 框架类型均有一个默认类型，公共语言运行库将使用此默认类型在 COM 调用间进行封送处理时封送。例如，C# 字符串值的默认封送处理是封送到本机类型 LPTSTR（指向 TCHAR 字符缓冲区的指针）。可以在 COM 接口的 C# 声明中使用 MarshalAs 属性重写默认封送处理。

在 COM 中，返回成功或失败的常用方法是返回一个 HRESULT，并在 MIDL 中有一个标记为"retval"、用于方法的实际返回值的 out 参数。在 C#（和 .NET 框架）中，指示已经发生错误的标准方法是引发异常。
默认情况下，.NET 框架为由其调用的 COM 接口方法在两种异常处理类型之间提供自动映射。

返回值更改为标记为 retval 的参数的签名（如果方法没有标记为 retval 的参数，则为 void）。

标记为 retval 的参数从方法的参数列表中剥离。

任何非成功返回值都将导致引发 System.COMException 异常。

此示例显示用 MIDL 声明的 COM 接口以及用 C# 声明的同一接口（注意这些方法使用 COM 错误处理方法）。

下面是接口转换的C#程序：
 
using System.Runtime.InteropServices;
// 声明一个COM接口 IMediaControl 
[Guid("56A868B1-0AD4-11CE-B03A-0020AF0BA770"),
InterfaceType(ComInterfaceType.InterfaceIsDual)] 
interface IMediaControl // 这里不能列出任何基接口 
{ 
void Run();
void Pause();
void Stop();
void GetState( [In] int msTimeout, [Out] out int pfs);
void RenderFile(
[In, MarshalAs(UnmanagedType.BStr)] string strFilename);
void AddSourceFilter(
[In, MarshalAs(UnmanagedType.BStr)] string strFilename, 
[Out, MarshalAs(UnmanagedType.Interface)] out object ppUnk);
[return : MarshalAs(UnmanagedType.Interface)]
object FilterCollection();
[return : MarshalAs(UnmanagedType.Interface)]
object RegFilterCollection();
void StopWhenReady(); 
}

若要防止 HRESULT 翻译为 COMException，请在 C# 声明中将 PreserveSig(true) 属性附加到方法。

下面是一个使用C# 映射媒体播放机COM 对象的程序。

程序清单2 DemonCOM.cs
 
using System;
using System.Runtime.InteropServices;
namespace QuartzTypeLib 
{
//声明一个COM接口 IMediaControl，此接口来源于媒体播放机COM类
[Guid("56A868B1-0AD4-11CE-B03A-0020AF0BA770"), 
InterfaceType(ComInterfaceType.InterfaceIsDual)] 
interface IMediaControl 
{ //列出接口成员
void Run();
void Pause();
void Stop();
void GetState( [In] int msTimeout, [Out] out int pfs);
void RenderFile(
[In, MarshalAs(UnmanagedType.BStr)] string strFilename);
void AddSourceFilter( 
[In, MarshalAs(UnmanagedType.BStr)] string strFilename, 
[Out, MarshalAs(UnmanagedType.Interface)]
out object ppUnk);
[return: MarshalAs(UnmanagedType.Interface)] 
object FilterCollection();
[return: MarshalAs(UnmanagedType.Interface)] 
object RegFilterCollection();
void StopWhenReady(); 
}
//声明一个COM类:
[ComImport, Guid("E436EBB3-524F-11CE-9F53-0020AF0BA770")] 
class FilgraphManager //此类不能再继承其它基类或接口 
{ 
//这里不能有任何代码 ，系统自动增加一个缺省的构造函数
}
}
class MainClass 
{ 
public static void Main(string[] args) 
{ 
//命令行参数:
if (args.Length != 1) 
{ 
DisplayUsage();
return;
} 
String filename = args[0]; 
if (filename.Equals("/?")) 
{ 
DisplayUsage(); 
return;
}
// 声明FilgraphManager的实类对象：
QuartzTypeLib.FilgraphManager graphManager =new QuartzTypeLib.FilgraphManager();
//声明IMediaControl的实类对象：:
QuartzTypeLib.IMediaControl mc =(QuartzTypeLib.IMediaControl)graphManager;
// 调用COM的方法：
mc.RenderFile(filename);
//运行文件. 
mc.Run();
//暂借停. 
Console.WriteLine("Press Enter to continue."); 
Console.ReadLine();
}
private static void DisplayUsage() 
{ // 显示 
Console.WriteLine("媒体播放机: 播放 AVI 文件."); 
Console.WriteLine("使用方法: VIDEOPLAYER.EXE 文件名"); 
} 
}

运行示例：

若要显示影片示例 Clock.avi，请使用以下命令：

interop2 %windir%\clock.avi

这将在屏幕上显示影片，直到按 ENTER 键停止。

在 .NET 框架程序中通过DllImport使用 Win32 API

.NET 框架程序可以通过静态 DLL 入口点的方式来访问本机代码库。DllImport 属性用于指定包含外部方法的实现的dll 位置。

DllImport 属性定义如下：
 
namespace System.Runtime.InteropServices
{
　[AttributeUsage(AttributeTargets.Method)]
　public class DllImportAttribute: System.Attribute
　{
　　public DllImportAttribute(string dllName) {...}
　　public CallingConvention CallingConvention;
　　public CharSet CharSet;
　　public string EntryPoint;
　　public bool ExactSpelling;
　　public bool PreserveSig;
　　public bool SetLastError;
　　public string Value { get {...} }
　}
}

说明：

1、DllImport只能放置在方法声明上。

2、DllImport具有单个定位参数：指定包含被导入方法的 dll 名称的 dllName 参数。

3、DllImport具有五个命名参数：

a、CallingConvention 参数指示入口点的调用约定。如果未指定 CallingConvention，则使用默认值 CallingConvention.Winapi。

b、CharSet 参数指示用在入口点中的字符集。如果未指定 CharSet，则使用默认值 CharSet.Auto。

c、EntryPoint 参数给出 dll 中入口点的名称。如果未指定 EntryPoint，则使用方法本身的名称。

d、ExactSpelling 参数指示 EntryPoint 是否必须与指示的入口点的拼写完全匹配。如果未指定 ExactSpelling，则使用默认值 false。

e、PreserveSig 参数指示方法的签名应当被保留还是被转换。当签名被转换时，它被转换为一个具有 HRESULT 返回值和该返回值的一个名为 retval 的附加输出参数的签名。如果未指定 PreserveSig，则使用默认值 true。

f、SetLastError 参数指示方法是否保留 Win32"上一错误"。如果未指定 SetLastError，则使用默认值 false。

4、它是一次性属性类。

5、此外，用 DllImport 属性修饰的方法必须具有 extern 修饰符。

下面是 C# 调用 Win32 MessageBox 函数的示例：
 
using System; 
using System.Runtime.InteropServices; 
class MainApp 
{ //通过DllImport引用user32.dll类。MessageBox来自于user32.dll类
　[DllImport("user32.dll", EntryPoint="MessageBox")] 
　public static extern int MessageBox(int hWnd, String strMessage, String strCaption, uint uiType); 
　public static void Main() 
　{ 
　　MessageBox( 0, "您好，这是 PInvoke！", ".NET", 0 ); 
　} 
}

面向对象的编程语言几乎都用到了抽象类这一概念，抽象类为实现抽象事物提供了更大的灵活性。C#也不例外, C#通过覆盖虚接口的技术深化了抽象类的应用。欲了解这方面的知识，请看下一节-覆盖虚接口