Apps Script插件全局调用Document Properties致菜单消失的解决办法咨询

问题根源 #

全局作用域的代码会在脚本加载阶段自动执行，而PropertiesService.getDocumentProperties()需要文档级权限。当文档刷新后脚本重新加载时，全局调用这个方法可能在菜单注册代码执行前触发权限异常，导致菜单初始化失败，只剩帮助标签。

可行方案 #

方案1：惰性初始化全局实例 #

定义一个全局变量和配套函数，第一次调用时才获取Properties实例，后续直接复用缓存的实例：

let sheet_properties;

function getSheetProperties() {
  if (!sheet_properties) {
    sheet_properties = PropertiesService.getDocumentProperties();
  }
  return sheet_properties;
}

之后在需要的函数里调用getSheetProperties()即可，不用每次重复获取，同时避开了全局加载时的权限问题。

方案2：分离菜单注册与属性操作 #

确保菜单注册函数（比如onOpen）只负责创建菜单，不涉及任何属性操作，把属性获取逻辑放在实际功能函数里：

// 仅负责菜单创建，逻辑极简
function onOpen() {
  SpreadsheetApp.getUi()
    .createMenu('我的插件')
    .addItem('打开侧边栏', 'showSidebar')
    .addToUi();
}

// 惰性获取属性实例
let sheet_properties;
function getSheetProperties() {
  if (!sheet_properties) {
    sheet_properties = PropertiesService.getDocumentProperties();
  }
  return sheet_properties;
}

// 功能函数内使用属性
function showSidebar() {
  const props = getSheetProperties();
  // 后续业务逻辑...
  SpreadsheetApp.getUi().showSidebar(HtmlService.createHtmlOutput('侧边栏内容'));
}

方案3：命名空间封装属性逻辑 #

把属性相关操作封装在一个对象里，既实现实例复用，又让代码结构更清晰：

const PluginProps = {
  _instance: null,
  getInstance() {
    if (!this._instance) {
      this._instance = PropertiesService.getDocumentProperties();
    }
    return this._instance;
  },
  // 可封装常用读写方法
  get(key) {
    return this.getInstance().getProperty(key);
  },
  set(key, value) {
    this.getInstance().setProperty(key, value);
  }
};

// 使用示例
function saveUserSetting() {
  PluginProps.set('theme', 'dark');
  const currentTheme = PluginProps.get('theme');
}

关键注意点 #

• 全局作用域只放常量、函数定义或未初始化的变量，不要执行任何需要权限或依赖文档环境的操作。
• 菜单注册函数onOpen要保持简洁，避免引入可能触发异常的逻辑。

内容的提问来源于stack exchange，提问作者alsanmph