微软Word .NET VSTO自定义加载项闲置一小时后失效问题咨询

我们为Microsoft Word开发了自定义Ribbon，通过绑定Word的DocumentBeforeSave事件在用户保存文档时执行业务逻辑，绑定及事件处理代码如下：

// 该绑定在Ribbon加载时执行
Globals.ThisAddIn.Application.DocumentBeforeSave += Application_DocumentBeforeSave;

// 绑定到事件的处理方法
void Application_DocumentBeforeSave(Word.Document Doc, ref bool SaveAsUI, ref bool Cancel)
{
     // 业务逻辑实现
}

功能原本运行正常，传入的Doc对象包含文档全部内容及相关数据（批注、路径、名称等），但当应用闲置约一小时后，函数无法正常接收数据。

经日志追踪和故障排查，确认以下两点：

• Application_DocumentBeforeSave函数仍正确绑定到对应事件，每次保存都会触发；
• 传入的Word.Document Doc变量不包含活动文档内容及相关数据，调试发现Doc.Path返回路径为C:\Users\<USER>\AppData\Roaming\Microsoft\Word，而非打开文档的预期路径。

请问这是VSTO加载项已知的超时问题吗？是否有解决办法？

问题分析与解决办法 #

这是VSTO加载项中常见的COM对象生存期管理问题，并非单纯的"超时"。Word进程在闲置一段时间后，会对未被强引用的COM包装对象进行回收或状态重置，导致应用级事件绑定关联的文档对象引用失效，最终传入错误的默认文档对象（即你看到的临时路径对应的模板文档）。

以下是几种有效的解决方案：

1. 改用文档级事件绑定（推荐） #

放弃在Application级别绑定DocumentBeforeSave，改为针对每个打开/新建的文档单独绑定Document.BeforeSave事件。这样每个文档的事件关联都是独立的，不会因为应用闲置导致引用失效。

示例代码：

// 加载项启动时绑定文档打开、新建事件
private void ThisAddIn_Startup(object sender, EventArgs e)
{
    Globals.ThisAddIn.Application.DocumentOpen += Application_DocumentOpen;
    Globals.ThisAddIn.Application.NewDocument += Application_NewDocument;
}

// 文档打开时绑定其BeforeSave事件
void Application_DocumentOpen(Word.Document Doc)
{
    Doc.BeforeSave += Doc_BeforeSave;
}

// 新建文档时绑定其BeforeSave事件
void Application_NewDocument(Word.Document Doc)
{
    Doc.BeforeSave += Doc_BeforeSave;
}

// 文档级的BeforeSave事件处理方法
void Doc_BeforeSave(ref bool SaveAsUI, ref bool Cancel)
{
    Word.Document currentDoc = this as Word.Document;
    // 此处执行业务逻辑，currentDoc为当前触发保存的有效文档对象
}

2. 维护文档对象的强引用集合 #

如果必须使用应用级事件，需在加载项中维护一个存活的文档对象集合，保存所有打开文档的强引用，防止.NET垃圾回收器回收COM包装对象导致事件关联失效。同时在文档关闭时移除对应引用。

示例代码：

private List<Word.Document> _openDocuments = new List<Word.Document>();

private void ThisAddIn_Startup(object sender, EventArgs e)
{
    Application.DocumentOpen += Application_DocumentOpen;
    Application.DocumentBeforeClose += Application_DocumentBeforeClose;
    Application.DocumentBeforeSave += Application_DocumentBeforeSave;
}

void Application_DocumentOpen(Word.Document Doc)
{
    lock (_openDocuments)
    {
        if (!_openDocuments.Contains(Doc))
            _openDocuments.Add(Doc);
    }
}

void Application_DocumentBeforeClose(Word.Document Doc, ref bool Cancel)
{
    lock (_openDocuments)
    {
        if (_openDocuments.Contains(Doc))
            _openDocuments.Remove(Doc);
    }
}

void Application_DocumentBeforeSave(Word.Document Doc, ref bool SaveAsUI, ref bool Cancel)
{
    // 验证传入的Doc是否为有效文档
    if (string.IsNullOrEmpty(Doc.Path) || 
        Doc.Path.Equals(@"C:\Users\<USER>\AppData\Roaming\Microsoft\Word", StringComparison.OrdinalIgnoreCase))
    {
        // 重新获取当前活动文档
        Doc = Application.ActiveDocument;
    }
    // 执行业务逻辑
}

3. 禁用Word的COM对象闲置回收（不推荐） #

可以通过修改注册表关闭Word的COM对象闲置回收，但这会增加Word的内存占用并影响性能，仅作为临时应急方案：

• 打开注册表编辑器，定位到HKEY_CURRENT_USER\Software\Microsoft\Office\<你的Word版本>\Word\Options
• 添加DWORD值IdleShutdownMinutes，设置为0（表示永不触发闲置回收）；或添加DWORD值DisableAutoRecover，设置为1

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