Word Web Addin开发：如何跟踪Word文档文本变更事件

原生API支持结论 #

• Office 2019 对 Word JavaScript API 的最高支持版本为 Requirement Set 1.3，全文档范围的文本变更监听事件Document.onChanged是在 Requirement Set 1.4 版本中首次引入，该版本仅兼容Microsoft 365及后续Office版本，无法在Office 2019环境下直接调用原生事件实现需求。
• 低版本API仅支持对手动绑定的特定内容控件、表格等独立对象监听变更事件，无法覆盖全文档的文本变更场景。

兼容Office 2019的替代实现方案 #

如果必须在Office 2019环境下实现全文档文本变更监听，可采用轮询比对内容哈希的方案实现，参考代码如下：

let lastContentHash = "";
// 轮询间隔可根据业务需求调整，单位为毫秒
const POLL_INTERVAL = 1000;

setInterval(async () => {
  await Word.run(async (context) => {
    const documentBody = context.document.body;
    documentBody.load("text");
    await context.sync();

    const currentContentHash = getContentHash(documentBody.text);
    if (currentContentHash !== lastContentHash && lastContentHash !== "") {
      // 此处写入文本变更后需要执行的业务逻辑
      console.log("检测到文档文本发生变更");
    }
    lastContentHash = currentContentHash;
  });
}, POLL_INTERVAL);

// 简易内容哈希计算函数，可根据需求替换为更严谨的哈希算法
function getContentHash(content) {
  let hash = 0;
  if (content.length === 0) return hash;
  for (let i = 0; i < content.length; i++) {
    const charCode = content.charCodeAt(i);
    hash = ((hash << 5) - hash) + charCode;
    hash = hash & hash;
  }
  return hash;
}

方案注意事项 #

• 轮询间隔不宜设置过短，避免造成不必要的性能开销，普通办公场景下1000ms到3000ms的间隔基本可满足需求
• 如果文档体积偏大，可调整为仅监听选中区域、或者分片比对内容，进一步降低性能消耗
• 该方案仅能检测到最终文本的变更，无法获取变更的具体位置、变更前的内容等细粒度信息，如果需要这类信息，需额外实现差分逻辑

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