Node.js 虛擬機

穩(wěn)定性: 3 - 穩(wěn)定

本節(jié)介紹了Node.js的虛擬機（VM）模塊，該模塊提供了用于在V8虛擬機上下文中編譯和運行代碼的API。

可以通過以下方法訪問該模塊：

var vm = require('vm');

JavaScript 可以立即編譯立即執(zhí)行，也可以編譯，保存，之后再運行。

vm.runInThisContext(code[, options])

vm.runInThisContext()對參數(shù)code編譯，運行并返回結(jié)果。運行的代碼沒有權(quán)限訪問本地作用域（local scope），但是可以訪問全局對象。

使用vm.runInThisContext和eval方法運行同樣代碼的例子：

var localVar = 'initial value';

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

var 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用起來很像間接調(diào)用eval，比如(0,eval)('code')。但是，vm.runInThisContext也包含以下選項：

• filename: 允許更改顯示在站追蹤（stack traces）的文件名。
• displayErrors: 是否在stderr上打印錯誤，拋出異常的代碼行高亮顯示。會捕獲編譯時的語法錯誤，和執(zhí)行時拋出的錯誤。默認(rèn)為true。
• timeout: 中斷前代碼執(zhí)行的毫秒數(shù)。如果執(zhí)行終止，將會拋出錯誤。

vm.createContext([sandbox])

如果參數(shù)sandbox不為空，調(diào)用vm.runInContext或script.runInContext時可以調(diào)用沙箱的上下文。以此方式運行的腳本，sandbox是全局對象，它保留自己的屬性同時擁有標(biāo)準(zhǔn)全局對象（global object）擁有的內(nèi)置對象和函數(shù)。

如果參數(shù)sandbox對象為空，返回一個可用的新且空的上下文相關(guān)的沙盒對象。

這個函數(shù)對于創(chuàng)建一個可運行多腳本的沙盒非常有用。比如，在模擬瀏覽器的時候可以使用該函數(shù)創(chuàng)建一個用于表示window全局對象的沙箱，并將所有<script>標(biāo)簽放入沙箱執(zhí)行。

vm.isContext(sandbox)

沙箱對象是否已經(jīng)通過調(diào)用vm.createContext上下文化。

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

vm.runInContext編譯代碼，運行在contextifiedSandbox并返回結(jié)果。運行代碼不能訪問本地域。contextifiedSandbox對象必須通過 vm.createContext上下文化；code 會通過全局變量使用它。

vm.runInContext和vm.runInThisContext參數(shù)相同。

在同一個上下文中編譯并執(zhí)行不同的腳本，例子：

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

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

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

// { globalVar: 1024 }

注意，執(zhí)行不被信任的代碼是需要技巧且要非常的小心。vm.runInContext非常有用，不過想要安全些，最好還是在獨立的進程里運行不被信任的代碼。

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

vm.runInNewContext編譯代碼, 如果提供了sandbox ，則將sandbox上下文化，否則創(chuàng)建一個新的上下文化過的沙盒，將沙盒作為全局變量運行代碼并返回結(jié)果。

vm.runInNewContext和vm.runInThisContext參數(shù)相同。

編譯并執(zhí)行代碼，增加全局變量值，并設(shè)置一個新的。這些全局變量包含在一個新的沙盒里。

var util = require('util');
var vm = require('vm'),

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

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

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

注意，執(zhí)行不被信任的代碼是需要技巧且要非常的小心。vm.runInNewContext非常有用，不過想要安全些，最好還是在獨立的進程里運行不被信任的代碼。

vm.runInDebugContext(code)

vm.runInDebugContext在V8的調(diào)試上下文中編譯并執(zhí)行。最主要的應(yīng)用場景是獲得V8調(diào)試對象訪問權(quán)限。

var Debug = vm.runInDebugContext('Debug');
Debug.scripts().forEach(function(script) { console.log(script.name); });

注意，調(diào)試上下文和對象內(nèi)部綁定到V8的調(diào)試實現(xiàn)里，并可能在沒有警告時改變（或移除）。

可以通過--expose_debug_as=開關(guān)暴露調(diào)試對象。

Class: Script

包含預(yù)編譯腳本的類，并在指定的沙盒里執(zhí)行。

new vm.Script(code, options)

創(chuàng)建一個新的腳本編譯代碼，但是不運行。使用被創(chuàng)建的vm.Script來表示編譯完的代碼。這個代碼可以使用以下的方法調(diào)用多次。返回的腳本沒有綁定到任何全局變量。在運行前綁定，執(zhí)行后釋放。

創(chuàng)建腳本的選項有:

• filename: 允許更改顯示在站追蹤（stack traces）的文件名。
• displayErrors: 是否在stderr上打印錯誤，拋出異常的代碼行高亮顯示。只會捕獲編譯時的語法錯誤，執(zhí)行時拋出的錯誤由腳本的方法的選項來控制。默認(rèn)為 true。

script.runInThisContext([options])

和vm.runInThisContext類似，只是作為Script腳本對象的預(yù)編譯方法。script.runInThisContext執(zhí)行編譯過的腳本并返回結(jié)果。被運行的代碼沒有本地作用域訪問權(quán)限，但是擁有權(quán)限訪問全局對象。

以下例子，使用script.runInThisContext編譯代碼一次，并運行多次：

var vm = require('vm');

global.globalVar = 0;

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

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

console.log(globalVar);

// 1000

所運行的代碼選項：

• displayErrors: 是否在stderr上打印錯誤，拋出異常的代碼行高亮顯示。僅適用于執(zhí)行時拋出的錯誤。不能創(chuàng)建一個語法錯誤的Script實例，因為構(gòu)造函數(shù)會拋出。
• timeout: 中斷前代碼執(zhí)行的毫秒數(shù)。如果執(zhí)行終止，將會拋出錯誤。

script.runInContext(contextifiedSandbox[, options])

和vm.runInContext類似，只是作為預(yù)編譯的Script對象方法。script.runInContext運行腳本（在contextifiedSandbox中編譯）并返回結(jié)果。運行的代碼沒有權(quán)限訪問本地域。

script.runInContext的選項和script.runInThisContext類似。

例子：編譯一段代碼，并執(zhí)行多次，這段代碼實現(xiàn)了一個全局變量的自增，并創(chuàng)建一個新的全局變量。這些全局變量保存在沙盒里。

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

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

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

for (var i = 0; i < 10; ++i) {
  script.runInContext(sandbox);
}

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

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

注意，執(zhí)行不被信任的代碼是需要技巧且要非常的小心。script.runInContext非常有用，不過想要安全些，最好還是在獨立的進程里運行不被信任的代碼。

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

和vm.runInNewContext類似，只是作為預(yù)編譯的Script對象方法。若提供sandbox則script.runInNewContext將sandbox上下文化，若未提供，則創(chuàng)建一個新的上下文化的沙箱。

script.runInNewContext和script.runInThisContext的參數(shù)類似。

例子：編譯代碼（設(shè)置了一個全局變量）并在不同的上下文里執(zhí)行多次。這些全局變量會被保存在沙箱中。

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

var sandboxes = [{}, {}, {}];

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

sandboxes.forEach(function (sandbox) {
  script.runInNewContext(sandbox);
});

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

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

注意，執(zhí)行不被信任的代碼是需要技巧且要非常的小心。script.runInNewContext非常有用，不過想要安全些，最好還是在獨立的進程里運行不被信任的代碼。