在 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 的文件，然后运行 视图：拆分编辑器 命令。在这种情况下，仍然只有一个 TextDocument，因为工作区中该资源仍然只有一个副本，但现在该资源有两个 webview。

CustomEditor 与 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 用户界面中标识自定义编辑器的名称。

    显示名称会显示给用户，例如在 VS Code 用户界面中的 视图：使用...重新打开 下拉菜单中。

  • 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 只是向用户显示有关可用自定义编辑器的一些信息（例如通过 视图：使用...重新打开 命令），您的扩展将不会被激活。

自定义文本编辑器

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

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

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

VS Code 处理自定义文本编辑器的视图组件（webview）和模型组件（TextDocument）的生命周期。当需要创建新的自定义编辑器实例时，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 返回，我们的自定义编辑器就会显示给用户。webivew 中绘制的内容完全取决于我们的扩展。

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

关闭自定义文本编辑器

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

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

与 TextDocument 同步更改

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

从 webview 到 TextDocument

自定义文本编辑器中的编辑可以采取多种不同形式——点击按钮、更改文本、拖动项目等。每当用户在自定义文本编辑器中编辑文件本身时，扩展必须更新 TextDocument。猫抓扩展是这样实现的：

  1. 用户点击 webview 中的 添加便签 按钮。这会从 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 使用步骤 2 中的 CustomDocument 和一个新的 WebviewPanel 调用 resolveCustomEditor。

    在这里，我们的扩展必须填充自定义编辑器的初始 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 的实现必须清理与文档关联的任何资源。

如果用户随后使用我们的自定义编辑器重新打开同一资源，我们将通过新的 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 — 可选文本，描述所做的编辑类型（例如：“裁剪”、“插入”等）。
  • undo — 当需要撤消编辑时由 VS Code 调用的函数。
  • redo — 当需要重做编辑时由 VS Code 调用的函数。

当扩展从 onDidChangeCustomDocument 触发 CustomDocumentEditEvent 时，VS Code 会将关联的文档标记为脏文件。要使文档不再脏，用户可以保存或还原文档，或者撤消/重做回文档上次保存的状态。

当特定编辑需要撤消或重新应用时，VS Code 会调用编辑器上的 undo 和 redo 方法。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 确实具有显著的内存开销，因此请谨慎使用它。

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

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

下一步

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

06/12/2025