Nodejs 调用c动态库，选用哪种方法好（node addons OR node-ffi）

Nodejs 调用c动态库，选用哪种方法好（node addons OR node-ffi）

###如题 正在写一个希望调用c lib的方法，问一下哪种方式更好一点

3 回复

Nodejs 调用C动态库，选用哪种方法好（Node Addons OR Node-FFI）

在Node.js中调用C语言编写的动态库时，主要可以使用两种方法：Node Addons和Node-FFI。每种方法都有其特点和适用场景。下面我们来详细比较这两种方法，并提供一些示例代码。

Node Addons

优点:

  1. 性能高: 因为Node Addons是用C++编写的，可以直接与V8引擎交互，因此性能非常高。
  2. 类型安全: 可以通过TypeScript等工具进行类型检查，减少运行时错误。
  3. 稳定性: 长期维护，官方支持，社区活跃。

缺点:

  1. 开发复杂: 需要掌握C++和Node.js的API，开发难度较大。
  2. 编译依赖: 每次修改后都需要重新编译，部署相对复杂。

示例代码:

假设有一个C库libhello.so，其中定义了一个函数void sayHello(const char* name)，我们想在Node.js中调用它。

  1. 创建一个binding.gyp文件：

    {
  "targets": [
    {
      "target_name": "helloaddon",
      "sources": [ "helloaddon.cpp" ]
    }
  ]
}

  2. 编写helloaddon.cpp:

    #include <node.h>
#include <string>
#include <cstring>

void SayHello(const v8::FunctionCallbackInfo<v8::Value>& args) {
  Isolate* isolate = args.GetIsolate();
  v8::String::Utf8Value str(isolate, args[0]);
  const char* cstr = *str;
  printf("Hello %s!\n", cstr);
}

void Initialize(Local<Object> exports) {
  NODE_SET_METHOD(exports, "sayHello", SayHello);
}

NODE_MODULE(helloaddon, Initialize)

  3. 编译并安装addon:

    node-gyp configure build
npm install .

  4. 在Node.js中使用:

    const addon = require('./build/Release/helloaddon');
addon.sayHello('World');

Node-FFI

优点:

  1. 简单易用: 不需要编写C++代码，只需要JavaScript即可完成调用。
  2. 快速原型开发: 适合快速原型开发和测试。

缺点:

  1. 性能低: 由于需要通过FFI库进行反射调用，性能不如Node Addons。
  2. 不安全: 容易出现类型不匹配等问题，缺乏类型安全检查。

示例代码:

假设同样有一个C库libhello.so，其中定义了一个函数void sayHello(const char* name)。

  1. 安装Node-FFI库:

    npm install ffi-napi

  2. 编写JavaScript代码:

    const ffi = require('ffi-napi');

// 加载动态库
const libhello = new ffi.Library('libhello', {
  'sayHello': ['void', ['string']]
});

// 调用C函数
libhello.sayHello('World');

总结

选择Node Addons还是Node-FFI取决于你的具体需求。如果你需要高性能且愿意投入更多时间去学习和开发，Node Addons是更好的选择。如果你只是需要快速原型开发或简单的功能调用，Node-FFI则更为便捷。


node addons C++

对于Node.js调用C语言编写的动态库，node-addons 和 node-ffi 是两种常用的方法。选择哪种方法取决于你的具体需求、复杂度以及性能考虑。

Node-Addons

node-addons 是Node.js官方推荐的方法，用于直接将C/C++代码编译为原生模块，从而能够与JavaScript代码进行高效交互。它使用的是V8引擎的API，并且可以提供接近本地的性能。

优点：

  1. 性能高：由于是原生代码，性能接近于C/C++。
  2. 直接访问底层功能：可以直接操作内存，适合高性能计算场景。

缺点：

  1. 开发复杂：需要编写C/C++代码并编译成动态库，有一定的学习曲线。
  2. 平台依赖性：生成的动态库可能不跨平台。

示例代码：

假设你有一个C库文件，定义如下：

// mylib.h
int add(int a, int b);

// mylib.c
#include "mylib.h"
int add(int a, int b) {
    return a + b;
}

使用node-addons可以这样调用：

// binding.gyp
{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "addon.cpp" ]
    }
  ]
}

// addon.cpp
#include <node.h>
#include <v8.h>
#include "mylib.h"

using namespace v8;

void Add(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  int a = args[0]->Int32Value(isolate->GetCurrentContext()).FromJust();
  int b = args[1]->Int32Value(isolate->GetCurrentContext()).FromJust();
  int result = add(a, b);
  args.GetReturnValue().Set(Integer::New(isolate, result));
}

void Initialize(Local<Object> exports) {
  NODE_SET_METHOD(exports, "add", Add);
}

NODE_MODULE(NODE_GYP_MODULE_NAME, Initialize)

然后通过npm安装并加载这个模块：

npm install --build-from-source

const addon = require('./build/Release/addon');
console.log(addon.add(1, 2)); // 输出: 3

Node-FFI

node-ffi 可以让你无需编译任何C代码就能调用C库函数。它使用动态链接的方式加载库函数，并将其包装成JavaScript函数。这种方式简单易用，但性能相对较低。

优点：

  1. 简单易用：无需编译C代码，直接加载即可。
  2. 适用于快速原型开发。

缺点：

  1. 性能较差：相比于原生模块，调用速度较慢。
  2. 平台兼容性问题：某些库可能无法正确加载。

示例代码：

const ffi = require('ffi-napi');
const ref = require('ref-napi');

const libm = new ffi.Library('libm', {
  'sin': [ 'double', [ 'double' ] ],
  'cos': [ 'double', [ 'double' ] ],
});

console.log(libm.sin(Math.PI / 2)); // 输出接近1的值

结论

如果性能是关键因素，或者你需要频繁地调用大量数据，建议使用node-addons。如果你只是需要一个简单的解决方案，或者原型开发阶段，node-ffi会更方便。

回到顶部