Excel JS插件任务窗格关闭后工作表仍更新的检测与解决问询

我正在开发一款包含多任务窗格的Excel JS插件，其中一个任务窗格会发起多次HTTP请求从服务器获取数据并填充工作表，但遇到以下异常情况：

• 同时打开多个任务窗格时，关闭该数据获取窗格（保留其他窗格）后，工作表仍会像该窗格未关闭一样持续更新；
• 甚至关闭所有窗格后，工作表更新仍不会停止。

已尝试的无效方案 #

• 曾认为问题与SharedRuntime相关，禁用后并未解决；
• 尝试捕获任务窗格的关闭/隐藏事件以停止工作表更新，但事件未触发；
• 尝试捕获beforeunload事件，同样无效。

本地复现代码 #

为排除网络因素影响，我通过本地定时更新函数复现了问题：

function intervalUpdateCells() {
  setInterval(() => {
    var values = [
        [Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000)],
        [Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000)],
        [Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000)]
    ];

    // Run a batch operation against the Excel object model
    Excel.run(function (ctx) {
        var sheet = ctx.workbook.worksheets.getActiveWorksheet();
        sheet.getRange("B2:D4").values = values;
        sheet.getRange("B1:D1").values = [['A', 'B', 'C']];
        return ctx.sync();
    })
    .catch(errorHandler);
  }, 100);
};

运行该函数（每秒更新工作表10次）后，关闭发起更新的窗格及其他窗格，工作表仍会持续更新。

核心问题 #

如何检测任务窗格已关闭，从而停止工作表的更新操作？

1. 监听Office.js的VisibilityChanged事件 #

Office.js提供了任务窗格可见性变更的原生事件，可用于检测窗格关闭/隐藏状态，结合定时器ID清理更新任务：

// 任务窗格初始化时注册可见性变更事件
Office.addin.onVisibilityChanged(async (args) => {
  if (!args.isVisible) {
    // 窗格已隐藏/关闭，停止定时更新
    clearInterval(window.updateTimer);
  }
});

// 修改定时更新函数，保存定时器ID到全局变量
function intervalUpdateCells() {
  window.updateTimer = setInterval(() => {
    var values = [
        [Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000)],
        [Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000)],
        [Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000), Math.floor(Math.random() * 1000)]
    ];

    Excel.run(function (ctx) {
        var sheet = ctx.workbook.worksheets.getActiveWorksheet();
        sheet.getRange("B2:D4").values = values;
        sheet.getRange("B1:D1").values = [['A', 'B', 'C']];
        return ctx.sync();
    })
    .catch(errorHandler);
  }, 100);
};

注意：该事件需要插件启用Shared Runtime，需在manifest.xml中配置：

<Runtime>
  <Override>true</Override>
  <SharedRuntime>true</SharedRuntime>
</Runtime>

2. 多任务窗格场景下的实例化管理 #

如果存在多个任务窗格，需为每个窗格实例单独维护定时器：

• 窗格加载时创建专属定时器，并通过实例ID或命名空间区分；
• 监听VisibilityChanged事件时，仅销毁当前窗格对应的定时器；
• 避免全局变量冲突，可将定时器ID存储在窗格的局部作用域中。

3. 监听插件卸载事件清理全局任务 #

若关闭所有窗格后插件仍在后台运行，可通过onRemoved事件彻底清理所有异步操作：

Office.addin.onRemoved(() => {
  clearInterval(window.updateTimer);
  // 同时取消未完成的HTTP请求等异步任务
});

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