如何通过Office JS检测文档关闭并完成工作簿扫描

问题核心 #

Office JS没有原生的文档关闭事件，window.onbeforeunload中执行全工作簿扫描+服务器请求时，会因浏览器异步操作时间限制导致任务中断，无法完成完整扫描。

可行解决方案 #

1. 优化关闭时的执行逻辑（应急方案）

首先优化数据获取效率，减少context.sync()的调用次数——原代码逐工作表循环加载数据，多次同步会浪费时间，改为批量获取整个工作簿的已用范围：

window.onbeforeunload = function() {
  // 用同步包装异步逻辑，强制浏览器等待（注意：现代浏览器可能限制此操作）
  let scanCompleted = false;
  let nonEmptyValues = [];

  Excel.run(async (context) => {
    const usedRange = context.workbook.getUsedRange();
    usedRange.load("text");
    await context.sync();

    usedRange.text.forEach(row => {
      row.forEach(cell => {
        if (cell !== "") {
          nonEmptyValues.push(cell);
        }
      });
    });

    // 改用同步请求上传数据
    const xhr = new XMLHttpRequest();
    xhr.open('POST', '/your-scan-endpoint', false);
    xhr.setRequestHeader('Content-Type', 'application/json');
    xhr.send(JSON.stringify(nonEmptyValues));
    
    scanCompleted = true;
  }).catch(error => {
    console.log(error);
  });

  // 浏览器会等待同步操作完成再关闭
  return scanCompleted ? undefined : "正在扫描文档内容，请稍候...";
};

注意：同步请求会导致页面卡顿，且部分浏览器可能拦截这种阻塞式操作，仅作为临时应急方案。

2. 提前缓存+触发式上传（推荐方案）

不要等到关闭时才处理数据，而是在用户操作过程中实时缓存非空值，在保存或关闭时仅上传缓存数据：

// 全局缓存非空值（用Set避免重复）
let cachedValues = new Set();

// 初始化时加载现有数据
async function initCache() {
  await Excel.run(async (context) => {
    const usedRange = context.workbook.getUsedRange();
    usedRange.load("text");
    await context.sync();

    usedRange.text.forEach(row => {
      row.forEach(cell => {
        if (cell !== "") cachedValues.add(cell);
      });
    });
  }).catch(err => console.error(err));
}

// 监听工作表变化，更新缓存
function setupChangeListeners() {
  Office.context.document.addHandlerAsync(
    Office.EventType.DocumentSelectionChanged,
    async () => {
      await Excel.run(async (context) => {
        const activeRange = context.workbook.getSelectedRange();
        activeRange.load("text");
        await context.sync();

        activeRange.text.forEach(row => {
          row.forEach(cell => {
            if (cell !== "") cachedValues.add(cell);
          });
        });
      }).catch(err => console.error(err));
    }
  );

  // 监听文档保存事件，自动上传缓存
  Office.context.document.addHandlerAsync(
    Office.EventType.DocumentSaved,
    () => {
      if (cachedValues.size > 0) {
        ScanValuesInTheServer(Array.from(cachedValues));
        cachedValues.clear(); // 上传后清空缓存
      }
    }
  );
}

// 页面初始化时执行
initCache().then(setupChangeListeners);

// 关闭时兜底上传剩余缓存
window.onbeforeunload = function() {
  if (cachedValues.size > 0) {
    const xhr = new XMLHttpRequest();
    xhr.open('POST', '/your-scan-endpoint', false);
    xhr.setRequestHeader('Content-Type', 'application/json');
    xhr.send(JSON.stringify(Array.from(cachedValues)));
  }
};

这种模式将大量计算分散到用户操作过程中，关闭时仅需上传少量剩余数据，几乎不会出现超时问题，同时保证数据完整性。

3. 利用Excel Online后台任务（进阶方案）

Excel Online支持通过Office.context.document.startAsync启动后台任务，可将扫描逻辑拆分到后台执行：

window.onbeforeunload = function() {
  Excel.run(async (context) => {
    const usedRange = context.workbook.getUsedRange();
    usedRange.load("text");
    await context.sync();

    const data = Array.from(new Set(
      usedRange.text.flat().filter(cell => cell !== "")
    ));

    // 启动后台任务上传数据
    Office.context.document.startAsync(
      { taskType: "upload" },
      (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          ScanValuesInTheServer(data);
        }
      }
    );
  }).catch(err => console.error(err));
};

注意：后台任务的执行时间仍有限制，需确保数据量和请求逻辑足够轻量化。

关键总结 #

• 避免在beforeunload中执行大量异步操作，浏览器对此限制严格；
• 优先采用提前缓存+保存时上传的模式，这是最稳定且用户友好的方案；
• 若必须在关闭时执行，务必优化数据获取逻辑，减少同步次数，必要时用同步请求兜底。

内容的提问来源于stack exchange，提问作者Fatih Karameşe