如何通过Office.js（Word插件）从文档获取指定XML文件？

问题根源与解决办法 #

我来帮你拆解下当前遇到的问题：

关于方法一的失败原因 #

你用getByNamespaceAsync的思路完全走偏啦！这个API的作用是根据XML的命名空间（Namespace）查找自定义XML部件，而不是根据文件路径。你拼接的Office.context.document.url + '\customXml\item1.xml\'是Word文档包内部的文件路径，根本不是XML本身的命名空间，所以自然找不到对应的部件，只会打印"2"，进不了判断分支。

如果想用命名空间查找，你需要先打开item1.xml，查看根元素的xmlns属性值。比如你的XML结构是这样的：

<root xmlns="http://my-custom-namespace.com/item1">
  <!-- 内容 -->
</root>

那你应该把这个命名空间字符串传给getByNamespaceAsync，代码改成这样：

const targetNamespace = "http://my-custom-namespace.com/item1";
Office.context.document.customXmlParts.getByNamespaceAsync(targetNamespace, (result) => {
  console.log("2");
  if (result.value.length > 0) {
    console.log("3");
    // 找到目标部件，这里处理逻辑
    for (var i = 0; i < result.value.length; i++) {
      console.log("找到的XML部件:", result.value[i]);
    }
  } else {
    console.log("未找到对应命名空间的XML部件");
  }
});

关于方法二：无需解压获取XML部件ID的办法 #

你提到用getByIdAsync能正常运行，但不知道怎么不用解压文档获取ID，这里有几个可行方案：

• 方案1：添加部件时提前保存ID
  如果这个item1.xml是你自己添加到Word文档里的，在调用addAsync添加部件的时候，就可以把返回的ID存起来——比如存在插件的本地设置里，或者文档的自定义属性中。下次需要调用时直接取出ID即可，示例代码：

  // 添加自定义XML部件时保存ID
  const xmlContent = '<root xmlns="http://my-custom-namespace.com/item1">...</root>';
  Office.context.document.customXmlParts.addAsync(xmlContent, (addResult) => {
    if (addResult.status === Office.AsyncResultStatus.Succeeded) {
      const partId = addResult.value.id;
      // 把partId存到文档自定义属性
      Office.context.document.properties.customProperties.setAsync("Item1XmlPartId", partId);
    }
  });
  
  // 后续获取时读取自定义属性
  Office.context.document.properties.customProperties.getAsync("Item1XmlPartId", (getResult) => {
    if (getResult.status === Office.AsyncResultStatus.Succeeded) {
      const targetId = getResult.value;
      Office.context.document.customXmlParts.getByIdAsync(targetId, (result) => {
        // 处理找到的部件
      });
    }
  });
  

• 方案2：遍历所有部件筛选目标
  如果你没办法提前保存ID，可以用getAllAsync获取文档中所有的自定义XML部件，然后通过读取部件的XML内容或者命名空间来筛选出你要的item1.xml，不用依赖ID：

  Office.context.document.customXmlParts.getAllAsync((result) => {
    if (result.status === Office.AsyncResultStatus.Succeeded) {
      const allXmlParts = result.value;
      allXmlParts.forEach(part => {
        part.getXmlAsync((xmlResult) => {
          if (xmlResult.status === Office.AsyncResultStatus.Succeeded) {
            const xmlContent = xmlResult.value;
            // 这里可以根据XML内容的特征判断，比如是否包含特定标签、属性，或者匹配命名空间
            if (xmlContent.includes('<item1-root>') || xmlContent.includes('http://my-custom-namespace.com/item1')) {
              console.log("找到目标XML部件:", part);
              // 这里执行你的业务逻辑
            }
          }
        });
      });
    }
  });
  

总结 #

• 方法一的核心错误是混淆了文件路径和XML命名空间，纠正参数为正确的命名空间就能正常使用。
• 方法二的ID可以通过「添加时提前存储」或「遍历所有部件筛选」两种方式获取，完全不需要解压Word文档。

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