使用 cbindgen 为 Rust 项目生成 C 绑定（Rust cbindgen C绑定生成器入门教程）

什么是 cbindgen？

cbindgen 是一个由 Mozilla 开发的工具，它能自动从你的 Rust 代码中提取带有 #[repr(C)] 属性的结构体、枚举和函数，并生成对应的 C 语言头文件。这使得 C 或 C++ 项目可以轻松调用你编写的 Rust 库。

通过使用 Rust与C互操作 技术，你可以逐步将关键模块用 Rust 重写，同时保持与现有 C 代码的兼容性。

安装 cbindgen

首先，确保你已安装 Rust 工具链（包括 cargo）。然后，在终端运行以下命令安装 cbindgen：

cargo install cbindgen

安装完成后，你就可以在任何项目中使用 cbindgen 命令了。

创建一个简单的 Rust 库

我们先创建一个新的 Rust 库项目：

cargo new --lib my_rust_libcd my_rust_lib

编辑 src/lib.rs 文件，添加一些可被 C 调用的函数和结构体。注意必须使用 #[repr(C)] 来保证内存布局与 C 兼容：

// src/lib.rs#[repr(C)]pub struct Point {    pub x: f32,    pub y: f32,}#[no_mangle]pub extern "C" fn add_points(a: Point, b: Point) -> Point {    Point {        x: a.x + b.x,        y: a.y + b.y,    }}#[no_mangle]pub extern "C" fn greet() -> *const libc::c_char {    b"Hello from Rust!\0".as_ptr() as *const _}

别忘了在 Cargo.toml 中添加 libc 依赖：

[dependencies]libc = "0.2"

配置并运行 cbindgen

在项目根目录下运行以下命令，初始化 cbindgen 配置文件：

cbindgen --init

这会生成一个 cbindgen.toml 文件。你可以根据需要调整配置，但默认设置通常已足够。

现在，生成 C 头文件：

cbindgen --crate my_rust_lib --output my_rust_lib.h

成功执行后，你会在项目目录下看到 my_rust_lib.h 文件。打开它，内容大致如下：

// my_rust_lib.h#include <stdarg.h>#include <stdbool.h>#include <stdint.h>#include <stdlib.h>typedef struct {  float x;  float y;} Point;Point add_points(Point a, Point b);const char *greet(void);

在 C 项目中使用生成的头文件

现在，你可以在 C 代码中包含这个头文件，并链接编译后的 Rust 静态库（需使用 cargo build --release 生成 .a 或 .so 文件）。

例如，创建一个 main.c 文件：

#include "my_rust_lib.h"#include <stdio.h>int main() {    Point p1 = {1.0, 2.0};    Point p2 = {3.0, 4.0};    Point sum = add_points(p1, p2);    printf("Sum: (%.1f, %.1f)\n", sum.x, sum.y);    printf("%s\n", greet());    return 0;}

编译时需链接 Rust 生成的库，具体方法因平台而异，但这是 生成C头文件 后实现跨语言调用的关键一步。

小贴士与最佳实践

• 始终为要导出的结构体添加 #[repr(C)]。
• 使用 #[no_mangle] 防止 Rust 编译器修改函数名。
• 字符串返回值建议使用 *const c_char 并以空字符结尾。
• 避免在公共 API 中使用 Rust 特有类型（如 String、Vec）。

结语

通过本篇 cbindgen教程，你应该已经掌握了如何使用 cbindgen 为 Rust 项目生成 C 绑定。这项技能不仅能帮助你集成 Rust 到现有 C/C++ 项目中，还能提升系统的安全性和性能。

赶快动手试试吧！如果你有任何问题，欢迎查阅 cbindgen 官方 GitHub 仓库 获取更多文档和示例。