Node.js v18.18.2 文档

Hello world#

这个“Hello world”示例是一个简单的插件，用 C++ 编写，相当于以下 JavaScript 代码：

module.exports.hello = () => 'world'; copy

首先，创建文件hello.cc：

// hello.cc
#include <node.h>

namespace demo {

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

void Method(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  args.GetReturnValue().Set(String::NewFromUtf8(
      isolate, "world").ToLocalChecked());
}

void Initialize(Local<Object> exports) {
  NODE_SET_METHOD(exports, "hello", Method);
}

NODE_MODULE(NODE_GYP_MODULE_NAME, Initialize)

}  // namespace demo copy

所有 Node.js 插件都必须导出遵循以下模式的初始化函数：

void Initialize(Local<Object> exports);
NODE_MODULE(NODE_GYP_MODULE_NAME, Initialize) copy

NODE_MODULE之后没有分号，因为它不是函数（请参阅 node.h）。

module_name必须与最终二进制文件的文件名匹配（不包括.node后缀）。

在hello.cc示例中，初始化函数为Initialize ，插件模块名称为addon。

使用node-gyp构建插件时，使用宏NODE_GYP_MODULE_NAME作为NODE_MODULE()的第一个参数将确保传递最终二进制文件的名称到NODE_MODULE()。

使用NODE_MODULE()定义的插件无法同时加载到多个上下文或多个线程中。

上下文感知插件#

在某些环境中，Node.js 插件可能需要在多个上下文中多次加载。例如，Electron运行时在单个进程中运行 Node.js 的多个实例。每个实例都有自己的 require()缓存，因此每个实例都需要一个本机插件才能在通过require()加载时正确运行。这意味着插件必须支持多个初始化。

可以使用宏 NODE_MODULE_INITIALIZER构建上下文感知插件，该宏扩展为 Node.js 在加载插件时期望找到的函数名称。因此，可以按照以下示例初始化插件：

using namespace v8;

extern "C" NODE_MODULE_EXPORT void
NODE_MODULE_INITIALIZER(Local<Object> exports,
                        Local<Value> module,
                        Local<Context> context) {
  /* Perform addon initialization steps here. */
} copy

另一种选择是使用宏NODE_MODULE_INIT()，它也将构造一个上下文感知插件。与用于围绕给定插件初始值设定项函数构造插件的 NODE_MODULE()不同， NODE_MODULE_INIT()用作此类初始值设定项的声明，后跟函数体。

调用NODE_MODULE_INIT()后，可以在函数体内使用以下三个变量：

• Local<Object> exports,
• Local<Value> module, and
• Local<Context> context

选择构建上下文感知插件需要仔细管理全局静态数据。由于插件可能会被多次加载，甚至可能从不同的线程加载，因此插件中存储的任何全局静态数据都必须受到适当的保护，并且不得包含对 JavaScript 对象的任何持久引用。原因是 JavaScript 对象仅在一种上下文中有效，并且当从错误的上下文或与创建它们的线程不同的线程访问时，可能会导致崩溃。

可以通过执行以下步骤来构造上下文感知插件以避免全局静态数据：

• 定义一个类，该类将保存每个插件实例的数据，并具有以下形式的静态成员

  static void DeleteInstance(void* data) {
    // Cast `data` to an instance of the class and delete it.
  } copy

• 在插件初始值设定项中堆分配此类的实例。这可以使用new关键字来完成。
• 调用node::AddEnvironmentCleanupHook()，向其传递上面创建的实例和指向DeleteInstance() 的指针。这将确保在环境被拆除时删除实例。
• 将类的实例存储在v8::External中，并且
• 将v8::External传递给暴露给 JavaScript 的所有方法，方法是将其传递给v8::FunctionTemplate::New()或v8::Function::New()，后者创建本机支持的 ​​JavaScript 函数。v8::FunctionTemplate::New()或v8::Function::New()的第三个参数 接受 v8::External并使其在本机回调中使用 v8::FunctionCallbackInfo::Data()方法。

这将确保每个插件实例的数据到达可以从 JavaScript 调用的每个绑定。每个插件实例的数据还必须传递到插件可能创建的任何异步回调中。

以下示例说明了上下文感知插件的实现：

#include <node.h>

using namespace v8;

class AddonData {
 public:
  explicit AddonData(Isolate* isolate):
      call_count(0) {
    // Ensure this per-addon-instance data is deleted at environment cleanup.
    node::AddEnvironmentCleanupHook(isolate, DeleteInstance, this);
  }

  // Per-addon data.
  int call_count;

  static void DeleteInstance(void* data) {
    delete static_cast<AddonData*>(data);
  }
};

static void Method(const v8::FunctionCallbackInfo<v8::Value>& info) {
  // Retrieve the per-addon-instance data.
  AddonData* data =
      reinterpret_cast<AddonData*>(info.Data().As<External>()->Value());
  data->call_count++;
  info.GetReturnValue().Set((double)data->call_count);
}

// Initialize this addon to be context-aware.
NODE_MODULE_INIT(/* exports, module, context */) {
  Isolate* isolate = context->GetIsolate();

  // Create a new instance of `AddonData` for this instance of the addon and
  // tie its life cycle to that of the Node.js environment.
  AddonData* data = new AddonData(isolate);

  // Wrap the data in a `v8::External` so we can pass it to the method we
  // expose.
  Local<External> external = External::New(isolate, data);

  // Expose the method `Method` to JavaScript, and make sure it receives the
  // per-addon-instance data we created above by passing `external` as the
  // third parameter to the `FunctionTemplate` constructor.
  exports->Set(context,
               String::NewFromUtf8(isolate, "method").ToLocalChecked(),
               FunctionTemplate::New(isolate, Method, external)
                  ->GetFunction(context).ToLocalChecked()).FromJust();
} copy

Worker支持#

为了从多个 Node.js 环境（例如主线程和工作线程）加载，附加组件需要：

• 是 Node-API 插件，或者
• 如上所述，使用NODE_MODULE_INIT()声明为上下文感知

为了支持Worker线程，插件需要在此类线程存在时清理它们可能分配的任何资源。这可以通过使用AddEnvironmentCleanupHook()函数来实现：

void AddEnvironmentCleanupHook(v8::Isolate* isolate,
                               void (*fun)(void* arg),
                               void* arg); copy

此函数添加了一个钩子，该钩子将在给定 Node.js 实例关闭之前运行。如有必要，可以在使用具有相同签名的RemoveEnvironmentCleanupHook()运行之前删除此类挂钩 。回调按后进先出的顺序运行。

如有必要，还有一对额外的AddEnvironmentCleanupHook() 和RemoveEnvironmentCleanupHook()重载，其中清理挂钩采用回调函数。这可用于关闭异步资源，例如由插件注册的任何 libuv 句柄。

以下addon.cc使用AddEnvironmentCleanupHook：

// addon.cc
#include <node.h>
#include <assert.h>
#include <stdlib.h>

using node::AddEnvironmentCleanupHook;
using v8::HandleScope;
using v8::Isolate;
using v8::Local;
using v8::Object;

// Note: In a real-world application, do not rely on static/global data.
static char cookie[] = "yum yum";
static int cleanup_cb1_called = 0;
static int cleanup_cb2_called = 0;

static void cleanup_cb1(void* arg) {
  Isolate* isolate = static_cast<Isolate*>(arg);
  HandleScope scope(isolate);
  Local<Object> obj = Object::New(isolate);
  assert(!obj.IsEmpty());  // assert VM is still alive
  assert(obj->IsObject());
  cleanup_cb1_called++;
}

static void cleanup_cb2(void* arg) {
  assert(arg == static_cast<void*>(cookie));
  cleanup_cb2_called++;
}

static void sanity_check(void*) {
  assert(cleanup_cb1_called == 1);
  assert(cleanup_cb2_called == 1);
}

// Initialize this addon to be context-aware.
NODE_MODULE_INIT(/* exports, module, context */) {
  Isolate* isolate = context->GetIsolate();

  AddEnvironmentCleanupHook(isolate, sanity_check, nullptr);
  AddEnvironmentCleanupHook(isolate, cleanup_cb2, cookie);
  AddEnvironmentCleanupHook(isolate, cleanup_cb1, isolate);
} copy

通过运行以下命令在 JavaScript 中进行测试：

// test.js
require('./build/Release/addon'); copy

架构#

源代码编写完成后，必须将其编译为二进制 addon.node文件。为此，请在项目顶层创建一个名为binding.gyp的文件，使用类似 JSON 的格式描述模块的构建配置。该文件由node-gyp使用，这是一个专门为编译 Node.js 插件而编写的工具。

{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "hello.cc" ]
    }
  ]
} copy

node-gyp实用程序的一个版本作为npm的一部分与 Node.js 捆绑和分发。此版本不直接供开发人员使用，仅用于支持使用 npm install命令编译和安装插件的功能。希望直接使用node-gyp的开发者可以使用命令 npm install -g node-gyp安装它。请参阅node-gyp 安装说明以了解更多信息，包括特定于平台的要求。

创建binding.gyp文件后，使用node-gyp configure为当前平台生成适当的项目构建文件。这将在 build/目录中生成Makefile（在 Unix 平台上）或vcxproj文件（在 Windows 上）。

接下来，调用node-gyp build命令生成编译后的addon.node 文件。这将被放入build/Release/目录中。

当使用npm install安装 Node.js 插件时，npm 使用自己的捆绑版本node-gyp来执行相同的一组操作，为该插件生成编译版本按需用户平台。

构建完成后，可以通过将require()指向构建的addon.node模块，在 Node.js 中使用二进制插件 ：

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

console.log(addon.hello());
// Prints: 'world' copy

因为已编译的插件二进制文件的确切路径可能会根据其编译方式而有所不同（即有时可能位于 ./build/Debug/中），所以插件可以使用绑定包来加载已编译的模块。

虽然bindings包实现在如何定位插件模块方面更加复杂，但它本质上使用类似于以下的tryb&catch模式：

try {
  return require('./build/Release/addon.node');
} catch (err) {
  return require('./build/Debug/addon.node');
} copy

链接到 Node.js 附带的库#

Node.js 使用静态链接库，例如 V8、libuv 和 OpenSSL。所有插件都需要链接到 V8，并且也可以链接到任何其他依赖项。通常，这就像包含适当的 #include <...>语句（例如#include ）一样简单，并且node-gyp将自动找到适当的标头。但是，有一些注意事项需要注意：

• 当node-gyp运行时，它将检测 Node.js 的特定发行版本并下载完整的源 tarball 或仅下载标头。如果下载了完整的源代码，插件将可以完全访问全套 Node.js 依赖项。但是，如果仅下载 Node.js 标头，则只有 Node.js 导出的符号可用。

• node-gyp可以使用指向本地 Node.js 源映像的--nodedir标志运行。使用此选项，插件将可以访问完整的依赖项集。

使用require()加载插件#

编译后的插件二进制文件的文件扩展名是.node（而不是.dll或.so）。require()函数的编写目的是查找具有.node文件扩展名的文件并将其初始化为动态链接库。

当调用require()时，通常可以省略.node扩展，Node.js 仍会查找并初始化插件。然而，需要注意的是，Node.js 将首先尝试查找并加载恰好共享相同基本名称的模块或 JavaScript 文件。例如，如果文件addon.js与二进制文件addon.node位于同一目录中，则require('addon')将优先考虑addon.js文件并加载它。

Node.js 的本机抽象#

本文档中所示的每个示例都直接使用 Node.js 和 V8 API 来实现插件。V8 API 可以而且已经从一个 V8 版本到下一个版本（以及从一个主要 Node.js 版本到下一个版本）发生了巨大变化。每次更改时，插件可能需要更新并重新编译才能继续运行。Node.js 发布计划旨在最大限度地减少此类更改的频率和影响，但 Node.js 在确保 V8 API 的稳定性方面几乎无能为力。

Node.js 的本机抽象（或nan）提供了一组建议插件开发人员使用的工具，以保持 V8 和 Node.js 过去和未来版本之间的兼容性。请参阅nan 示例以了解如何使用它。

Node-API#

Node-API 是用于构建本机插件的 API。它独立于底层 JavaScript 运行时（例如 V8），并作为 Node.js 本身的一部分进行维护。该 API 将在 Node.js 版本之间保持稳定的应用程序二进制接口 (ABI)。它的目的是将插件与底层 JavaScript 引擎的更改隔离开来，并允许为一个版本编译的模块无需重新编译即可在更高版本的 Node.js 上运行。插件是使用本文档中概述的相同方法/工具（node-gyp 等）构建/打包的。唯一的区别是本机代码使用的 API 集。不使用 Node.js API 的 V8 或本机抽象，而是使用 Node-API 中可用的函数。

创建和维护受益于 Node-API 提供的 ABI 稳定性的插件会带来某些 实现注意事项。

要在上面的“Hello world”示例中使用 Node-API，请将hello.cc的内容替换 为以下内容。所有其他说明保持不变。

// hello.cc using Node-API
#include <node_api.h>

namespace demo {

napi_value Method(napi_env env, napi_callback_info args) {
  napi_value greeting;
  napi_status status;

  status = napi_create_string_utf8(env, "world", NAPI_AUTO_LENGTH, &greeting);
  if (status != napi_ok) return nullptr;
  return greeting;
}

napi_value init(napi_env env, napi_value exports) {
  napi_status status;
  napi_value fn;

  status = napi_create_function(env, nullptr, 0, Method, nullptr, &fn);
  if (status != napi_ok) return nullptr;

  status = napi_set_named_property(env, exports, "hello", fn);
  if (status != napi_ok) return nullptr;
  return exports;
}

NAPI_MODULE(NODE_GYP_MODULE_NAME, init)

}  // namespace demo copy

可用的函数以及如何使用它们记录在 带有 Node-API 的 C/C++ 插件中。

插件示例#

以下是一些旨在帮助开发人员入门的示例插件。这些示例使用 V8 API。请参阅在线V8 参考 以获取有关各种 V8 调用的帮助，并参阅 V8 的嵌入指南以获取所使用的几个概念（例如句柄、作用域、函数模板等）的说明。

每个示例都使用以下binding.gyp文件：

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

如果有多个.cc文件，只需将附加文件名添加到sources数组中：

"sources": ["addon.cc", "myexample.cc"] copy

一旦binding.gyp文件准备就绪，就可以使用node-gyp配置和构建示例插件：

$ node-gyp configure build copy

函数参数#

插件通常会公开可以从 Node.js 中运行的 JavaScript 访问的对象和函数。当从 JavaScript 调用函数时，输入参数和返回值必须映射到 C/C++ 代码或从 C/C++ 代码映射。

以下示例说明如何读取从 JavaScript 传递的函数参数以及如何返回结果：

// addon.cc
#include <node.h>

namespace demo {

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

// This is the implementation of the "add" method
// Input arguments are passed using the
// const FunctionCallbackInfo<Value>& args struct
void Add(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  // Check the number of arguments passed.
  if (args.Length() < 2) {
    // Throw an Error that is passed back to JavaScript
    isolate->ThrowException(Exception::TypeError(
        String::NewFromUtf8(isolate,
                            "Wrong number of arguments").ToLocalChecked()));
    return;
  }

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

  // Perform the operation
  double value =
      args[0].As<Number>()->Value() + args[1].As<Number>()->Value();
  Local<Number> num = Number::New(isolate, value);

  // Set the return value (using the passed in
  // FunctionCallbackInfo<Value>&)
  args.GetReturnValue().Set(num);
}

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

NODE_MODULE(NODE_GYP_MODULE_NAME, Init)

}  // namespace demo copy

编译后，可以在 Node.js 中需要并使用示例插件：

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

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

回调#

插件中的常见做法是将 JavaScript 函数传递给 C++ 函数并从那里执行它们。以下示例说明了如何调用此类回调：

// addon.cc
#include <node.h>

namespace demo {

using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Null;
using v8::Object;
using v8::String;
using v8::Value;

void RunCallback(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  Local<Context> context = isolate->GetCurrentContext();
  Local<Function> cb = Local<Function>::Cast(args[0]);
  const unsigned argc = 1;
  Local<Value> argv[argc] = {
      String::NewFromUtf8(isolate,
                          "hello world").ToLocalChecked() };
  cb->Call(context, Null(isolate), argc, argv).ToLocalChecked();
}

void Init(Local<Object> exports, Local<Object> module) {
  NODE_SET_METHOD(module, "exports", RunCallback);
}

NODE_MODULE(NODE_GYP_MODULE_NAME, Init)

}  // namespace demo copy

此示例使用双参数形式的Init()，它接收完整的 module对象作为第二个参数。这允许插件使用单个函数完全覆盖exports ，而不是将函数添加为exports的属性。

要测试它，请运行以下 JavaScript：

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

addon((msg) => {
  console.log(msg);
// Prints: 'hello world'
}); copy

在本例中，回调函数是同步调用的。

对象工厂#

插件可以从 C++ 函数中创建并返回新对象，如以下示例所示。创建并返回一个对象，其属性msg与传递给createObject() 的字符串相呼应：

// addon.cc
#include <node.h>

namespace demo {

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

void CreateObject(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  Local<Context> context = isolate->GetCurrentContext();

  Local<Object> obj = Object::New(isolate);
  obj->Set(context,
           String::NewFromUtf8(isolate,
                               "msg").ToLocalChecked(),
                               args[0]->ToString(context).ToLocalChecked())
           .FromJust();

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

void Init(Local<Object> exports, Local<Object> module) {
  NODE_SET_METHOD(module, "exports", CreateObject);
}

NODE_MODULE(NODE_GYP_MODULE_NAME, Init)

}  // namespace demo copy

要在 JavaScript 中测试它：

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

const obj1 = addon('hello');
const obj2 = addon('world');
console.log(obj1.msg, obj2.msg);
// Prints: 'hello world' copy

函数工厂#

另一个常见场景是创建包装 C++ 函数的 JavaScript 函数并将其返回给 JavaScript：

// addon.cc
#include <node.h>

namespace demo {

using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void MyFunction(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  args.GetReturnValue().Set(String::NewFromUtf8(
      isolate, "hello world").ToLocalChecked());
}

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

  Local<Context> context = isolate->GetCurrentContext();
  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, MyFunction);
  Local<Function> fn = tpl->GetFunction(context).ToLocalChecked();

  // omit this to make it anonymous
  fn->SetName(String::NewFromUtf8(
      isolate, "theFunction").ToLocalChecked());

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

void Init(Local<Object> exports, Local<Object> module) {
  NODE_SET_METHOD(module, "exports", CreateFunction);
}

NODE_MODULE(NODE_GYP_MODULE_NAME, Init)

}  // namespace demo copy

去测试：

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

const fn = addon();
console.log(fn());
// Prints: 'hello world' copy

包装 C++ 对象#

还可以以允许使用 JavaScript new运算符创建新实例的方式包装 C++ 对象/类：

// addon.cc
#include <node.h>
#include "myobject.h"

namespace demo {

using v8::Local;
using v8::Object;

void InitAll(Local<Object> exports) {
  MyObject::Init(exports);
}

NODE_MODULE(NODE_GYP_MODULE_NAME, InitAll)

}  // namespace demo copy

然后，在myobject.h中，包装类继承自node::ObjectWrap：

// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include <node.h>
#include <node_object_wrap.h>

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Local<v8::Object> exports);

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);
  static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);

  double value_;
};

}  // namespace demo

#endif copy

在myobject.cc中，实现要公开的各种方法。下面，通过将方法plusOne()添加到构造函数的原型来公开：

// myobject.cc
#include "myobject.h"

namespace demo {

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

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Local<Object> exports) {
  Isolate* isolate = exports->GetIsolate();
  Local<Context> context = isolate->GetCurrentContext();

  Local<ObjectTemplate> addon_data_tpl = ObjectTemplate::New(isolate);
  addon_data_tpl->SetInternalFieldCount(1);  // 1 field for the MyObject::New()
  Local<Object> addon_data =
      addon_data_tpl->NewInstance(context).ToLocalChecked();

  // Prepare constructor template
  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New, addon_data);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject").ToLocalChecked());
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  // Prototype
  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);

  Local<Function> constructor = tpl->GetFunction(context).ToLocalChecked();
  addon_data->SetInternalField(0, constructor);
  exports->Set(context, String::NewFromUtf8(
      isolate, "MyObject").ToLocalChecked(),
      constructor).FromJust();
}

void MyObject::New(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  Local<Context> context = isolate->GetCurrentContext();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ?
        0 : args[0]->NumberValue(context).FromMaybe(0);
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local<Value> argv[argc] = { args[0] };
    Local<Function> cons =
        args.Data().As<Object>()->GetInternalField(0).As<Function>();
    Local<Object> result =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(result);
  }
}

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

  MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());
  obj->value_ += 1;

  args.GetReturnValue().Set(Number::New(isolate, obj->value_));
}

}  // namespace demo copy

要构建此示例，必须将myobject.cc文件添加到 binding.gyp：

{
  "targets": [
    {
      "target_name": "addon",
      "sources": [
        "addon.cc",
        "myobject.cc"
      ]
    }
  ]
} copy

测试它：

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

const obj = new addon.MyObject(10);
console.log(obj.plusOne());
// Prints: 11
console.log(obj.plusOne());
// Prints: 12
console.log(obj.plusOne());
// Prints: 13 copy

包装对象的析构函数将在对象被垃圾收集时运行。对于析构函数测试，可以使用命令行标志来强制垃圾回收。这些标志由底层 V8 JavaScript 引擎提供。它们可能随时更改或删除。Node.js 或 V8 没有记录它们，并且永远不应该在测试之外使用它们。

在进程或工作线程关闭期间，JS 引擎不会调用析构函数。因此，用户有责任跟踪这些对象并确保正确销毁以避免资源泄漏。

包装对象工厂#

或者，可以使用工厂模式来避免使用 JavaScript new运算符显式创建对象实例：

const obj = addon.createObject();
// instead of:
// const obj = new addon.Object(); copy

首先，createObject()方法在addon.cc中实现：

// addon.cc
#include <node.h>
#include "myobject.h"

namespace demo {

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

void CreateObject(const FunctionCallbackInfo<Value>& args) {
  MyObject::NewInstance(args);
}

void InitAll(Local<Object> exports, Local<Object> module) {
  MyObject::Init(exports->GetIsolate());

  NODE_SET_METHOD(module, "exports", CreateObject);
}

NODE_MODULE(NODE_GYP_MODULE_NAME, InitAll)

}  // namespace demo copy

在myobject.h中，添加了静态方法NewInstance()来处理实例化对象。此方法取代了JavaScript 中使用new的位置：

// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include <node.h>
#include <node_object_wrap.h>

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Isolate* isolate);
  static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);
  static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);
  static v8::Global<v8::Function> constructor;
  double value_;
};

}  // namespace demo

#endif copy

myobject.cc中的实现与前面的示例类似：

// myobject.cc
#include <node.h>
#include "myobject.h"

namespace demo {

using node::AddEnvironmentCleanupHook;
using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Global;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::String;
using v8::Value;

// Warning! This is not thread-safe, this addon cannot be used for worker
// threads.
Global<Function> MyObject::constructor;

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Isolate* isolate) {
  // Prepare constructor template
  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject").ToLocalChecked());
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  // Prototype
  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);

  Local<Context> context = isolate->GetCurrentContext();
  constructor.Reset(isolate, tpl->GetFunction(context).ToLocalChecked());

  AddEnvironmentCleanupHook(isolate, [](void*) {
    constructor.Reset();
  }, nullptr);
}

void MyObject::New(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  Local<Context> context = isolate->GetCurrentContext();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ?
        0 : args[0]->NumberValue(context).FromMaybe(0);
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local<Value> argv[argc] = { args[0] };
    Local<Function> cons = Local<Function>::New(isolate, constructor);
    Local<Object> instance =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(instance);
  }
}

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

  const unsigned argc = 1;
  Local<Value> argv[argc] = { args[0] };
  Local<Function> cons = Local<Function>::New(isolate, constructor);
  Local<Context> context = isolate->GetCurrentContext();
  Local<Object> instance =
      cons->NewInstance(context, argc, argv).ToLocalChecked();

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

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

  MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());
  obj->value_ += 1;

  args.GetReturnValue().Set(Number::New(isolate, obj->value_));
}

}  // namespace demo copy

再次，要构建此示例，必须将myobject.cc文件添加到 binding.gyp：

{
  "targets": [
    {
      "target_name": "addon",
      "sources": [
        "addon.cc",
        "myobject.cc"
      ]
    }
  ]
} copy

测试它：

// test.js
const createObject = require('./build/Release/addon');

const obj = createObject(10);
console.log(obj.plusOne());
// Prints: 11
console.log(obj.plusOne());
// Prints: 12
console.log(obj.plusOne());
// Prints: 13

const obj2 = createObject(20);
console.log(obj2.plusOne());
// Prints: 21
console.log(obj2.plusOne());
// Prints: 22
console.log(obj2.plusOne());
// Prints: 23 copy

传递包装对象#

除了包装和返回 C++ 对象之外，还可以通过使用 Node.js 辅助函数 node::ObjectWrap::Unwrap解包来传递包装对象。以下示例显示了一个函数add() ，它可以采用两个MyObject对象作为输入参数：

// addon.cc
#include <node.h>
#include <node_object_wrap.h>
#include "myobject.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 CreateObject(const FunctionCallbackInfo<Value>& args) {
  MyObject::NewInstance(args);
}

void Add(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  Local<Context> context = isolate->GetCurrentContext();

  MyObject* obj1 = node::ObjectWrap::Unwrap<MyObject>(
      args[0]->ToObject(context).ToLocalChecked());
  MyObject* obj2 = node::ObjectWrap::Unwrap<MyObject>(
      args[1]->ToObject(context).ToLocalChecked());

  double sum = obj1->value() + obj2->value();
  args.GetReturnValue().Set(Number::New(isolate, sum));
}

void InitAll(Local<Object> exports) {
  MyObject::Init(exports->GetIsolate());

  NODE_SET_METHOD(exports, "createObject", CreateObject);
  NODE_SET_METHOD(exports, "add", Add);
}

NODE_MODULE(NODE_GYP_MODULE_NAME, InitAll)

}  // namespace demo copy

在myobject.h中，添加了一个新的公共方法，以允许在解包对象后访问私有值。

// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include <node.h>
#include <node_object_wrap.h>

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Isolate* isolate);
  static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);
  inline double value() const { return value_; }

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);
  static v8::Global<v8::Function> constructor;
  double value_;
};

}  // namespace demo

#endif copy

myobject.cc的实现与之前类似：

// myobject.cc
#include <node.h>
#include "myobject.h"

namespace demo {

using node::AddEnvironmentCleanupHook;
using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Global;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

// Warning! This is not thread-safe, this addon cannot be used for worker
// threads.
Global<Function> MyObject::constructor;

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Isolate* isolate) {
  // Prepare constructor template
  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject").ToLocalChecked());
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  Local<Context> context = isolate->GetCurrentContext();
  constructor.Reset(isolate, tpl->GetFunction(context).ToLocalChecked());

  AddEnvironmentCleanupHook(isolate, [](void*) {
    constructor.Reset();
  }, nullptr);
}

void MyObject::New(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  Local<Context> context = isolate->GetCurrentContext();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ?
        0 : args[0]->NumberValue(context).FromMaybe(0);
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local<Value> argv[argc] = { args[0] };
    Local<Function> cons = Local<Function>::New(isolate, constructor);
    Local<Object> instance =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(instance);
  }
}

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

  const unsigned argc = 1;
  Local<Value> argv[argc] = { args[0] };
  Local<Function> cons = Local<Function>::New(isolate, constructor);
  Local<Context> context = isolate->GetCurrentContext();
  Local<Object> instance =
      cons->NewInstance(context, argc, argv).ToLocalChecked();

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

}  // namespace demo copy

测试它：

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

const obj1 = addon.createObject(10);
const obj2 = addon.createObject(20);
const result = addon.add(obj1, obj2);

console.log(result);
// Prints: 30 copy