C#与C++ DLL的交互

时间  2019-11-09
标签 c# c++ dll 交互 栏目 C# 繁體版
原文   原文链接

C#与C++交互，整体来讲能够有两种方法：

1.利用C++/CLI做为代理中间层ios

2.利用PInvoke实现直接调用编程

 

  第一种方法：实现起来比较简单直观，而且能够实现C#调用C++所写的类，可是问题是MONO架构不支持C++/CIL功能，所以没法实现脱离Microsoft.NET Framework跨平台运行。数组

  第二种方法：简单的实现并不麻烦，只要添加DllImportAttribute特性便可导入C++的函数，可是问题是PInvoke不能简单的实现C++类的调用。在Warensoft3D中为了可使用MONO实现跨平台（固然DirectX是不能跨平台的），因此使用了本方法，下面将对本方法展开详细的说明。安全

 

注意事项:

  PInvoke从功能上来讲，只支持函数调用，在被导出的函数前面必定要添加rxtern “C来指明导出函数的时候使用C语言方式编译和连接的，这样保证函数定义的名字相同，不然若是默认按C++方式导出，那个函数名字就会变得乱七八糟，咱们的程序就没法找到入口点了。架构

 

本文将说明一下几点：

  1. 互调的基本原理。
  2. 基本数据类型的传递
  3. 函数指针的传递
  4. 结构体的传递

 

1.互调的基本原理

  首先，咱们-来看一个在常规不过的概念“数据类型”。在大多数的静态语言中定义变量的时候都要先指定其数据的类型，所谓数据类型，都是人们增强的一个便于记忆的名称，究其本质就是指明了这个数据在内存中到底占用了几个字节，程序在运行时，首先找到这个数据的地址，而后在按着该类型的长度，读取相应的内存，而后再作处理。了解了前面，全部编程语言之间进行互调就有眉目了，对于不一样的语言之间的互调，只要将该数据的指针（内存地址）传递给另外一个语言，在另外一个语言中根据通讯协议将指针所指向的数据存入长度对应的数据类型便可，固然要知足如下几点。编程语言

1.对于像Java，.NET这样有运行时虚拟机编程语言来说，因为虚拟机会让堆内存来回转移，所以，在进行互调的时候要保证正在被互调的数据所在的内存必定要固定，不能被转移。函数

2.有一些编程语言支持指针，有一些编程语言不支持指针（如Java），这个问题并不重要，所谓指针，其实就是一个内存地址，对于32位os的指针是一个32位整数，而对于64位机os的指针是一个64位整数。由于大多数语言中都有整形数，因此能够利用整形来接收指针。spa

 

2.基本数据类型的传递

  互调过程当中，最基本要传递的无非是数值和字符，即：int,long,float,char等等，可是此类型非彼类型，C/C++与C#中有一些数据类型长度是不同的，下表中列出常见数据类型的异同：线程

 

C/C++ 3d

C# 

长度

short 

short 

2Bytes

int

int 

4Bytes 

long(该类型在传递的时候经常会弄混)

int 

4Bytes 

bool 

bool 

1Byte 

char(Ascii码字符)

byte 

1Byte 

wchar_t（Unicode字符，该类型与C#中的Char兼容）

char 

2Bytes 

float

float

4Bytes

double 

double 

8Bytes 

  最容易弄混的是就是long,char两个类型，在C/C++中long和int都是4个字节，都对应着C#中的int类型，而C/C++中的char类型占一个字节，用来表示一个ASCII码字符，在C#中可以表示一个字节的是byte类型。与C#中char类型对应的应该是C/C++中的wchar_t类型，对应的是一个2字节的Unicode字符。

  下面经过实例来讲明调用过程：

  因为项目的名称是"TestCPPDLL"，所以，会自动生成TestCPPDLL.h和TestCPPDLL.cpp两个文件，.h文件是要导出内容的声明文件，为了能清楚的说明问题，咱们将TestCPPDLL.h和TestCPPDLL.cpp两个文件中的全部内容都删除，而后在TestCPPDLL.h中添加以下内容：

  第一行代码中定义了一个名为"TESTCPPDLL_API"的宏，该宏对应的内容是"__declspec(dllexport)"意思是将后面修饰的内容定义为DLL中要导出的内容。固然你也能够不使用这个宏，能够直接将"__declspec(dllexport)"写在要导出的函数前面。

  第二行中的"EXTERN_C"，是在"winnt.h"中定义的宏，在函数前面添加"EXTERN_C"等同于在函数前面添加extern "C",意思是该函数在编译和链接时使用C语言的方式，以保证函数名字不变。第二行的代码是一个函数的声明，说明该函数能够被模块外部调用，其定义实如今TestCPPDLL.cpp中，TestCPPDLL.cpp的代码以下所示：

第三步：

  在编译C++DLL以前，须要作如下配置，在项目属性对话框中选择"C/C++"|"Advanced"，将Compile AS 选项的值改成"C++"。而后肯定，并编译。

生成的DLL文件以下图所示：

第四步：

首先，添加一个C#的应用程序，若是要在C#中调用C++的DLL文件，先要在C#的类中添加一个静态方法，而且使用DllImportAttribute对该方法进行修饰，代码以下所示：

DllImport中的第一个参数是指明DLL文件的位置，第二个参数"EntryPoint"用来指明对应的C/C++中的函数名称是什么。"extern"关键字代表该处声明的这个Add方法是一个外部调用。

该方法声明完毕以后，就能够像调用一个普通的静态方法同样去使用了。

下面是示例程序：

class Program
{ 
    [DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "Add")] 
    extern static int Add(int a, int b); 
    static void Main(string[] args) 
    { 
        int c = Add(1,2); 
        Console.WriteLine(c); 
        Console.Read(); 
    } 
}

在运行C#程序以前，先要修改C#的项目属性，以下图所示：

将platform target设置为x86,而且容许非安全代码（后面有用）。

而后运行该C#程序，其结果以下图所示：

第五步：

前面的Add方法中传递的是数值类型（int），其余的数据类型，如float,double,和bool类型的传递方式是同样的，下面演示如何传递字符串。

在TestCPPDLL.h中添加一个新的函数声明，代码以下：

EXTERN_C TESTCPPDLL_API void __stdcall WriteString(wchar_t*content);

这里的参数是wchar_t类型的指针，对应着C#中的char类型。TestCPPDLL.cpp中添加以下代码：

TESTCPPDLL_API void __stdcall WriteString(wchar_t*content) 
{ 
    cout<<content; 
}

该代码的功能就是将输入的字符串经过C++在控制台上输出。下面是在C#中的声明:

[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "WriteString")] 
extern unsafe static void WriteString(char*c);

调用过程以下所示：

//由于使用指针，由于要声明非安全域
unsafe
{
    //在传递字符串时，将字符所在的内存固化，
    //并取出字符数组的指针
    fixed (char* p = &("hello".ToCharArray()[0]))
    {
//调用方法
        WriteString(p);
    }
}

其运行效果以下图所示：

3. 指针的传递

根据前面介绍的数据类型对照表，咱们能够直接在方法中传递指针，可是要注意的是咱们经常须要将数组的指针（数据入口地址，第一个元素的地址），数据从C/C++到C#时问题不大，可是若是从C#到C/C++时必定要将数组先固化，而后再传递处理。

下面演示如何传递指针，首先在TestCPPDLL.h中添加下列声明：

//传入一个整型指针，将其所指向的内容加1
EXTERN_C TESTCPPDLL_API void __stdcall AddInt(int *i); 
//传入一个整型数组的指针以及数组长度，遍历每个元素而且输出
EXTERN_C TESTCPPDLL_API void __stdcall AddIntArray(int *firstElement,int arraylength); 
//在C++中生成一个整型数组，而且数组指针返回给C#
EXTERN_C TESTCPPDLL_API int* __stdcall GetArrayFromCPP(); 
其实现写在TestCPPDLL.cpp中，代码以下所示：
TESTCPPDLL_API void __stdcall AddInt(int *i) 
{ 
    (*i)++; 
} 
TESTCPPDLL_API void __stdcall AddIntArray(int *firstElement,int arrayLength) 
{ 
    int*currentPointer=firstElement; 
    for (int i = 0; i < arrayLength; i++) 
    { 
        cout<<*currentPointer; 
        currentPointer++; 
    } 
    cout<<endl; 
} 
 
int *arrPtr; 
TESTCPPDLL_API int* __stdcall GetArrayFromCPP() 
{ 
    arrPtr=new int[10]; 
     
    for (int i = 0; i < 10; i++) 
    { 
        arrPtr[i]=i; 
    } 
     
    return arrPtr; 
}

对应调用的C#代码以下所示：

[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "AddInt")] 
extern unsafe static void AddInt(int* i); 
[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "AddIntArray")] 
extern unsafe static void AddIntArray(int* firstElement, int arraylength); 
[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "GetArrayFromCPP")] 
extern unsafe static int* GetArrayFromCPP();

调用过程以下所示：

unsafe
{ 
    // 调用C++中的AddInt方法
    int i = 10; 
 
    AddInt(&i); 
    Console.WriteLine(i); 
 
    //调用C++中的AddIntArray方法将C#中的数据传递到C++中，并在C++中输出
    int[] CSArray = new int[10]; 
    for (int iArr = 0; iArr < 10; iArr++) 
    { 
        CSArray[iArr] = iArr; 
    } 
    fixed (int* pCSArray = &CSArray[0]) 
    { 
        AddIntArray(pCSArray, 10); 
    } 
    //调用C++中的GetArrayFromCPP方法获取一个C++中创建的数组
    int* pArrayPointer = null; 
    pArrayPointer = GetArrayFromCPP(); 
    for (int iArr = 0; iArr < 10; iArr++) 
    { 
        Console.WriteLine(*pArrayPointer); 
        pArrayPointer++; 
    } 
}

4. 函数指针的传递

前面说明的都是简单数据类型的及其指针的传递，利用PInvoke咱们也能够实现函数指针的传递，C#中并无函数指针的概念，可是可使用委托（delegate）来代替函数指针，关于C#中委托的说明，能够参考笔者前面的一个文章：《C#委托及事件》

你们可能会问，为何要传递函数指针呢？利用PInvoke能够实现C#对C/C++函数的调用，反过来，咱们能不能在C/C++程序运行的某一时刻，来调用一个C#对应的函数呢？（例如在C++中存在一个独立线程，该线程可能在任意时刻触发一个事件，而且须要通知C#）。这个时候，咱们就有必要将一个C#中已经指向某一个函数的函数指针（委托）传递给C++。

想要传递函数指针，首先要在C#中定义一个委托，而且在C++中定义一个函数指针，同时要保证委托和函数指针具有相同的函数原型，咱们首先编写C#的代码，以下所示：

//定义一个委托，返回值为空，存在一个整型参数
public delegate void CSCallback(int tick); 
//定义一个用于回调的方法，与前面定义的委托的原型同样
//该方法会被C++所调用
static void CSCallbackFunction(int tick) 
{ 
    Console.WriteLine(tick.ToString ()); 
} 
//定义一个委托类型的实例，
//在主程序中该委托实例将指向前面定义的CSCallbackFunction方法
static CSCallback callback; 
 
在CS的主程序中让callback指向CSCallbackFunction方法，代码以下所示：
//调用委托所指向的方法
callback = CSCallbackFunction; 
 
 
而后在C/C++中定义一个函数指针，而且添加一个用于设置函数指针的函数，TestCPPDLL.h中的代码以下所示：
//定义一个函数指针
typedef void (__stdcall *CPPCallback)(int tick); 
//定义一个用于设置函数指针的方法,
//并在该函数中调用C#中传递过来的委托
EXTERN_C TESTCPPDLL_API void SetCallback(CPPCallback callback); 
SetCallback函数的实如今TestCPPDLL.cpp中，代码以下所示：
TESTCPPDLL_API void SetCallback(CPPCallback callback) 
{ 
    int tick=rand(); 
    //下面的代码是对C#中委托进行调用
    callback(tick); 
} 
在C#中添加SetCallback函数的声明，代码以下所示：
//这里使用CSCallback委托类型来兼容C++里的CPPCallback函数指针
[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "SetCallback")] 
extern static void SetCallback(CSCallback callback);

在C#中的调用过程以下所示：

//让委托指向将被回调的方法
callback = CSCallbackFunction; 
//将委托传递给C++
SetCallback(callback);

SetCallback方法被执行后，在C#中定义的CSCallbackFunction就会被C++所调用。

5. 结构体的传递

 

传递结构体的想法和传递一个int类型数据相似，struct中的数据是在内存中顺序排列的，只要保证保证如下几点，就能够直接传递结构体，甚至是结构体的指针：

  • 要传递的成员为公有的值类型字段
  • C#中结构体字段类型与C++结构体中的字段类型相兼容
  • C#结构中的字段顺序与C++结构体中的字段顺序相同，要保证该功能，须要将C#结构体标记为[StructLayout( LayoutKind.Sequential)] 

下面经过代码进行说明，首先在C#中添加一个结构体，代码以下所示：

[StructLayout( LayoutKind.Sequential)] 
struct Vector3
{ 
    public float X, Y, Z; 
}

该结构体表示一个3D向量，包括X，Y，Z三个float类型的份量。

而后在TestCPPDLL.h中也定义一个相同结构的结构体，代码以下所示：

struct Vector3
{ 
    float X,Y,Z; 
};

在TestCPPDLL.h中声明一个用于传递Vector3结构体的一个函数，代码以下所示：

EXTERN_C TESTCPPDLL_API void __stdcall SendStructFromCSToCPP(Vector3 vector);

在TestCPPDLL.cpp中将其实现，代码以下所示：

TESTCPPDLL_API void __stdcall SendStructFromCSToCPP(Vector3 vector) 
{ 
    cout<<"got vector3 in cpp,x:"; 
    cout<<vector.X; 
    cout<<",Y:"; 
    cout<<vector.Y; 
    cout<<",Z:"; 
    cout<<vector.Z; 
}

在C#中添加对SendStructFromCSToCPP函数的声明，代码以下所示：

[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "SendStructFromCSToCPP")] 
extern static void SendStructFromCSToCPP(Vector3 vector);

C#中的调用过程以下所示：

//创建一个Vector3的实例
Vector3 vector = new Vector3() { X =10,Y=20,Z=30 }; 
//将vector传递给C++并在C++中输出
SendStructFromCSToCPP(vector);

基输出效果以下所示：

 

完整的TestCPPDLL.h代码以下所示： 

#define TESTCPPDLL_API __declspec(dllexport)

EXTERN_C TESTCPPDLL_API int __stdcall Add(int a,int b);

EXTERN_C TESTCPPDLL_API void __stdcall WriteString(wchar_t*content);

//传入一个整型指针，将其所指向的内容加1

EXTERN_C TESTCPPDLL_API void __stdcall AddInt(int *i);

//传入一个整型数组的指针以及数组长度，遍历每个元素而且输出

EXTERN_C TESTCPPDLL_API void __stdcall AddIntArray(int *firstElement,int arraylength);

//在C++中生成一个整型数组，而且数组指针返回给C#

EXTERN_C TESTCPPDLL_API int* __stdcall GetArrayFromCPP();

 

//定义一个函数指针

typedef void (__stdcall *CPPCallback)(int tick);

//定义一个用于设置函数指针的方法,

//并在该函数中调用C#中传递过来的委托

EXTERN_C TESTCPPDLL_API void __stdcall SetCallback(CPPCallback callback);

 

struct Vector3

{

    float X,Y,Z;

};

EXTERN_C TESTCPPDLL_API void __stdcall SendStructFromCSToCPP(Vector3 vector);

 

完整的TestCPPDLL.CPP代码以下所示： 

#include "stdafx.h"

#include <iostream>

#include "TestCPPDLL.h"

using namespace std;

TESTCPPDLL_API int __stdcall Add(int a,int b)

{

    return a+b;

}

TESTCPPDLL_API void __stdcall WriteString(wchar_t*content)

{

    wprintf(content);

    printf("\n");

}

 

TESTCPPDLL_API void __stdcall AddInt(int *i)

{

    (*i)++;

}

 

TESTCPPDLL_API void __stdcall AddIntArray(int *firstElement,int arrayLength)

{

    int*currentPointer=firstElement;

    for (int i = 0; i < arrayLength; i++)

    {

        cout<<*currentPointer;

        currentPointer++;

    }

    cout<<endl;

}

int *arrPtr;

TESTCPPDLL_API int* __stdcall GetArrayFromCPP()

{

    arrPtr=new int[10];

    

    for (int i = 0; i < 10; i++)

    {

        arrPtr[i]=i;

    }

    

    return arrPtr;

}

 

TESTCPPDLL_API void __stdcall SetCallback(CPPCallback callback)

{

    int tick=100;

    //下面的代码是对C#中委托进行调用

    callback(tick);

}

 

TESTCPPDLL_API void __stdcall SendStructFromCSToCPP(Vector3 vector)

{

    cout<<"got vector3 in cpp,x:";

    cout<<vector.X;

    cout<<",Y:";

    cout<<vector.Y;

    cout<<",Z:";

    cout<<vector.Z;

}

 

完整的C#代码以下所示：

 

using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using System.Text;

 
namespace ConsoleApplication1
{
    class Program
{

[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "Add")]
extern static int Add(int a, int b);
[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "WriteString")]
extern unsafe static void WriteString(char* c);
[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "AddInt")]
extern unsafe static void AddInt(int* i);
[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "AddIntArray")]
extern unsafe static void AddIntArray(int* firstElement, int arraylength);
[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "GetArrayFromCPP")]
extern unsafe static int* GetArrayFromCPP();

 

//定义一个委托，返回值为空，存在一个整型参数
public delegate void CSCallback(int tick);
//定义一个用于回调的方法，与前面定义的委托的原型同样
//该方法会被C++所调用
static void CSCallbackFunction(int tick)
{
    Console.WriteLine(tick.ToString());
}
//定义一个委托类型的实例，
//在主程序中该委托实例将指向前面定义的CSCallbackFunction方法
static CSCallback callback;
//这里使用CSCallback委托类型来兼容C++里的CPPCallback函数指针
[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "SetCallback")]
extern static void SetCallback(CSCallback callback);
[StructLayout(LayoutKind.Sequential)]
struct Vector3
{
    public float X, Y, Z;
}
[DllImport(@"E:\ex\TestCPPDLL\Debug\TestCPPDLL.dll", EntryPoint = "SendStructFromCSToCPP")]
extern static void SendStructFromCSToCPP(Vector3 vector);
static void Main(string[] args)
{
    int c = Add(1, 2);
    Console.WriteLine(c);
    //由于使用指针，由于要声明非安全域
    unsafe
　　{
    //在传递字符串时，将字符所在的内存固化，
    //并取出字符数组的指针
    　　fixed (char* p = &("hello".ToCharArray()[0]))
    　　{
         //调用方法
       　　WriteString(p);
    　　}
　　}
　　　unsafe
　　{
    // 调用C++中的AddInt方法
    　　int i = 10;
    　　AddInt(&i);
    　　Console.WriteLine(i);
    　　//调用C++中的AddIntArray方法将C#中的数据传递到C++中，并在C++中输出
   　　 int[] CSArray = new int[10];
  　　  for (int iArr = 0; iArr < 10; iArr++)
    　 {
         CSArray[iArr] = iArr;
   　  } 
      fixed (int* pCSArray = &CSArray[0])
      {
    　　　AddIntArray(pCSArray, 10);
      }
      //调用C++中的GetArrayFromCPP方法获取一个C++中创建的数组
   　　int* pArrayPointer = null;
    　 pArrayPointer = GetArrayFromCPP();
    　for (int iArr = 0; iArr < 10; iArr++)
      {
         Console.WriteLine(*pArrayPointer);
          pArrayPointer++;
     }
}
//让委托指向将被回调的方法
callback = CSCallbackFunction;
//将委托传递给C++
SetCallback(callback);
//创建一个Vector3的实例
Vector3 vector = new Vector3() { X = 10, Y = 20, Z = 30 };
//将vector传递给C++并在C++中输出
SendStructFromCSToCPP(vector);
Console.Read();
}
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程