将.NET P / Invoke代码组织到Win32 API的最佳实践

Question

我在.NET中重构了一个庞大而复杂的代码库，它大量使用P / Invoke到Win32 API。项目的结构并不是最好的，我发现DllImport语句遍布整个地方，经常复制到同一个函数，并且还以各种方式声明：

import指令和方法有时被声明为public，有时是私有的，有时是静态的，有时也是实例方法。我担心重构可能会产生意想不到的后果，但这可能是不可避免的。

我是否有可以帮助我的最佳实践记录？

我的目标是组织一个静态/共享的Win32 P / Invoke API类，它在一个文件中列出所有这些方法和相关常量... 编辑对user32 DLL有超过70个导入

（代码库由20多个项目组成，包含大量的Windows消息传递和跨线程调用。如果有所不同，它也是从VB6升级的VB.NET项目。）

Answer 1

您可能会考虑在.NET框架中完成它的方式。它总是声明一个名为NativeMethods的静态类（VB.NET中的Module），它包含P / Invoke声明。您可能比Microsoft程序员更有条理，有许多重复声明​​。不同的团队致力于框架的不同部分。

但是，如果要在所有项目中共享此项，则必须将这些声明声明为Public而不是Friend。哪个不好，它应该是一个实现细节。我认为你可以通过在每个需要它的项目中重用源代码文件来解决这个问题。通常禁忌但在这种情况下没问题，我想。

我个人在需要它们的源代码文件中根据需要声明它们，使它们成为私有。当说谎参数类型时，这也很有帮助，特别是对于SendMessage。

Answer 2

将它们组织成[Safe|Unsafe]NativeMethods class。将班级标记为internal static。如果需要将它们暴露给自己的程序集，可以使用InternalsVisibleTo - 尽管如果可以将相关的组合分组到每个程序集中更合适。

每个方法都应该是static - 老实说，我甚至不知道您甚至可以使用DllImport标记实例方法。

作为第一步 - 我可能会将所有内容移动到Core程序集（如果有的话），或创建Product.Native程序集。然后，您可以轻松找到欺骗和重叠，并寻找管理的等价物。如果你的p / invokes是一团糟，我不怀疑你在引导你的分组的其他程序集中有很多分层的方法。

Answer 3

在这种情况下，我通常尝试做的是做你正在谈论的事情，创建各种类，静态或不静态，提供功能，这样可以根据需要重新使用。根据调用的性质，我不喜欢静态类实现，但这取决于您的具体实现。

根据要求扩展到上方。

考虑到P / Invoke的性质，特别是如果需要多次调用并且具有不同的实现区域，我发现最好将类似的项目组合在一起，这样你就不会引起很多其他的混乱，或者其他DLL导入时不需要。

希望远离静态方法，是由于调用了非托管资源和内存泄漏等可能性。

Answer 4

为什么不创建一个名为Win32.vb的单个文件，并在该逻辑组中将pinvokes转换为单独的命名空间，例如GDI命名空间可以使用所有GDI pinvokes，User32命名空间可以使用驻留在User32内核中的所有pinvoke，等等....一开始可能会很痛苦，但至少你会在该文件中包含一个集中的命名空间？看看here看看我的意思......你怎么看？

Answer 5

您的P / Invoke是否从VB6调用了迁移的工件？我已经将300,000行代码从VB6迁移到C＃（Windows.Forms和System.EnterpriseServices），除了少数几个P / Invokes调用之外几乎没有 - 几乎总是有一个托管等价物。如果您正在重构，您可能需要考虑做类似的事情。生成的代码应该更容易维护。

Answer 6

推荐的方法是每个程序集都有一个NativeMethods类，其中包含所有DllImported方法，并具有内部可见性。通过这种方式，您始终知道导入函数的位置，并避免重复声明。