Node.js v21.7.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，以及
• 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 环境（例如主线程和 Worker 线程）加载，插件需要

• 成为 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 实用程序的一个版本与 Node.js 捆绑在一起并作为 npm 的一部分进行分发。此版本不会直接提供给开发人员使用，仅用于支持使用 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 包来加载已编译的模块。

虽然 bindings 包实现更复杂，因为它在定位附加组件模块方面更复杂，但它本质上使用类似于以下的 try…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 <v8.h>）一样简单，node-gyp 会自动找到合适的标题。但是，需要注意一些注意事项。

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

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

使用 require() 加载插件#

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

调用 require() 时，通常可以省略 .node 扩展名，Node.js 仍然可以找到并初始化插件。但是，需要注意的是，Node.js 将首先尝试定位和加载与相同基本名称共享的模块或 JavaScript 文件。例如，如果在二进制文件 addon.node 所在的同一目录中存在一个文件 addon.js，则 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 集。它不使用 V8 或 用于 Node.js 的原生抽象 API，而是使用 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++ 对象#

还可以包装 C++ 对象/类，以便可以使用 JavaScript new 运算符创建新实例

// 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<Value>().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

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

// 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