API для встраивания C++

Node.js предоставляет ряд API на C++, которые можно использовать для выполнения JavaScript в среде Node.js из другого программного обеспечения на C++.

Документацию по этим API можно найти в файле src/node.h в исходном дереве Node.js. Помимо API, предоставляемых Node.js, некоторые необходимые концепции описаны в API для встраивания V8.

Поскольку использование Node.js в качестве встраиваемой библиотеки отличается от написания кода, выполняемого Node.js, критические изменения не следуют типичной политике устаревания Node.js и могут появляться в каждом выпуске с повышением основной версии semver без предварительного предупреждения.

Пример встраиваемого приложения

В следующих разделах будет представлен обзор того, как использовать эти API для создания с нуля приложения, которое выполняет задачу, эквивалентную node -e <code>, то есть принимает фрагмент JavaScript и запускает его в среде, специфичной для Node.js.

Полный код можно найти в исходном дереве Node.js.

Настройка состояния для каждого процесса

Для работы Node.js требуется управлять некоторым состоянием на уровне процесса:

• Разбор аргументов для параметров CLI Node.js,
• Требования V8 на уровне процесса, например экземпляр v8::Platform.

В следующем примере показано, как настроить эти компоненты. Некоторые имена классов взяты из пространств имён C++ node и v8 соответственно.

int main(int argc, char** argv) {
  argv = uv_setup_args(argc, argv);
  std::vector<std::string> args(argv, argv + argc);
  // Parse Node.js CLI options, and print any errors that have occurred while
  // trying to parse them.
  std::unique_ptr<node::InitializationResult> result =
      node::InitializeOncePerProcess(args, {
        node::ProcessInitializationFlags::kNoInitializeV8,
        node::ProcessInitializationFlags::kNoInitializeNodeV8Platform
      });

  for (const std::string& error : result->errors())
    fprintf(stderr, "%s: %s\n", args[0].c_str(), error.c_str());
  if (result->early_return() != 0) {
    return result->exit_code();
  }

  // Create a v8::Platform instance. `MultiIsolatePlatform::Create()` is a way
  // to create a v8::Platform instance that Node.js can use when creating
  // Worker threads. When no `MultiIsolatePlatform` instance is present,
  // Worker threads are disabled.
  std::unique_ptr<MultiIsolatePlatform> platform =
      MultiIsolatePlatform::Create(4);
  V8::InitializePlatform(platform.get());
  V8::Initialize();

  // See below for the contents of this function.
  int ret = RunNodeInstance(
      platform.get(), result->args(), result->exec_args());

  V8::Dispose();
  V8::DisposePlatform();

  node::TearDownOncePerProcess();
  return ret;
}
cppcopy

Настройка состояния для каждого экземпляра

В Node.js есть понятие «экземпляр Node.js», который обычно называют node::Environment. Каждый node::Environment связан со следующими компонентами:

• Ровно один v8::Isolate, то есть один экземпляр JS-движка,
• Ровно один uv_loop_t, то есть один цикл событий,
• Некоторое количество v8::Context, но ровно один основной v8::Context, и
• Один экземпляр node::IsolateData, содержащий информацию, которую могут использовать несколько node::Environment. Встраивающая сторона должна убедиться, что node::IsolateData используется совместно только между node::Environment, использующими один и тот же v8::Isolate; Node.js эту проверку не выполняет.

Для настройки v8::Isolate необходимо предоставить v8::ArrayBuffer::Allocator. Один из вариантов — стандартный аллокатор Node.js, который можно создать с помощью node::ArrayBufferAllocator::Create(). Использование аллокатора Node.js позволяет применять небольшие оптимизации производительности, когда аддоны используют API C++ Buffer Node.js, и необходимо для отслеживания памяти ArrayBuffer в process.memoryUsage().

Кроме того, каждый v8::Isolate, используемый для экземпляра Node.js, необходимо зарегистрировать и отменить его регистрацию в экземпляре MultiIsolatePlatform, если он используется, чтобы платформа знала, какой цикл событий применять для задач, запланированных v8::Isolate.

Вспомогательная функция node::NewIsolate() создаёт v8::Isolate, настраивает для него некоторые хуки, специфичные для Node.js (например, обработчик ошибок Node.js), и автоматически регистрирует его на платформе.

int RunNodeInstance(MultiIsolatePlatform* platform,
                    const std::vector<std::string>& args,
                    const std::vector<std::string>& exec_args) {
  int exit_code = 0;

  // Setup up a libuv event loop, v8::Isolate, and Node.js Environment.
  std::vector<std::string> errors;
  std::unique_ptr<CommonEnvironmentSetup> setup =
      CommonEnvironmentSetup::Create(platform, &errors, args, exec_args);
  if (!setup) {
    for (const std::string& err : errors)
      fprintf(stderr, "%s: %s\n", args[0].c_str(), err.c_str());
    return 1;
  }

  Isolate* isolate = setup->isolate();
  Environment* env = setup->env();

  {
    Locker locker(isolate);
    Isolate::Scope isolate_scope(isolate);
    HandleScope handle_scope(isolate);
    // The v8::Context needs to be entered when node::CreateEnvironment() and
    // node::LoadEnvironment() are being called.
    Context::Scope context_scope(setup->context());

    // Set up the Node.js instance for execution, and run code inside of it.
    // There is also a variant that takes a callback and provides it with
    // the `require` and `process` objects, so that it can manually compile
    // and run scripts as needed.
    // The `require` function inside this script does *not* access the file
    // system, and can only load built-in Node.js modules.
    // `module.createRequire()` is being used to create one that is able to
    // load files from the disk, and uses the standard CommonJS file loader
    // instead of the internal-only `require` function.
    MaybeLocal<Value> loadenv_ret = node::LoadEnvironment(
        env,
        "const publicRequire ="
        "  require('node:module').createRequire(process.cwd() + '/');"
        "globalThis.require = publicRequire;"
        "require('node:vm').runInThisContext(process.argv[1]);");

    if (loadenv_ret.IsEmpty())  // There has been a JS exception.
      return 1;

    exit_code = node::SpinEventLoop(env).FromMaybe(1);

    // node::Stop() can be used to explicitly stop the event loop and keep
    // further JavaScript from running. It can be called from any thread,
    // and will act like worker.terminate() if called from another thread.
    node::Stop(env);
  }

  return exit_code;
}
cppcopy