Rust与Deno的桥梁：deno_napi插件库的使用，实现高性能Node-API与Deno的交互

概述

deno_napi是一个用于连接Rust与Deno的插件库，它通过Node-API标准实现了两者之间的高性能交互。该实现保持了与Node.js相似的文件组织方式，确保良好的兼容性。

添加新函数

1. 声明符号

在symbol_exports.json中添加需要导出的函数符号：

{
  "symbols": [
    "napi_get_undefined",
    "napi_get_null",
    "napi_get_boolean"
  ]
}

2. 实现函数

在适当的Rust文件中(如js_native_api.rs)编写实现：

#[napi_sym::napi_sym]
fn napi_get_boolean(
  env: *mut Env,       // 环境指针
  value: bool,         // 输入布尔值
  result: *mut napi_value,  // 输出结果指针
) -> Result {
  // 实现逻辑...
  Ok(())
}

3. 更新符号列表

运行生成脚本更新符号列表：

deno run --allow-write tools/napi/generate_symbols_lists.js

测试示例

JavaScript测试代码

// 测试napi_get_boolean功能
import { assertEquals, loadTestLibrary } from "./common.js";
const lib = loadTestLibrary();

Deno.test("napi get boolean", function () {
  assertEquals(lib.test_get_boolean(true), true);
  assertEquals(lib.test_get_boolean(false), false);
});

Rust测试实现

use napi_sys::Status::napi_ok;
use napi_sys::ValueType::napi_boolean;
use napi_sys::*;

extern "C" fn test_boolean(
  env: napi_env,
  info: napi_callback_info,
) -> napi_value {
  // 获取回调信息
  let (args, argc, _) = crate::get_callback_info!(env, info, 1);
  assert_eq!(argc, 1);

  // 验证参数类型
  let mut ty = -1;
  assert!(unsafe { napi_typeof(env, args[0], &mut ty) } == napi_ok);
  assert_eq!(ty, napi_boolean);

  // 返回原始值
  value
}

模块注册

在lib.rs中注册测试模块：

mod boolean;

#[no_mangle]
unsafe extern "C" fn napi_register_module_v1(
  env: napi_env,
  exports: napi_value,
) -> napi_value {
  boolean::init(env, exports);
  exports
}

运行测试：

cargo test -p tests/napi

完整开发示例

1. 配置Cargo.toml

[dependencies]
deno_napi = "0.143.0"  # Deno的Node-API支持
napi-sys = "0.5"       # Node-API系统绑定

2. Rust模块实现

use napi_sys::*;
use std::os::raw::c_void;

// 模块注册函数
#[no_mangle]
pub unsafe extern "C" fn napi_register_module_v1(
    env: napi_env,
    exports: napi_value,
) -> napi_value {
    // 定义要导出的hello函数
    let desc = napi_property_descriptor {
        utf8name: "hello\0".as_ptr() as *const _,
        name: std::ptr::null_mut(),
        method: Some(hello),
        getter: None,
        setter: None,
        value: std::ptr::null_mut(),
        attributes: napi_default,
        data: std::ptr::null_mut(),
    };
    
    // 将函数添加到exports对象
    napi_define_properties(env, exports, 1, &desc);
    exports
}

// hello函数实现
unsafe extern "C" fn hello(
    env: napi_env,
    info: napi_callback_info,
) -> napi_value {
    let mut result: napi_value = std::ptr::null_mut();
    
    // 创建返回字符串
    napi_create_string_utf8(
        env,
        "Hello from Rust!\0".as_ptr() as *const _,
        15,
        &mut result,
    );
    
    result
}

3. Deno调用代码

// 加载编译好的Rust库
const lib = Deno.dlopen("./target/debug/libexample.dylib", {
  napi_register_module_v1: { 
    parameters: ["pointer", "pointer"], 
    result: "pointer" 
  },
});

// 初始化模块
const exports = new Deno.UnsafePointerObject(
  lib.symbols.napi_register_module_v1(
    new Deno.UnsafePointer(0n),
    new Deno.UnsafePointer(0n)
  )
);

// 调用Rust函数
const result = Deno.core.unescapePointer(expts.hello());
console.log(result); // 输出: "Hello from Rust!"

4. 构建和运行

# 编译Rust库
cargo build

# 运行Deno测试(需要启用不稳定特性)
deno run --allow-ffi --unstable test.ts

平台注意事项

根据操作系统不同，生成的库文件扩展名也不同：

• macOS: .dylib
• Linux: .so
• Windows: .dll

在Deno代码中需要根据实际平台调整库文件路径。