c#调用c++编写的dll踩坑笔记

和小伙伴合作c#项目，遇到了一些性能上的问题，打算把密集运算的部分用c++写成dll再给c#调用，突破性能瓶颈，也省下用unsafe块的功夫了。此文是由我编写的一个入门示例，权当抛砖引玉。

一.创建DLL

• 1.创建VS的c++空项目，项目叫mydll
• 2.创建cpp加入以下代码

#define DECL_DLLEXPORT __declspec(dllexport)
extern "C" DECL_DLLEXPORT float add(float a, float b);

float add(float a, float b) {
	return a + b;
}

• 3.打开项目属性，平台设置成Win32，配置类型设成动态库(.dll)
• 4.生成解决方案

1>------ 已启动全部重新生成: 项目: mydll, 配置: Debug Win32 ------
1>源.cpp
1>  正在创建库 C:\Users\xw\source\repos\mydll\Debug\mydll.lib 和对象 C:\Users\xw\source\repos\mydll\Debug\mydll.exp
1>mydll.vcxproj -> C:\Users\xw\source\repos\mydll\Debug\mydll.dll
========== 全部重新生成: 成功 1 个，失败 0 个，跳过 0 个 ==========

至此得到mydll.dll文件。

二.创建c#程序

• 1.创建VS的c#控制台应用(.NET Framework)，项目叫mydll_csharp
• 2.在Program加入一些代码，让它变成这样

using System;
using System.Runtime.InteropServices;

namespace mydll_csharp
{
    class Program
    {
    	//这里是引入dll
    	//记得把mydll.dll放在执行文件相同目录下,而不是项目文件夹下
        [DllImport("mydll.dll", CallingConvention = CallingConvention.Cdecl)]
        //函数需要声明
        static extern float add(float a, float b);

        static void Main(string[] args)
        {
        	//调用add方法,计算 4 + 0.27
            float answer = add(4f, 0.27f);
            Console.WriteLine("答案是" + answer);
            return;
        }
    }
}

• 3.把mydll.dll复制到mydll_csharp/bin/Debug目录下
• 4.启动程序，得到正确答案

其实到这里就完结撒花了，但是小伙伴报了一些错，于是决定一并记下。

三.踩坑总结

• 1.目标签名不匹配

托管调试助手 “PInvokeStackImbalance”
对 PInvoke 函数“mydll_csharp!mydll_csharp.Program::add”的调用导致堆栈不对称。原因可能是托管的 PInvoke 签名与非托管的目标签名不匹配。请检查 PInvoke 签名的调用约定和参数与非托管的目标签名是否匹配。

通常是没有加上CallingConvention = CallingConvention.Cdecl
报错的DLLImport是这样[DllImport("mydll.dll")]
本例子中完整的DllImport是这样[DllImport("mydll.dll", CallingConvention = CallingConvention.Cdecl)]
这个例子中，我们编写的dll里协议是Cdecl，我们要告诉c#它应该遵循什么协议去调用dll，就用这个参数。后面的参数具体是做什么的，可以参考官方文档。

• 2.必须定义入口点

错误 LNK1561 必须定义入口点 mydll C:\Users\xw\source\repos\mydll\LINK 1

VS里先改了配置类型，然后又切平台，导致Win32平台下面的配置类型还是exe，就会报这个错误。

• 3.BadImageFormatException 试图加载格式不正确的程序

Unhandled exception. System.BadImageFormatException: 试图加载格式不正确的程序。 (0x8007000B)
at mydll_csharp.Program.add(Single a, Single b)
at mydll_csharp.Program.Main(String[] args) in C:\Users\xw\source\repos\mydll_csharp\Program.cs:line 12
C:\Users\xw\source\repos\mydll_csharp\bin\Debug\mydll_csharp.exe (进程 18964)已退出，代码为 -532462766。
按任意键关闭此窗口. . .

dll与c#程序的平台不一致，检查一下dll的平台或者c#的平台。
c#平台可以在项目属性->生成->平台目标 选择x86，或者勾选"首选32位"。

• 4.DllNotFoundException: 无法加载 DLL 找不到指定的模块

未经处理的异常: System.DllNotFoundException: 无法加载 DLL“mydll.dll”: 找不到指定的模块。 (异常来自 HRESULT:0x8007007E)。
在 mydll_csharp.Program.add(Single a, Single b)
在 mydll_csharp.Program.Main(String[] args) C:\Users\xw\source\repos\mydll_csharp\Program.cs:位置 行号: 17

有的人在下载附件时，直接运行c#程序会报这个错误。把c++项目重新编译一遍，使用新生成的dll就解决了。
我自己电脑编译时，发布版本是debug版。使用dumpbin /dependents mydll.dll命令查看mydll.dll的依赖文件，发现引入了VCRUNTIME140D.dll,ucrtbased.dll,KERNEL32.dll这三个dll，最后的字母d表示这些是调试所需的库，有的电脑缺少其中某个dll，于是就会报错。
因此，还有一种解决方法是发布Release版本。对Release版dumpbin一下，引入的是VCRUNTIME140.dll,api-ms-win-crt-runtime-l1-1-0.dll,KERNEL32.dll这三个，最后字母不是d，这样对比就很明显了。