尝试以扩展 VS Code 中的代理模式！

自定义编辑器 API

自定义编辑器允许扩展程序创建完全可定制的读写编辑器，用于替换 VS Code 的标准文本编辑器，以处理特定类型的资源。它们具有广泛的用例，例如：

  • 直接在 VS Code 中预览资产，例如着色器或 3D 模型。
  • 为 Markdown 或 XAML 等语言创建 WYSIWYG（所见即所得）编辑器。
  • 为 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 中的自定义编辑器贡献与代码中的自定义编辑器实现关联起来的方式。此标识符在所有扩展中必须是唯一的，因此不要使用通用的 viewType，例如 "preview"，请确保使用对您的扩展程序而言唯一的标识符，例如 "viewType": "myAmazingExtension.svgPreview"。

  • displayName - 在 VS Code UI 中标识自定义编辑器的名称。

    显示名称会显示给用户，例如在 View: Reopen with 下拉菜单中。

  • selector - 指定自定义编辑器对哪些文件有效。

    selector 是一个或多个全局模式的数组。这些全局模式会与文件名匹配，以确定自定义编辑器是否可用于它们。例如，filenamePattern 如 *.png 将为所有 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作为其文档模型。

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

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

VS Code 处理自定义文本编辑器的视图组件（Webview）和模型组件（TextDocument）的生命周期。当需要创建新的自定义编辑器实例时，VS Code 会调用您的扩展；当用户关闭其选项卡时，VS Code 会清理编辑器实例和文档模型。

为了理解这一切在实践中是如何工作的，让我们从扩展程序的角度来看看当用户打开一个自定义文本编辑器，然后关闭一个自定义文本编辑器时会发生什么。

打开自定义文本编辑器

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

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

    如果我们的扩展尚未激活，这将激活它。在激活期间，我们的扩展必须通过调用 registerCustomEditorProvider 确保为 catCustoms.catScratch 注册一个 CustomTextEditorProvider。

  2. VS Code 随后调用为 catCustoms.catScratch 注册的 CustomTextEditorProvider 上的 resolveCustomTextEditor。

    此方法接收正在打开的资源的 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。以下是猫抓扩展实现此功能的方式：

  1. 用户点击 Webview 中的 Add scratch 按钮。这会从 Webview 发布一条消息回扩展程序。

  2. 扩展程序收到消息。然后它更新其内部的文档模型（在猫抓示例中，这仅包括向 JSON 添加一个新条目）。

  3. 扩展程序创建一个 WorkspaceEdit，将更新后的 JSON 写入文档。此编辑使用 vscode.workspace.applyEdit 应用。

尽量将您的工作区编辑保持为更新文档所需的最少更改。另请记住，如果您正在处理 JSON 等语言，您的扩展程序应尝试遵守用户现有的格式约定（空格与制表符、缩进大小等）。

从 TextDocument 到 Webview

当 TextDocument 发生更改时，您的扩展程序还需要确保其 Webview 反映文档的新状态。TextDocument 可以通过用户操作（例如撤销、重做或文件恢复）、通过其他扩展程序使用 WorkspaceEdit，或者通过用户在 VS Code 的默认文本编辑器中打开文件来更改。以下是猫抓扩展程序如何实现此功能：

  1. 在扩展程序中，我们订阅了 vscode.workspace.onDidChangeTextDocument 事件。此事件会在 TextDocument 发生每次更改时触发（包括我们的自定义编辑器所做的更改！）

  2. 当我们的编辑器所编辑的文档发生更改时，我们会向 Webview 发布一条包含其新文档状态的消息。然后该 Webview 会自行更新以渲染更新后的文档。

重要的是要记住，自定义编辑器触发的任何文件编辑都会导致 onDidChangeTextDocument 触发。请确保您的扩展程序不会陷入更新循环，即用户在 Webview 中进行编辑，这会触发 onDidChangeTextDocument，导致 Webview 更新，从而导致 Webview 触发您的扩展程序上的另一次更新，然后又触发 onDidChangeTextDocument，如此循环往复。

还要记住，如果您正在处理 JSON 或 XML 等结构化语言，文档可能并不总是处于有效状态。您的扩展程序必须能够优雅地处理错误，或者向用户显示错误消息，以便他们了解问题所在以及如何修复。

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

自定义编辑器

CustomEditorProvider 和 CustomReadonlyEditorProvider 允许您为二进制文件格式创建自定义编辑器。此 API 赋予您对文件如何显示给用户、如何进行编辑的完全控制，并允许您的扩展程序挂接到 save 和其他文件操作。再次强调，如果您正在为基于文本的文件格式构建编辑器，强烈建议使用CustomTextEditor，因为它们实现起来要简单得多。

自定义编辑器扩展示例包含一个简单的爪子绘图文件（只是以 .pawdraw 文件扩展名结尾的 jpeg 文件）的自定义二进制编辑器示例。让我们来看看构建二进制文件的自定义编辑器需要哪些内容。

CustomDocument

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

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

自定义编辑器生命周期

supportsMultipleEditorsPerDocument

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

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

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

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

    如果我们的扩展尚未激活，这将激活它。我们还必须确保我们的扩展在激活期间为 catCustoms.pawDraw 注册一个 CustomReadonlyEditorProvider 或 CustomEditorProvider。

  2. VS Code 调用为 catCustoms.pawDraw 编辑器注册的 CustomReadonlyEditorProvider 或 CustomEditorProvider 上的 openCustomDocument。

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

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

  3. VS Code 调用 resolveCustomEditor，其中包含步骤 2 中的 CustomDocument 和一个新的 WebviewPanel。

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

一旦 resolveCustomEditor 返回，我们的自定义编辑器就会显示给用户。

如果用户使用我们的自定义编辑器在另一个编辑器组中打开相同的资源——例如通过分割第一个编辑器——扩展程序的工作就简化了。在这种情况下，VS Code 只会使用我们打开第一个编辑器时创建的相同 CustomDocument 调用 resolveCustomEditor。

关闭自定义编辑器

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

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

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

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

只读自定义编辑器

以下许多部分仅适用于支持编辑的自定义编辑器，虽然这听起来可能有些矛盾，但许多自定义编辑器根本不需要编辑功能。例如，考虑一个图像预览器。或者内存转储的视觉渲染。两者都可以使用自定义编辑器实现，但都不需要可编辑。这就是 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 — 描述所做编辑类型的可选文本（例如：“裁剪”、“插入”等）。
  • 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 扩展性方面的信息，请尝试以下主题：

07/09/2025