如何制作 PInvoke 友好的本机 API？

Question

如何使原生 API 对 PInvoke 友好？

此处提供了一些有关如何修改与 P/Invoke 一起使用的本机程序的提示。但在我编写本机程序之前，我应该注意哪些事项才能使我的程序/库 PInvoke 友好？

使用 C 或 C++ 都可以。

---

update:
if I write a C API, what are the things I have to do so that It is P/Invoke-able using C# syntax like the following:

[DLLimport("MyDLL.dll")]

是否可以对本机 C++ 代码/库执行相同操作？

---

Summary/Rephrase of Some Tips to make a P/Invoke friendly native-API:
+ the parameters should be of native types (int, char*, float, ...)
+ less parameters is better
+ if dynamic memory is allocated and passed to managed code, make sure to create a "cleaner" function which is also p/invoked
+ provide samples and/or unit tests that illustrate how to call the API from .NET
+ provide C++/CLI wrapper

Answer 1

如果您自己控制本机库，则可以编写一组包装本机调用的 C++/CLI 类，而不是使用 P/Invoke。在许多情况下，这比使用平台调用的性能更好，并且您可以获得类型正确性的额外好处。例如，如果您有如下所示的某种 C API（它没有做任何有用的事情，我只是添加了指针和结构来强化它是本机代码的事实）：

struct SomeStruct {
  int a, b;
  int* somePtr;
};

int foo(struct SomeStruct* a, int b) {
  *a->somePtr = a->a + a->b;
  return a->b * *a->somePtr + b;
}

您可以创建一个 C++/CLI 类来包装它：

public ref class MyNativeAPI {
  private:
    SomeStruct* x;
  public:
    MyNativeAPI() {
      x = new SomeStruct;
    }  
    ~MyNativeAPI() {
      delete x;
    }
    int Foo(int a) {
      pin_ptr<SomeStruct*> ptr = this->x;
      return foo(ptr, a);
    }
}

然后，您可以在 C# 中调用它：

MyNativeAPI a = new MyNativeAPI();
if(a.Foo(5) > 5) { ... };

您必须阅读有关 C++/CLI 的更多内容，以了解对托管堆和本机堆的新控制，以及混合两者的注意事项（例如 < code>pin_ptr 我在上面使用过），但总的来说，它是在 .NET 中实现本机互操作的更优雅的解决方案。

Answer 2

根据定义，每个本机函数都可以从托管代码中 p/调用。但为了 p/invoke 友好，函数应该具有尽可能少的参数，这些参数应该是本机类型（int、char*、float，...）。此外，如果函数在返回到托管代码的某个指针上分配内存，请确保编写其对应部分来释放该指针，因为托管代码无法释放从非托管代码分配的内存。

Answer 3

提供一个从 C# 或 .NET 正确调用它的示例，最好提供一个包装所有方法的 .NET 类

使用 nunit 编写简单的单元测试
证明你的代码工作正常
当从 .Net 调用时会很棒
这样做的方法。

另请记住，可能调用您的代码的 .NET 开发人员不太可能了解 C++，或者不知道不同数据类型的大小等，也不知道这些类型如何映射到 PInvoke 属性。

首先考虑一下您希望客户代码的外观，然后设计一个允许它的 API。