最佳做法

本文档列出了可帮助您提高脚本性能的最佳实践。

尽可能减少对其他服务的调用

在脚本中使用 JavaScript 操作要比调用其他服务快得多。与需要从 Google 服务器或外部服务器提取数据的调用(例如对 Google 表格、Google 文档、Google 协作平台、翻译、UrlFetch 等的请求)相比,您可以在 Google Apps 脚本本身中完成的任何调用都要快得多。如果您能设法最大限度地减少脚本对这些服务的调用,您的脚本将运行得更快。

考虑通过共享云端硬盘开展协作

如果您正在与其他开发者合作处理脚本项目,则可以借助共享云端硬盘协作处理 Apps 脚本项目。共享云端硬盘中的文件归群组(而非个人)所有。这样可以简化项目的开发和维护。

使用批量操作

脚本通常需要从电子表格读取数据、执行计算,然后将数据结果写入电子表格。Google Apps 脚本已经具有一些内置的优化功能,例如使用前向缓存检索脚本可能获得的内容,以及写入缓存以保存可能设置的内容。

您可以编写脚本,通过最大限度减少读取和写入次数来充分利用内置缓存。交替读写命令的速度很慢。为了加快脚本的运行速度,请使用一个命令将所有数据读入数组,对该数组中的数据执行任意操作,然后使用一个命令写出数据。

下面举例说明,您不应关注或使用。脚本使用以下代码设置 100 x 100 电子表格网格中每个单元格的背景颜色。它使用名为 getColorFromCoordinates()(此处未显示)的函数来确定每个单元格要使用的颜色:

  // DO NOT USE THIS CODE. It is an example of SLOW, INEFFICIENT code.
  // FOR DEMONSTRATION ONLY
  var cell = sheet.getRange('a1');
  for (var y = 0; y < 100; y++) {
    xcoord = xmin;
    for (var x = 0; x < 100; x++) {
      var c = getColorFromCoordinates(xcoord, ycoord);
      cell.offset(y, x).setBackgroundColor(c);
      xcoord += xincrement;
    }
    ycoord -= yincrement;
    SpreadsheetApp.flush();
  }

该脚本效率低下:它会遍历 100 行和 100 列,连续写入 10,000 个单元格。Google Apps 脚本回写缓存非常有用,因为它会在每行末尾使用刷新功能强制回写。由于缓存的原因,电子表格仅有 100 次调用。

不过,通过批量处理调用可以大幅提高代码的效率。以下是一个重写过程,其中将单元格范围读入名为“颜色”的数组,对该数组中的数据执行颜色分配操作,然后将数组中的值写出到电子表格:

  // OKAY TO USE THIS EXAMPLE or code based on it.
  var cell = sheet.getRange('a1');
  var colors = new Array(100);
  for (var y = 0; y < 100; y++) {
    xcoord = xmin;
    colors[y] = new Array(100);
    for (var x = 0; x < 100; x++) {
      colors[y][x] = getColorFromCoordinates(xcoord, ycoord);
      xcoord += xincrement;
    }
    ycoord -= yincrement;
  }
  sheet.getRange(1, 1, 100, 100).setBackgroundColors(colors);

低效的代码需要大约 70 秒才能运行完毕。高效代码仅需 1 秒钟即可运行!

避免在界面密集型脚本中使用库

是重用代码的便捷方式,但库会略微增加脚本的启动时间。对于运行时间相对较长的脚本(例如用于清理 Google 云端硬盘文件的实用程序脚本),这种延迟不会很明显,但对于会进行短时运行的重复 google.script.run 调用的客户端 HTML 服务界面,延迟会影响每次调用。因此,应谨慎在插件中使用库,并且建议您避免在进行大量 google.script.run 调用的非插件脚本中使用这些库。

使用缓存服务

您可以使用缓存服务在脚本执行之间缓存资源。通过缓存数据,您可以减少提取数据的次数或频率。请考虑以下场景:example.com 上的 RSS Feed 需要 20 秒才能提取,并且您希望加快平均请求的访问速度。以下示例展示了如何使用缓存服务加快对此数据的访问速度。

  function getRssFeed() {
    var cache = CacheService.getScriptCache();
    var cached = cache.get("rss-feed-contents");
    if (cached != null) {
      return cached;
    }
    // This fetch takes 20 seconds:
    var result = UrlFetchApp.fetch("http://example.com/my-slow-rss-feed.xml");
    var contents = result.getContentText();
    cache.put("rss-feed-contents", contents, 1500); // cache for 25 minutes
    return contents;
  }

现在,如果项不在缓存中,您仍然需要等待 20 秒,但后续访问将非常快速,直到该项在 25 分钟内从缓存中消失。