Google Apps Script 中跨函数引用变量的正确方法

google apps script 中跨函数引用变量的正确方法

在 Google Apps Script (GAS) 开发 Google Workspace 插件时,经常会遇到需要在不同函数间共享和修改变量的情况。然而,GAS 的执行机制与传统的 JavaScript 有所不同,直接使用全局变量可能无法达到预期的效果。这是因为每次函数调用都被视为独立的执行,全局变量会被重新初始化。

问题分析

GAS 中,每次通过 UI 触发的函数调用,例如点击卡片上的按钮,都会启动一个新的脚本执行。这意味着在 onOpen() 函数中定义的全局变量 startdate 在 reviseStartDate() 函数中会被重新初始化为初始值,而不是保留 createCard() 函数中修改后的值。

解决方案:使用 CacheService

CacheService 提供了一种在脚本执行之间缓存数据的方式。我们可以利用它来存储需要在不同函数间共享的变量。

示例代码:

var cache = CacheService.getUserCache();function onHomepage() {  var card = createCard();  return card;}function createCard() {  cache.put("startdate", "tomorrow"); // 将 startdate 的值存储到缓存中  var startdate = cache.get("startdate"); // 从缓存中读取 startdate 的值  var button = CardService.newTextButton()    .setText('Revise start date')    .setOnClickAction(CardService.newAction()      .setFunctionName('reviseStartDate'));  var section = CardService.newCardSection()    .addWidget(button);  var card = CardService.newCardBuilder()    .setHeader(CardService.newCardHeader().setTitle('Default start: ' + startdate))    .addSection(section)  return card.build();}function reviseStartDate() {  var startdate = cache.get("startdate"); // 从缓存中读取 startdate 的值  var card = CardService.newCardBuilder()    .setHeader(CardService.newCardHeader().setTitle("Revised start: " + startdate));  return card.build();}

代码解释:

获取缓存服务: var cache = CacheService.getUserCache(); 获取当前用户的缓存服务。存储变量: cache.put(“startdate”, “tomorrow”); 将 startdate 的值 “tomorrow” 存储到缓存中,键为 “startdate”。读取变量: var startdate = cache.get(“startdate”); 从缓存中读取键为 “startdate” 的值,并将其赋值给变量 startdate。

通过使用 CacheService,我们可以确保 reviseStartDate() 函数能够获取到 createCard() 函数中修改后的 startdate 值。

注意事项:

动态WEB网站中的PHP和MySQL:直观的QuickPro指南第2版 动态WEB网站中的PHP和MySQL:直观的QuickPro指南第2版

动态WEB网站中的PHP和MySQL详细反映实际程序的需求,仔细地探讨外部数据的验证(例如信用卡卡号的格式)、用户登录以及如何使用模板建立网页的标准外观。动态WEB网站中的PHP和MySQL的内容不仅仅是这些。书中还提到如何串联JavaScript与PHP让用户操作时更快、更方便。还有正确处理用户输入错误的方法,让网站看起来更专业。另外还引入大量来自PEAR外挂函数库的强大功能,对常用的、强大的包

动态WEB网站中的PHP和MySQL:直观的QuickPro指南第2版 508 查看详情 动态WEB网站中的PHP和MySQL:直观的QuickPro指南第2版 CacheService 存储的数据有一定的有效期,过期后会被自动清除。默认有效期为 6 小时。CacheService 适合存储少量的数据,不适合存储大量数据。

替代方案:使用 User Properties

除了 CacheService,还可以使用 User Properties 来存储需要在不同函数间共享的变量。User Properties 允许您为每个用户存储键值对,这些键值对在用户的脚本执行之间保持持久性。

示例代码:

var userProperties = PropertiesService.getUserProperties();function onHomepage() {  var card = createCard();  return card;}function createCard() {  userProperties.setProperty("startdate", "tomorrow"); // 将 startdate 的值存储到 User Properties 中  var startdate = userProperties.getProperty("startdate"); // 从 User Properties 中读取 startdate 的值  var button = CardService.newTextButton()    .setText('Revise start date')    .setOnClickAction(CardService.newAction()      .setFunctionName('reviseStartDate'));  var section = CardService.newCardSection()    .addWidget(button);  var card = CardService.newCardBuilder()    .setHeader(CardService.newCardHeader().setTitle('Default start: ' + startdate))    .addSection(section)  return card.build();}function reviseStartDate() {  var startdate = userProperties.getProperty("startdate"); // 从 User Properties 中读取 startdate 的值  var card = CardService.newCardBuilder()    .setHeader(CardService.newCardHeader().setTitle("Revised start: " + startdate));  return card.build();}

代码解释:

获取 User Properties 服务: var userProperties = PropertiesService.getUserProperties(); 获取当前用户的 User Properties 服务。存储变量: userProperties.setProperty(“startdate”, “tomorrow”); 将 startdate 的值 “tomorrow” 存储到 User Properties 中,键为 “startdate”。读取变量: var startdate = userProperties.getProperty(“startdate”); 从 User Properties 中读取键为 “startdate” 的值,并将其赋值给变量 startdate。

注意事项:

User Properties 存储的数据没有有效期限制,会一直存在,直到手动删除。User Properties 适合存储用户的配置信息等需要长期保存的数据。

总结

在 Google Apps Script 中跨函数引用变量时,需要注意 GAS 的执行机制。可以使用 CacheService 或 User Properties 来存储需要在不同函数间共享的变量。CacheService 适合存储临时数据,而 User Properties 适合存储需要长期保存的数据。选择哪种方式取决于具体的应用场景和需求。

通过本文的学习,相信您已经掌握了在 Google Apps Script 中跨函数引用变量的正确方法,能够更加高效地开发 Google Workspace 插件。

以上就是Google Apps Script 中跨函数引用变量的正确方法的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/744364.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年11月25日 16:51:13
下一篇 2025年11月25日 16:55:47

相关推荐

发表回复

登录后才能评论
关注微信