如何在Google Sheets App Script中通过Sheet CodeName指定工作表？

Google Sheets App Script本身没有像Excel那样原生支持的CodeName属性，目前常用的两种工作表指定方式都存在明显弊端：

• 通过工作表名称指定：使用Book.getSheetByName("Sheet1")，一旦用户修改工作表名称，代码直接失效
• 通过工作表位置指定：使用Book.getSheets()[1]，用户调整工作表顺序后，代码会因索引变化而出错

而Excel中工作表的CodeName属性不受用户修改名称、调整位置的影响，我们可以通过Google Sheets的**开发者元数据（Developer Metadata）**来模拟这一特性，实现稳定的工作表调用。

实现方案 #

1. 给工作表设置自定义CodeName

先创建一个函数，用于给目标工作表绑定唯一的CodeName元数据：

function setSheetCodeName(sheetName, codeName) {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName(sheetName);
  if (!sheet) return;
  
  // 清除已存在的CodeName元数据，避免重复
  const existingMetadata = sheet.getDeveloperMetadata().filter(meta => meta.getKey() === "CodeName");
  existingMetadata.forEach(meta => meta.remove());
  
  // 添加新的CodeName元数据
  sheet.addDeveloperMetadata("CodeName", codeName);
}

调用示例：执行setSheetCodeName("Sheet1", "DataSheet")，即可给名为Sheet1的工作表设置CodeName为DataSheet。

2. 通过CodeName获取工作表

创建函数根据自定义CodeName查找对应的工作表：

function getSheetByCodeName(codeName) {
  const book = SpreadsheetApp.getActiveSpreadsheet();
  const sheets = book.getSheets();
  
  for (const sheet of sheets) {
    const targetMeta = sheet.getDeveloperMetadata().find(meta => meta.getKey() === "CodeName" && meta.getValue() === codeName);
    if (targetMeta) return sheet;
  }
  
  return null; // 未找到对应CodeName的工作表
}

3. 实际使用示例

function Sheet_CodeNam(){
  let Book = SpreadsheetApp.getActiveSpreadsheet();
  // 通过自定义CodeName获取工作表
  let Sheet1 = getSheetByCodeName("DataSheet");
  
  if (Sheet1) {
    // 这里可以添加对工作表的操作逻辑
    Logger.log("成功找到工作表：" + Sheet1.getName());
  } else {
    Logger.log("未找到指定CodeName的工作表");
  }
}

方案优势 #

这个模拟方案的核心是将CodeName绑定在工作表本身的元数据中，不受用户修改工作表名称、调整工作表顺序的影响，完全达到Excel中CodeName属性的稳定调用效果。

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