将简单的 C# DLL 转变为 COM 互操作组件

Question

如何将 C# DLL 制作为可供 VB6 应用程序使用的 COM 互操作 DLL？

Answer 1

这是我想在 StackOverflow 中找到但找不到的答案。事实证明，将简单的 C# dll 转换为 COM dll 相当容易。

创建 C# dll

使用 C# 类项目创建解决方案。该类应该有一个属性/方法的接口和一个事件的接口。将 GUID 属性分配给类和接口，如 MSDN - 示例 COM 类（C# 编程）中所述指南）。另请参阅：MSDN - 如何：引发已处理的事件通过 COM 接收器。

在项目属性>应用程序选项卡>装配信息按钮>选中“使程序集 COM 可见”。这使得 COM 类中的所有公共方法都可见。

在项目属性>构建选项卡>将“平台目标”设置为 x86。

这就是创建 DLL 所需要做的全部工作。要调用DLL，您需要注册它。

在开发计算机上注册 DLL

您可以通过以下方式之一注册 DLL：

• 检查项目属性 >构建选项卡> “注册 COM 互操作”。这将在您构建 DLL 时自动注册它。

• 使用 RegAsm 手动注册 DLL。这允许您在您选择的目录中注册 DLL，而不是在构建目录中。我用的就是这个方法。

  • 请勿检查项目属性 >构建选项卡> “注册 COM 互操作”
  • 将DLL复制到要注册的目录

  • 使用管理员权限打开命令 shell 并键入

    RegAsm.exe -tlb -codebase mydll.dll
    

    RegAsm.exe可以在“C:\Windows\Microsoft.NET\Framework\v2.0.50727”中找到，而“mydll.dll”是你的DLL的名称； tlb 表示“创建类型库”；
    codebase 的意思是“将目录位置写入注册表，假设它没有放置在 GAC 中”。

    RegAsm 将显示一条警告，提示程序集应采用强名称。你可以忽略它。

    此时，您应该能够在 VB6 中添加对 COM DLL 的引用，使用 Intellisense 查看它，并像常规 COM DLL 一样运行它。

使用InstallShield 安装DLL

如果您使用InstallShield 将DLL 与应用程序的其余部分一起安装，请执行以下操作。

在 InstallShield 中，将新组件添加到组件列表中。请记住将组件与功能相关联。
将组件属性“.NET COM Interop”设置为“是”。

将 .dll 文件添加到组件的“文件”部分。
不要选中“Self-Register”属性。
右键单击 .dll 文件并选择“设置密钥文件”。

将 .tlb 文件添加到组件的文件部分。
检查“自注册”属性。

目标 PC 上需要存在正确版本的 .Net Framework。

就是这样。

Answer 2

作为 @Kieren Johnstone 的回答的扩展，您需要做的关于类修改的实用代码示例：

来自：

public class ApiCaller 
{

    public DellAsset GetDellAsset(string serviceTag, string apiKey)
    {
     ....
    }
}

public class DellAsset
{
    public string CountryLookupCode { get; set; }
    public string CustomerNumber { get; set; }
    public bool IsDuplicate { get; set; }
    public string ItemClassCode { get; set; }
    public string LocalChannel { get; set; }
    public string MachineDescription { get; set; }
    public string OrderNumber { get; set; }
    public string ParentServiceTag { get; set; }
    public string ServiceTag { get; set; }
    public string ShipDate { get; set; }

}

到：

[Guid("EAA4976A-45C3-4BC5-BC0B-E474F4C3C83F")]
[ComVisible(true)]
public interface IComClassApiCaller
{
    IComClassDellAsset GetDellAsset(string serviceTag, string apiKey);

}

[Guid("7BD20046-DF8C-44A6-8F6B-687FAA26FA71"),
InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
[ComVisible(true)]
public interface IComClassApiCallerEvents
{
}

[Guid("0D53A3E8-E51A-49C7-944E-E72A2064F938"),
    ClassInterface(ClassInterfaceType.None),
    ComSourceInterfaces(typeof(IComClassApiCallerEvents))]
[ComVisible(true)]
[ProgId("ProgId.ApiCaller")]
public class ApiCaller : IComClassApiCaller {

    public IComClassDellAsset GetDellAsset(string serviceTag, string apiKey)
    {
        .....
    }
}


[Guid("EAA4976A-45C3-4BC5-BC0B-E474F4C3C83E")]
[ComVisible(true)]
public interface IComClassDellAsset
{
     string CountryLookupCode { get; set; }
     string CustomerNumber { get; set; }
     bool IsDuplicate { get; set; }
     string ItemClassCode { get; set; }
     string LocalChannel { get; set; }
     string MachineDescription { get; set; }
     string OrderNumber { get; set; }
     string ParentServiceTag { get; set; }
     string ServiceTag { get; set; }
     string ShipDate { get; set; }

}

[Guid("7BD20046-DF8C-44A6-8F6B-687FAA26FA70"),
InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
[ComVisible(true)]
public interface IComClassDellAssetEvents
{
}

[Guid("0D53A3E8-E51A-49C7-944E-E72A2064F937"),
    ClassInterface(ClassInterfaceType.None),
    ComSourceInterfaces(typeof(IComClassDellAssetEvents))]
[ComVisible(true)]
[ProgId("ProgId.DellAsset")]
public class DellAsset : IComClassDellAsset
{
    public string CountryLookupCode { get; set; }
    public string CustomerNumber { get; set; }
    public bool IsDuplicate { get; set; }
    public string ItemClassCode { get; set; }
    public string LocalChannel { get; set; }
    public string MachineDescription { get; set; }
    public string OrderNumber { get; set; }
    public string ParentServiceTag { get; set; }
    public string ServiceTag { get; set; }
    public string ShipDate { get; set; }

}

希望这个为您节省一些时间

Answer 3

互联网上的大多数 COM 服务器示例都只包含一个 CoClass，并且声称该 CoClass 必须有一个公共构造函数。在这种情况下确实如此，但普通服务器有多个 CoClass，其中只能创建一个，而不可创建 CoClass 的实例是可创建 CoClass 的属性。例如，考虑具有可创建的 CoClass Application 的 Word 对象模型，该 CoClass 具有 Documents 属性，而该属性又由 CoClass Document 的实例组成。下面的服务器有两个 CoClass，一个具有公共构造函数，另一个具有私有构造函数。

1. 为 C# 类库 (.Net Framework) 而不是类库 (.Net Standard) 创建解决方案，并将其命名为 BankServerCSharp。明智地选择这个名称，因为它将成为 CoClass 的 ProgID 的主要部分以及 C++ 中的命名空间名称。此名称还将列在 C# 和 VBA 的“引用”对话框中。

2. 删除样板代码并添加两个文件 Bank.cs 和 Account.cs。插入以下代码：

   //Account.cs
   使用 System.Runtime.InteropServices；
   
   命名空间 BankServerCSharp
   {
     [ComVisible(true)] // 这是强制性的。
     [接口类型(ComInterfaceType.InterfaceIsDual)]
     公共接口 IAccount
     {
       双平衡{得到; } // 一个属性
       无效存款（双b）； // 一个方法
     }
   
     [ComVisible(true)] // 这是强制性的。
     [类接口（类接口类型.无）]
     公开课账号：IAccount
     {
       私人双 mBalance = 0;
       private Account() { } // 私有构造函数，组件类不可创建
   
       公共静态帐户MakeAccount() { 返回新帐户(); }
       //MakeAccount不暴露给COM，但可以被其他类使用
   
       公共双余额{获取{返回mBalance; } }
       public void Deposit(double b) { mBalance += b; }
     }
   }
   
   //银行.cs
   使用 System.Runtime.InteropServices；
   
   命名空间 BankServerCSharp
   {
     [ComVisible(true)] // 这是强制性的。
     [接口类型(ComInterfaceType.InterfaceIsDual)]
     公共接口 IBank
     {
       字符串银行名称 { get;放; } // 一个属性
       IAccount 第一个帐户 { 获取； } // 另一种 IDispatch 类型
     }
   
     [ComVisible(true)] // 这是强制性的。
     [类接口（类接口类型.无）]
     公开课银行：IBank
     {
       私有字符串名称=“”；
       私人只读帐户优先；
   
       公共银行() { First = Account.MakeAccount(); }
   
       公共字符串银行名称{
         获取{返回名称; }
         设置{名称=值; }
       }
   
       公共 IAccount 第一个帐户 {
         获取{首先返回； }
       }
     }
   }
   

3. 使用配置 Release/Any CPU 构建项目。输出是位于 \bin\release 文件夹中的托管 DLL BankServerCSharp.dll。

4. 现在您必须注册您的托管 COM DLL。不要尝试 regsvr32，有一个名为 regasm 的特殊程序，用于托管 COM DLL。 Regasm 有适用于 32 位和 64 位应用程序的版本。以管理员身份打开命令提示符并更改为 C:\Windows\Microsoft.NET\Framework\v4.0.30319。此文件夹包含 regasm.exe 应用程序，用于注册托管 COM DLL，就像它是本机 32 位 COM DLL 一样。

5. 输入RegAsm.exe /tlb /codebase path_to_your_bin_release_folder\BankServerCSharp.dll。 您必须以这种方式在任何计算机上注册 DLL。不要忘记创建类型库的 /tlb 开关。编译器将使用一些您可以忽略的警告来注释开关 /codebase。该 DLL 在注册表的 WoW64 部分中注册，可供本机（非托管）32 位应用程序使用。

6. 现在重复注册以供 64 位应用程序使用托管 COM DLL。更改为 C:\Windows\Microsoft.NET\Framework64\v4.0.30319 并键入与之前相同的命令。

7. 您可以通过使用管理权限运行 Visual Studio 并添加以下构建后事件来在您自己的 PC 上加快注册速度：

   %SystemRoot%\Microsoft.NET\Framework\v4.0.30319\RegAsm.exe /tlb /codebase "$(TargetPath)"
   %SystemRoot%\Microsoft.NET\Framework64\v4.0.30319\RegAsm.exe /tlb /codebase "$(TargetPath)"
   

您可以现在，像使用本机非托管 COM DLL 一样使用您的 DLL。使用 VBA 测试 DLL：在 Tools/References 下勾选 BankServerCSharp。如果没有显示，则说明注册失败。一个简单的测试子：

Sub TestSOExampleNew()
 On Error GoTo Oops

   Dim BiBiBaBa As New BankServerCSharp.Bank 'New!
   BiBiBaBa.BankName = "Big Bird Bad Bank"
   Dim Account As BankServerCSharp.Account   'No New!
   Set Account = BiBiBaBa.FirstAccount
   Account.Deposit 2000
   MsgBox BiBiBaBa.BankName & ". First client's balance: " & Account.Balance

   Exit Sub

 Oops:
   MsgBox "Sorry, an unexpected error occurred!"
End Sub

要在 C++ 中测试托管 COM DLL，请创建一个新的控制台应用程序，插入以下代码并构建为 Release/x64 或 Release/x86：

#include "stdafx.h"
#import "D:\Aktuell\CSharpProjects\BankServerCSharp\BankServerCSharp\bin\Release\BankServerCSharp.tlb"
//this is the path of my C# project's bin\Release folder

inline void TESTHR(HRESULT x) { if FAILED(x) _com_issue_error(x); };

int main()
{
  try
  {
    TESTHR(CoInitialize(0));
    BankServerCSharp::IBankPtr BankPtr = nullptr;
    TESTHR(BankPtr.CreateInstance("BankServerCSharp.Bank"));
    BankPtr->BankName = L"Ernie First Global Bank";
    BankServerCSharp::IAccountPtr AccountPtr = BankPtr->FirstAccount;
    TESTHR(AccountPtr->Deposit(200.09));
    wprintf(L"Name: %s, Balance: %.2f\n", (LPCWSTR)BankPtr->BankName, AccountPtr->Balance);
  }
  catch (const _com_error& e)
  {
    CStringW out;
    out.Format(L"Exception occurred. HR = %lx, error = %s", e.Error(), e.ErrorMessage());
    MessageBoxW(NULL, out, L"Error", MB_OK);
  }

  CoUninitialize();// Uninitialize COM
  return 0;
}