本文档列出了有助于提升脚本性能的最佳实践。
尽量减少对其他服务的调用
在脚本中使用 JavaScript 操作比调用其他服务快得多。您可以在 Google Apps 脚本本身中执行的任何操作(例如向 Google 表格、Google 文档、Google 协作平台、翻译、UrlFetch 等发出需要从 Google 服务器或外部服务器提取数据的调用)要快得多。如果能够设法最大限度减少脚本对这些服务的调用,您的脚本运行速度会更快。
考虑使用共享云端硬盘开展协作
如果您与其他开发者一起处理脚本项目,可以使用共享云端硬盘就 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 脚本回写缓存会有所帮助,因为它会在每行末尾使用 flush 强制回写。由于缓存的原因,对电子表格仅有 100 次调用。
但批量调用代码可以提高代码的效率。如下所示,系统将单元格范围读入名为“color”的数组,对该数组中的数据执行颜色分配操作,并将数组中的值写入电子表格:
// 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 分钟内从缓存中过期。