共用 Visual Basic 6 和 Visual Basic .NET 的最佳实践

导航到“开始”|“运行”。

在“运行”对话框中，输入“CMD”，然后单击“确定”。

输入“cd C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727”。

输入“regasm system.dll”。

下载并解压缩本文的示例代码。

将 ComClass.zip 文件复制到 C:\Documents and Settings\[User Name]\My Documents\Visual Studio 2005\Templates\ItemTemplates\Visual Basic。

如果您使用的是 Visual Studio 2005，可以跳过步骤 2。不过，Visual Basic Express 默认情况下不包含 COM 类模板，而此模板对于将 .NET Framework 公开为 COM 对象很有用。将 ComClass.zip 文件复制到此文件夹中后，COM 类模板将可用于 Visual Basic Express。

从“Visual Basic Express”，选择“文件”|“新建工程”菜单命令。

在“新建工程”对话框中：

图 3. 在 Visual Basic .NET 中创建包装工程

单击“确定”。

在“解决方案资源管理器”中，删除“Class1”。

选择“工程”|“添加新项”菜单命令。

在“添加新项”对话框中：

图 4. 创建 Visual Basic .NET 包装 COM 类

单击“添加”。

在第 20 行（End Sub 之后、End Class 之前）中，输入以下内容：

代码清单 3.Visual Basic .NET 中的包装函数

Public Function NewGuid() As String
        Dim g As Guid = Guid.NewGuid()
        Return g.ToString()
    End Function

这会创建 Guid 类的一个实例，并将其分配给新生成的 Guid 值。然后它将 Guid 值转换为字符串，并返回该字符串。

选择“生成”|“生成 NetFxWrapper”菜单命令。这将编译该组件并将其注册为 COM 对象。

启动 Microsoft Visual Basic 6.0。

在“新建工程”对话框中，选择“标准 Exe”，然后单击“打开”。

选择“工程”|“引用”菜单命令。

添加对 NetFxWrapper 的引用。

图 5. 添加对 Visual Basic .NET 中创建的 COM 对象的引用

在窗体中添加 CommandButton 和 TextBox。

将 CommandButton Caption 属性设置为 Generate。

对于 CommandButton 的 click 事件，输入：

代码清单 4. 从 Visual Basic 6 调用包装

Private Sub Command1_Click()
    Dim gw As NetFxWrapper.GuidWrapper
    Set gw = New NetFxWrapper.GuidWrapper
    
    Text1.Text = gw.NewGuid
End Sub

运行应用程序。每次单击该按钮时，Visual Basic 6 应用程序都会调用 Visual Basic .NET 包装并生成新的 GUID。该 GUID 将显示在 TextBox 中。

图 6. 显示 GUID

包装必须公开默认构造函数

在 Visual Basic 6 中，您需要先创建一个对象实例，然后使用属性和方法初始化该对象。例如：

代码清单 5. 在 Visual Basic 6 中初始化连接对象

Dim cn As ADODB.Connection
Set cn = New ADODB.Connection
cn.ConnectionString = _
    "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=mydb.mdb;" & _
    "User Id=admin;Password=;"

要设置连接对象，必须首先创建该对象的实例，然后设置属性（例如 ConnectionString）。在 Visual Basic 6 中，对象的创建和对象属性的初始化必须在不同的步骤中完成。

但是，在 Visual Basic .NET 中，可以在创建对象的实例时指定初始化信息。Visual Basic .NET 中的等效代码是：

代码清单 6. 向 Visual Basic .NET 中的构造函数传递参数

Dim cn As New OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;" & _
    "Data Source=mydb.mdb;User Id=admin;Password=;")

您可以看到对象是在一行代码中创建并初始化的。之所以可以做到这一点是因为创建该对象时会调用 .NET 类型中的 Sub New，此 Sub New 可以采用参数。一个类甚至可以有多个 Sub New 构造函数方法，每个都采用不同的参数类型或参数数量。

代码清单 7. Visual Basic .NET 类构造函数

Public Sub New()
End Sub
Public Sub New(ByVal connectionString As String)
End Sub

当创建类的实例时，Visual Basic .NET 编译器会计算出将自动调用哪一个 Sub New。如果创建了不包含任何参数的 OleDbConnection 的实例，它将调用不采用任何参数的 Sub New。如果创建了带有连接字符串参数的 OleDbConnection 的实例，编译器将自动调用将字符串作为参数的 Sub New。

不采用任何参数的 Sub New 称为“默认构造函数”，这意味着如果未提供参数，默认情况下将调用该方法。

由于 Visual Basic 6 无法在您创建对象的实例时传递参数，.NET 类必须提供默认构造函数，否则您无法在 Visual Basic 6 中直接使用它。许多 .NET Framework 类不能直接使用的一个原因是它们的 Sub New 方法都需要参数。它们不公开默认构造函数，因此您无法在 Visual Basic 6 中创建它们的实例。

您可以为这些对象创建包装类。包装公开默认构造函数，但是当包装创建实际 .NET framework 类的实例时，它会将所需的参数传递给该类的 Sub New。

举一个具体的示例：.NET Framework FileInfo 类。此类允许您获取磁盘文件的多个特征。但是它不包含默认构造函数。FileInfo 的 Sub New 需要所需的文件的路径，但是它可以按以下方法包装：

代码清单 8. FileInfo 的 Visual Basic .NET 包装

Private fi As FileInfo
Public Sub New()
End Sub
Public Sub Initialize(ByVal filePath As String)
    fi = New FileInfo(filePath)
End Sub

此包装包含不接受任何参数的 Sub New。这会允许此类注册为 COM Interop，以便 Visual Basic 6 应用程序可以创建它的实例。在 Visual Basic 6 应用程序调用 Initialize 方法之前，不会创建内部 FileInfo。将按如下方法在 Visual Basic 6 中使用 FileInfo：

代码清单 9. 在 Visual Basic 6 中使用 FileInfo 包装

Dim fi As NetFxWrapper.FileInfoWrapper
Set fi = New NetFxWrapper.FileInfoWrapper
fi.Initialize ("c:\somefile.txt")

许多数据类型必须在 Visual Basic 6 和 Visual Basic .NET 之间进行转换

创建包装的大多数工作归结为将 Visual Basic .NET 数据类型转换为 Visual Basic 6 可以使用的类型。请考虑以下两个方法，一个返回字符串，另一个返回 Guid 数据类型：

代码清单 10. Visual Basic .NET 中的包装函数

Public Function NewGuidAsString() As String
        Dim g As Guid = Guid.NewGuid()
        Return g.ToString()
    End Function
    Public Function NewGuidAsGuid () As Guid
        Dim g As Guid = Guid.NewGuid()
        Return g
    End Function

在 Visual Basic 6 中，调用 NewGuidAsString 不会出现问题，因为字符串可以轻松在 Visual Basic 6 和 Visual Basic .NET 之间传递。但是，在 Visual Basic 6 中调用 NewGuidAsGuid 会生成以下错误：

图 7. 在 Visual Basic 6 中调用 NewGuidAsGuid 所生成的错误

这是因为 Guid 类型的对象无法直接从 Visual Basic .NET 传递到 Visual Basic 6。当创建 .NET 类的包装时，大多数时间用在将 .NET 数据类型转换为可在 Visual Basic 6 中使用的类型上。

还可以使用 .NET MarshalAs 属性来指定参数和返回值应当使用哪一个 Visual Basic 6 类型。例如，如果 Visual Basic .NET 函数返回 Decimal 数据类型，则不能从 Visual Basic 6 调用此函数。但是，可以指定将返回值转换为 Currency 类型。这样，Visual Basic 6 就可以使用该函数而不会产生错误了。

代码清单 11. 使用 MarshalAs 在 Visual Basic 6 和 Visual Basic .NET 类型之间转换：

Public Function ReturnDecimal() As _
<Runtime.InteropServices.MarshalAs(Runtime.InteropServices.UnmanagedType.Currency)> _
    Decimal
    Return 1.1
End Function

下表列出在 Visual Basic .NET 和 Visual Basic 6 类型之间完成的自动转换：

表 1. 从 Visual Basic .NET 到 Visual Basic 6 的类型转换

共享函数不互操作

在 Visual Basic 6 中，为您提供了可以从代码中任何位置调用的全局函数。全局函数的问题是很难知道两个不同全局函数之间是逻辑相关的。在 Visual Basic .NET 中，可以将全局函数组合到一个类中。其好处是您可以使用类名来调用函数，从而不必创建该类的实际实例：

代码清单 12. 共享函数

If Not File.Exists(someFile) Then
    MessageBox.Show("File not found")
End If

在此例中，从 File 类直接调用 Exists 函数。代码未创建 File 类的实例来调用此方法；而是从 File 类型直接调用 Exists。此种函数称为共享（或静态）函数，在整个 .NET Framework 中都会用到它们。

共享函数的问题是它们不与 Visual Basic 6 进行互操作。若要使 Visual Basic 6 调用某函数，该函数必须是真正的全局函数，或者是从类的实例调用的。共享函数不具备这两个条件。

解决方案是创建一个您可以创建其实例的包装，然后使用该包装调用共享函数。

代码清单 13. 调用共享函数的包装

Imports System.IO
<ComClass(FileWrapper.ClassId, FileWrapper.InterfaceId, FileWrapper.EventsId)> _
Public Class FileWrapper
    Public Const ClassId As String = "1596574F-9EE1-4439-854B-DF503099CEAE"
    Public Const InterfaceId As String = "02F98DBC-9298-4E9D-A991-E618C1B1BC53"
    Public Const EventsId As String = "2286FD23-B22D-4D49-B2CE-F3CFEC5C1CA5"
    Public Sub New()
        MyBase.New()
    End Sub
    Public Function Exists(ByVal fileName As String) As Boolean
        Return File.Exists(fileName)
    End Function
End Class

由于 FileWrapper 类公开了默认构造函数，因此可以从 Visual Basic 6 创建该类。调用 Exists 函数时，它会调用共享的 File.Exists .NET 函数并返回结果。Visual Basic 6 调用 FileWrapper 的实例方法，而 FileWrapper 调用 .NET Framework File 类的共享方法。

在 Visual Basic 6 中，可以按如下方法使用该函数：

代码清单 14. 在 Visual Basic 6 中使用 File.Exists

Private Sub Command5_Click() Dim fw As New NetFxWrapper.FileWrapper Label2 = fw.Exists("c:\platform.ini")End Sub

包装不应使用重载函数

在 .NET Framework 中，您可以使用名称完全相同但参数不同的多个函数。请看以下代码：

代码清单 15. Visual Basic .NET 中的重载函数

Public Sub Save(ByVal fileName As String)
    _image.Save(fileName)
End Sub
Public Sub Save(ByVal fileName As String, 
    ByVal format As ImageFormatWrapper)
    Dim imageFormat As Imaging.ImageFormat
    Select Case format
        Case ImageFormatWrapper.Bmp
            imageFormat = Imaging.ImageFormat.Bmp
        Case ImageFormatWrapper.Emf
            imageFormat = Imaging.ImageFormat.Emf
        Case ImageFormatWrapper.Exif
            imageFormat = Imaging.ImageFormat.Exif
        Case ImageFormatWrapper.Gif
            imageFormat = Imaging.ImageFormat.Gif
        Case ImageFormatWrapper.Icon
            imageFormat = Imaging.ImageFormat.Icon
        Case ImageFormatWrapper.MemoryBmp
            imageFormat = Imaging.ImageFormat.MemoryBmp
        Case ImageFormatWrapper.Png
            imageFormat = Imaging.ImageFormat.Png
        Case ImageFormatWrapper.Tiff
            imageFormat = Imaging.ImageFormat.Tiff
        Case ImageFormatWrapper.Wmf
            imageFormat = Imaging.ImageFormat.Wmf
    End Select
    _image.Save(fileName, imageFormat)
End Sub

一个函数采用文件名作为参数，另一个函数还采用其他图形格式参数。这两个函数都被命名为 Save。从 Visual Basic .NET 调用这两个函数时，编译器可以根据传递的参数来确定调用哪一个函数。如果只传递一个参数，则调用第一个函数。如果传递两个参数，则调用第二个函数。

COM 不支持重载函数，因此如果此类是通过 COM interop 公开的，COM 包装必须为这些函数生成唯一的函数名称。对于 Visual Basic 6，它们显示为：

图 8. 从 Visual Basic 6 调用重载函数

请注意，Save 函数被命名为 Save 和 Save_2。这样，您可以确定要从 Visual Basic 6 调用哪一个函数，但是名称不具有描述性。最好不在包装中使用重载，而改为给每个函数赋予唯一的名称：

代码清单 16. 函数的唯一名称

Public Sub Save(ByVal fileName As String)
    _image.Save(fileName)
End Sub
Public Sub SaveWithImageFormat(ByVal fileName As String, _
    ByVal format As ImageFormatWrapper)
    Dim imageFormat As Imaging.ImageFormat
    Select Case format
        Case ImageFormatWrapper.Bmp
            imageFormat = Imaging.ImageFormat.Bmp
        Case ImageFormatWrapper.Emf
            imageFormat = Imaging.ImageFormat.Emf
        Case ImageFormatWrapper.Exif
            imageFormat = Imaging.ImageFormat.Exif
        Case ImageFormatWrapper.Gif
            imageFormat = Imaging.ImageFormat.Gif
        Case ImageFormatWrapper.Icon
            imageFormat = Imaging.ImageFormat.Icon
        Case ImageFormatWrapper.MemoryBmp
            imageFormat = Imaging.ImageFormat.MemoryBmp
        Case ImageFormatWrapper.Png
            imageFormat = Imaging.ImageFormat.Png
        Case ImageFormatWrapper.Tiff
            imageFormat = Imaging.ImageFormat.Tiff
        Case ImageFormatWrapper.Wmf
            imageFormat = Imaging.ImageFormat.Wmf
    End Select
    _image.Save(fileName, imageFormat)
End Sub

现在，每个函数都有唯一的名称，可以在 Visual Basic 6 中更方便地使用了。

图 9. 具有唯一名称的函数

包装应当放在全局程序集缓存中

当注册 COM 对象时，系统注册表包含 COM 对象 DLL 的文件路径。这样，当您的程序创建 COM 对象的实例时，操作系统可以找到该 DLL 并将其加载到内存中。

.NET 程序集的工作方式与之不同。.NET framework 需要程序集与使用它的可执行文件位于同一位置中，或者需要程序集位于称为“全局程序集缓存”(GAC) 的位置中。为了确保在运行时始终可以找到 .NET 包装类，应将它们放在 GAC 中。

将程序集放入 GAC 需要两个步骤。首先，必须对程序集进行签名。这可以通过如下方法完成：

Install.bat — 用于注册和安装 .NET 包装，以便可以在 Visual Basic 6 中使用这些包装。

NetFxWrapper — 包含 Visual Basic .NET 包装类的源代码的文件夹。

Best Practices Visual Basic 6 — 包含使用包装类的 Visual Basic 6 示例的文件夹。

ComClass.zip — 包含 ComClass 工程项。如果此文件放在 C:\Documents and Settings\[User Name]\My Documents\Visual Studio 2005\Templates\ItemTemplates 文件夹中，此工程模板将可用于 Visual Basic Express 工程。