Azure DevOps扩展无法访问Extension Data Service问题求助

错误原因分析 #

你遇到的Uncaught TypeError: (void 0) is not a function主要有两个核心原因：

• import语句位置错误：ES模块规范要求import必须放在代码最顶层，不能在异步操作（await）之后执行
• 缺少SDK初始化步骤：调用SDK.getService前需要确保Azure DevOps SDK已经完成初始化

正确可用代码示例 #

以下是完整的、可运行的IExtensionDataService使用代码，包含数据存储与读取的完整流程：

// 1. 必须将import放在代码最顶部
import { IExtensionDataService, CommonServiceIds } from "azure-devops-extension-api";
import * as SDK from "azure-devops-extension-sdk";

// 初始化SDK（关键步骤，不可省略）
await SDK.init();

// 2. 获取ExtensionDataService实例
const extDataService = await SDK.getService<IExtensionDataService>(CommonServiceIds.ExtensionDataService);

// 3. 定义存储键名（建议使用唯一标识，避免冲突）
const storageKey = "my-extension-storage";
const userId = SDK.getUser().id;

// 4. 保存数据到用户专属存储
async function saveData(key: string, data: any) {
    // 获取或创建用户级存储容器
    const userContainer = await extDataService.getDocumentCollection(storageKey, userId);
    // 保存数据（若key已存在则覆盖）
    await extDataService.createDocument(userContainer, data, key);
}

// 5. 从存储读取数据
async function loadData(key: string) {
    try {
        const userContainer = await extDataService.getDocumentCollection(storageKey, userId);
        return await extDataService.getDocument(userContainer, key);
    } catch (error) {
        // 处理数据不存在的情况
        console.log("数据不存在或读取失败:", error);
        return null;
    }
}

// 示例调用
await saveData("user-preferences", { theme: "dark", notificationsEnabled: true });
const preferences = await loadData("user-preferences");
console.log("用户偏好设置:", preferences);

关键注意事项 #

• 存储权限：确保你的Azure DevOps扩展清单（vss-extension.json）中声明了data权限，例如：

  "contributions": [
      // ... 其他贡献点
  ],
  "scopes": [
      "vso.extension.data_write",
      "vso.extension.data_read"
  ]
  

• 存储级别：代码中使用的是用户级存储（传入userId），如果需要共享存储（跨用户），可以省略userId参数，使用集合级存储
• 错误处理：实际使用时建议添加完善的错误捕获逻辑，处理网络异常、权限不足等情况

替代方案（若IExtensionDataService不可用） #

如果因扩展环境限制无法使用IExtensionDataService，可考虑以下替代方案：

• 使用Azure DevOps的Work Item自定义字段：将数据关联到特定工作项（适合与工作项绑定的数据）
• 调用外部API：将数据存储到你自己的后端服务或Azure存储（如Blob Storage、Cosmos DB），通过扩展中的API请求交互

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