VSCode扩展开发：如何即时检测API打开的文档窗口关闭？

这确实是VSCode的有意设计，不是Bug。我之前开发扩展时也遇到过一模一样的问题，查了VSCode源码和官方讨论才搞清楚背后的逻辑：

VSCode为了优化性能，会对「通过API自动打开、而非用户手动打开」的文档做临时缓存处理。这类文档被关闭后，并不会立即触发onDidCloseTextDocument事件，而是会在后台保留一段时间（通常是几分钟），等系统判定不再需要时才清理缓存，这时才会触发关闭事件。

如何实现文档窗口关闭的即时检测？ #

你可以通过主动跟踪自己通过API打开的文档，结合编辑器可见性变化事件来实现即时检测，具体步骤如下：

• 第一步：记录API打开的文档
  维护一个集合，专门存储你通过API（比如vscode.window.showTextDocument）打开的文档URI，这样能区分开用户手动打开的文档和你的扩展自动打开的文档。

• 第二步：监听编辑器可见性变化
  使用vscode.window.onDidChangeVisibleTextEditors事件，当可见编辑器列表变化时，检查你记录的文档是否还在可见列表中。如果不在，就说明这个文档窗口已经被关闭，可以立即执行你的处理逻辑。

代码示例 #

// 存储扩展通过API打开的文档URI字符串
const apiOpenedDocuments = new Set<string>();

// 封装扩展打开文档的方法，同时记录URI
async function openDocumentViaApi(uri: vscode.Uri): Promise<vscode.TextEditor | undefined> {
    try {
        const editor = await vscode.window.showTextDocument(uri);
        apiOpenedDocuments.add(editor.document.uri.toString());
        return editor;
    } catch (error) {
        console.error("打开文档失败:", error);
        return undefined;
    }
}

// 监听可见编辑器变化，检测文档是否被关闭
vscode.window.onDidChangeVisibleTextEditors((visibleEditors) => {
    // 获取当前所有可见文档的URI集合
    const visibleDocUris = new Set(visibleEditors.map(editor => editor.document.uri.toString()));

    // 遍历我们记录的API打开文档，检查是否已不在可见列表中
    for (const uriStr of apiOpenedDocuments) {
        if (!visibleDocUris.has(uriStr)) {
            // 这里执行文档关闭后的逻辑
            console.log(`检测到API打开的文档已关闭: ${uriStr}`);
            // 从记录中移除，避免重复处理
            apiOpenedDocuments.delete(uriStr);
        }
    }
});

// 同时保留原生关闭事件作为兜底（处理缓存清理时的触发）
vscode.workspace.onDidCloseTextDocument((doc) => {
    if (apiOpenedDocuments.has(doc.uri.toString())) {
        console.log(`原生关闭事件触发: ${doc.uri.toString()}`);
        apiOpenedDocuments.delete(doc.uri.toString());
    }
});

补充说明 #

VSCode的这个设计是为了避免频繁触发文件关闭事件，尤其是当扩展批量打开文档时，快速切换窗口不会导致大量的IO操作和事件回调，从而提升整体性能。通过主动跟踪的方式，你可以绕过这个缓存机制，实现对自己扩展打开文档的即时关闭检测。

内容的提问来源于stack exchange，提问作者A. Cheshirov