Office.js Word插件saveAsync无报错但无法保存问题求助

针对你遇到的Office.context.document.settings.saveAsync偶尔无报错但未保存设置的问题，结合你的代码和环境，以下是可能的原因及对应解决办法：

1. 未正确处理refreshAsync失败场景 #

你的代码中，当refreshAsync执行失败时仅打印日志，仍继续执行set和saveAsync操作。此时本地Settings缓存可能处于不一致状态，后续的保存操作无法正确同步到文档，导致看似成功实际未保存。

修复方案：
在refreshAsync失败时，立即终止流程并通知订阅者错误，不再执行后续操作：

protected saveSetting<T>(key, val): Observable<T> {
  return new Observable<T>(subscriber => { 
    try {                  
      Office.context.document.settings.refreshAsync((asyncResult) => { 
        if (asyncResult.status === Office.AsyncResultStatus.Failed) { 
          const errorMsg = 'refreshAsync failed: ' + asyncResult.error.message;
          console.log(errorMsg);
          subscriber.error(errorMsg); // 通知订阅者错误
          subscriber.complete();
          return; // 终止后续流程
        } 
        Office.context.document.settings.set(key, val); 
        Office.context.document.settings.saveAsync((result) => { 
          if (result.status === Office.AsyncResultStatus.Failed) { 
            const errorMsg = 'saveAsync failed: ' + result.error.message;
            console.log(errorMsg);
            subscriber.error(errorMsg);
          } else {
            // 可选：保存后重新验证值是否存在
            const savedVal = Office.context.document.settings.get(key);
            if (savedVal === val) {
              subscriber.next(val);
            } else {
              subscriber.error('Setting saved but value mismatch');
            }
          }
          subscriber.complete();              
        });          
      });       
    } catch (e) { 
      subscriber.error('Error saving setting ' + key); 
      subscriber.complete();       
    } 
  }); 
}

2. Angular Zone.js干扰Office.js异步回调 #

Angular的Zone.js会追踪异步操作，但Office.js的原生异步回调可能脱离Zone管控，导致Angular无法及时感知状态变化，或Office.js内部状态更新不及时。

修复方案：
使用NgZone将Office.js操作移出Angular Zone，完成后再回调到Zone内：

import { NgZone } from '@angular/core';

// 注入NgZone
constructor(private zone: NgZone) {}

protected saveSetting<T>(key, val): Observable<T> {
  return new Observable<T>(subscriber => { 
    this.zone.runOutsideAngular(() => { // 移出Angular Zone
      try {                  
        Office.context.document.settings.refreshAsync((asyncResult) => { 
          if (asyncResult.status === Office.AsyncResultStatus.Failed) { 
            const errorMsg = 'refreshAsync failed: ' + asyncResult.error.message;
            console.log(errorMsg);
            this.zone.run(() => { // 回到Zone通知错误
              subscriber.error(errorMsg);
              subscriber.complete();
            });
            return;
          } 
          Office.context.document.settings.set(key, val); 
          Office.context.document.settings.saveAsync((result) => { 
            this.zone.run(() => { // 回到Zone处理结果
              if (result.status === Office.AsyncResultStatus.Failed) { 
                const errorMsg = 'saveAsync failed: ' + result.error.message;
                console.log(errorMsg);
                subscriber.error(errorMsg);
              } else {
                subscriber.next(val);
              }
              subscriber.complete();              
            });
          });          
        });       
      } catch (e) { 
        this.zone.run(() => {
          subscriber.error('Error saving setting ' + key); 
          subscriber.complete();
        });
      } 
    });
  }); 
}

3. Office客户端或Office.js版本兼容性问题 #

你使用的Word 2304版本可能存在Settings模块的已知bug，或当前加载的Office.js版本与客户端不兼容。

解决办法：

• 将Word客户端更新到最新稳定版，查看是否修复该问题；
• 加载Office.js时指定稳定版本，例如使用https://appsforoffice.microsoft.com/lib/1/hosted/office.js（最新稳定版），避免使用未稳定的预览版。

4. 设置值的序列化异常 #

若保存的值包含无法被JSON序列化的内容（如循环引用、函数对象等），Office.js可能静默失败，不会抛出错误。

解决办法：

• 确保保存的值为可JSON序列化的类型（对象、数组、字符串、数字等）；
• 保存前可手动序列化验证：JSON.stringify(val)，若抛出错误则调整值的结构。

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