Node.js v12.13.1 文档


vm(虚拟机)#

中英对照提交修改

稳定性: 2 - 稳定

vm 模块提供了在 V8 虚拟机上下文中编译和运行代码的一系列 API。vm 模块不是一个安全的虚拟机。不要用它来运行不受信任的代码。在这些文档中 "sanbox" 这个术语仅仅是为了表示一个单独的上下文,并不提供任何安全保障。

JavaScript 代码可以被编译并立即运行,也可以编译、保存,以后再运行。

一个常见的场景是在沙盒中运行代码。沙盒中的代码使用不同的 V8 上下文,这意味着它具有与其余代码不同的全局对象。

可以通过上下文隔离化一个沙箱对象来提供上下文。沙盒代码将沙盒中的任何属性视为全局对象。由沙盒代码引起的任何全局变量的更改都将反映到沙盒对象中。

const vm = require('vm');

const x = 1;

const sandbox = { x: 2 };
vm.createContext(sandbox); // 上下文隔离化一个沙盒。

const code = 'x += 40; var y = 17;';
// `x` and `y` 是沙盒环境中的全局变量。
// 最初,x 的值为 2,因为这是 sandbox.x 的值。
vm.runInContext(code, sandbox);

console.log(sandbox.x); // 42
console.log(sandbox.y); // 17

console.log(x); // 1; y 没有定义。

vm.Script 类#

中英对照提交修改

vm.Script类型的实例包含若干预编译的脚本,这些脚本能够在特定的沙箱(或者上下文)中被运行。

new vm.Script(code[, options])#

中英对照提交修改

  • code <string> 需要被解析的 JavaScript 代码。
  • options <Object> | <string>

    • filename <string> 定义供脚本生成的堆栈跟踪信息所使用的文件名。默认值: 'evalmachine.<anonymous>'
    • lineOffset <number> 定义脚本生成的堆栈跟踪信息所显示的行号偏移。默认值: 0
    • columnOffset <number> 定义脚本生成的堆栈跟踪信息所显示的列号偏移。默认值: 0
    • cachedData <Buffer> | <TypedArray> | <DataView> 为源码提供一个可选的存有 V8 代码缓存数据的 BufferTypedArrayTypedArray。 如果提供了,则 cachedDataRejected 的值将会被设为要么为 true 要么为 false,这取决于 v8 引擎对数据的接受状况。
    • produceCachedData <boolean> 当值为 truecachedData 不存在的时候,V8 将会试图为 code 生成代码缓存数据。 一旦成功,则一个有 V8 代码缓存数据的 Buffer 将会被生成和储存在返回的 vm.Script 实例的 cachedData 属性里。 cachedDataProduced 的值会被设置为 true 或者 false,这取决于代码缓存数据是否被成功生成。 不推荐使用此选项,而应该使用 script.createCachedData()默认值: false
    • importModuleDynamically <Function> 在调用 import() 时评估此模块期间调用。 如果未指定此选项,则对 import() 的调用将拒绝 ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING。 此选项是 --experimental-modules 标志的实验 API 的一部分,不应被视为稳定。

如果 options 是字符串,则它指定文件名。

创建一个新的 vm.Script 对象只编译 code 但不会执行它。 编译过的 vm.Script 此后可以被多次执行。 code 是不绑定于任何全局对象的,相反,它仅仅绑定于每次执行它的对象。

script.createCachedData()#

中英对照提交修改

创建一个可以被 Script 构造函数中 cachedData 选项使用的代码缓存。返回 Buffer。可以在任何时候不限次数地调用该方法。

const script = new vm.Script(`
function add(a, b) {
  return a + b;
}

const x = add(1, 2);
`);

const cacheWithoutX = script.createCachedData();

script.runInThisContext();

const cacheWithX = script.createCachedData();

script.runInContext(contextifiedSandbox[, options])#

中英对照提交修改

  • contextifiedSandbox <Object>vm.createContext() 返回的上下文隔离化的对象。
  • options <Object>

    • displayErrors <boolean> 当值为 true 的时候,假如在解析代码的时候发生错误 Error,引起错误的行将会被加入堆栈跟踪信息。默认值: true
    • timeout <integer> 定义在被终止执行之前此 code 被允许执行的最大毫秒数。假如执行被终止,将会抛出一个错误 Error。该值必须是严格正整数。
    • breakOnSigint <boolean> 若值为 true,当收到 SIGINT (Ctrl+C)事件时,代码会被终止执行。 此外,通过 process.on('SIGINT') 方法所设置的消息响应机制在代码被执行时会被屏蔽,但代码被终止后会被恢复。如果执行被终止,一个错误 Error 会被抛出。默认值: false
  • 返回: <any> 脚本中执行的最后一个语句的结果。

在指定的 contextifiedSandbox 中执行 vm.Script 对象中被编译后的代码并返回其结果。被执行的代码无法获取本地作用域。

以下的例子会编译一段代码,该代码会递增一个全局变量,给另外一个全局变量赋值。同时该代码被编译后会被多次执行。全局变量会被置于 sandbox 对象内。

const util = require('util');
const vm = require('vm');

const sandbox = {
  animal: 'cat',
  count: 2
};

const script = new vm.Script('count += 1; name = "kitty";');

const context = vm.createContext(sandbox);
for (let i = 0; i < 10; ++i) {
  script.runInContext(context);
}

console.log(util.inspect(sandbox));

// { animal: 'cat', count: 12, name: 'kitty' }

使用 timeout 或者 breakOnSigint 选项会导致若干新的事件循环以及对应的线程,这有一个非零的性能消耗。

script.runInNewContext([sandbox[, options]])#

中英对照提交修改

  • sandbox <Object> 一个将会被上下文隔离化的对象。如果是 undefined, 则会生成一个新的对象。
  • options <Object>

    • displayErrors <boolean> 当值为 true 的时候,假如在解析代码的时候发生错误 Error,引起错误的行将会被加入堆栈跟踪信息。默认值: true
    • timeout <integer> 定义在被终止执行之前此 code 被允许执行的最大毫秒数。假如执行被终止,将会抛出一个错误 Error。该值必须是严格正整数。
    • breakOnSigint <boolean> 若值为 true,当收到 SIGINT (Ctrl+C)事件时,代码会被终止执行。 此外,通过 process.on('SIGINT') 方法所设置的消息响应机制在代码被执行时会被屏蔽,但代码被终止后会被恢复。如果执行被终止,一个错误 Error 会被抛出。默认值: false
    • contextName <string> 新创建的上下文的人类可读名称。 默认值: 'VM Context i',其中 i 是创建的上下文的升序数字索引。
    • contextOrigin <string> 对应于新创建用于显示目的的上下文的原点。 原点应格式化为类似一个 URL,但只包含协议,主机和端口(如果需要),例如 URL 对象的 url.origin 属性的值。 最值得注意的是,此字符串应省略尾部斜杠,因为它表示路径。 默认值: ''
    • contextCodeGeneration <Object>

      • strings <boolean> 如果设置为 false,则对 eval 或函数构造函数(FunctionGeneratorFunction 等)的任何调用都将抛出 EvalError默认值: true
      • wasm <boolean> 如果设置为 false,则任何编译 WebAssembly 模块的尝试都将抛出 WebAssembly.CompileError默认值: true
  • 返回: <any> 脚本中执行的最后一个语句的结果。

首先给指定的 sandbox 提供一个隔离的上下文, 再在此上下文中执行 vm.Script 中被编译的代码,最后返回结果。运行中的代码无法获取本地作用域。

以下的例子会编译一段代码,该代码会递增一个全局变量,给另外一个全局变量赋值。同时该代码被编译后会被多次执行。全局变量会被置于各个独立的 sandbox 对象内。

const util = require('util');
const vm = require('vm');

const script = new vm.Script('globalVar = "set"');

const sandboxes = [{}, {}, {}];
sandboxes.forEach((sandbox) => {
  script.runInNewContext(sandbox);
});

console.log(util.inspect(sandboxes));

// [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }]

script.runInThisContext([options])#

中英对照提交修改

  • options <Object>

    • displayErrors <boolean> 当值为 true 的时候,假如在解析代码的时候发生错误 Error,引起错误的行将会被加入堆栈跟踪信息。默认值: true
    • timeout <integer> 定义在被终止执行之前此 code 被允许执行的最大毫秒数。假如执行被终止,将会抛出一个错误 Error。该值必须是严格正整数。
    • breakOnSigint <boolean> 若值为 true,当收到 SIGINT (Ctrl+C)事件时,代码会被终止执行。 此外,通过 process.on('SIGINT') 方法所设置的消息响应机制在代码被执行时会被屏蔽,但代码被终止后会被恢复。如果执行被终止,一个错误 Error 会被抛出。默认值: false
  • 返回: <any> 脚本中执行的最后一个语句的结果。

在指定的 global 对象的上下文中执行 vm.Script 对象里被编译的代码并返回其结果。被执行的代码虽然无法获取本地作用域,但是能获取 global 对象。

以下的例子会编译一段代码,该代码会递增一个 global 变量。同时该代码被编译后会被多次执行。

const vm = require('vm');

global.globalVar = 0;

const script = new vm.Script('globalVar += 1', { filename: 'myfile.vm' });

for (let i = 0; i < 1000; ++i) {
  script.runInThisContext();
}

console.log(globalVar);

// 1000

vm.SourceTextModule 类#

暂无中英对照

稳定性: 1 - 试验

This feature is only available with the --experimental-vm-modules command flag enabled.

The vm.SourceTextModule class provides a low-level interface for using ECMAScript modules in VM contexts. It is the counterpart of the vm.Script class that closely mirrors Source Text Module Records as defined in the ECMAScript specification.

Unlike vm.Script however, every vm.SourceTextModule object is bound to a context from its creation. Operations on vm.SourceTextModule objects are intrinsically asynchronous, in contrast with the synchronous nature of vm.Script objects. With the help of async functions, however, manipulating vm.SourceTextModule objects is fairly straightforward.

Using a vm.SourceTextModule object requires three distinct steps: creation/parsing, linking, and evaluation. These three steps are illustrated in the following example.

This implementation lies at a lower level than the ECMAScript Module loader. There is also currently no way to interact with the Loader, though support is planned.

const vm = require('vm');

const contextifiedSandbox = vm.createContext({ secret: 42 });

(async () => {
  // Step 1
  //
  // Create a Module by constructing a new `vm.SourceTextModule` object. This
  // parses the provided source text, throwing a `SyntaxError` if anything goes
  // wrong. By default, a Module is created in the top context. But here, we
  // specify `contextifiedSandbox` as the context this Module belongs to.
  //
  // Here, we attempt to obtain the default export from the module "foo", and
  // put it into local binding "secret".

  const bar = new vm.SourceTextModule(`
    import s from 'foo';
    s;
  `, { context: contextifiedSandbox });

  // Step 2
  //
  // "Link" the imported dependencies of this Module to it.
  //
  // The provided linking callback (the "linker") accepts two arguments: the
  // parent module (`bar` in this case) and the string that is the specifier of
  // the imported module. The callback is expected to return a Module that
  // corresponds to the provided specifier, with certain requirements documented
  // in `module.link()`.
  //
  // If linking has not started for the returned Module, the same linker
  // callback will be called on the returned Module.
  //
  // Even top-level Modules without dependencies must be explicitly linked. The
  // callback provided would never be called, however.
  //
  // The link() method returns a Promise that will be resolved when all the
  // Promises returned by the linker resolve.
  //
  // Note: This is a contrived example in that the linker function creates a new
  // "foo" module every time it is called. In a full-fledged module system, a
  // cache would probably be used to avoid duplicated modules.

  async function linker(specifier, referencingModule) {
    if (specifier === 'foo') {
      return new vm.SourceTextModule(`
        // The "secret" variable refers to the global variable we added to
        // "contextifiedSandbox" when creating the context.
        export default secret;
      `, { context: referencingModule.context });

      // Using `contextifiedSandbox` instead of `referencingModule.context`
      // here would work as well.
    }
    throw new Error(`Unable to resolve dependency: ${specifier}`);
  }
  await bar.link(linker);

  // Step 3
  //
  // Evaluate the Module. The evaluate() method returns a Promise with a single
  // property "result" that contains the result of the very last statement
  // executed in the Module. In the case of `bar`, it is `s;`, which refers to
  // the default export of the `foo` module, the `secret` we set in the
  // beginning to 42.

  const { result } = await bar.evaluate();

  console.log(result);
  // Prints 42.
})();

new vm.SourceTextModule(code[, options])#

暂无中英对照

  • code <string> JavaScript Module code to parse
  • options

    • identifier <string> String used in stack traces. Default: 'vm:module(i)' where i is a context-specific ascending index.
    • context <Object> The contextified object as returned by the vm.createContext() method, to compile and evaluate this Module in.
    • lineOffset <integer> Specifies the line number offset that is displayed in stack traces produced by this Module. Default: 0.
    • columnOffset <integer> Specifies the column number offset that is displayed in stack traces produced by this Module. Default: 0.
    • initializeImportMeta <Function> Called during evaluation of this Module to initialize the import.meta.

    • importModuleDynamically <Function> Called during evaluation of this module when import() is called. If this option is not specified, calls to import() will reject with ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING.

Creates a new ES Module object.

Properties assigned to the import.meta object that are objects may allow the Module to access information outside the specified context, if the object is created in the top level context. Use vm.runInContext() to create objects in a specific context.

const vm = require('vm');

const contextifiedSandbox = vm.createContext({ secret: 42 });

(async () => {
  const module = new vm.SourceTextModule(
    'Object.getPrototypeOf(import.meta.prop).secret = secret;',
    {
      initializeImportMeta(meta) {
        // Note: this object is created in the top context. As such,
        // Object.getPrototypeOf(import.meta.prop) points to the
        // Object.prototype in the top context rather than that in
        // the sandbox.
        meta.prop = {};
      }
    });
  // Since module has no dependencies, the linker function will never be called.
  await module.link(() => {});
  await module.evaluate();

  // Now, Object.prototype.secret will be equal to 42.
  //
  // To fix this problem, replace
  //     meta.prop = {};
  // above with
  //     meta.prop = vm.runInContext('{}', contextifiedSandbox);
})();

module.dependencySpecifiers#

暂无中英对照

The specifiers of all dependencies of this module. The returned array is frozen to disallow any changes to it.

Corresponds to the [[RequestedModules]] field of Source Text Module Records in the ECMAScript specification.

module.error#

暂无中英对照

If the module.status is 'errored', this property contains the exception thrown by the module during evaluation. If the status is anything else, accessing this property will result in a thrown exception.

The value undefined cannot be used for cases where there is not a thrown exception due to possible ambiguity with throw undefined;.

Corresponds to the [[EvaluationError]] field of Source Text Module Records in the ECMAScript specification.

module.evaluate([options])#

暂无中英对照

  • options <Object>

    • timeout <integer> Specifies the number of milliseconds to evaluate before terminating execution. If execution is interrupted, an Error will be thrown. This value must be a strictly positive integer.
    • breakOnSigint <boolean> If true, the execution will be terminated when SIGINT (Ctrl+C) is received. Existing handlers for the event that have been attached via process.on('SIGINT') will be disabled during script execution, but will continue to work after that. If execution is interrupted, an Error will be thrown. Default: false.
  • Returns: <Promise>

Evaluate the module.

This must be called after the module has been linked; otherwise it will throw an error. It could be called also when the module has already been evaluated, in which case it will do one of the following two things:

  • return undefined if the initial evaluation ended in success (module.status is 'evaluated')
  • rethrow the same exception the initial evaluation threw if the initial evaluation ended in an error (module.status is 'errored')

This method cannot be called while the module is being evaluated (module.status is 'evaluating') to prevent infinite recursion.

Corresponds to the Evaluate() concrete method field of Source Text Module Records in the ECMAScript specification.

module.link(linker)#

暂无中英对照

Link module dependencies. This method must be called before evaluation, and can only be called once per module.

The function is expected to return a Module object or a Promise that eventually resolves to a Module object. The returned Module must satisfy the following two invariants:

  • It must belong to the same context as the parent Module.
  • Its status must not be 'errored'.

If the returned Module's status is 'unlinked', this method will be recursively called on the returned Module with the same provided linker function.

link() returns a Promise that will either get resolved when all linking instances resolve to a valid Module, or rejected if the linker function either throws an exception or returns an invalid Module.

The linker function roughly corresponds to the implementation-defined HostResolveImportedModule abstract operation in the ECMAScript specification, with a few key differences:

The actual HostResolveImportedModule implementation used during module linking is one that returns the modules linked during linking. Since at that point all modules would have been fully linked already, the HostResolveImportedModule implementation is fully synchronous per specification.

Corresponds to the Link() concrete method field of Source Text Module Records in the ECMAScript specification.

module.namespace#

暂无中英对照

The namespace object of the module. This is only available after linking (module.link()) has completed.

Corresponds to the GetModuleNamespace abstract operation in the ECMAScript specification.

module.status#

暂无中英对照

The current status of the module. Will be one of:

  • 'unlinked': module.link() has not yet been called.

  • 'linking': module.link() has been called, but not all Promises returned by the linker function have been resolved yet.

  • 'linked': The module has been linked successfully, and all of its dependencies are linked, but module.evaluate() has not yet been called.

  • 'evaluating': The module is being evaluated through a module.evaluate() on itself or a parent module.

  • 'evaluated': The module has been successfully evaluated.

  • 'errored': The module has been evaluated, but an exception was thrown.

Other than 'errored', this status string corresponds to the specification's Source Text Module Record's [[Status]] field. 'errored' corresponds to 'evaluated' in the specification, but with [[EvaluationError]] set to a value that is not undefined.

module.identifier#

暂无中英对照

The identifier of the current module, as set in the constructor.

vm.compileFunction(code[, params[, options]])#

中英对照提交修改

  • code <string> 需要编译的函数体。
  • params <string[]> 包含所有函数参数的字符串数组。
  • options <Object>

    • filename <string> 定义此脚本生成的堆栈跟踪信息中使用的文件名。 默认值: ''
    • lineOffset <number> 定义此脚本生成的堆栈跟踪信息中显示的行号偏移量。默认值: 0
    • columnOffset <number> 定义此脚本生成的堆栈跟踪中显示的列偏移量。 默认值: 0
    • cachedData <Buffer> | <TypedArray> | <DataView> 为源码提供一个 BufferTypedArrayDataView 格式的 V8 代码缓存。
    • produceCachedData <boolean> 定义是否需要生成新的缓存数据。默认值: false
    • parsingContext <Object> 编译函数的上下文隔离化的沙箱。
    • contextExtensions <Object[]> 包含要在编译时应用的上下文扩展(包装当前范围的对象)的集合的数组。默认值: []
  • 返回: <Function>

将给定的代码编译到提供的上下文/沙箱中(如果没有提供上下文,则使用当前上下文),并返回包装了给定 params 的函数。

vm.createContext([sandbox[, options]])#

中英对照提交修改

  • sandbox <Object>
  • options <Object>

    • name <string> 新创建的上下文的人类可读名称。 默认值: 'VM Context i',其中 i 是创建的上下文的升序数字索引。
    • origin <string> 对应于新创建用于显示目的的上下文的原点。 原点应格式化为类似一个 URL,但只包含协议,主机和端口(如果需要),例如 URL 对象的 url.origin 属性的值。 最值得注意的是,此字符串应省略尾部斜杠,因为它表示路径。 默认值: ''
    • codeGeneration <Object>

      • strings <boolean> 如果设置为 false,则对 eval 或函数构造函数(FunctionGeneratorFunction 等)的任何调用都将抛出 EvalError默认值: true
      • wasm <boolean> 如果设置为 false,则任何编译 WebAssembly 模块的尝试都将抛出 WebAssembly.CompileError默认值: true
  • 返回: <Object> 上下文隔离化的沙盒。

给定一个 sandbox 对象, vm.createContext()设置此沙盒,从而让它具备在 vm.runInContext() 或者 script.runInContext() 中被使用的能力。 对于此二方法中所调用的脚本,他们的全局对象不仅拥有我们提供的 sandbox 对象的所有属性,同时还有任何全局对象所拥有的属性。 对于这些脚本之外的所有代码,他们的全局变量将保持不变。

const util = require('util');
const vm = require('vm');

global.globalVar = 3;

const sandbox = { globalVar: 1 };
vm.createContext(sandbox);

vm.runInContext('globalVar *= 2;', sandbox);

console.log(util.inspect(sandbox)); // { globalVar: 2 }

console.log(util.inspect(globalVar)); // 3

如果未提供 sandbox(或者传入undefined),那么会返回一个全新的空的上下文隔离化后的 sandbox 对象。

vm.createContext() 主要是用于创建一个能运行多个脚本的沙盒。 比如说,在模拟一个网页浏览器时,此方法可以被用于创建一个单独的沙盒来代表一个窗口的全局对象,然后所有的 <script> 标签都可以在这个沙盒的上下文中运行。

通过 Inspector API 可以看到提供的上下文的 nameorigin

vm.isContext(sandbox)#

中英对照提交修改

当给定的 sandbox 对象已经被 vm.createContext() 上下文隔离化,则返回 true

vm.runInContext(code, contextifiedSandbox[, options])#

中英对照提交修改

  • code <string> 将被编译和运行的 JavaScript 代码。
  • contextifiedSandbox <Object> 一个被上下文隔离化过的对象,会在 code 被编译和执行之后充当 global 对象。
  • options <Object> | <string>

    • filename <string> 定义供脚本生成的堆栈跟踪信息所使用的文件名。默认值: 'evalmachine.<anonymous>'
    • lineOffset <number> 定义脚本生成的堆栈跟踪信息所显示的行号偏移。默认值: 0
    • columnOffset <number> 定义脚本生成的堆栈跟踪信息所显示的列号偏移。默认值: 0
    • displayErrors <boolean> 当值为 true 的时候,假如在解析代码的时候发生错误 Error,引起错误的行将会被加入堆栈跟踪信息。默认值: true
    • timeout <integer> 定义在被终止执行之前此 code 被允许执行的最大毫秒数。假如执行被终止,将会抛出一个错误 Error。该值必须是严格正整数。
    • breakOnSigint <boolean> 若值为 true,当收到 SIGINT (Ctrl+C)事件时,代码会被终止执行。 此外,通过 process.on('SIGINT') 方法所设置的消息响应机制在代码被执行时会被屏蔽,但代码被终止后会被恢复。如果执行被终止,一个错误 Error 会被抛出。默认值: false
    • cachedData <Buffer> | <TypedArray> | <DataView> 为源码提供一个可选的存有 V8 代码缓存数据的 BufferTypedArrayTypedArray。 如果提供了,则 cachedDataRejected 的值将会被设为要么为 true 要么为 false,这取决于 v8 引擎对数据的接受状况。
    • produceCachedData <boolean> 当值为 truecachedData 不存在的时候,V8 将会试图为 code 生成代码缓存数据。 一旦成功,则一个有 V8 代码缓存数据的 Buffer 将会被生成和储存在返回的 vm.Script 实例的 cachedData 属性里。 cachedDataProduced 的值会被设置为 true 或者 false,这取决于代码缓存数据是否被成功生成。 不推荐使用此选项,而应该使用 script.createCachedData()默认值: false
    • importModuleDynamically <Function> 在调用 import() 时评估此模块期间调用。 如果未指定此选项,则对 import() 的调用将拒绝 ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING。 此选项是 --experimental-modules 标志的实验 API 的一部分,不应被视为稳定。

  • 返回: <any> 脚本中执行的最后一个语句的结果。

vm.runInContext() 方法会编译 code,然后在指定的 contextifiedSandbox 的上下文里执行它并返回其结果。 被执行的代码无法获取本地作用域。 contextifiedSandbox 必须是事先被 vm.createContext() 方法上下文隔离化过的对象。

如果 options 是字符串,则它指定文件名。

以下例子使用一个单独的上下文隔离化过的对象来编译并运行几个不同的脚本:

const util = require('util');
const vm = require('vm');

const sandbox = { globalVar: 1 };
vm.createContext(sandbox);

for (let i = 0; i < 10; ++i) {
  vm.runInContext('globalVar *= 2;', sandbox);
}
console.log(util.inspect(sandbox));

// { globalVar: 1024 }

vm.runInNewContext(code[, sandbox[, options]])#

中英对照提交修改

  • code <string> 将被编译和运行的 JavaScript 代码。
  • sandbox <Object> 一个将会被上下文隔离化的对象。如果是 undefined, 则会生成一个新的对象。
  • options <Object> | <string>

    • filename <string> 定义供脚本生成的堆栈跟踪信息所使用的文件名。默认值: 'evalmachine.<anonymous>'
    • lineOffset <number> 定义脚本生成的堆栈跟踪信息所显示的行号偏移。默认值: 0
    • columnOffset <number> 定义脚本生成的堆栈跟踪信息所显示的列号偏移。默认值: 0
    • displayErrors <boolean> 当值为 true 的时候,假如在解析代码的时候发生错误 Error,引起错误的行将会被加入堆栈跟踪信息。默认值: true
    • timeout <integer> 定义在被终止执行之前此 code 被允许执行的最大毫秒数。假如执行被终止,将会抛出一个错误 Error。该值必须是严格正整数。
    • breakOnSigint <boolean> 若值为 true,当收到 SIGINT (Ctrl+C)事件时,代码会被终止执行。 此外,通过 process.on('SIGINT') 方法所设置的消息响应机制在代码被执行时会被屏蔽,但代码被终止后会被恢复。如果执行被终止,一个错误 Error 会被抛出。默认值: false
    • contextName <string> 新创建的上下文的人类可读名称。 默认值: 'VM Context i',其中 i 是创建的上下文的升序数字索引。
    • contextOrigin <string> 对应于新创建用于显示目的的上下文的原点。 原点应格式化为类似一个 URL,但只包含协议,主机和端口(如果需要),例如 URL 对象的 url.origin 属性的值。 最值得注意的是,此字符串应省略尾部斜杠,因为它表示路径。 默认值: ''
    • contextCodeGeneration <Object>

      • strings <boolean> 如果设置为 false,则对 eval 或函数构造函数(FunctionGeneratorFunction 等)的任何调用都将抛出 EvalError默认值: true
      • wasm <boolean> 如果设置为 false,则任何编译 WebAssembly 模块的尝试都将抛出 WebAssembly.CompileError默认值: true
    • cachedData <Buffer> | <TypedArray> | <DataView> 为源码提供一个可选的存有 V8 代码缓存数据的 BufferTypedArrayTypedArray。 如果提供了,则 cachedDataRejected 的值将会被设为要么为 true 要么为 false,这取决于 v8 引擎对数据的接受状况。
    • produceCachedData <boolean> 当值为 truecachedData 不存在的时候,V8 将会试图为 code 生成代码缓存数据。 一旦成功,则一个有 V8 代码缓存数据的 Buffer 将会被生成和储存在返回的 vm.Script 实例的 cachedData 属性里。 cachedDataProduced 的值会被设置为 true 或者 false,这取决于代码缓存数据是否被成功生成。 不推荐使用此选项,而应该使用 script.createCachedData()默认值: false
    • importModuleDynamically <Function> 在调用 import() 时评估此模块期间调用。 如果未指定此选项,则对 import() 的调用将拒绝 ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING。 此选项是 --experimental-modules 标志的实验 API 的一部分,不应被视为稳定。

  • 返回: <any> 脚本中执行的最后一个语句的结果。

vm.runInNewContext() 首先给指定的 sandbox(若为 undefined,则会新建一个sandbox)提供一个隔离的上下文, 再在此上下文中执行编译的 code,最后返回结果。 运行中的代码无法获取本地作用域。

如果 options 是字符串,则它指定文件名。

以下的例子会编译一段代码,该代码会递增一个全局变量,给另外一个全局变量赋值。同时该代码被编译后会被多次执行。全局变量会被置于 sandbox 对象内。

const util = require('util');
const vm = require('vm');

const sandbox = {
  animal: 'cat',
  count: 2
};

vm.runInNewContext('count += 1; name = "kitty"', sandbox);
console.log(util.inspect(sandbox));

// { animal: 'cat', count: 3, name: 'kitty' }

vm.runInThisContext(code[, options])#

中英对照提交修改

  • code <string> 将被编译和运行的 JavaScript 代码。
  • options <Object> | <string>

    • filename <string> 定义供脚本生成的堆栈跟踪信息所使用的文件名。默认值: 'evalmachine.<anonymous>'
    • lineOffset <number> 定义脚本生成的堆栈跟踪信息所显示的行号偏移。默认值: 0
    • columnOffset <number> 定义脚本生成的堆栈跟踪信息所显示的列号偏移。默认值: 0
    • displayErrors <boolean> 当值为 true 的时候,假如在解析代码的时候发生错误 Error,引起错误的行将会被加入堆栈跟踪信息。默认值: true
    • timeout <integer> 定义在被终止执行之前此 code 被允许执行的最大毫秒数。假如执行被终止,将会抛出一个错误 Error。该值必须是严格正整数。
    • breakOnSigint <boolean> 若值为 true,当收到 SIGINT (Ctrl+C)事件时,代码会被终止执行。 此外,通过 process.on('SIGINT') 方法所设置的消息响应机制在代码被执行时会被屏蔽,但代码被终止后会被恢复。如果执行被终止,一个错误 Error 会被抛出。默认值: false
    • cachedData <Buffer> | <TypedArray> | <DataView> 为源码提供一个可选的存有 V8 代码缓存数据的 BufferTypedArrayTypedArray。 如果提供了,则 cachedDataRejected 的值将会被设为要么为 true 要么为 false,这取决于 v8 引擎对数据的接受状况。
    • produceCachedData <boolean> 当值为 truecachedData 不存在的时候,V8 将会试图为 code 生成代码缓存数据。 一旦成功,则一个有 V8 代码缓存数据的 Buffer 将会被生成和储存在返回的 vm.Script 实例的 cachedData 属性里。 cachedDataProduced 的值会被设置为 true 或者 false,这取决于代码缓存数据是否被成功生成。 不推荐使用此选项,而应该使用 script.createCachedData()默认值: false
    • importModuleDynamically <Function> 在调用 import() 时评估此模块期间调用。 如果未指定此选项,则对 import() 的调用将拒绝 ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING。 此选项是 --experimental-modules 标志的实验 API 的一部分,不应被视为稳定。

  • 返回: <any> 脚本中执行的最后一个语句的结果。

vm.runInThisContext() 在当前的 global 对象的上下文中编译并执行 code,最后返回结果。 运行中的代码无法获取本地作用域,但可以获取当前的 global 对象。

如果 options 是字符串,则它指定文件名。

下面的例子演示了使用 vm.runInThisContext() 和 JavaScript 的 eval() 方法去执行相同的一段代码:

const vm = require('vm');
let localVar = 'initial value';

const vmResult = vm.runInThisContext('localVar = "vm";');
console.log('vmResult:', vmResult);
console.log('localVar:', localVar);

const evalResult = eval('localVar = "eval";');
console.log('evalResult:', evalResult);
console.log('localVar:', localVar);

// vmResult: 'vm', localVar: 'initial value'
// evalResult: 'eval', localVar: 'eval'

正因 vm.runInThisContext() 无法获取本地作用域,故 localVar 的值不变。 相反,eval() 确实能获取本地作用域,所以 localVar 的值被改变了。 如此看来, vm.runInThisContext() 更像是间接的执行 eval(), 就像 (0,eval)('code')

示例:在 VM 中运行 HTTP Server#

中英对照提交修改

在使用 script.runInThisContext() 或者 vm.runInThisContext() 时,目标代码是在当前的V8全局对象的上下文中执行的。被传入此虚拟机上下文的目标代码会有自己独立的作用域。

要想用 http 模块搭建一个简易的服务器,被传入的代码必须要么自己执行 require('http'),要么引用一个 http,比如:

'use strict';
const vm = require('vm');

const code = `
((require) => {
  const http = require('http');

  http.createServer((request, response) => {
    response.writeHead(200, { 'Content-Type': 'text/plain' });
    response.end('你好世界\\n');
  }).listen(8124);

  console.log('服务器运行在 http://127.0.0.1:8124/');
})`;

vm.runInThisContext(code)(require);

上述例子中的 require() 和导出它的上下文共享状态。这在运行未经认证的代码时可能会引入风险,比如在不理想的情况下修改上下文中的对象。

上下文隔离化一个对象意味着什么?#

中英对照提交修改

所有用 Node.js 所运行的 JavaScript 代码都是在一个“上下文”的作用域中被执行的。 根据 V8 嵌入式指南

在 V8 中,一个上下文是一个执行环境,它允许分离的,无关的 JavaScript 应用在一个 V8 的单例中被运行。 必须明确地指定用于运行所有 JavaScript 代码的上下文。

当调用 vm.createContext() 时,传入的 sandbox 对象(或者新建的一个 sandbox 对象,若原 sandboxundefined)在底层会和一个新的V8上下文实例联系上。 这个 V8 上下文在一个隔离的全局环境中,使用 vm 模块的方法运行 code。 创建 V8 上下文和使之联系上 sandbox 的过程在此文档中被称作为"上下文隔离化" sandbox

当使用 process.nextTick()、Promise 和 queueMicrotask() 时的超时限制#

中英对照提交修改

由于在 V8 和 Node.js 中实现了 process.nextTick() 队列和作为 Promise 基础的微任务队列的内部机制,因此在上下文中运行的代码可以使用 vm.runInContext()vm.runInNewContext()vm.runInThisContext() 转义 timeout

例如, vm.runInNewContext() 执行的以下代码(超时为 5 毫秒)会在 promise 解决后调度无限循环。 调度的循环永远不会被超时中断:

const vm = require('vm');

function loop() {
  while (1) console.log(Date.now());
}

vm.runInNewContext(
  'Promise.resolve().then(loop);',
  { loop, console },
  { timeout: 5 }
);

使用 process.nextTick()queueMicrotask() 函数调度 loop() 调用时也会发生此问题。

出现此问题是因为所有上下文共享相同的微任务和 nextTick 队列。