Node中完整的 node addon 实现流程

下面将为你详细讲解 Node 中完整的 Node addon 实现流程。

1. Node addon 是什么？

Node addon 是指可以使用 C++ 代码编写并且在 Node.js 中使用的扩展。它允许 Node.js 的用户在 JavaScript 中使用 C/C++ 代码实现高效的模块和操作，以及与原生代码交互，从而提高 Node.js 在高性能计算、游戏等领域的适用性。

2. 实现流程

Node 中完整的 Node addon 实现流程可以分为以下几个步骤：

2.1 生成 binding.gyp 文件

binding.gyp 是 Node-addon-API 的配置文件，负责定义构建和安装 Node addon 的脚本。我们需要使用 node-gyp 命令生成一个名为 binding.gyp 的文件。

node-gyp configure

2.2 编写 C++ 代码

编写 C++ 代码实现 Node addon 的功能。需要注意的是，由于使用了 C/C++ 语言，需要使用头文件等语法，并且需要了解 Node.js 的内存管理机制。

例如，以下是一个使用 C++ 实现加法的代码示例：

#include <node.h>

namespace demo {

using v8::Context;
using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::String;
using v8::Value;

void Add(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  if (args.Length() < 2) {
    isolate->ThrowException(
        Exception::TypeError(String::NewFromUtf8(isolate, "Wrong number of arguments")));
    return;
  }

  if (!args[0]->IsNumber() || !args[1]->IsNumber()) {
    isolate->ThrowException(
        Exception::TypeError(String::NewFromUtf8(isolate, "Wrong arguments")));
    return;
  }

  double value = args[0]->NumberValue() + args[1]->NumberValue();
  Local<Number> num = Number::New(isolate, value);

  args.GetReturnValue().Set(num);
}

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

NODE_MODULE(addon, Init)

}  // namespace demo

2.3 生成编译产物

使用以下命令生成编译产物：

node-gyp build

生成的编译产物将位于 build/Release/addon.node。

2.4 导出 C++ 函数以供 Node.js 调用

最后，将 C++ 函数导出为 Node addon 的接口，供 JavaScript 代码使用：

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

console.log('This should be eight:', addon.add(3, 5));

3. 示例说明

以下是两个使用 C++ 编写的 Node addon 示例，分别实现了对数组元素求和和使用 OpenSSL 加密字符串的功能。

3.1 示例一：对数组元素求和

以下代码以 C++ 实现，实现了对数组元素求和的功能：

#include <node.h>

namespace demo {

using v8::Array;
using v8::Context;
using v8::Exception;
using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::String;
using v8::Value;

void Sum(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  if (!args[0]->IsArray()) {
    isolate->ThrowException(
      Exception::TypeError(
        String::NewFromUtf8(isolate, "Expected an array")
      )
    );
    return;
  }

  Local<Array> arr = Local<Array>::Cast(args[0]);

  double sum = 0;

  for (unsigned int i = 0; i < arr->Length(); i++) {
    Local<Value> val = arr->Get(i);

    if (val->IsNumber()) {
      sum += val->NumberValue();
    }
  }

  args.GetReturnValue().Set(Number::New(isolate, sum));
}

void Init(Local<Object> exports) {
  NODE_SET_METHOD(exports, "sum", Sum);
}

NODE_MODULE(addon, Init)

}  // namespace demo

然后，在 JavaScript 中使用以下代码引用并使用 Node addon：

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

let list = [1, 2, 3, 4, 5];
let sum = addon.sum(list);

console.log('Sum: ' + sum);

输出：

Sum: 15

3.2 示例二：使用 OpenSSL 加密字符串

以下代码以 C++ 实现，实现了使用 OpenSSL 加密字符串的功能：

#include <node.h>
#include <openssl/evp.h>
#include <string>

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void Encrypt(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  if (args.Length() < 2 || !args[0]->IsString() || !args[1]->IsString()) {
    isolate->ThrowException(v8::Exception::TypeError(String::NewFromUtf8(isolate, "Expected two string arguments")));
    return;
  }

  std::string password(*v8::String::Utf8Value(args[0]->ToString()));
  std::string data(*v8::String::Utf8Value(args[1]->ToString()));

  EVP_CIPHER_CTX* ctx = EVP_CIPHER_CTX_new();
  EVP_EncryptInit_ex(ctx, EVP_aes_256_cbc(), NULL, (const unsigned char*) password.c_str(), NULL);

  int len = data.length() + EVP_MAX_BLOCK_LENGTH;
  char* ciphertext = new char[len];

  int ciphertext_len = 0;
  EVP_EncryptUpdate(ctx, (unsigned char*) ciphertext, &len, (const unsigned char*) data.c_str(), data.length());
  ciphertext_len += len;

  EVP_EncryptFinal_ex(ctx, (unsigned char*) ciphertext + ciphertext_len, &len);
  ciphertext_len += len;

  EVP_CIPHER_CTX_free(ctx);

  args.GetReturnValue().Set(String::NewFromUtf8(isolate, ciphertext, String::kNormalString, ciphertext_len));

  delete[] ciphertext;
}

void Init(Local<Object> exports) {
  NODE_SET_METHOD(exports, "encrypt", Encrypt);
}

NODE_MODULE(addon, Init)

}  // namespace demo