探索 FFI - Rust 与 C# 互调实战

所谓幸福，就是把灵魂安放在适当的位置。

一、Rust + C# = ？

1、C# 的优势

1. 丰富的生态系统：C# 是由微软开发和维护的，拥有强大的 .NET 框架支持，提供了大量的库和工具，可以极大地提高开发效率。Visual Studio 是一个功能强大的集成开发环境（IDE），为 C# 开发提供了卓越的支持。
2. 跨平台能力：随着 .NET Core 的推出，C# 现在可以在 Windows、Linux 和 macOS上运行，实现了真正的跨平台开发。
3. 面向对象编程：C# 是一种纯粹的面向对象编程语言，支持类、继承、多态等特性，使得代码结构清晰，易于维护和扩展。
4. 企业级应用开发：C# 广泛应用于企业级应用开发，特别是在 Web 应用、桌面应用和云服务方面，如 ASP.NET 用于构建高性能的 Web 应用和 API。
5. 社区和支持：拥有庞大的开发者社区和丰富的在线资源，包括文档、教程和论坛，帮助开发者快速解决问题。

2、Rust 的优势

1. 内存安全：Rust最显著的特点是其内存安全性，通过所有权系统和借用检查器，在编译时防止数据竞争、空指针引用和缓冲区溢出等常见的内存错误。
2. 高性能：Rust 的性能接近 C 和 C++，因为它是编译型语言，并且没有运行时开销，非常适合系统编程和性能关键的应用。
3. 并发编程：Rust 提供了强大的并发编程模型，通过所有权和类型系统来确保线程安全，避免了传统多线程编程中的许多陷阱。
4. 现代化设计：Rust 结合了现代编程语言的许多优点，如模式匹配、闭包、泛型和函数式编程风格，使得代码更加简洁和可读。
5. 活跃的社区和工具链：Rust 社区非常活跃，官方提供了优秀的包管理工具 Cargo，以及丰富的第三方库和工具，帮助开发者更高效地进行开发。

3、Rust + C# 的应用思路

C# 和 Rust 各有其独特的优势，适用于不同的应用场景：

• C# 更适合需要快速开发、良好 IDE 支持和丰富库的企业级应用，尤其是在 Web 和桌面应用领域。
• Rust 则更适合需要高性能、内存安全和并发编程的系统级编程，如操作系统、嵌入式系统和高性能计算。

结合 Rust 和 C# 的优势，可以创建具有高性能、安全性和易用性的混合应用程序。

3.1、C# 主要负责

• 用户界面（UI）：使用 WPF、WinForms 或 UWP 等技术构建桌面应用程序的图形用户界面。使用 ASP.NET Core 或 Blazor 构建 Web 应用程序的前端和后端。
• 业务逻辑：实现企业级应用的业务逻辑，包括数据处理、验证、工作流等。编写与数据库交互的代码，使用 Entity Framework 等 ORM 工具进行数据持久化。
• Web 服务和 API：使用 ASP.NET Core 开发 RESTful API 或 gRPC 服务，提供对外接口。处理身份验证、授权和其他安全相关的功能。
• 快速原型开发：利用 C# 的高效开发工具和丰富的库，快速实现和迭代应用原型。
• 集成和自动化：编写脚本和工具，用于自动化部署、持续集成和持续交付（CI/CD）。

3.2、Rust 主要负责

• 性能关键模块：实现需要极高性能和低延迟的核心计算模块，如图像处理、数据压缩、加密解密等。开发高性能的算法和数据结构，确保系统在高负载下的稳定性和效率。
• 系统编程：编写操作系统内核、驱动程序、嵌入式系统固件等底层代码。实现与硬件直接交互的代码，确保高效和可靠的资源管理。
• 并发和多线程编程：开发需要高度并发和多线程支持的应用，如高性能服务器、实时系统等。利用 Rust 的所有权和借用检查器，确保线程安全，避免数据竞争。
• 安全关键应用：编写涉及敏感数据处理的代码，如身份验证、加密解密、权限管理等。确保代码在运行时的内存安全，防止缓冲区溢出、空指针引用等常见漏洞。
• WebAssembly 模块：将 Rust 代码编译为 WebAssembly，用于在浏览器中执行高性能任务。在 Web 应用中使用 Rust 提供的功能，提高前端性能。

3.3、示例项目

假设我们要开发一个金融分析平台，该平台包括一个桌面应用程序和一个高性能后台服务：

桌面应用程序（C#）

• 使用 WPF 构建用户界面，展示数据分析结果和图表。
• 实现用户登录、权限管理和配置界面。
• 与后台服务通信，发送分析请求并接收结果。

后台服务（Rust）

• 实现高性能的数据处理和分析算法，处理大量金融数据。
• 确保数据处理过程中的内存安全和并发安全。
• 提供 RESTful API 接口，供桌面应用程序调用。

通过这种职责分配，可以充分利用 C# 和 Rust 各自的优势。

4、应用场景

结合 Rust 和 C# 的优势，可以创建具有高性能、安全性和易用性的混合应用程序。以下是一些具体的应用场景和方法：

1. 高性能计算模块
   Rust：用于编写需要极高性能和内存安全的核心计算模块。例如，图像处理、数据压缩、加密算法等。
   C#：用于构建用户界面、业务逻辑和其他高层次的应用部分。
   通过这种方式，开发者可以利用 Rust 的性能优势，同时享受 C# 提供的丰富生态系统和开发工具。

2. 游戏开发
   Rust：用于实现游戏引擎的底层部分，如物理引擎、渲染引擎等，这些部分对性能要求非常高。
   C#：用于编写游戏逻辑、用户界面和脚本。Unity 引擎就是一个很好的例子，它主要使用 C# 进行开发。
   这种组合可以确保游戏在性能关键的部分表现出色，同时保持开发过程的高效和灵活。

3. 微服务架构
   Rust：用于编写性能关键的微服务，例如需要处理大量并发请求的服务，或者需要进行复杂数据处理的服务。
   C#：用于编写其他微服务，特别是那些涉及到企业级应用逻辑、数据库操作和 Web API 的部分。
   通过这种方式，可以在保证整体系统性能的同时，利用 C# 的快速开发和维护优势。

4. 嵌入式系统与前端交互
   Rust：用于开发嵌入式系统中的固件或驱动程序，这些部分通常需要高度的可靠性和性能。
   C#：用于开发与嵌入式系统交互的桌面应用或移动应用，通过网络协议或串口通信与嵌入式设备进行数据交换。
   这种组合可以确保嵌入式系统的稳定性和性能，同时提供用户友好的界面和交互体验。

5. 安全关键应用
   Rust：用于编写需要高度安全性的代码部分，例如身份验证、加密解密、权限管理等。
   C#：用于构建应用的其余部分，包括用户界面、数据展示和业务逻辑。
   通过这种方式，可以最大限度地减少安全漏洞，同时保持开发效率。

二、技术集成方法

1、FFI（外部函数接口）

使用 Rust 编写的库可以通过 FFI 暴露给 C# 使用。C# 可以调用这些高性能的 Rust 函数，从而将两者的优势结合起来。

2、WebAssembly

Rust 可以编译为 WebAssembly，然后在 C#（例如 Blazor 项目）中使用。这种方法特别适用于 Web 应用开发，使得前端部分也能享受到 Rust 的性能优势。

3、微服务架构

将不同语言编写的服务部署为独立的微服务，通过 HTTP/REST 或 gRPC 等协议进行通信。这种方法使得各个服务可以独立开发和部署，充分利用各自语言的优势。

三、探索 FFI

1、什么是 FFI

FFI 是 “Foreign Function Interface” 的缩写，指的是一种编程接口，它允许一种编程语言调用另一种编程语言的函数或子程序。FFI 通常用于以下几种情况：

1. 性能优化：某些任务在特定语言（如 C 或 C++）中执行速度更快，因此可以通过 FFI 调用这些高效的函数。
2. 代码重用：利用已有的库和代码，而不必重新实现相同的功能。
3. 跨语言协作：在多语言项目中，各个部分可能由不同的编程语言编写，通过 FFI 可以使它们互操作。

例如，在 Python 中，可以使用 ctypes 或 cffi 库来调用 C 语言编写的函数。在 Java 中，可以使用 JNI（Java Native Interface）来调用本地代码。

FFI 的具体实现和使用方法会因编程语言而异，但其核心思想是提供一种机制，使得不同语言之间能够进行函数调用和数据交换。

示例：Rust 调用 C 函数

FFI 主要关注的是如何在源代码层面上进行跨语言调用。具体职责：

• 声明外部函数：提供语法和机制来声明其他语言中的函数。例如，在 Rust 中使用 extern 关键字。
• 类型匹配：确保调用的参数和返回值类型与外部函数的定义相匹配。
• 内存管理：处理跨语言调用时的内存分配和释放问题。
• 安全性：由于跨语言调用涉及到不受当前语言控制的代码执行，FFI 通常需要通过 unsafe 块来显式标记不安全操作。

// main.rs

// 声明外部 C 函数
extern "C" {
   
    fn add(a: i32, b: i32) -> i32;
}

fn main() {
   
    let result = unsafe {
    add(5, 3) };
    println!("The sum is: {}", result);
}

在这个示例中，FFI 的角色体现在 extern “C” 关键字和 unsafe 块上，它们使得 Rust 可以调用 C 编写的 add 函数。

2、C ABI

FFI 的实现通常依赖于底层的 ABI 规范，例如 C ABI。C ABI 是一组规定了函数调用、参数传递、返回值处理、内存布局等细节的规则和约定。它确保了编译后的二进制代码能够正确地进行函数调用和数据交换。C ABI 通常由操作系统和硬件平台定义，并且不同的平台可能有不同的 ABI 规范。

主要内容包括：

• 调用约定：函数参数如何传递（通过寄存器或堆栈）、返回值如何传递、调用者和被调用者的职责。
• 名称修饰：函数名和变量名在编译后的符号表中的表示方式。
• 内存布局：数据结构（如结构体、联合体）的内存对齐和布局方式。
• 错误处理：错误码或异常处理机制。

示例：C 函数

C ABI 主要关注的是在二进制层面上如何进行跨语言调用。具体职责：

• 调用约定：定义函数参数如何传递（通过寄存器或堆栈）、返回值如何传递、调用者和被调用者的职责。
• 名称修饰：规定函数名和变量名在编译后的符号表中的表示方式，以避免命名冲突。
• 内存布局：定义数据结构（如结构体、联合体）的内存对齐和布局方式。
• 错误处理：规定错误码或异常处理机制。

// add.c
#include 

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

当我们编译这个 C 文件时，编译器会按照目标平台的 C ABI 规则生成二进制代码，包括函数 add 的参数传递、返回值处理、名称修饰等。

FFI 与 C ABI 的关系

• 依赖关系：FFI 的实现依赖于底层的 ABI 规范。例如，Rust 调用 C 函数时，需要遵循 C ABI 的规则，以确保参数传递、函数调用和返回值处理的正确性。
• 互补关系：C ABI 定义了二进制级别的调用约定和内存布局，而 FFI 提供了语言级别的接口，使得程序员可以在源代码中声明和调用外部函数。
• 跨语言互操作：通过 FFI 和 C ABI，不同编程语言可以互相调用对方的函数，实现跨语言的功能复用和集成。

总结

• FFI 的角色：提供语言级别的接口，使得程序员可以在源代码中声明和调用外部函数，处理类型匹配、内存管理和安全性问题。
• C ABI 的角色：定义二进制级别的调用约定和内存布局，确保不同编程语言生成的二进制代码能够正确地互操作。

通过 FFI 和 C ABI 的协作，不同编程语言可以实现跨语言调用和互操作，从而复用已有的库和功能。

3、C# 导出 C ABI

在 C# 中，可以使用 UnmanagedFunctionPointer 属性和委托来将 C# 方法导出为 C ABI 函数，以便其他非托管代码（如 C/C++）可以调用它。这通常涉及到以下几个步骤：

• 定义一个委托类型，表示要导出的函数签名。
• 使用 UnmanagedFunctionPointer 属性指定调用约定。
• 创建一个静态方法，并将其分配给该委托。
• 获取该委托的函数指针，并将其传递给需要调用的非托管代码。

下面是一个示例，展示了如何在 C# 中定义并导出一个 C ABI 函数：

using System;
using System.Runtime.InteropServices;

class Program
{
   
    // 定义一个委托类型，表示要导出的函数签名
    [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
    public delegate void HelloDelegate();

    // 定义一个静态方法，将其导出为 C ABI 函数
    public static void HelloFromCSharp()
    {
   
        Console.WriteLine("Hello from C#!");
    }

    static void Main()
    {
   
        // 创建一个委托实例，指向静态方法
        HelloDelegate helloDelegate = new HelloDelegate(HelloFromCSharp);

        // 获取委托的函数指针