将脚本迁移到 V8 运行时

如果您有使用 Rhino 运行时的现有脚本，并且想要使用 V8 语法和功能，则必须将脚本迁移到 V8。

使用 Rhino 运行时编写的大多数脚本都可以使用 V8 运行时运行，无需调整。通常，向脚本添加 V8 语法和功能的唯一前提是启用 V8 运行时。

不过，存在一小部分不兼容性和其他差异，可能会导致脚本在启用 V8 运行时后失败或行为异常。在将脚本迁移为使用 V8 时，您必须在脚本项目中搜索这些问题，并修正找到的所有问题。

V8 迁移过程

如需将脚本迁移到 V8，请按以下步骤操作：

  1. 为脚本启用 V8 运行时。
  2. 请仔细查看下方列出的不兼容性。检查您的脚本，确定是否存在任何不兼容性；如果存在一个或多个不兼容性，请调整脚本代码以移除或避免问题。
  3. 请仔细查看下方列出的其他差异。 检查您的脚本，确定所列的任何差异是否会影响代码的行为。调整脚本以更正行为。
  4. 修正发现的任何不兼容性或其他差异后，您就可以开始更新代码，以便根据需要使用 V8 语法和其他功能。
  5. 完成代码调整后，请彻底测试脚本，确保其行为符合预期。
  6. 如果您的脚本是 Web 应用或已发布的插件，您必须创建一个新版本的脚本，并进行 V8 调整。如需向用户提供 V8 版本，您必须使用此版本重新发布脚本。

不兼容性

遗憾的是，基于 Rhino 的旧版 Apps Script 运行时允许了多种非标准 ECMAScript 行为。由于 V8 符合标准，因此迁移后不支持这些行为。如果未更正这些问题，则会导致启用 V8 运行时后出现错误或脚本行为异常。

以下部分介绍了这些行为以及您在迁移到 V8 期间必须执行的步骤，以更正脚本代码。

避免使用 for each(variable in object)

for each (variable in object) 语句已添加到 JavaScript 1.6 中，但已被移除，取而代之的是 for...of。

将脚本迁移到 V8 时，请避免使用 for each (variable in object) 语句。

请改用 for (variable in object)：

// Rhino runtime
var obj = {a: 1, b: 2, c: 3};

// Don't use 'for each' in V8
for each (var value in obj) {
  Logger.log("value = %s", value);
}
      
// V8 runtime
var obj = {a: 1, b: 2, c: 3};

for (var key in obj) {  // OK in V8
  var value = obj[key];
  Logger.log("value = %s", value);
}

避免使用 Date.prototype.getYear()

在原始 Rhino 运行时中，对于 1900 年至 1999 年，Date.prototype.getYear() 会返回两位数年份，但对于其他日期，则会返回四位数年份，这与 JavaScript 1.2 及更早版本中的行为相同。

在 V8 运行时中，Date.prototype.getYear() 会返回年份减 1900，而不是根据 ECMAScript 标准返回年份。

将脚本迁移到 V8 时，请始终使用 Date.prototype.getFullYear()，无论日期如何，它都会返回四位数的年份。

避免将保留关键字用作名称

ECMAScript 禁止在函数和变量名称中使用某些预留关键字。Rhino 运行时允许使用许多此类字词，因此，如果您的代码使用了这些字词，您必须重命名函数或变量。

将脚本迁移到 V8 时，请避免使用预留关键字之一来命名变量或函数。重命名所有变量或函数，以免使用关键字名称。将关键字用作名称的常见用法包括 class、import 和 export。

避免重新分配 const 变量

在原始 Rhino 运行时中，您可以使用 const 声明变量，这意味着符号的值永远不会更改，并且系统会忽略对该符号的未来赋值。

在新版 V8 运行时中，const 关键字符合标准，将值赋给声明为 const 的变量会导致 TypeError: Assignment to constant variable 运行时错误。

将脚本迁移到 V8 时，请勿尝试重新分配 const 变量的值：

// Rhino runtime
const x = 1;
x = 2;          // No error
console.log(x); // Outputs 1
      
// V8 runtime
const x = 1;
x = 2;          // Throws TypeError
console.log(x); // Never executed

避免使用 XML 字面量和 XML 对象

借助此对 ECMAScript 的非标准扩展，Apps Script 项目可以直接使用 XML 语法。

将脚本迁移到 V8 时，请避免使用直接 XML 字面量或 XML 对象。

请改用 XmlService 解析 XML：

// V8 runtime
var incompatibleXml1 = <container><item/></container>;             // Don't use
var incompatibleXml2 = new XML('<container><item/></container>');  // Don't use

var xml3 = XmlService.parse('<container><item/></container>');     // OK

请勿使用 __iterator__ 构建自定义迭代器函数

JavaScript 1.7 添加了一项功能，允许通过在类的原型中声明 __iterator__ 函数，将自定义迭代器添加到任何类；为方便开发者，此功能也添加到了 Apps Script 的 Rhino 运行时中。不过，此功能从未包含在 ECMA-262 标准中，并且已从符合 ECMAScript 规范的 JavaScript 引擎中移除。使用 V8 的脚本无法使用此迭代器构造。

将脚本迁移到 V8 时，请避免使用 __iterator__ 函数构建自定义迭代器。请改用 ECMAScript 6 迭代器。

请考虑以下数组构造：

// Create a sample array
var myArray = ['a', 'b', 'c'];
// Add a property to the array
myArray.foo = 'bar';

// The default behavior for an array is to return keys of all properties,
//  including 'foo'.
Logger.log("Normal for...in loop:");
for (var item in myArray) {
  Logger.log(item);            // Logs 0, 1, 2, foo
}

// To only log the array values with `for..in`, a custom iterator can be used.

以下代码示例展示了如何在 Rhino 运行时中构建迭代器，以及如何在 V8 运行时中构建替换迭代器：

// Rhino runtime custom iterator
function ArrayIterator(array) {
  this.array = array;
  this.currentIndex = 0;
}

ArrayIterator.prototype.next = function() {
  if (this.currentIndex
      >= this.array.length) {
    throw StopIteration;
  }
  return "[" + this.currentIndex
    + "]=" + this.array[this.currentIndex++];
};

// Direct myArray to use the custom iterator
myArray.__iterator__ = function() {
  return new ArrayIterator(this);
}


Logger.log("With custom Rhino iterator:");
for (var item in myArray) {
  // Logs [0]=a, [1]=b, [2]=c
  Logger.log(item);
}
      
// V8 runtime (ECMAScript 6) custom iterator
myArray[Symbol.iterator] = function() {
  var currentIndex = 0;
  var array = this;

  return {
    next: function() {
      if (currentIndex < array.length) {
        return {
          value: "[${currentIndex}]="
            + array[currentIndex++],
          done: false};
      } else {
        return {done: true};
      }
    }
  };
}

Logger.log("With V8 custom iterator:");
// Must use for...of since
//   for...in doesn't expect an iterable.
for (var item of myArray) {
  // Logs [0]=a, [1]=b, [2]=c
  Logger.log(item);
}

避免使用条件 catch 子句

V8 运行时不支持 catch..if 条件捕获子句，因为它们不符合标准。

将脚本迁移到 V8 时，请将所有 catch 条件移至 catch 正文中：

// Rhino runtime

try {
  doSomething();
} catch (e if e instanceof TypeError) {  // Don't use
  // Handle exception
}
      
// V8 runtime
try {
  doSomething();
} catch (e) {
  if (e instanceof TypeError) {
    // Handle exception
  }
}

避免使用 Object.prototype.toSource()

JavaScript 1.3 包含一个 Object.prototype.toSource() 方法，该方法从未包含在任何 ECMAScript 标准中。V8 运行时不支持它。

将脚本迁移到 V8 时，请从代码中移除对 Object.prototype.toSource() 的任何使用。

其他差异

除了上述可能会导致脚本失败的不兼容性之外，还有一些其他差异，如果不加以修正，可能会导致意外的 V8 运行时脚本行为。

以下部分介绍了如何更新脚本代码，以避免出现这些意外情况。

调整特定于语言区域的日期和时间格式

与 Rhino 相比，Date 方法 toLocaleString()、toLocaleDateString() 和 toLocaleTimeString() 在 V8 运行时中的行为有所不同。

在 Rhino 中，默认格式为长格式，传入的任何参数都会被忽略。

在 V8 运行时中，默认格式为简短格式，传入的参数会根据 ECMA 标准进行处理（如需了解详情，请参阅 toLocaleDateString() 文档）。

将脚本迁移到 V8 时，请测试并调整代码对特定于语言区域的日期和时间方法的输出结果的预期：

// Rhino runtime
var event = new Date(
  Date.UTC(2012, 11, 21, 12));

// Outputs "December 21, 2012" in Rhino
console.log(event.toLocaleDateString());

// Also outputs "December 21, 2012",
//  ignoring the parameters passed in.
console.log(event.toLocaleDateString(
    'de-DE',
    { year: 'numeric',
      month: 'long',
      day: 'numeric' }));
 
// V8 runtime
var event = new Date(
  Date.UTC(2012, 11, 21, 12));

// Outputs "12/21/2012" in V8
console.log(event.toLocaleDateString());

// Outputs "21. Dezember 2012"
console.log(event.toLocaleDateString(
    'de-DE',
    { year: 'numeric',
      month: 'long',
      day: 'numeric' }));

避免使用 Error.fileName 和 Error.lineNumber

在 V8 非实时环境中，标准 JavaScript Error 对象不支持将 fileName 或 lineNumber 用作构造函数参数或对象属性。

将脚本迁移到 V8 时，请移除对 Error.fileName 和 Error.lineNumber 的任何依赖项。

您也可以使用 Error.prototype.stack。此堆栈也不是标准堆栈，但 Rhino 和 V8 都支持它。这两个平台生成的堆栈轨迹格式略有不同：

// Rhino runtime Error.prototype.stack
// stack trace format
at filename:92 (innerFunction)
at filename:97 (outerFunction)
 
// V8 runtime Error.prototype.stack
// stack trace format
Error: error message
at innerFunction (filename:92:11)
at outerFunction (filename:97:5)

调整了对字符串化枚举对象的处理

在原始 Rhino 运行时中，对枚举对象使用 JavaScript JSON.stringify() 方法只会返回 {}。

在 V8 中，对枚举对象使用相同的方法会返回枚举名称。

将脚本迁移到 V8 时，请测试并调整代码对枚举对象上的 JSON.stringify() 输出的预期：

// Rhino runtime
var enumName =
  JSON.stringify(Charts.ChartType.BUBBLE);

// enumName evaluates to {}
 
// V8 runtime
var enumName =
  JSON.stringify(Charts.ChartType.BUBBLE);

// enumName evaluates to "BUBBLE"

调整了对未定义参数的处理方式

在原始 Rhino 运行时中，将 undefined 作为参数传递给方法会导致将字符串 "undefined" 传递给该方法。

在 V8 中，将 undefined 传递给方法等同于传递 null。

将脚本迁移到 V8 时，请测试并调整代码对 undefined 参数的预期：

// Rhino runtime
SpreadsheetApp.getActiveRange()
    .setValue(undefined);

// The active range now has the string
// "undefined"  as its value.
      
// V8 runtime
SpreadsheetApp.getActiveRange()
    .setValue(undefined);

// The active range now has no content, as
// setValue(null) removes content from
// ranges.

调整了对全局 this 的处理

Rhino 运行时为使用它的脚本定义了隐式特殊上下文。脚本代码在此隐式上下文中运行，与实际的全局 this 不同。这意味着，代码中对“全局 this”的引用实际上会求值为特殊上下文，其中仅包含脚本中定义的代码和变量。内置的 Apps 脚本服务和 ECMAScript 对象不在此类 this 用法中。这种情况类似于以下 JavaScript 结构：

// Rhino runtime

// Apps Script built-in services defined here, in the actual global context.
var SpreadsheetApp = {
  openById: function() { ... }
  getActive: function() { ... }
  // etc.
};

function() {
  // Implicit special context; all your code goes here. If the global this
  // is referenced in your code, it only contains elements from this context.

  // Any global variables you defined.
  var x = 42;

  // Your script functions.
  function myFunction() {
    ...
  }
  // End of your code.
}();

在 V8 中，移除了隐式特殊上下文。脚本中定义的全局变量和函数会放置在全局上下文中，与内置 Google Apps 脚本服务和 ECMAScript 内置函数（例如 Math 和 Date）并排。

将脚本迁移到 V8 时，请测试并调整代码在全局上下文中使用 this 的预期行为。在大多数情况下，只有当您的代码检查全局 this 对象的键或属性名称时，差异才会明显显现：

// Rhino runtime
var myGlobal = 5;

function myFunction() {

  // Only logs [myFunction, myGlobal];
  console.log(Object.keys(this));

  // Only logs [myFunction, myGlobal];
  console.log(
    Object.getOwnPropertyNames(this));
}





      
// V8 runtime
var myGlobal = 5;

function myFunction() {

  // Logs an array that includes the names
  // of Apps Script services
  // (CalendarApp, GmailApp, etc.) in
  // addition to myFunction and myGlobal.
  console.log(Object.keys(this));

  // Logs an array that includes the same
  // values as above, and also includes
  // ECMAScript built-ins like Math, Date,
  // and Object.
  console.log(
    Object.getOwnPropertyNames(this));
}

调整了库中对 instanceof 的处理

在库中对作为其他项目函数中参数传递的对象使用 instanceof 可能会导致假负例。在 V8 运行时中，项目及其库在不同的执行上下文中运行，因此具有不同的全局变量和原型链。

请注意，只有当您的库对未在项目中创建的对象使用 instanceof 时，才会出现这种情况。在项目中创建的对象上使用它（无论是在项目中的同一脚本中还是在其他脚本中）应该会按预期运行。

如果在 V8 上运行的项目将您的脚本用作库，请检查您的脚本是否对将从其他项目传递的参数使用了 instanceof。调整 instanceof 的使用方式，并根据您的用例使用其他可行替代方案。

如果您不需要搜索整个原型链，只需检查构造函数，则可以使用 a 的构造函数作为 a instanceof b 的替代方案。用法：a.constructor.name == "b"

假设有两个项目：项目 A 和项目 B，其中项目 A 使用项目 B 作为库。

//Rhino runtime

//Project A

function caller() {
   var date = new Date();
   // Returns true
   return B.callee(date);
}

//Project B

function callee(date) {
   // Returns true
   return(date instanceof Date);
}

      
//V8 runtime

//Project A

function caller() {
   var date = new Date();
   // Returns false
   return B.callee(date);
}

//Project B

function callee(date) {
   // Incorrectly returns false
   return(date instanceof Date);
   // Consider using return (date.constructor.name ==
   // “Date”) instead.
   // return (date.constructor.name == “Date”) -> Returns
   // true
}

另一种替代方案是引入一个函数，用于检查主项目中的 instanceof，并在调用库函数时将该函数以及其他参数一起传递。然后，传递的函数可用于检查库中的 instanceof。

//V8 runtime

//Project A

function caller() {
   var date = new Date();
   // Returns True
   return B.callee(date, date => date instanceof Date);
}

//Project B

function callee(date, checkInstanceOf) {
  // Returns True
  return checkInstanceOf(date);
}

调整了向库传递非共享资源的方式

在 V8 运行时中，从主脚本将非共享资源传递给库的方式有所不同。

在 Rhino 运行时中，传递非共享资源不起作用。该库会改用自己的资源。

在 V8 运行时中，将非共享资源传递给库是可行的。该库使用传递的非共享资源。

请勿将非共享资源作为函数参数传递。请务必在使用非共享资源的同一脚本中声明这些资源。

假设有两个项目：项目 A 和项目 B，其中项目 A 使用项目 B 作为库。在此示例中，PropertiesService 是非共享资源。

// Rhino runtime
// Project A
function testPassingNonSharedProperties() {
  PropertiesService.getScriptProperties()
      .setProperty('project', 'Project-A');
  B.setScriptProperties();
  // Prints: Project-B
  Logger.log(B.getScriptProperties(
      PropertiesService, 'project'));
}



//Project B
function setScriptProperties() {
  PropertiesService.getScriptProperties()
      .setProperty('project', 'Project-B');
}
function getScriptProperties(
    propertiesService, key) {
  return propertiesService.getScriptProperties()
      .getProperty(key);
}
 
// V8 runtime
// Project A
function testPassingNonSharedProperties() {
  PropertiesService.getScriptProperties()
      .setProperty('project', 'Project-A');
  B.setScriptProperties();
  // Prints: Project-A
  Logger.log(B.getScriptProperties(
      PropertiesService, 'project'));
}



// Project B
function setProperties() {
  PropertiesService.getScriptProperties()
        .setProperty('project', 'Project-B');
}
function getScriptProperties(
    propertiesService, key) {
  return propertiesService.getScriptProperties()
      .getProperty(key);
}

更新对独立脚本的访问权限

对于在 V8 运行时上运行的独立脚本，您需要至少向用户提供对脚本的查看权限，才能让脚本的触发器正常运行。