C#与C++互操作

一、C#调用C++库

1、创建C++库

打开VisualStudio，创建一个C++工程，输入项目名称HelloWorldLib

确定，然后下一步。选择应用程序类型为DLL

单击完成，我们就创建好了一个C++库的项目。

这里为了方便，我们直接在HelloWorldLib.cpp里定义函数

C++库导出有两种方式

一、以C语言接口的方式导出

这种方法就是在函数前面加上 extern "C" __declspec(dllexport)

加上extern "C"后，会指示编译器这部分代码按C语言的进行编译，而不是C++的。

#include "stdafx.h"
#include<iostream>

extern "C" __declspec(dllexport) void HelloWorld(char* name);


extern "C" __declspec(dllexport) void HelloWorld(char* name)
{
    std::cout << "Hello World " << name << std::endl;
}

 

二、以模块定义文件的方式导出

在工程上右键，选择添加-》新建项

然后选择代码-》模块定义文件

在Source.def中输入

LIBRARY

EXPORTS
HelloWorld

EXPORTS下面就是要导出的函数，这里不需要添加分号隔开，直接换行就行。

此时，我们函数的定义如下

#include "stdafx.h"
#include<iostream>

void HelloWorld(char* name);


void HelloWorld(char* name)
{
    std::cout <<"Hello World "<< name << std::endl;
}

编译，生成dll。这里需要注意的是，如果生成是64位的库，C#程序也要是64位的，否则会报错。

2、使用C#调用

接下来我们新建一个C#控制台项目

打开前面C++库生成的目录，将HelloWorldLib.dll复制到C#工程的Debug目录下。也可以不复制，只需在引用dll的时候写上完整路径就行了。这里我是直接复制到Debug目录下

using System.Runtime.InteropServices;

namespace ConsoleApplication2
{
    class Program
    {
        [DllImport("HelloWorldLib.dll")]
        public static extern void HelloWorld(string name);

        //可以通过EntryPoint特性指定函数入口，然后为函数定义别名

        [DllImport("HelloWorldLib.dll", EntryPoint = "HelloWorld")]
        public static extern void CustomName(string name);
        static void Main(string[] args)
        {
            HelloWorld("LiLi");
            //跟上面是一样的
            CustomName("QiQi");
        }
    }
}

运行程序，结果如下：

这样就成功创建了一个C#可以调用的C++库

下面我们动态调用C++库，这里委托的作用就比较明显了。把委托比喻为C++的函数指针，一点也不为过。

我们在C++库中再新增一个函数GetYear(),用来获取当前年份。

int GetYear();

int GetYear()
{
    SYSTEMTIME tm;
    GetLocalTime(&tm);

    return tm.wYear;
}

记得在导出文件中(Source.def)增加GetYear。编译，生成新的DLL

再新建一个C#控制台程序

代码如下：

using System;
using System.Runtime.InteropServices;

namespace ConsoleApplication3
{

    class Program
    {
        [DllImport("kernel32.dll")]
        public static extern IntPtr LoadLibrary(string lpFileName);

        [DllImport("kernel32.dll")]
        public static extern IntPtr GetProcAddress(IntPtr hModule, string lpProcName);

        [DllImport("kernel32", EntryPoint = "FreeLibrary", SetLastError = true)]
        public static extern bool FreeLibrary(IntPtr hModule);

        //声明委托，这里的签名，需要跟C++库中的对应
        delegate int GetYearDelegate();

        static void Main(string[] args)
        {
            GetYearDelegate m_fGetYear;
            IntPtr hModule = LoadLibrary("HelloWorldLib.dll");
            if(hModule != IntPtr.Zero)
            {
                IntPtr hProc = GetProcAddress(hModule, "GetYear");
                if(hProc != IntPtr.Zero)
                {
                    m_fGetYear = (GetYearDelegate)Marshal.GetDelegateForFunctionPointer(hProc, typeof(GetYearDelegate));

                    //在这里可以调用
                    int year = m_fGetYear();
                    Console.WriteLine("年份是:" + year);
                }
            }
        }
    }
}

运行结果：

好的，前面函数里面涉及的都是简单数据类型，下面来介绍一下复杂数据类型。这里指的是结构体

在C++库中定义一个GetDate()的函数，代码如下。这里也要记得在导出文件中添加（Source.def）

struct MyDate
{
    int year;
    int month;
    int day;
};

MyDate GetDate();

MyDate GetDate()
{
    SYSTEMTIME tm;
    GetLocalTime(&tm);
    
    MyDate md;
    md.day = tm.wDay;
    md.month = tm.wMonth;
    md.year = tm.wYear;
    return md;
}

 新建一个C#控制台程序，完整代码如下

using System;
using System.Runtime.InteropServices;

namespace ConsoleApplication3
{  
    struct MyDate
    {
        public int Year;
        public int Month;
        public int Day;
    }


    class Program
    {
        [DllImport("kernel32.dll")]
        public static extern IntPtr LoadLibrary(string lpFileName);

        [DllImport("kernel32.dll")]
        public static extern IntPtr GetProcAddress(IntPtr hModule, string lpProcName);

        [DllImport("kernel32", EntryPoint = "FreeLibrary", SetLastError = true)]
        public static extern bool FreeLibrary(IntPtr hModule);

        delegate IntPtr GetDateDelegate();

        static void Main(string[] args)
        {
            GetDateDelegate m_fGetDate;
            IntPtr hModule = LoadLibrary("HelloWorldLib.dll");

            if (hModule != IntPtr.Zero)
            {
                IntPtr hProc = GetProcAddress(hModule, "GetDate");
                if (hProc != IntPtr.Zero)
                {
                    m_fGetDate = (GetDateDelegate)Marshal.GetDelegateForFunctionPointer(hProc, typeof(GetDateDelegate));
                    IntPtr ptr = m_fGetDate();
                    if(ptr != IntPtr.Zero)
                    {
                        MyDate md = (MyDate)Marshal.PtrToStructure(ptr, typeof(MyDate));
                        Console.WriteLine("{0}年-{1}月-{2}日",md.Year,md.Month,md.Day);
                    }
                }
            }
        }
    }
}

运行结果如下：

C#与C++互操作，很重要的一个地方就是，要注意数据类型的对应。有时还需要加上一些限制，

关于C#与C++数据类型对应

可以参考以下链接：

https://www.cnblogs.com/zjoch/p/5999335.html

大部分硬件厂商提供的SDK都是需要C++来调用的，有了上面的知识，使用C#来调用一些硬件的SDK就比较容易了。只需要使用C++再进行一次封装就行了。

二、C++调用C#库

这里用到是C++/CLI,就是如何用C++在·NET中编程。就是因为有这个东西的存在，C++才能调用C#的库

下面新建一个C#类库CSharpLib

 

这里我们使用C#封装一个读取XML节点的函数(仅供演示)

先创建一个XML文件，并保存为Student.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<Student>
    <Name>自由在高处</Name>
    <Age>17</Age>
    <Size>40</Size>
</Student>

 

在CSharpLib工程中创建一个XmlQuery类（包含XPathQuery和GetFirstStudent两个成员函数）和一个Student结构体，代码如下：

public class XmlQuery
    {
        private string fileName;
        private XDocument doc;

        public XmlQuery(string fileName)
        {
            this.fileName = fileName;
            doc = XDocument.Load(fileName);
        }

        public XmlQuery()
        {

        }

        public string XPathQuery(string xPath)
        {
            if (doc == null)
                return "";

            var result = doc.XPathSelectElement(xPath);

            if (result == null)
                return "";

            return result.Value;
        }

        public Student GetFirstStudent()
        {
            if (doc == null)
                return new Student();

            var root = doc.Root;

            Student student = new Student();
            student.Name = root.Element("Name").Value;
            student.Age = Convert.ToInt32( root.Element("Age").Value);
            student.Size = Convert.ToInt32(root.Element("Size").Value);

            return student;
        }
    }

    public struct Student
    {
        /// <summary>
        /// 需要限定长度，否则会转换失败
        /// </summary>
        [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 256)]
        public string Name;

        /// <summary>
        /// 基本数据类型注意封送时对应的类型即可
        /// </summary>
        public int Age;

        public int Size;
    }

 

然后我们创建一个C++控制台程序UseCSharpLib

 

创建完成后，将前面编译的CSharpLib.dll和Student.xml拷贝到编译目录下和代码目录下

 

 

然后到属性页里开启公共语言运行时支持

 

使用#using引用前面编译并复制到代码目录下的C#库。这里的相对路径是相对代码工程文件所在的位置

#using "CSharpLib.dll"

 

包含必要的头文件及引入命名空间

#include<msclr\marshal_cppstd.h>

using namespace System;
using namespace msclr::interop;
using namespace std;
using namespace CSharpLib;

 

使用gcnew实例化对象，并调用XmlQuery类的成员函数XPathQuery：

XmlQuery^ query = gcnew XmlQuery("Student.xml");
System::String ^str = query->XPathQuery("Student/Name");

 

XPathQuery函数返回类型是System.String类型，可以直接使用.Net中String类提供的功能，也可以转换成char*来进行下一步的操作

//直接使用System.String类中的属性和函数
System::Console::WriteLine(str);
System::Console::WriteLine(str->Length);
    
//将System.String转换成char*
System::IntPtr ptr = System::Runtime::InteropServices::Marshal::StringToHGlobalAnsi(str);
char* chData = (char *)(void *)ptr;
    
cout << chData << endl;
cout << strlen(chData) << endl;

//释放内存
System::Runtime::InteropServices::Marshal::FreeHGlobal(ptr);

 

运行结果如下：

 

GetFirstStudent函数返回了一个Student结构体，下面的代码演示了调用该函数后，将返回值转换为C++中的结构体。

首先在C++中定义一个结构体：

struct StudentCPP
{
    char Name[256]; //大小要跟C#中的保持一致
    int Age;
    int Size;
};

 

调用GetFirstStudent

CSharpLib::Student stu = query->GetFirstStudent();

//可以直接操作stu
int age = stu.Age;
System::String^ name = stu.Name;
int size = stu.Size;

//也可以转换为C++中的结构体
System::IntPtr stuPtr = System::Runtime::InteropServices::Marshal::AllocHGlobal(System::Runtime::InteropServices::Marshal::SizeOf(stu));
System::Runtime::InteropServices::Marshal::StructureToPtr(stu, stuPtr,true);
StudentCPP* student = (StudentCPP*)(void*)stuPtr;

cout << "Name: " << student->Name << endl
    << "Age: " << student->Age << endl
    << "Size: " << student->Size << endl;

//释放内存
System::Runtime::InteropServices::Marshal::FreeHGlobal(stuPtr);

 

运行如果如下：

 

说明：

1、需要注意C#和C++在进行互操作时的数据类型对应 。可以参考以下链接

https://www.cnblogs.com/zhaotianff/p/12896297.html

 

2、C#中的类和结构体可以转换成C++中的结构体，但要注意一些原则，可以参考以下链接

https://www.cnblogs.com/zhaotianff/p/12510286.html

https://www.cnblogs.com/zhaotianff/p/13300438.html

 

3、暂时只想到这两点

 

最后再附上示例代码，玩得愉快。

时隔两年才更新在C++中调用C#库，我也是醉了啊