Node-Bindgen 项目教程

Node-Bindgen 项目教程

node-bindgenEasy way to write Node.js module using Rust项目地址:https://gitcode.com/gh_mirrors/no/node-bindgen

项目介绍

Node-Bindgen 是一个 Rust 库，旨在简化使用 Rust 编写 Node.js 模块的过程。它通过自动生成外部 "C" 胶水代码，包括本地模块注册，使得编写 Node.js 模块变得简单和有趣。Node-Bindgen 支持多种特性，如自动类型检查、异步支持、类封装、流实现以及与 Node.js N-API 的兼容性。

项目快速启动

安装 CLI

首先，安装 nj-cli 命令行工具，这将帮助你构建 Node.js 模块：

cargo install nj-cli

创建项目

创建一个新的 Rust 项目并添加 node-bindgen 依赖：

cargo new my_node_module
cd my_node_module
cargo add node-bindgen

编写 Rust 代码

在 src/lib.rs 文件中编写你的 Rust 代码：

use node_bindgen::derive::node_bindgen;

#[node_bindgen]
fn sum(first: i32, second: i32) -> i32 {
    first + second
}

构建模块

使用 nj-cli 构建 Node.js 模块：

nj-cli build

这将生成 Node.js 模块在 dist 文件夹中。

使用模块

在 Node.js 中使用生成的模块：

let addon = require('./dist');
addon.sum(2, 3, function(result) {
    console.log(result); // 输出 5
});

应用案例和最佳实践

异步支持

Node-Bindgen 支持异步 Rust 函数，这些函数会被映射为 Node.js 的 Promise：

use std::time::Duration;
use flv_future_aio::time::sleep;
use node_bindgen::derive::node_bindgen;

#[node_bindgen]
async fn hello(arg: f64) -> f64 {
    println!("sleeping");
    sleep(Duration::from_secs(1)).await;
    println!("woke and adding 10.0");
    arg + 10.0
}

在 Node.js 中使用：

let addon = require('./dist');
addon.hello(5).then((val) => {
    console.log("future value is %s", val);
});

类封装

你可以使用 Rust 结构体来创建 Node.js 类：

use node_bindgen::derive::node_bindgen;

struct MyStruct {
    inc: i32,
}

#[node_bindgen]
impl MyStruct {
    #[node_bindgen(constructor)]
    pub fn new(inc: i32) -> Self {
        Self { inc }
    }

    #[node_bindgen]
    fn inc_my_number(&self, a: i32) -> i32 {
        a + self.inc
    }
}

在 Node.js 中使用：

let addon = require('./dist');
let myStruct = new addon.MyStruct(10);
console.log(myStruct.incMyNumber(5)); // 输出 15

典型生态项目

Node-Bindgen 可以与多种 Node.js 生态项目结合使用，例如：

• Express.js: 使用 Rust 编写的中间件可以提高性能。
• Electron: 在 Electron 应用中使用 Rust 编写的模块来处理计算密集型任务。
• WebAssembly: 结合 WebAssembly 使用 Rust 编写的模块，以提高前端性能。

通过这些应用案例，Node-Bindgen 展示了其在提高 Node.js 模块性能和开发效率方面的潜力。

node-bindgenEasy way to write Node.js module using Rust项目地址:https://gitcode.com/gh_mirrors/no/node-bindgen