自定义编辑器 API

自定义编辑器允许扩展创建完全可定制的读/写编辑器，这些编辑器可以代替 VS Code 对特定类型资源的标准文本编辑器。它们有多种用例，例如：

直接在 VS Code 中预览着色器或 3D 模型等资源。
为 Markdown 或 XAML 等语言创建所见即所得编辑器。
为 CSV、JSON 或 XML 等数据文件提供替代的可视化渲染。
为二进制或文本文件构建完全可定制的编辑体验。

本文档提供了自定义编辑器 API 的概述以及实现自定义编辑器的基础知识。我们将探讨两种类型的自定义编辑器及其差异，以及哪种适合您的用例。然后，对于每种自定义编辑器类型，我们将介绍构建一个行为良好的自定义编辑器的基础知识。

虽然自定义编辑器是一个强大的新扩展点，但实现一个基本的自定义编辑器实际上并不难！但是，如果您正在开发第一个 VS Code 扩展，您可能想在深入研究自定义编辑器之前，先熟悉 VS Code API 的基础知识。自定义编辑器建立在许多 VS Code 概念之上，例如 Webview 和文本文档，因此如果您同时学习所有这些新概念，可能会让人不知所措。

但是，如果您感觉准备好了，并且正在考虑您将要构建的所有很棒的自定义编辑器，那么让我们开始吧！请务必下载自定义编辑器扩展示例，以便您可以跟随文档并了解自定义编辑器 API 如何协同工作。

链接

自定义编辑器示例

VS Code API 用法

自定义编辑器 API 基础知识

自定义编辑器是显示在特定资源的标准 VS Code 文本编辑器位置的替代视图。自定义编辑器有两个部分：用户与之交互的视图和您的扩展用来与底层资源交互的文档模型。

自定义编辑器的视图部分使用 Webview 实现。这允许您使用标准的 HTML、CSS 和 JavaScript 构建自定义编辑器的用户界面。Webview 不能直接访问 VS Code API，但可以通过双向传递消息与扩展进行通信。有关 Webview 的更多信息以及使用它们的最佳实践，请查看我们的 Webview 文档。

自定义编辑器的另一部分是文档模型。此模型是您的扩展如何理解它正在处理的资源（文件）。CustomTextEditorProvider 使用 VS Code 的标准 TextDocument 作为其文档模型，并且所有对文件的更改都使用 VS Code 的标准文本编辑 API 来表达。另一方面，CustomReadonlyEditorProvider 和 CustomEditorProvider 允许您提供自己的文档模型，这使得它们可以用于非文本文件格式。

自定义编辑器每个资源只有一个文档模型，但可能存在此文档的多个编辑器实例（视图）。例如，想象一下您打开了一个具有 CustomTextEditorProvider 的文件，然后运行 View: Split editor 命令。在这种情况下，仍然只有一个 TextDocument，因为工作区中仍然只有一个资源的副本，但现在有两个用于该资源的 Webview。

`CustomEditor` vs `CustomTextEditor`

自定义编辑器分为两类：自定义文本编辑器和自定义编辑器。它们之间的主要区别在于它们如何定义它们的文档模型。

CustomTextEditorProvider 使用 VS Code 的标准 TextDocument 作为其数据模型。您可以使用 CustomTextEditor 处理任何基于文本的文件类型。CustomTextEditor 的实现要容易得多，因为 VS Code 已经知道如何处理文本文件，因此可以实现诸如保存和备份文件以用于热退出等操作。

另一方面，使用 CustomEditorProvider，您的扩展需要提供自己的文档模型。这意味着您可以使用 CustomEditor 处理二进制格式，例如图像，但也意味着您的扩展需要负责更多工作，包括实现保存和备份。如果您的自定义编辑器是只读的，例如用于预览的自定义编辑器，则可以跳过其中许多复杂性。

在决定使用哪种类型的自定义编辑器时，决定通常很简单：如果您正在处理基于文本的文件格式，请使用 CustomTextEditorProvider；对于二进制文件格式，请使用 CustomEditorProvider。

贡献点

customEditors 贡献点是您的扩展告知 VS Code 其提供的自定义编辑器的方式。例如，VS Code 需要知道您的自定义编辑器处理哪些类型的文件，以及如何在任何 UI 中识别您的自定义编辑器。

这是自定义编辑器扩展示例的一个基本 customEditor 贡献。

"contributes": {
  "customEditors": [
    {
      "viewType": "catEdit.catScratch",
      "displayName": "Cat Scratch",
      "selector": [
        {
          "filenamePattern": "*.cscratch"
        }
      ],
      "priority": "default"
    }
  ]
}

customEditors 是一个数组，因此您的扩展可以贡献多个自定义编辑器。让我们分解一下自定义编辑器条目本身。

viewType - 您的自定义编辑器的唯一标识符。

这是 VS Code 如何将 package.json 中的自定义编辑器贡献与代码中的自定义编辑器实现联系起来。这在所有扩展中必须是唯一的，所以不要使用像 "preview" 这样通用的 viewType，而要确保使用一个对您的扩展来说是唯一的，例如 "viewType": "myAmazingExtension.svgPreview"。
displayName - 在 VS Code UI 中标识自定义编辑器的名称。

显示名称会显示给用户，例如在 View: Reopen with 下拉菜单中。
selector - 指定自定义编辑器在哪些文件上激活。

selector 是一个或多个 Glob 模式的数组。这些 Glob 模式会与文件名匹配，以确定是否可以使用自定义编辑器。像 *.png 这样的 filenamePattern 将为所有 PNG 文件启用自定义编辑器。

您还可以创建更具体的模式来匹配文件或目录名，例如 **/translations/*.json。
priority - (可选) 指定何时使用自定义编辑器。

priority 控制在打开资源时何时使用自定义编辑器。可能的值是：
- "default" - 尝试为匹配自定义编辑器 selector 的每个文件使用自定义编辑器。如果一个文件有多个自定义编辑器，用户将不得不选择他们想要使用的自定义编辑器。
- "option" - 默认不使用自定义编辑器，但允许用户切换到它或将其配置为默认编辑器。

自定义编辑器激活

当用户打开您的自定义编辑器之一时，VS Code 会触发 onCustomEditor:VIEW_TYPE 激活事件。在激活期间，您的扩展必须调用 registerCustomEditorProvider 来注册一个具有预期的 viewType 的自定义编辑器。

需要注意的是，onCustomEditor 仅在 VS Code 需要创建自定义编辑器实例时调用。如果 VS Code 仅仅向用户显示有关可用自定义编辑器的信息（例如通过 View: Reopen with 命令），您的扩展将不会被激活。

自定义文本编辑器

自定义文本编辑器允许您为文本文件创建自定义编辑器。这可以是任何东西，从纯文本到 CSV 再到 JSON 或 XML。自定义文本编辑器使用 VS Code 的标准 TextDocument 作为其文档模型。

自定义编辑器扩展示例包含一个简单的自定义文本编辑器示例，用于 cat scratch 文件（这些文件只是以 .cscratch 文件扩展名结尾的 JSON 文件）。让我们看一下实现自定义文本编辑器的一些重要部分。

自定义文本编辑器生命周期

VS Code 负责管理自定义文本编辑器视图组件（Webview）和模型组件（TextDocument）的生命周期。当需要创建新的自定义编辑器实例时，VS Code 会调用您的扩展，并在用户关闭标签页时清理编辑器实例和文档模型。

为了理解这一切是如何实际工作的，让我们一步步地了解当用户打开自定义文本编辑器以及当用户关闭自定义文本编辑器时，从扩展的角度会发生什么。

打开自定义文本编辑器

使用自定义编辑器扩展示例，当用户首次打开 .cscratch 文件时，会发生以下情况：

VS Code 触发 onCustomEditor:catCustoms.catScratch 激活事件。

如果我们的扩展尚未激活，这将激活它。在激活期间，我们的扩展必须通过调用 registerCustomEditorProvider 来确保它为 catCustoms.catScratch 注册一个 CustomTextEditorProvider。
VS Code 然后调用已注册的 CustomTextEditorProvider 的 resolveCustomTextEditor 方法，用于 catCustoms.catScratch。

此方法接收要打开的资源的 TextDocument 和一个 WebviewPanel。扩展必须填充此 Webview 面板的初始 HTML 内容。

resolveCustomTextEditor 返回后，我们的自定义编辑器将显示给用户。Webview 中渲染的内容完全取决于我们的扩展。

每次打开自定义编辑器时，都会发生相同的流程，即使您拆分自定义编辑器。自定义编辑器的每个实例都有自己的 WebviewPanel，尽管多个自定义文本编辑器将共享同一 TextDocument（如果它们是针对同一资源的）。请记住：将 TextDocument 视为资源的模型，而 Webview 面板是该模型的视图。

关闭自定义文本编辑器

当用户关闭自定义文本编辑器时，VS Code 会在 WebviewPanel 上触发 WebviewPanel.onDidDispose 事件。此时，您的扩展应清理与该编辑器关联的任何资源（事件订阅、文件观察器等）。

当给定资源的最后一个自定义编辑器关闭时，该资源的 TextDocument 也将被释放，前提是没有其他编辑器使用它，也没有其他扩展持有它。您可以使用 TextDocument.isClosed 属性来检查 TextDocument 是否已关闭。一旦 TextDocument 关闭，使用自定义编辑器打开同一资源将导致打开一个新的 TextDocument。

将更改与 TextDocument 同步

由于自定义文本编辑器使用 TextDocument 作为其文档模型，因此它们负责在自定义编辑器中发生编辑时更新 TextDocument，以及在 TextDocument 更改时更新自身。

从 Webview 到 TextDocument

自定义文本编辑器中的编辑可以采取多种形式——单击按钮、更改文本、拖动项目等。每当用户在自定义编辑器内的文件本身进行编辑时，扩展都必须更新 TextDocument。以下是 cat scratch 扩展实现此功能的方式：

用户单击 Webview 中的 Add scratch 按钮。此操作从 Webview 发布消息回到扩展。
扩展接收消息。然后它更新其文档的内部模型（在 cat scratch 示例中，这只是在 JSON 中添加一个新条目）。
扩展创建一个 WorkspaceEdit，将更新后的 JSON 写入文档。此编辑使用 vscode.workspace.applyEdit 应用。

尽量使您的工作区编辑保持对文档进行更新所需的最少更改。还要记住，如果您处理的是 JSON 或 XML 等语言，您的扩展应该尝试遵循用户现有的格式约定（空格与制表符，缩进大小等）。

从 TextDocument 到 Webview

当 TextDocument 更改时，您的扩展还需要确保其 Webview 反映文档的新状态。TextDocument 可以由用户操作（如撤销、重做或还原文件）、其他扩展使用 WorkspaceEdit 进行更改，或者由在 VS Code 的默认文本编辑器中打开文件的用户进行更改。以下是 cat scratch 扩展实现此功能的方式：

在扩展中，我们订阅 vscode.workspace.onDidChangeTextDocument 事件。此事件在 TextDocument 的每次更改时触发（包括我们的自定义编辑器进行的更改！）。
当收到我们有编辑器正在处理的文档的更改时，我们会将新文档状态的消息发布到 Webview。然后，Webview 会更新自身以渲染更新后的文档。

重要的是要记住，自定义编辑器触发的任何文件编辑都会导致 onDidChangeTextDocument 触发。确保您的扩展不会陷入更新循环，即用户在 Webview 中进行编辑，这会触发 onDidChangeTextDocument，这会导致 Webview 更新，这会导致 Webview 触发您扩展的另一个更新，这会触发 onDidChangeTextDocument，依此类推。

另外请记住，如果您正在处理像 JSON 或 XML 这样的结构化语言，文档可能不总是处于有效状态。您的扩展必须能够优雅地处理错误，或者向用户显示错误消息，以便他们了解哪里出了问题以及如何修复它。

最后，如果更新您的 Webview 成本很高，请考虑防抖 Webview 的更新。

自定义编辑器

CustomEditorProvider 和 CustomReadonlyEditorProvider 允许您为二进制文件格式创建自定义编辑器。此 API 使您可以完全控制文件如何显示给用户、如何对其进行编辑，并允许您的扩展挂钩到 save 和其他文件操作。同样，如果您正在为基于文本的文件格式构建编辑器，请强烈考虑使用 CustomTextEditor，因为它们更容易实现。

自定义编辑器扩展示例包含一个简单的自定义二进制编辑器示例，用于 paw draw 文件（这些文件只是以 .pawdraw 文件扩展名结尾的 JPEG 文件）。让我们看一下为二进制文件构建自定义编辑器需要注意的事项。

CustomDocument

对于自定义编辑器，您的扩展负责实现自己的文档模型，即 CustomDocument 接口。这使您的扩展可以自由地在 CustomDocument 上存储与自定义编辑器交互所需的任何数据，但也意味着您的扩展必须实现基本的文档操作，例如保存和备份文件数据以供热退出。

每个打开的文件都有一个 CustomDocument。用户可以为单个资源打开多个编辑器（例如，通过拆分当前自定义编辑器），但所有这些编辑器都将由同一个 CustomDocument 支持。

自定义编辑器生命周期

supportsMultipleEditorsPerDocument

默认情况下，VS Code 只允许每个自定义文档有一个编辑器。此限制使正确实现自定义编辑器更加容易，因为您不必担心同步多个自定义编辑器实例。

但是，如果您的扩展支持，我们建议在注册自定义编辑器时设置 supportsMultipleEditorsPerDocument: true，以便可以为同一文档打开多个编辑器实例。这将使您的自定义编辑器更像 VS Code 的常规文本编辑器。

打开自定义编辑器 当用户打开一个与 customEditor 贡献点匹配的文件时，VS Code 会触发一个 onCustomEditor 激活事件，然后调用为提供的视图类型注册的提供程序。CustomEditorProvider 有两个角色：提供自定义编辑器的文档，然后提供编辑器本身。以下是自定义编辑器扩展示例中 catCustoms.pawDraw 编辑器的操作流程：

VS Code 触发 onCustomEditor:catCustoms.pawDraw 激活事件。

如果我们的扩展尚未激活，这将激活它。在激活期间，我们还必须确保我们的扩展为 catCustoms.pawDraw 注册一个 CustomReadonlyEditorProvider 或 CustomEditorProvider。
VS Code 调用我们为 catCustoms.pawDraw 编辑器注册的 CustomReadonlyEditorProvider 或 CustomEditorProvider 上的 openCustomDocument。

在这里，我们的扩展会收到一个资源 URI，并且必须为该资源返回一个新的 CustomDocument。这是我们的扩展应该创建该资源的内部文档模型的时候。这可能涉及从磁盘读取和解析初始资源状态，或初始化我们的新 CustomDocument。

我们的扩展可以通过创建一个实现 CustomDocument 的新类来定义此模型。请记住，此初始化阶段完全取决于扩展；VS Code 不关心扩展存储在 CustomDocument 上的任何额外信息。
VS Code 调用 resolveCustomEditor，传入第 2 步中的 CustomDocument 和一个新的 WebviewPanel。

在这里，我们的扩展必须填充自定义编辑器的初始 HTML。如果需要，我们还可以保留对 WebviewPanel 的引用，以便稍后引用它，例如在命令内部。

resolveCustomEditor 返回后，我们的自定义编辑器将显示给用户。

如果用户在另一个编辑器组中打开同一资源（例如，通过拆分第一个编辑器），则扩展的工作会变得更简单。在这种情况下，VS Code 只是调用 resolveCustomEditor，传入我们在打开第一个编辑器时创建的相同 CustomDocument。

关闭自定义编辑器

假设我们打开了同一个资源的两个自定义编辑器实例。当用户关闭这些编辑器时，VS Code 会向我们的扩展发出信号，以便它可以清理与编辑器相关的任何资源。

当第一个编辑器实例关闭时，VS Code 会在关闭的编辑器中的 WebviewPanel 上触发 WebviewPanel.onDidDispose 事件。此时，我们的扩展必须清理与该特定编辑器实例相关的任何资源。

当第二个编辑器关闭时，VS Code 再次触发 WebviewPanel.onDidDispose。但现在我们还关闭了与 CustomDocument 相关的所有编辑器。当不再有 CustomDocument 的编辑器时，VS Code 会调用其 CustomDocument.dispose。我们扩展的 dispose 实现必须清理与文档相关的任何资源。

如果用户随后使用我们的自定义编辑器重新打开同一资源，我们将通过一个新的 CustomDocument 重新经历整个 openCustomDocument、resolveCustomEditor 流程。

只读自定义编辑器

以下许多部分仅适用于支持编辑的自定义编辑器，并且，尽管听起来有些矛盾，但许多自定义编辑器根本不需要编辑功能。例如，考虑一个图像预览。或者内存转储的可视化渲染。两者都可以使用自定义编辑器实现，但两者都不需要可编辑。这就是 CustomReadonlyEditorProvider 的用武之地。

CustomReadonlyEditorProvider 允许您创建不支持编辑的自定义编辑器。它们仍然可以是交互式的，但不支持撤销和保存等操作。与完全可编辑的自定义编辑器相比，实现只读自定义编辑器要简单得多。

可编辑自定义编辑器基础知识

可编辑自定义编辑器允许您挂钩到标准的 VS Code 操作，如撤销和重做、保存和热退出。这使得可编辑自定义编辑器非常强大，但也意味着正确实现它们比实现可编辑自定义文本编辑器或只读自定义编辑器要复杂得多。

可编辑自定义编辑器由 CustomEditorProvider 实现。此接口扩展了 CustomReadonlyEditorProvider，因此您必须实现基本的 openCustomDocument 和 resolveCustomEditor 操作，以及一组特定于编辑的操作。让我们看一下 CustomEditorProvider 的特定于编辑的部分。

编辑

对可编辑自定义文档的更改通过编辑来表达。编辑可以是任何东西，从文本更改到图像旋转，再到列表重新排序。VS Code 将编辑的具体内容完全留给您的扩展，但 VS Code 需要知道何时发生编辑。编辑是 VS Code 标记文档为脏状态的方式，这反过来又启用了自动保存和备份。

每当用户在您的自定义编辑器的任何 Webview 中进行编辑时，您的扩展都必须从其 CustomEditorProvider 触发 onDidChangeCustomDocument 事件。onDidChangeCustomDocument 事件可以根据您的自定义编辑器实现触发两种事件类型：CustomDocumentContentChangeEvent 和 CustomDocumentEditEvent。

CustomDocumentContentChangeEvent

CustomDocumentContentChangeEvent 是一个基本编辑。它的唯一功能是告诉 VS Code 文档已被编辑。

当扩展从 onDidChangeCustomDocument 触发 CustomDocumentContentChangeEvent 时，VS Code 会将关联的文档标记为脏。此时，文档变回干净状态的唯一方法是用户保存或还原它。使用 CustomDocumentContentChangeEvent 的自定义编辑器不支持撤销/重做。

CustomDocumentEditEvent

CustomDocumentEditEvent 是一个更复杂的编辑，支持撤销/重做。您应该始终尝试使用 CustomDocumentEditEvent 来实现您的自定义编辑器，并且只有在无法实现撤销/重做时才回退到使用 CustomDocumentContentChangeEvent。

CustomDocumentEditEvent 具有以下字段：

document — 编辑针对的 CustomDocument。
label — 可选文本，描述进行了什么类型的编辑（例如：“Crop”、“Insert”、...）。
undo — VS Code 在需要撤销编辑时调用的函数。
redo — VS Code 在需要重做编辑时调用的函数。

当扩展从 onDidChangeCustomDocument 触发 CustomDocumentEditEvent 时，VS Code 会将关联的文档标记为脏。为了使文档不再是脏的，用户可以通过保存或还原文档，或者通过撤销/重做回到文档的最后一个保存状态。

编辑器上的 undo 和 redo 方法在需要撤销或重做特定编辑时由 VS Code 调用。VS Code 维护一个内部编辑堆栈，因此如果您的扩展使用三个编辑触发 onDidChangeCustomDocument，我们称之为 a、b、c。

onDidChangeCustomDocument(a);
onDidChangeCustomDocument(b);
onDidChangeCustomDocument(c);

以下用户操作顺序会导致这些调用：

undo — c.undo()
undo — b.undo()
redo — b.redo()
redo — c.redo()
redo — no op, no more edits

要实现撤销/重做，您的扩展必须更新其关联的自定义文档的内部状态，以及更新文档的所有关联 Webview，以便它们反映文档的新状态。请记住，单个资源可能存在多个 Webview。这些 Webview 必须始终显示相同的数据。例如，图像编辑器的多个实例必须始终显示相同的像素数据，但可能允许每个编辑器实例拥有自己的缩放级别和 UI 状态。

保存

当用户保存自定义编辑器时，您的扩展负责将资源的当前状态写入磁盘。您的自定义编辑器如何执行此操作很大程度上取决于您的扩展的 CustomDocument 类型以及您的扩展如何在内部跟踪编辑。

保存的第一步是获取要写入磁盘的数据流。常见的方法包括：

跟踪资源的状万，以便可以快速序列化。

例如，一个基本的图像编辑器可能维护一个像素数据缓冲区。
重放自上次保存以来的编辑以生成新文件。

例如，一个更高效的图像编辑器可能会跟踪自上次保存以来的编辑，例如 crop、rotate、scale。在保存时，它会将这些编辑应用到文件的最后一个保存状态，以生成新文件。
向 WebviewPanel 请求自定义编辑器以保存文件数据。

但请记住，即使自定义编辑器不可见，也可以保存它们。因此，建议您的扩展的 save 实现不要依赖于 WebviewPanel。如果这不可行，您可以使用 WebviewPanelOptions.retainContextWhenHidden 设置，以便 Webview 即使在隐藏时也能保持活动状态。retainContextWhenHidden 确实有很高的内存开销，所以在使用它时要谨慎。

在获取资源数据后，您通常应该使用工作区 FS API 将其写入磁盘。FS API 接受 UInt8Array 数据，并且可以写入二进制和文本文件。对于二进制文件数据，只需将二进制数据放入 UInt8Array。对于文本文件数据，使用 Buffer 将字符串转换为 UInt8Array。

const writeData = Buffer.from('my text data', 'utf8');
vscode.workspace.fs.writeFile(fileUri, writeData);

后续步骤

如果您想了解更多关于 VS Code 可扩展性的信息，请尝试以下主题：

扩展 API - 了解完整的 VS Code 扩展 API。
扩展功能 - 查看扩展 VS Code 的其他方法。

01/08/2026