Node.js v25.0.0 文档

v8.cachedDataVersionTag()#

• 返回：<integer>

返回一个整数，表示从 V8 版本、命令行标志和检测到的 CPU 特性派生出的版本标签。这对于确定 vm.Script 的 cachedData 缓冲区是否与此 V8 实例兼容非常有用。

console.log(v8.cachedDataVersionTag()); // 3947234607
// The value returned by v8.cachedDataVersionTag() is derived from the V8
// version, command-line flags, and detected CPU features. Test that the value
// does indeed update when flags are toggled.
v8.setFlagsFromString('--allow_natives_syntax');
console.log(v8.cachedDataVersionTag()); // 183726201 copy

v8.getHeapCodeStatistics()#

• 返回：<Object>

获取关于堆中代码及其元数据的统计信息，参见 V8 的 GetHeapCodeAndMetadataStatistics API。返回一个包含以下属性的对象：

• code_and_metadata_size <number>
• bytecode_and_metadata_size <number>
• external_script_source_size <number>
• cpu_profiler_metadata_size <number>

{
  code_and_metadata_size: 212208,
  bytecode_and_metadata_size: 161368,
  external_script_source_size: 1410794,
  cpu_profiler_metadata_size: 0,
} copy

v8.getHeapSnapshot([options])#

• options <Object>

  • exposeInternals <boolean> 如果为 true，则在堆快照中暴露内部信息。默认值： false。
  • exposeNumericValues <boolean> 如果为 true，则在人工字段中暴露数值。默认值： false。

• 返回：<stream.Readable> 一个包含 V8 堆快照的可读流。

生成当前 V8 堆的快照，并返回一个可读流，可用于读取 JSON 序列化表示。此 JSON 流格式旨在与 Chrome DevTools 等工具一起使用。该 JSON 模式未被文档化，且特定于 V8 引擎。因此，该模式可能会随着 V8 版本的不同而改变。

创建堆快照需要的内存大约是创建快照时堆大小的两倍。这会导致 OOM killer 终止进程的风险。

生成快照是一个同步操作，它会阻塞事件循环，持续时间取决于堆的大小。

// Print heap snapshot to the console
const v8 = require('node:v8');
const stream = v8.getHeapSnapshot();
stream.pipe(process.stdout); copy

v8.getHeapSpaceStatistics()#

• 返回：<Object[]>

返回有关 V8 堆空间（即构成 V8 堆的段）的统计信息。堆空间的排序和可用性都无法保证，因为这些统计信息是通过 V8 的 GetHeapSpaceStatistics 函数提供的，并且可能随着 V8 版本的不同而改变。

返回的值是一个对象数组，每个对象包含以下属性：

• space_name <string>
• space_size <number>
• space_used_size <number>
• space_available_size <number>
• physical_space_size <number>

[
  {
    "space_name": "new_space",
    "space_size": 2063872,
    "space_used_size": 951112,
    "space_available_size": 80824,
    "physical_space_size": 2063872
  },
  {
    "space_name": "old_space",
    "space_size": 3090560,
    "space_used_size": 2493792,
    "space_available_size": 0,
    "physical_space_size": 3090560
  },
  {
    "space_name": "code_space",
    "space_size": 1260160,
    "space_used_size": 644256,
    "space_available_size": 960,
    "physical_space_size": 1260160
  },
  {
    "space_name": "map_space",
    "space_size": 1094160,
    "space_used_size": 201608,
    "space_available_size": 0,
    "physical_space_size": 1094160
  },
  {
    "space_name": "large_object_space",
    "space_size": 0,
    "space_used_size": 0,
    "space_available_size": 1490980608,
    "physical_space_size": 0
  }
] copy

v8.getHeapStatistics()#

• 返回：<Object>

返回一个包含以下属性的对象：

• total_heap_size <number>
• total_heap_size_executable <number>
• total_physical_size <number>
• total_available_size <number>
• used_heap_size <number>
• heap_size_limit <number>
• malloced_memory <number>
• peak_malloced_memory <number>
• does_zap_garbage <number>
• number_of_native_contexts <number>
• number_of_detached_contexts <number>
• total_global_handles_size <number>
• used_global_handles_size <number>
• external_memory <number>

total_heap_size 的值是 V8 为堆分配的字节数。如果 used_heap 需要更多内存，这个值可能会增长。

total_heap_size_executable 的值是堆中可以包含可执行代码的部分，以字节为单位。这包括 JIT 编译代码使用的内存以及任何必须保持可执行状态的内存。

total_physical_size 的值是 V8 堆实际使用的物理内存，以字节为单位。这是已提交（或正在使用）而不是预留的内存量。

total_available_size 的值是 V8 堆可用的内存字节数。这个值表示 V8 在超过堆限制之前还可以使用多少内存。

used_heap_size 的值是 V8 的 JavaScript 对象当前正在使用的字节数。这是实际使用的内存，不包括已分配但尚未使用​​的内存。

heap_size_limit 的值是 V8 堆的最大大小，以字节为单位（可以是默认限制，由系统资源决定，也可以是传递给 --max_old_space_size 选项的值）。

malloced_memory 的值是 V8 通过 malloc 分配的字节数。

peak_malloced_memory 的值是进程生命周期内 V8 通过 malloc 分配的峰值字节数。

does_zap_garbage 是一个 0/1 的布尔值，表示 --zap_code_space 选项是否启用。这使得 V8 用一个位模式覆盖堆中的垃圾。RSS（驻留集大小）占用空间会变大，因为它持续地接触所有堆页面，这使得它们不太可能被操作系统换出。

number_of_native_contexts 的值是当前活动的最顶层上下文的数量。这个数字随时间增加表明存在内存泄漏。

number_of_detached_contexts 的值是已分离但尚未被垃圾回收的上下文数量。这个数字非零表明可能存在内存泄漏。

total_global_handles_size 的值是 V8 全局句柄的总内存大小。

used_global_handles_size 的值是 V8 全局句柄的已用内存大小。

external_memory 的值是数组缓冲区和外部字符串的内存大小。

{
  total_heap_size: 7326976,
  total_heap_size_executable: 4194304,
  total_physical_size: 7326976,
  total_available_size: 1152656,
  used_heap_size: 3476208,
  heap_size_limit: 1535115264,
  malloced_memory: 16384,
  peak_malloced_memory: 1127496,
  does_zap_garbage: 0,
  number_of_native_contexts: 1,
  number_of_detached_contexts: 0,
  total_global_handles_size: 8192,
  used_global_handles_size: 3296,
  external_memory: 318824
} copy

v8.getCppHeapStatistics([detailLevel])#

使用 V8 的 CollectStatistics() 函数检索关于内存消耗和利用率的 CppHeap 统计信息，该函数可能随 V8 版本的不同而改变。

• detailLevel <string> | <undefined>：默认值：'detailed'。指定返回统计信息的详细级别。可接受的值为：
  • 'brief'：简要统计信息只包含整个堆的顶层已分配和已使用内存统计。
  • 'detailed'：详细统计信息还包含按空间和页面的细分，以及空闲列表统计和对象类型直方图。

它返回一个结构与 cppgc::HeapStatistics 对象类似的对象。有关该对象属性的更多信息，请参阅 V8 文档。

// Detailed
({
  committed_size_bytes: 131072,
  resident_size_bytes: 131072,
  used_size_bytes: 152,
  space_statistics: [
    {
      name: 'NormalPageSpace0',
      committed_size_bytes: 0,
      resident_size_bytes: 0,
      used_size_bytes: 0,
      page_stats: [{}],
      free_list_stats: {},
    },
    {
      name: 'NormalPageSpace1',
      committed_size_bytes: 131072,
      resident_size_bytes: 131072,
      used_size_bytes: 152,
      page_stats: [{}],
      free_list_stats: {},
    },
    {
      name: 'NormalPageSpace2',
      committed_size_bytes: 0,
      resident_size_bytes: 0,
      used_size_bytes: 0,
      page_stats: [{}],
      free_list_stats: {},
    },
    {
      name: 'NormalPageSpace3',
      committed_size_bytes: 0,
      resident_size_bytes: 0,
      used_size_bytes: 0,
      page_stats: [{}],
      free_list_stats: {},
    },
    {
      name: 'LargePageSpace',
      committed_size_bytes: 0,
      resident_size_bytes: 0,
      used_size_bytes: 0,
      page_stats: [{}],
      free_list_stats: {},
    },
  ],
  type_names: [],
  detail_level: 'detailed',
}); copy

// Brief
({
  committed_size_bytes: 131072,
  resident_size_bytes: 131072,
  used_size_bytes: 128864,
  space_statistics: [],
  type_names: [],
  detail_level: 'brief',
}); copy

v8.queryObjects(ctor[, options])#

• ctor <Function> 可用于在原型链上搜索以过滤堆中目标对象的构造函数。
• options <undefined> | <Object>
  • format <string> 如果是 'count'，则返回匹配对象的数量。如果是 'summary'，则返回一个包含匹配对象摘要字符串的数组。
• 返回：{number|Array}

这类似于 Chromium DevTools 控制台提供的 queryObjects() 控制台 API。它可以在一次完整的垃圾回收后，用于在堆中搜索在其原型链上具有匹配构造函数的对象，这对于内存泄漏回归测试非常有用。为避免意外结果，用户应避免在他们无法控制其实现的构造函数上使用此 API，或在应用程序中可能被其他方调用的构造函数上使用。

为了避免意外泄漏，此 API 不会返回找到对象的原始引用。默认情况下，它返回找到的对象的数量。如果 options.format 是 'summary'，它会返回一个包含每个对象的简短字符串表示的数组。此 API 中提供的可见性类似于堆快照提供的可见性，但用户可以节省序列化和解析的成本，并直接在搜索过程中过滤目标对象。

只有在当前执行上下文中创建的对象才会包含在结果中。

const { queryObjects } = require('node:v8');
class A { foo = 'bar'; }
console.log(queryObjects(A)); // 0
const a = new A();
console.log(queryObjects(A)); // 1
// [ "A { foo: 'bar' }" ]
console.log(queryObjects(A, { format: 'summary' }));

class B extends A { bar = 'qux'; }
const b = new B();
console.log(queryObjects(B)); // 1
// [ "B { foo: 'bar', bar: 'qux' }" ]
console.log(queryObjects(B, { format: 'summary' }));

// Note that, when there are child classes inheriting from a constructor,
// the constructor also shows up in the prototype chain of the child
// classes's prototype, so the child classes's prototype would also be
// included in the result.
console.log(queryObjects(A));  // 3
// [ "B { foo: 'bar', bar: 'qux' }", 'A {}', "A { foo: 'bar' }" ]
console.log(queryObjects(A, { format: 'summary' }));import { queryObjects } from 'node:v8';
class A { foo = 'bar'; }
console.log(queryObjects(A)); // 0
const a = new A();
console.log(queryObjects(A)); // 1
// [ "A { foo: 'bar' }" ]
console.log(queryObjects(A, { format: 'summary' }));

class B extends A { bar = 'qux'; }
const b = new B();
console.log(queryObjects(B)); // 1
// [ "B { foo: 'bar', bar: 'qux' }" ]
console.log(queryObjects(B, { format: 'summary' }));

// Note that, when there are child classes inheriting from a constructor,
// the constructor also shows up in the prototype chain of the child
// classes's prototype, so the child classes's prototype would also be
// included in the result.
console.log(queryObjects(A));  // 3
// [ "B { foo: 'bar', bar: 'qux' }", 'A {}', "A { foo: 'bar' }" ]
console.log(queryObjects(A, { format: 'summary' }));copy

v8.setFlagsFromString(flags)#

• flags <string>

v8.setFlagsFromString() 方法可用于以编程方式设置 V8 命令行标志。应谨慎使用此方法。在虚拟机启动后更改设置可能会导致不可预测的行为，包括崩溃和数据丢失；或者它可能根本不起作用。

可以通过运行 node --v8-options 来确定某个 Node.js 版本可用的 V8 选项。

用法

// Print GC events to stdout for one minute.
const v8 = require('node:v8');
v8.setFlagsFromString('--trace_gc');
setTimeout(() => { v8.setFlagsFromString('--notrace_gc'); }, 60e3); copy

v8.stopCoverage()#

v8.stopCoverage() 方法允许用户停止由 NODE_V8_COVERAGE 启动的覆盖率收集，以便 V8 可以释放执行计数记录并优化代码。如果用户希望按需收集覆盖率，可以与 v8.takeCoverage() 结合使用。

v8.takeCoverage()#

v8.takeCoverage() 方法允许用户按需将由 NODE_V8_COVERAGE 启动的覆盖率写入磁盘。此方法可以在进程的生命周期内多次调用。每次调用时，执行计数器都将被重置，并且一个新的覆盖率报告将被写入由 NODE_V8_COVERAGE 指定的目录。

当进程即将退出时，除非在进程退出前调用 v8.stopCoverage()，否则最后一次覆盖率仍将被写入磁盘。

v8.writeHeapSnapshot([filename[,options]])#

• filename <string> 要保存 V8 堆快照的文件路径。如果未指定，将生成一个模式为 'Heap-${yyyymmdd}-${hhmmss}-${pid}-${thread_id}.heapsnapshot' 的文件名，其中 {pid} 将是 Node.js 进程的 PID，{thread_id} 在从主 Node.js 线程调用 writeHeapSnapshot() 时为 0，或者是工作线程的 ID。
• options <Object>
  • exposeInternals <boolean> 如果为 true，则在堆快照中暴露内部信息。默认值： false。
  • exposeNumericValues <boolean> 如果为 true，则在人工字段中暴露数值。默认值： false。
• 返回：<string> 保存快照的文件名。

生成当前 V8 堆的快照并将其写入一个 JSON 文件。此文件旨在与 Chrome DevTools 等工具一起使用。该 JSON 模式未被文档化，且特定于 V8 引擎，并可能随着 V8 版本的不同而改变。

堆快照特定于单个 V8 isolate。当使用 工作线程时，从主线程生成的堆快照将不包含有关工作线程的任何信息，反之亦然。

创建堆快照需要的内存大约是创建快照时堆大小的两倍。这会导致 OOM killer 终止进程的风险。

生成快照是一个同步操作，它会阻塞事件循环，持续时间取决于堆的大小。

const { writeHeapSnapshot } = require('node:v8');
const {
  Worker,
  isMainThread,
  parentPort,
} = require('node:worker_threads');

if (isMainThread) {
  const worker = new Worker(__filename);

  worker.once('message', (filename) => {
    console.log(`worker heapdump: ${filename}`);
    // Now get a heapdump for the main thread.
    console.log(`main thread heapdump: ${writeHeapSnapshot()}`);
  });

  // Tell the worker to create a heapdump.
  worker.postMessage('heapdump');
} else {
  parentPort.once('message', (message) => {
    if (message === 'heapdump') {
      // Generate a heapdump for the worker
      // and return the filename to the parent.
      parentPort.postMessage(writeHeapSnapshot());
    }
  });
} copy

v8.setHeapSnapshotNearHeapLimit(limit)#

• limit <integer>

如果已从命令行设置了 --heapsnapshot-near-heap-limit 或该 API 被调用超过一次，则该 API 为空操作。limit 必须是一个正整数。更多信息请参见 --heapsnapshot-near-heap-limit。

序列化 API#

序列化 API 提供了一种序列化 JavaScript 值的方法，该方法与 HTML 结构化克隆算法兼容。

该格式是向后兼容的（即可以安全地存储到磁盘）。相等的 JavaScript 值可能会产生不同的序列化输出。

Promise 钩子#

promiseHooks 接口可用于跟踪 promise 的生命周期事件。要跟踪*所有*异步活动，请参阅 async_hooks，它内部使用此模块来产生 promise 生命周期事件以及其他异步资源的事件。对于请求上下文管理，请参阅 AsyncLocalStorage。

import { promiseHooks } from 'node:v8';

// There are four lifecycle events produced by promises:

// The `init` event represents the creation of a promise. This could be a
// direct creation such as with `new Promise(...)` or a continuation such
// as `then()` or `catch()`. It also happens whenever an async function is
// called or does an `await`. If a continuation promise is created, the
// `parent` will be the promise it is a continuation from.
function init(promise, parent) {
  console.log('a promise was created', { promise, parent });
}

// The `settled` event happens when a promise receives a resolution or
// rejection value. This may happen synchronously such as when using
// `Promise.resolve()` on non-promise input.
function settled(promise) {
  console.log('a promise resolved or rejected', { promise });
}

// The `before` event runs immediately before a `then()` or `catch()` handler
// runs or an `await` resumes execution.
function before(promise) {
  console.log('a promise is about to call a then handler', { promise });
}

// The `after` event runs immediately after a `then()` handler runs or when
// an `await` begins after resuming from another.
function after(promise) {
  console.log('a promise is done calling a then handler', { promise });
}

// Lifecycle hooks may be started and stopped individually
const stopWatchingInits = promiseHooks.onInit(init);
const stopWatchingSettleds = promiseHooks.onSettled(settled);
const stopWatchingBefores = promiseHooks.onBefore(before);
const stopWatchingAfters = promiseHooks.onAfter(after);

// Or they may be started and stopped in groups
const stopHookSet = promiseHooks.createHook({
  init,
  settled,
  before,
  after,
});

// To stop a hook, call the function returned at its creation.
stopWatchingInits();
stopWatchingSettleds();
stopWatchingBefores();
stopWatchingAfters();
stopHookSet(); copy

import { promiseHooks } from 'node:v8';

const stop = promiseHooks.onInit((promise, parent) => {});const { promiseHooks } = require('node:v8');

const stop = promiseHooks.onInit((promise, parent) => {});copy

import { promiseHooks } from 'node:v8';

const stop = promiseHooks.onSettled((promise) => {});const { promiseHooks } = require('node:v8');

const stop = promiseHooks.onSettled((promise) => {});copy

import { promiseHooks } from 'node:v8';

const stop = promiseHooks.onBefore((promise) => {});const { promiseHooks } = require('node:v8');

const stop = promiseHooks.onBefore((promise) => {});copy

import { promiseHooks } from 'node:v8';

const stop = promiseHooks.onAfter((promise) => {});const { promiseHooks } = require('node:v8');

const stop = promiseHooks.onAfter((promise) => {});copy

import { promiseHooks } from 'node:v8';

const stopAll = promiseHooks.createHook({
  init(promise, parent) {},
});const { promiseHooks } = require('node:v8');

const stopAll = promiseHooks.createHook({
  init(promise, parent) {},
});copy

启动快照 API#

v8.startupSnapshot 接口可用于为自定义启动快照添加序列化和反序列化钩子。

$ node --snapshot-blob snapshot.blob --build-snapshot entry.js
# This launches a process with the snapshot
$ node --snapshot-blob snapshot.blob copy

在上面的示例中，entry.js 可以使用 v8.startupSnapshot 接口中的方法来指定如何在序列化期间保存快照中自定义对象的信息，以及在反序列化快照期间如何使用这些信息来同步这些对象。例如，如果 entry.js 包含以下脚本：

'use strict';

const fs = require('node:fs');
const zlib = require('node:zlib');
const path = require('node:path');
const assert = require('node:assert');

const v8 = require('node:v8');

class BookShelf {
  storage = new Map();

  // Reading a series of files from directory and store them into storage.
  constructor(directory, books) {
    for (const book of books) {
      this.storage.set(book, fs.readFileSync(path.join(directory, book)));
    }
  }

  static compressAll(shelf) {
    for (const [ book, content ] of shelf.storage) {
      shelf.storage.set(book, zlib.gzipSync(content));
    }
  }

  static decompressAll(shelf) {
    for (const [ book, content ] of shelf.storage) {
      shelf.storage.set(book, zlib.gunzipSync(content));
    }
  }
}

// __dirname here is where the snapshot script is placed
// during snapshot building time.
const shelf = new BookShelf(__dirname, [
  'book1.en_US.txt',
  'book1.es_ES.txt',
  'book2.zh_CN.txt',
]);

assert(v8.startupSnapshot.isBuildingSnapshot());
// On snapshot serialization, compress the books to reduce size.
v8.startupSnapshot.addSerializeCallback(BookShelf.compressAll, shelf);
// On snapshot deserialization, decompress the books.
v8.startupSnapshot.addDeserializeCallback(BookShelf.decompressAll, shelf);
v8.startupSnapshot.setDeserializeMainFunction((shelf) => {
  // process.env and process.argv are refreshed during snapshot
  // deserialization.
  const lang = process.env.BOOK_LANG || 'en_US';
  const book = process.argv[1];
  const name = `${book}.${lang}.txt`;
  console.log(shelf.storage.get(name));
}, shelf); copy

最终生成的二进制文件将在启动时打印从快照反序列化的数据，使用启动进程的已刷新的 process.env 和 process.argv：

$ BOOK_LANG=es_ES node --snapshot-blob snapshot.blob book1
# Prints content of book1.es_ES.txt deserialized from the snapshot. copy

目前，从用户区快照反序列化的应用程序无法再次进行快照，因此这些 API 仅对那些不是从用户区快照反序列化的应用程序可用。

类：v8.GCProfiler#

此 API 在当前线程中收集 GC 数据。

{
  "version": 1,
  "startTime": 1674059033862,
  "statistics": [
    {
      "gcType": "Scavenge",
      "beforeGC": {
        "heapStatistics": {
          "totalHeapSize": 5005312,
          "totalHeapSizeExecutable": 524288,
          "totalPhysicalSize": 5226496,
          "totalAvailableSize": 4341325216,
          "totalGlobalHandlesSize": 8192,
          "usedGlobalHandlesSize": 2112,
          "usedHeapSize": 4883840,
          "heapSizeLimit": 4345298944,
          "mallocedMemory": 254128,
          "externalMemory": 225138,
          "peakMallocedMemory": 181760
        },
        "heapSpaceStatistics": [
          {
            "spaceName": "read_only_space",
            "spaceSize": 0,
            "spaceUsedSize": 0,
            "spaceAvailableSize": 0,
            "physicalSpaceSize": 0
          }
        ]
      },
      "cost": 1574.14,
      "afterGC": {
        "heapStatistics": {
          "totalHeapSize": 6053888,
          "totalHeapSizeExecutable": 524288,
          "totalPhysicalSize": 5500928,
          "totalAvailableSize": 4341101384,
          "totalGlobalHandlesSize": 8192,
          "usedGlobalHandlesSize": 2112,
          "usedHeapSize": 4059096,
          "heapSizeLimit": 4345298944,
          "mallocedMemory": 254128,
          "externalMemory": 225138,
          "peakMallocedMemory": 181760
        },
        "heapSpaceStatistics": [
          {
            "spaceName": "read_only_space",
            "spaceSize": 0,
            "spaceUsedSize": 0,
            "spaceAvailableSize": 0,
            "physicalSpaceSize": 0
          }
        ]
      }
    }
  ],
  "endTime": 1674059036865
} copy

const { GCProfiler } = require('node:v8');
const profiler = new GCProfiler();
profiler.start();
setTimeout(() => {
  console.log(profiler.stop());
}, 1000); copy

类：SyncCPUProfileHandle#

类：CPUProfileHandle#

类：HeapProfileHandle#

v8.isStringOneByteRepresentation(content)#

• content <string>
• 返回：<boolean>

V8 只支持 Latin-1/ISO-8859-1 和 UTF16 作为字符串的底层表示。如果 content 使用 Latin-1/ISO-8859-1 作为底层表示，此函数将返回 true；否则，返回 false。

如果此方法返回 false，并不意味着该字符串包含一些不在 Latin-1/ISO-8859-1 中的字符。有时一个 Latin-1 字符串也可能被表示为 UTF16。

const { isStringOneByteRepresentation } = require('node:v8');

const Encoding = {
  latin1: 1,
  utf16le: 2,
};
const buffer = Buffer.alloc(100);
function writeString(input) {
  if (isStringOneByteRepresentation(input)) {
    buffer.writeUint8(Encoding.latin1);
    buffer.writeUint32LE(input.length, 1);
    buffer.write(input, 5, 'latin1');
  } else {
    buffer.writeUint8(Encoding.utf16le);
    buffer.writeUint32LE(input.length * 2, 1);
    buffer.write(input, 5, 'utf16le');
  }
}
writeString('hello');
writeString('你好'); copy

v8.startCpuProfile()#

• 返回：<SyncCPUProfileHandle>

启动 CPU 分析，然后返回一个 SyncCPUProfileHandle 对象。此 API 支持 using 语法。

const handle = v8.startCpuProfile();
const profile = handle.stop();
console.log(profile); copy