Nodejs高性能原生模块接口n-api的使用

Nodejs高性能原生模块接口n-api的使用
N-API（Node-API）是Node.js提供的一种用于构建C/C++扩展的新API，它的一个主要优势是在不同版本的Node.js中保持二进制兼容性。这意味着你可以在不同的Node.js版本上使用相同的二进制扩展，而无需重新编译。

如何开始使用N-API

  1. 安装必要的工具

    首先，你需要安装node-gyp，这是一个用来编译Node.js C++插件的命令行工具。你可以通过npm来安装：

    npm install -g node-gyp

  2. 创建项目

    创建一个新的文件夹作为你的项目根目录，并在其中初始化一个npm项目：

    mkdir napi-example
cd napi-example
npm init -y

  3. 配置binding.gyp

    在项目根目录下创建一个名为binding.gyp的文件，这个文件描述了如何构建你的插件：

    {
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "src/addon.cc" ]
    }
  ]
}

  4. 编写C++代码

    在src文件夹中创建一个名为addon.cc的文件，这是你的C++代码入口点。这里是一个简单的示例，展示如何使用N-API创建一个函数：

    #include <napi.h>

Napi::String Method(const Napi::CallbackInfo& info) {
  Napi::Env env = info.Env();
  return Napi::String::New(env, "world");
}

Napi::Object Init(Napi::Env env, Napi::Object exports) {
  exports.Set(Napi::String::New(env, "hello"), Napi::Function::New(env, Method));
  return exports;
}

NODE_API_MODULE(addon, Init)

  5. 编译和测试

    使用node-gyp来编译你的插件：

    node-gyp configure build

    之后，在你的JavaScript代码中可以这样导入并使用这个插件：

    const addon = require('./build/Release/addon');
console.log(addon.hello()); // 输出 'world'

更多资源

  • 官方文档：N-API文档
  • 示例项目：Node.js GitHub仓库中有许多N-API的示例项目，可以作为学习参考。

以上就是使用N-API的基本步骤。希望这对你有所帮助！


3 回复

N-API（Node-API）是Node.js提供的一种编写原生插件的方式，它的一个主要优点是在不同版本的Node.js之间保持稳定，让你的插件能够更轻松地跨版本工作。使用N-API，你可以用C或C++编写高性能的原生模块，而不用担心Node.js的内部变化。

首先，你需要安装node-gyp来编译你的原生代码。然后，在你的项目中创建一个binding.gyp文件来描述你的构建配置。接下来，使用C/C++编写你的模块功能，并通过N-API函数来与Node.js环境交互。

举个例子，如果你想暴露一个简单的加法函数给JavaScript，你可以这样写：

#include <napi.h>

Napi::Number Add(const Napi::CallbackInfo& info) {
  Napi::Env env = info.Env();
  if (info.Length() < 2 || !info[0].IsNumber() || !info[1].IsNumber()) {
    Napi::TypeError::New(env, "Number expected").ThrowAsJavaScriptException();
    return Napi::Number::New(env, 0);
  }
  return Napi::Number::New(env, info[0].As<Napi::Number>().Int32Value() + info[1].As<Napi::Number>().Int32Value());
}

Napi::Object Init(Napi::Env env, Napi::Object exports) {
  exports.Set(Napi::String::New(env, "add"), Napi::Function::New(env, Add));
  return exports;
}

NODE_API_MODULE(addon, Init)

这段代码定义了一个名为add的函数，可以被JavaScript调用。记得编译这个模块后，你就可以在Node.js中像加载普通模块一样加载它了！


N-API（Node API）是Node.js提供的一种抽象层，旨在为编写可跨Node.js版本兼容的原生模块提供一个稳定的ABI（Application Binary Interface）。这意味着使用N-API编写的原生模块可以在不同的Node.js版本之间保持兼容性，无需重新编译。

下面我将展示如何使用N-API创建一个简单的Node.js原生模块。这个示例将展示如何创建一个简单的模块，该模块可以计算两个数字的和。

首先，你需要安装必要的工具。确保你已经安装了Node.js，并且可以通过npm安装node-gyp：

npm install -g node-gyp

接下来，创建一个新的项目目录，并初始化npm项目：

mkdir napi-example
cd napi-example
npm init -y

然后，安装N-API相关的头文件：

npm install --save-dev node-addon-api

现在，在项目根目录下创建一个名为binding.gyp的文件，用于配置构建选项：

{
  "targets": [
    {
      "target_name": "napi_example",
      "sources": [ "src/napi_example.cpp" ]
    }
  ]
}

接下来，在src目录下创建napi_example.cpp文件，这是我们的C++源文件，我们将在这里实现一些N-API功能：

#include <napi.h>

Napi::Number Add(const Napi::CallbackInfo& info) {
  Napi::Env env = info.Env();

  if (info.Length() < 2 || !info[0].IsNumber() || !info[1].IsNumber()) {
    Napi::TypeError::New(env, "Expected two numbers").ThrowAsJavaScriptException();
    return Napi::Number::New(env, 0);
  }

  double result = info[0].As<Napi::Number>().DoubleValue() + info[1].As<Napi::Number>().DoubleValue();
  return Napi::Number::New(env, result);
}

Napi::Object Init(Napi::Env env, Napi::Object exports) {
  exports.Set(Napi::String::New(env, "add"), Napi::Function::New(env, Add));
  return exports;
}

NODE_API_MODULE(napi_example, Init)

在这个文件中，我们定义了一个Add函数，它接收两个参数并返回它们的和。如果输入不正确，则抛出一个错误。

最后，你可以通过以下命令来构建你的原生模块：

node-gyp configure build

一旦构建成功，你应该能在build/Release目录下找到生成的.node文件。你可以在Node.js环境中使用这个模块：

const addon = require('./build/Release/napi_example');

console.log(addon.add(1, 2)); // 输出：3

这个简单的例子展示了如何使用N-API创建一个基本的Node.js原生模块。

N-API是Node.js的一个API层，它提供了一种编写原生插件的方式，这些插件可以在不同的Node.js版本之间保持兼容。使用N-API，你可以用C或C++编写原生模块，而无需关心Node.js的V8引擎或其他内部变化。

开始使用N-API，你需要安装node-addon-api库，这会提供一些C++封装类来简化开发过程。然后，在你的C/C++代码中，使用N-API函数来定义模块功能。编译时，确保配置正确的编译工具链以生成兼容的二进制文件。这样，即使未来Node.js升级，只要API保持不变，你的原生模块就无需更新。

回到顶部