【CPP 基础】如何把cpp库，分装给 c# 用。

news2024/9/22 21:22:30

基本方法

在C++中封装的方法（如在DLL中），如果输入参数是一个自定义类型，并且你想在C#中调用它，你需要做一些工作来确保数据结构在两种语言之间正确传递和解释。下面是详细的步骤。

1. 场景描述

假设我们有一个C++函数，它接收一个自定义类型（结构体）作为参数，我们想在C#中调用这个函数。

1. 创建C++库（DLL）

首先，我们创建一个C++ DLL项目，并定义一个自定义类型（结构体）以及一个使用该类型的方法。

示例：C++ 代码

头文件：

// MyLibrary.h
#pragma once

#ifdef MYLIBRARY_EXPORTS
#define MYLIBRARY_API __declspec(dllexport)
#else
#define MYLIBRARY_API __declspec(dllimport)
#endif

// 定义一个自定义类型
struct MyStruct
{
    int a;
    float b;
};

// 一个接收自定义类型的函数
extern "C" MYLIBRARY_API void ProcessStruct(MyStruct data);

// MyLibrary.cpp
#include "MyLibrary.h"
#include <iostream>

// 函数的实现
void ProcessStruct(MyStruct data)
{
    std::cout << "Processing Struct: " << data.a << ", " << data.b << std::endl;
}

MyStruct 是一个自定义类型的结构体。
ProcessStruct 是一个接受 MyStruct 类型参数的函数。
1. 在C#中定义相同的数据结构

为了在C#中调用这个C++函数，需要使用[StructLayout]属性来定义一个与C++结构体相同的结构体。

示例：C# 代码

Csharp：

using System;
using System.Runtime.InteropServices;

class Program
{
    // 定义与C++相匹配的结构体
    [StructLayout(LayoutKind.Sequential)]
    public struct MyStruct
    {
        public int a;
        public float b;
    }

    // 使用DllImport来导入C++库的函数
    [DllImport("MyLibrary.dll", CallingConvention = CallingConvention.Cdecl)]
    public static extern void ProcessStruct(MyStruct data);

    static void Main()
    {
        // 创建一个结构体实例
        MyStruct myStruct;
        myStruct.a = 10;
        myStruct.b = 3.14f;

        // 调用C++中的函数
        ProcessStruct(myStruct);
    }
}

关键点解释

1、 匹配的数据结构:

使用[StructLayout(LayoutKind.Sequential)]来确保C#结构体的内存布局与C++结构体的布局匹配。LayoutKind.Sequential确保字段按声明顺序排列。

2、数据类型一致性:

确保C#结构体中的数据类型与C++结构体中的数据类型匹配。例如，int 对应int，float 对应float等。

3、导入非托管代码:

使用[DllImport]特性导入C++库中的方法。指定CallingConvention为Cdecl，因为C++默认使用__cdecl调用约定。

4、调用方法:

在C#中创建MyStruct实例并为其字段赋值，然后将它传递给导入的C++方法ProcessStruct。

编译和运行

C++项目: 构建C++ DLL项目。生成的MyLibrary.dll文件需要复制到C#项目的输出目录（例如bin/Debug/net6.0/）。
C#项目: 构建并运行C#项目，你应该能够看到C++库中的ProcessStruct函数的输出结果。

测试代码链接

构建库

要求cpp 写成 c类型的接口，
1. ldd 看库文件，c类型的，名字稳定。反射能，稳定读取，库中函数名。

为什么要用C类型的接口，

在C#中调用C++库时，需要将C++库封装成C风格的API接口，主要是因为以下原因：

1. 互操作性（Interoperability）限制

C#（.NET）无法直接调用C++的类和成员函数，因为两者的底层调用约定和内存管理方式不同。

C++使用的类和对象模型：C++支持复杂的面向对象编程模型，包括继承、多态、虚函数等，这些特性在C#中没有直接的等效实现。
C++的ABI（Application Binary Interface）不稳定：不同的编译器（如MSVC、GCC、Clang等）生成的C++对象布局和调用约定可能不同，导致二进制不兼容。这会给直接调用C++类带来极大的困难。

相反，C风格的API使用简单的函数调用，并且使用固定的调用约定（如stdcall或cdecl），这使得跨语言调用变得更加可靠和稳定。