🚀 在 VS Code 中！

Webview API

webview API 允许扩展在 Visual Studio Code 中创建完全自定义的视图。例如，内置的 Markdown 扩展使用 webview 来渲染 Markdown 预览。Webview 还可以用于构建超出 VS Code 原生 API 支持的复杂用户界面。

将 webview 视为 VS Code 中由你的扩展控制的 iframe。Webview 可以在此框架中渲染几乎任何 HTML 内容，并使用消息传递与扩展进行通信。这种自由度使 webview 非常强大，并开辟了全新的扩展可能性。

Webview 在多个 VS Code API 中使用

  • 使用 createWebviewPanel 创建的 Webview 面板。在这种情况下，Webview 面板在 VS Code 中显示为不同的编辑器。这使得它们非常适合显示自定义 UI 和自定义可视化效果。
  • 作为自定义编辑器的视图。自定义编辑器允许扩展为工作区中的任何文件提供自定义 UI 以进行编辑。自定义编辑器 API 还允许你的扩展挂钩到编辑器事件（例如撤消和重做）以及文件事件（例如保存）。
  • 在侧边栏或面板区域中渲染的Webview 视图中。有关更多详细信息，请参阅webview 视图示例扩展。

本页重点介绍基本的 webview 面板 API，尽管此处涵盖的几乎所有内容也适用于自定义编辑器和 webview 视图中使用的 webview。即使你对这些 API 更感兴趣，我们也建议你首先阅读本页以熟悉 webview 的基础知识。

VS Code API 用法

我应该使用 webview 吗？

Webview 非常棒，但也应谨慎使用，仅在 VS Code 的原生 API 不足时才使用。Webview 资源密集型，并在与普通扩展不同的上下文中运行。设计不良的 webview 也很容易在 VS Code 中显得格格不入。

在使用 webview 之前，请考虑以下事项

  • 此功能真的需要驻留在 VS Code 中吗？作为单独的应用程序或网站是否更好？

  • webview 是实现你的功能的唯一方法吗？你可以改用常规 VS Code API 吗？

  • 你的 webview 会增加足够的用户价值来证明其高资源成本吗？

记住：仅仅因为你可以使用 webview 做某事，并不意味着你应该这样做。但是，如果你确信你需要使用 webview，那么本文档将为你提供帮助。让我们开始吧。

Webview API 基础知识

为了解释 webview API，我们将构建一个名为 Cat Coding 的简单扩展。此扩展将使用 webview 显示一只猫编写代码（大概是在 VS Code 中）的 gif 动画。当我们学习 API 时，我们将继续向扩展添加功能，包括一个计数器，用于跟踪我们的猫编写了多少行源代码，以及在猫引入错误时通知用户的通知。

这是 Cat Coding 扩展的第一个版本的 package.json。你可以在此处找到示例应用程序的完整代码。我们扩展的第一个版本贡献了一个命令，名为 catCoding.start。当用户调用此命令时，我们将显示一个简单的 webview，其中包含我们的猫。用户可以从命令面板中调用此命令，如Cat Coding: Start new cat coding session，甚至可以为其创建键绑定（如果他们愿意）。

{
  "name": "cat-coding",
  "description": "Cat Coding",
  "version": "0.0.1",
  "publisher": "bierner",
  "engines": {
    "vscode": "^1.74.0"
  },
  "activationEvents": [],
  "main": "./out/extension.js",
  "contributes": {
    "commands": [
      {
        "command": "catCoding.start",
        "title": "Start new cat coding session",
        "category": "Cat Coding"
      }
    ]
  },
  "scripts": {
    "vscode:prepublish": "tsc -p ./",
    "compile": "tsc -watch -p ./",
    "postinstall": "node ./node_modules/vscode/bin/install"
  },
  "dependencies": {
    "vscode": "*"
  },
  "devDependencies": {
    "@types/node": "^9.4.6",
    "typescript": "^2.8.3"
  }
}

注意：如果你的扩展的目标 VS Code 版本早于 1.74，则必须在 activationEvents 中显式列出 onCommand:catCoding.start。

现在让我们实现 catCoding.start 命令。在我们扩展的主文件中，我们注册 catCoding.start 命令并使用它来显示一个基本的 webview

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      // Create and show a new webview
      const panel = vscode.window.createWebviewPanel(
        'catCoding', // Identifies the type of the webview. Used internally
        'Cat Coding', // Title of the panel displayed to the user
        vscode.ViewColumn.One, // Editor column to show the new webview panel in.
        {} // Webview options. More on these later.
      );
    })
  );
}

vscode.window.createWebviewPanel 函数在编辑器中创建并显示一个 webview。如果你尝试在其当前状态下运行 catCoding.start 命令，你将看到以下内容

An empty webview

我们的命令打开了一个新的 webview 面板，标题正确，但没有内容！要将我们的猫添加到新面板，我们还需要使用 webview.html 设置 webview 的 HTML 内容

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      // Create and show panel
      const panel = vscode.window.createWebviewPanel(
        'catCoding',
        'Cat Coding',
        vscode.ViewColumn.One,
        {}
      );

      // And set its HTML content
      panel.webview.html = getWebviewContent();
    })
  );
}

function getWebviewContent() {
  return `<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Cat Coding</title>
</head>
<body>
    <img src="https://media.giphy.com/media/JIX9t2j0ZTN9S/giphy.gif" width="300" />
</body>
</html>`;
}

如果你再次运行该命令，现在 webview 看起来像这样

A webview with some HTML

有进展了！

webview.html 应该始终是一个完整的 HTML 文档。HTML 片段或格式错误的 HTML 可能会导致意外行为。

更新 webview 内容

webview.html 还可以在创建 webview 后更新其内容。让我们使用它通过引入猫的轮换来使 Cat Coding 更加动态

import * as vscode from 'vscode';

const cats = {
  'Coding Cat': 'https://media.giphy.com/media/JIX9t2j0ZTN9S/giphy.gif',
  'Compiling Cat': 'https://media.giphy.com/media/mlvseq9yvZhba/giphy.gif'
};

export function activate(context: vscode.ExtensionContext) {
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      const panel = vscode.window.createWebviewPanel(
        'catCoding',
        'Cat Coding',
        vscode.ViewColumn.One,
        {}
      );

      let iteration = 0;
      const updateWebview = () => {
        const cat = iteration++ % 2 ? 'Compiling Cat' : 'Coding Cat';
        panel.title = cat;
        panel.webview.html = getWebviewContent(cat);
      };

      // Set initial content
      updateWebview();

      // And schedule updates to the content every second
      setInterval(updateWebview, 1000);
    })
  );
}

function getWebviewContent(cat: keyof typeof cats) {
  return `<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Cat Coding</title>
</head>
<body>
    <img src="${cats[cat]}" width="300" />
</body>
</html>`;
}

Updating the webview content

设置 webview.html 会替换整个 webview 内容，类似于重新加载 iframe。一旦你开始在 webview 中使用脚本，记住这一点很重要，因为它意味着设置 webview.html 也会重置脚本的状态。

上面的示例还使用 webview.title 来更改编辑器中显示的文档的标题。设置标题不会导致 webview 重新加载。

生命周期

Webview 面板由创建它们的扩展所有。扩展必须持有从 createWebviewPanel 返回的 webview。如果你的扩展丢失了此引用，即使 webview 将继续在 VS Code 中显示，它也无法再次访问该 webview。

与文本编辑器一样，用户也可以随时关闭 webview 面板。当 webview 面板被用户关闭时，webview 本身将被销毁。尝试使用已销毁的 webview 会抛出异常。这意味着上面使用 setInterval 的示例实际上有一个重要的错误：如果用户关闭面板，setInterval 将继续触发，这将尝试更新 panel.webview.html，这当然会抛出异常。猫讨厌异常。让我们修复这个问题！

当 webview 被销毁时，会触发 onDidDispose 事件。我们可以使用此事件来取消进一步的更新并清理 webview 的资源

import * as vscode from 'vscode';

const cats = {
  'Coding Cat': 'https://media.giphy.com/media/JIX9t2j0ZTN9S/giphy.gif',
  'Compiling Cat': 'https://media.giphy.com/media/mlvseq9yvZhba/giphy.gif'
};

export function activate(context: vscode.ExtensionContext) {
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      const panel = vscode.window.createWebviewPanel(
        'catCoding',
        'Cat Coding',
        vscode.ViewColumn.One,
        {}
      );

      let iteration = 0;
      const updateWebview = () => {
        const cat = iteration++ % 2 ? 'Compiling Cat' : 'Coding Cat';
        panel.title = cat;
        panel.webview.html = getWebviewContent(cat);
      };

      updateWebview();
      const interval = setInterval(updateWebview, 1000);

      panel.onDidDispose(
        () => {
          // When the panel is closed, cancel any future updates to the webview content
          clearInterval(interval);
        },
        null,
        context.subscriptions
      );
    })
  );
}

扩展还可以通过调用 dispose() 以编程方式关闭 webview。例如，如果我们想将我们猫的工作日限制为五秒

export function activate(context: vscode.ExtensionContext) {
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      const panel = vscode.window.createWebviewPanel(
        'catCoding',
        'Cat Coding',
        vscode.ViewColumn.One,
        {}
      );

      panel.webview.html = getWebviewContent('Coding Cat');

      // After 5sec, programmatically close the webview panel
      const timeout = setTimeout(() => panel.dispose(), 5000);

      panel.onDidDispose(
        () => {
          // Handle user closing panel before the 5sec have passed
          clearTimeout(timeout);
        },
        null,
        context.subscriptions
      );
    })
  );
}

可见性和移动

当 webview 面板移动到后台选项卡时，它会变为隐藏状态。但它不会被销毁。当面板再次移到前台时，VS Code 将自动从 webview.html 恢复 webview 的内容

Webview content is automatically restored when the webview becomes visible again

.visible 属性告诉你 webview 面板当前是否可见。

扩展可以通过调用 reveal() 以编程方式将 webview 面板带到前台。此方法采用可选的目标视图列以在其中显示面板。一个 webview 面板一次只能在一个编辑器列中显示。调用 reveal() 或将 webview 面板拖动到新的编辑器列会将 webview 移动到新的列中。

Webviews are moved when you drag them between tabs

让我们更新我们的扩展，使其一次只允许存在一个 webview。如果面板在后台，则 catCoding.start 命令将使其转到前台

export function activate(context: vscode.ExtensionContext) {
  // Track the current panel with a webview
  let currentPanel: vscode.WebviewPanel | undefined = undefined;

  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      const columnToShowIn = vscode.window.activeTextEditor
        ? vscode.window.activeTextEditor.viewColumn
        : undefined;

      if (currentPanel) {
        // If we already have a panel, show it in the target column
        currentPanel.reveal(columnToShowIn);
      } else {
        // Otherwise, create a new panel
        currentPanel = vscode.window.createWebviewPanel(
          'catCoding',
          'Cat Coding',
          columnToShowIn || vscode.ViewColumn.One,
          {}
        );
        currentPanel.webview.html = getWebviewContent('Coding Cat');

        // Reset when the current panel is closed
        currentPanel.onDidDispose(
          () => {
            currentPanel = undefined;
          },
          null,
          context.subscriptions
        );
      }
    })
  );
}

这是新扩展的实际效果

Using a single panel and reveal

每当 webview 的可见性发生变化，或者当 webview 移动到新的列时，都会触发 onDidChangeViewState 事件。我们的扩展可以使用此事件根据 webview 显示在哪个列中来更改猫

const cats = {
  'Coding Cat': 'https://media.giphy.com/media/JIX9t2j0ZTN9S/giphy.gif',
  'Compiling Cat': 'https://media.giphy.com/media/mlvseq9yvZhba/giphy.gif',
  'Testing Cat': 'https://media.giphy.com/media/3oriO0OEd9QIDdllqo/giphy.gif'
};

export function activate(context: vscode.ExtensionContext) {
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      const panel = vscode.window.createWebviewPanel(
        'catCoding',
        'Cat Coding',
        vscode.ViewColumn.One,
        {}
      );
      panel.webview.html = getWebviewContent('Coding Cat');

      // Update contents based on view state changes
      panel.onDidChangeViewState(
        e => {
          const panel = e.webviewPanel;
          switch (panel.viewColumn) {
            case vscode.ViewColumn.One:
              updateWebviewForCat(panel, 'Coding Cat');
              return;

            case vscode.ViewColumn.Two:
              updateWebviewForCat(panel, 'Compiling Cat');
              return;

            case vscode.ViewColumn.Three:
              updateWebviewForCat(panel, 'Testing Cat');
              return;
          }
        },
        null,
        context.subscriptions
      );
    })
  );
}

function updateWebviewForCat(panel: vscode.WebviewPanel, catName: keyof typeof cats) {
  panel.title = catName;
  panel.webview.html = getWebviewContent(catName);
}

Responding to onDidChangeViewState events

检查和调试 webview

开发者: 切换开发者工具命令打开一个开发者工具窗口，你可以使用它来调试和检查你的 webview。

The developer tools

请注意，如果你使用的是低于 1.56 的 VS Code 版本，或者如果你尝试调试设置了 enableFindWidget 的 webview，则必须改用 开发者: 打开 Webview 开发者工具命令。此命令为每个 webview 打开一个专用的开发者工具页面，而不是使用由所有 webview 和编辑器本身共享的开发者工具页面。

在开发者工具中，你可以使用位于开发者工具窗口左上角的检查工具开始检查 webview 的内容

Inspecting a webview using the developer tools

你还可以在开发者工具控制台中查看 webview 中的所有错误和日志

The developer tools console

要在 webview 的上下文中评估表达式，请确保从开发者工具控制台面板左上角的下拉列表中选择活动帧环境

Selecting the active frame

活动帧环境是 webview 脚本本身执行的地方。

此外，开发者: 重新加载 Webview 命令会重新加载所有活动的 webview。如果你需要重置 webview 的状态，或者如果磁盘上的某些 webview 内容已更改并且你希望加载新内容，这将非常有用。

加载本地内容

Webview 在隔离的上下文中运行，无法直接访问本地资源。这样做是为了安全起见。这意味着，为了从你的扩展加载图像、样式表和其他资源，或从用户当前的工作区加载任何内容，你必须使用 Webview.asWebviewUri 函数将本地 file: URI 转换为 VS Code 可以用来加载本地资源子集的特殊 URI。

假设我们想开始将猫 gif 打包到我们的扩展中，而不是从 Giphy 中提取它们。为此，我们首先创建一个指向磁盘上文件的 URI，然后通过 asWebviewUri 函数传递这些 URI

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      const panel = vscode.window.createWebviewPanel(
        'catCoding',
        'Cat Coding',
        vscode.ViewColumn.One,
        {}
      );

      // Get path to resource on disk
      const onDiskPath = vscode.Uri.joinPath(context.extensionUri, 'media', 'cat.gif');

      // And get the special URI to use with the webview
      const catGifSrc = panel.webview.asWebviewUri(onDiskPath);

      panel.webview.html = getWebviewContent(catGifSrc);
    })
  );
}

function getWebviewContent(catGifSrc: vscode.Uri) {
  return `<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Cat Coding</title>
</head>
<body>
    <img src="${catGifSrc}" width="300" />
</body>
</html>`;
}

如果我们调试此代码，我们会看到 catGifSrc 的实际值类似于

vscode-resource:/Users/toonces/projects/vscode-cat-coding/media/cat.gif

VS Code 理解这个特殊的 URI，并将使用它从磁盘加载我们的 gif！

默认情况下，webview 只能访问以下位置的资源

  • 在你的扩展的安装目录中。
  • 在用户当前活动的工作区中。

使用 WebviewOptions.localResourceRoots 允许访问其他本地资源。

你也可以始终使用数据 URI 将资源直接嵌入到 webview 中。

控制对本地资源的访问

Webview 可以使用 localResourceRoots 选项控制可以从用户计算机加载哪些资源。localResourceRoots 定义了一组根 URI，可以从中加载本地内容。

我们可以使用 localResourceRoots 将 Cat Coding webview 限制为仅从我们扩展中的 media 目录加载资源

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      const panel = vscode.window.createWebviewPanel(
        'catCoding',
        'Cat Coding',
        vscode.ViewColumn.One,
        {
          // Only allow the webview to access resources in our extension's media directory
          localResourceRoots: [vscode.Uri.joinPath(context.extensionUri, 'media')]
        }
      );

      const onDiskPath = vscode.Uri.joinPath(context.extensionUri, 'media', 'cat.gif');
      const catGifSrc = panel.webview.asWebviewUri(onDiskPath);

      panel.webview.html = getWebviewContent(catGifSrc);
    })
  );
}

要禁止所有本地资源，只需将 localResourceRoots 设置为 []。

通常，webview 在加载本地资源时应尽可能严格。但是，请记住，localResourceRoots 本身并不能提供完整的安全保护。请确保你的 webview 也遵循安全最佳实践，并添加内容安全策略以进一步限制可以加载的内容。

主题化 webview 内容

Webview 可以使用 CSS 根据 VS Code 当前的主题更改其外观。VS Code 将主题分为三个类别，并在 body 元素中添加一个特殊的类来指示当前主题

  • vscode-light - 浅色主题。
  • vscode-dark - 深色主题。
  • vscode-high-contrast - 高对比度主题。

以下 CSS 根据用户当前的主题更改 webview 的文本颜色

body.vscode-light {
  color: black;
}

body.vscode-dark {
  color: white;
}

body.vscode-high-contrast {
  color: red;
}

在开发 webview 应用程序时，请确保它适用于这三种类型的主题。并且始终在高对比度模式下测试你的 webview，以确保有视觉障碍的人可以使用它。

Webview 还可以使用 CSS 变量 访问 VS Code 主题颜色。这些变量名称以 vscode 为前缀，并将 . 替换为 -。例如，editor.foreground 变为 var(--vscode-editor-foreground)

code {
  color: var(--vscode-editor-foreground);
}

查看主题颜色参考以获取可用的主题变量。一个扩展可用，它为变量提供 IntelliSense 建议。

还定义了以下字体相关变量

  • --vscode-editor-font-family - 编辑器字体系列（来自 editor.fontFamily 设置）。
  • --vscode-editor-font-weight - 编辑器字体粗细（来自 editor.fontWeight 设置）。
  • --vscode-editor-font-size - 编辑器字体大小（来自 editor.fontSize 设置）。

最后，对于需要编写针对单个主题的 CSS 的特殊情况，webview 的 body 元素具有一个名为 vscode-theme-id 的数据属性，该属性存储当前活动主题的 ID。这使你可以为 webview 编写特定于主题的 CSS

body[data-vscode-theme-id="One Dark Pro"] {
    background: hotpink;
}

支持的媒体格式

Webview 支持音频和视频，但是并非支持所有媒体编解码器或媒体文件容器类型。

以下音频格式可以在 Webview 中使用

  • Wav
  • Mp3
  • Ogg
  • Flac

以下视频格式可以在 webview 中使用

  • H.264
  • VP8

对于视频文件，请确保视频和音轨的媒体格式都受支持。例如，许多 .mp4 文件对视频使用 H.264，对音频使用 AAC。VS Code 将能够播放 mp4 的视频部分，但由于不支持 AAC 音频，因此不会有声音。相反，你需要对音轨使用 mp3。

上下文菜单

高级 webview 可以自定义用户在 webview 中单击鼠标右键时显示的上下文菜单。这是使用贡献点完成的，类似于 VS Code 的普通上下文菜单，因此自定义菜单与编辑器的其余部分完全吻合。Webview 还可以为 webview 的不同部分显示自定义上下文菜单。

要向你的 webview 添加新的上下文菜单项，请首先在新 webview/context 部分下的 menus 中添加一个新条目。每个贡献都采用一个 command（这也是项目标题的来源）和一个 when 子句。when 子句应包含 webviewId == 'YOUR_WEBVIEW_VIEW_TYPE'，以确保上下文菜单仅适用于你的扩展的 webview

"contributes": {
  "menus": {
    "webview/context": [
      {
        "command": "catCoding.yarn",
        "when": "webviewId == 'catCoding'"
      },
      {
        "command": "catCoding.insertLion",
        "when": "webviewId == 'catCoding' && webviewSection == 'editor'"
      }
    ]
  },
  "commands": [
    {
      "command": "catCoding.yarn",
      "title": "Yarn 🧶",
      "category": "Cat Coding"
    },
    {
      "command": "catCoding.insertLion",
      "title": "Insert 🦁",
      "category": "Cat Coding"
    },
    ...
  ]
}

在 webview 内部，你还可以使用 data-vscode-context 数据属性（或在 JavaScript 中使用 dataset.vscodeContext）设置 HTML 特定区域的上下文。data-vscode-context 值是一个 JSON 对象，用于指定用户右键单击元素时要设置的上下文。最终上下文由从文档根目录到单击的元素确定。

例如，考虑以下 HTML

<div class="main" data-vscode-context='{"webviewSection": "main", "mouseCount": 4}'>
  <h1>Cat Coding</h1>

  <textarea data-vscode-context='{"webviewSection": "editor", "preventDefaultContextMenuItems": true}'></textarea>
</div>

如果用户右键单击 textarea，则将设置以下上下文

  • webviewSection == 'editor' - 这会覆盖父元素中的 webviewSection。
  • mouseCount == 4 - 这是从父元素继承的。
  • preventDefaultContextMenuItems == true - 这是一个特殊的上下文，用于隐藏 VS Code 通常添加到 webview 上下文菜单的复制和粘贴条目。

如果用户在 <textarea> 内单击鼠标右键，他们将看到

Custom context menus showing in a webview

有时在左键/主键单击时显示菜单可能很有用。例如，在拆分按钮上显示菜单。你可以通过在 onClick 事件中调度 contextmenu 事件来执行此操作

<button data-vscode-context='{"preventDefaultContextMenuItems": true }' onClick='((e) => {
        e.preventDefault();
        e.target.dispatchEvent(new MouseEvent("contextmenu", { bubbles: true, clientX: e.clientX, clientY: e.clientY }));
        e.stopPropagation();
    })(event)'>Create</button>

Split button with a menu

脚本和消息传递

Webview 就像 iframe 一样，这意味着它们也可以运行脚本。默认情况下，在 webview 中禁用 JavaScript，但可以通过传入 enableScripts: true 选项轻松重新启用它。

让我们使用脚本添加一个计数器来跟踪我们的猫编写的源代码行数。运行基本脚本非常简单，但请注意，此示例仅用于演示目的。在实践中，你的 webview 应始终使用内容安全策略禁用内联脚本

import * as path from 'path';
import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      const panel = vscode.window.createWebviewPanel(
        'catCoding',
        'Cat Coding',
        vscode.ViewColumn.One,
        {
          // Enable scripts in the webview
          enableScripts: true
        }
      );

      panel.webview.html = getWebviewContent();
    })
  );
}

function getWebviewContent() {
  return `<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Cat Coding</title>
</head>
<body>
    <img src="https://media.giphy.com/media/JIX9t2j0ZTN9S/giphy.gif" width="300" />
    <h1 id="lines-of-code-counter">0</h1>

    <script>
        const counter = document.getElementById('lines-of-code-counter');

        let count = 0;
        setInterval(() => {
            counter.textContent = count++;
        }, 100);
    </script>
</body>
</html>`;
}

A script running in a webview

哇！真是一只高产的猫。

Webview 脚本几乎可以执行普通网页上的脚本可以执行的任何操作。但请记住，webview 存在于自己的上下文中，因此 webview 中的脚本无权访问 VS Code API。这就是消息传递的用武之地！

从扩展向 webview 传递消息

扩展可以使用 webview.postMessage() 将数据发送到其 webview。此方法将任何 JSON 可序列化数据发送到 webview。消息在 webview 内部通过标准 message 事件接收。

为了演示这一点，让我们向 Cat Coding 添加一个新命令，该命令指示当前编码的猫重构其代码（从而减少总行数）。新的 catCoding.doRefactor 命令使用 postMessage 将指令发送到当前 webview，并在 webview 本身内部使用 window.addEventListener('message', event => { ... }) 来处理消息

export function activate(context: vscode.ExtensionContext) {
  // Only allow a single Cat Coder
  let currentPanel: vscode.WebviewPanel | undefined = undefined;

  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      if (currentPanel) {
        currentPanel.reveal(vscode.ViewColumn.One);
      } else {
        currentPanel = vscode.window.createWebviewPanel(
          'catCoding',
          'Cat Coding',
          vscode.ViewColumn.One,
          {
            enableScripts: true
          }
        );
        currentPanel.webview.html = getWebviewContent();
        currentPanel.onDidDispose(
          () => {
            currentPanel = undefined;
          },
          undefined,
          context.subscriptions
        );
      }
    })
  );

  // Our new command
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.doRefactor', () => {
      if (!currentPanel) {
        return;
      }

      // Send a message to our webview.
      // You can send any JSON serializable data.
      currentPanel.webview.postMessage({ command: 'refactor' });
    })
  );
}

function getWebviewContent() {
  return `<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Cat Coding</title>
</head>
<body>
    <img src="https://media.giphy.com/media/JIX9t2j0ZTN9S/giphy.gif" width="300" />
    <h1 id="lines-of-code-counter">0</h1>

    <script>
        const counter = document.getElementById('lines-of-code-counter');

        let count = 0;
        setInterval(() => {
            counter.textContent = count++;
        }, 100);

        // Handle the message inside the webview
        window.addEventListener('message', event => {

            const message = event.data; // The JSON data our extension sent

            switch (message.command) {
                case 'refactor':
                    count = Math.ceil(count * 0.5);
                    counter.textContent = count;
                    break;
            }
        });
    </script>
</body>
</html>`;
}

Passing messages to a webview

从 webview 向扩展传递消息

Webview 也可以将消息传递回其扩展。这是通过在 webview 内的特殊 VS Code API 对象上使用 postMessage 函数来完成的。要访问 VS Code API 对象，请在 webview 内调用 acquireVsCodeApi。此函数每个会话只能调用一次。你必须保留此方法返回的 VS Code API 实例，并将其传递给任何需要使用它的其他函数。

我们可以在我们的 Cat Coding webview 中使用 VS Code API 和 postMessage，以便在我们的猫在其代码中引入错误时提醒扩展

export function activate(context: vscode.ExtensionContext) {
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      const panel = vscode.window.createWebviewPanel(
        'catCoding',
        'Cat Coding',
        vscode.ViewColumn.One,
        {
          enableScripts: true
        }
      );

      panel.webview.html = getWebviewContent();

      // Handle messages from the webview
      panel.webview.onDidReceiveMessage(
        message => {
          switch (message.command) {
            case 'alert':
              vscode.window.showErrorMessage(message.text);
              return;
          }
        },
        undefined,
        context.subscriptions
      );
    })
  );
}

function getWebviewContent() {
  return `<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Cat Coding</title>
</head>
<body>
    <img src="https://media.giphy.com/media/JIX9t2j0ZTN9S/giphy.gif" width="300" />
    <h1 id="lines-of-code-counter">0</h1>

    <script>
        (function() {
            const vscode = acquireVsCodeApi();
            const counter = document.getElementById('lines-of-code-counter');

            let count = 0;
            setInterval(() => {
                counter.textContent = count++;

                // Alert the extension when our cat introduces a bug
                if (Math.random() < 0.001 * count) {
                    vscode.postMessage({
                        command: 'alert',
                        text: '🐛  on line ' + count
                    })
                }
            }, 100);
        }())
    </script>
</body>
</html>`;
}

Passing messages from the webview to the main extension

出于安全原因，你必须保持 VS Code API 对象私有，并确保它永远不会泄漏到全局范围。

使用 Web Workers

Webview 内支持 Web Workers，但有一些重要的限制需要注意。

首先，worker 只能使用 data: 或 blob: URI 加载。你无法直接从扩展的文件夹加载 worker。

如果确实需要从扩展中的 JavaScript 文件加载 worker 代码，请尝试使用 fetch

const workerSource = 'absolute/path/to/worker.js';

fetch(workerSource)
  .then(result => result.blob())
  .then(blob => {
    const blobUrl = URL.createObjectURL(blob);
    new Worker(blobUrl);
  });

Worker 脚本也不支持使用 importScripts 或 import(...) 导入源代码。如果你的 worker 动态加载代码，请尝试使用捆绑器（例如 webpack）将 worker 脚本打包到单个文件中。

使用 webpack，你可以使用 LimitChunkCountPlugin 强制编译后的 worker JavaScript 成为单个文件

const path = require('path');
const webpack = require('webpack');

module.exports = {
  target: 'webworker',
  entry: './worker/src/index.js',
  output: {
    filename: 'worker.js',
    path: path.resolve(__dirname, 'media')
  },
  plugins: [
    new webpack.optimize.LimitChunkCountPlugin({
      maxChunks: 1
    })
  ]
};

安全性

与任何网页一样，在创建 webview 时，你必须遵循一些基本的安全最佳实践。

限制功能

webview 应具有其所需的最少功能集。例如，如果你的 webview 不需要运行脚本，请不要设置 enableScripts: true。如果你的 webview 不需要从用户的工作区加载资源，请将 localResourceRoots 设置为 [vscode.Uri.file(extensionContext.extensionPath)] 甚至 [] 以禁止访问所有本地资源。

内容安全策略

内容安全策略进一步限制了可以在 webview 中加载和执行的内容。例如，内容安全策略可以确保只能在 webview 中运行允许的脚本列表，甚至告诉 webview 仅通过 https 加载图像。

要添加内容安全策略，请在 webview 的 <head> 顶部放置一个 <meta http-equiv="Content-Security-Policy"> 指令

function getWebviewContent() {
  return `<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">

    <meta http-equiv="Content-Security-Policy" content="default-src 'none';">

    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <title>Cat Coding</title>
</head>
<body>
    ...
</body>
</html>`;
}

策略 default-src 'none'; 禁止所有内容。然后我们可以重新启用我们的扩展运行所需的最少量内容。这是一个内容安全策略，它允许加载本地脚本和样式表，以及通过 https 加载图像

<meta
  http-equiv="Content-Security-Policy"
  content="default-src 'none'; img-src ${webview.cspSource} https:; script-src ${webview.cspSource}; style-src ${webview.cspSource};"
/>

${webview.cspSource} 值是来自 webview 对象本身的值的占位符。有关如何使用此值的完整示例，请参阅webview 示例。

此内容安全策略还隐式禁用内联脚本和样式。最佳实践是将所有内联样式和脚本提取到外部文件中，以便可以在不放宽内容安全策略的情况下正确加载它们。

仅通过 https 加载内容

如果你的 webview 允许加载外部资源，则强烈建议你仅允许通过 https 而不是 http 加载这些资源。上面的示例内容安全策略已经通过仅允许通过 https: 加载图像来做到这一点。

清理所有用户输入

就像对普通网页一样，在构造 webview 的 HTML 时，你必须清理所有用户输入。未能正确清理输入可能会允许内容注入，这可能会使你的用户面临安全风险。

必须清理的示例值

  • 文件内容。
  • 文件和文件夹路径。
  • 用户和工作区设置。

考虑使用帮助程序库来构造你的 HTML 字符串，或者至少确保正确清理来自用户工作区的所有内容。

永远不要仅仅依靠清理来确保安全。请确保遵循其他安全最佳实践，例如具有内容安全策略，以最大限度地减少任何潜在内容注入的影响。

持久性

在标准 webview 生命周期中，webview 由 createWebviewPanel 创建，并在用户关闭它们或调用 .dispose() 时销毁。但是，webview 的内容在 webview 变为可见时创建，并在 webview 移动到后台时销毁。当 webview 移动到后台选项卡时，webview 内的任何状态都将丢失。

解决此问题的最佳方法是使你的 webview 无状态。使用消息传递来保存 webview 的状态，然后在 webview 再次变为可见时恢复状态。

getState 和 setState

在 webview 内运行的脚本可以使用 getState 和 setState 方法来保存和恢复 JSON 可序列化状态对象。即使当 webview 面板变为隐藏状态时 webview 内容本身被销毁后，此状态也会持久保存。当 webview 面板被销毁时，状态将被销毁。

// Inside a webview script
const vscode = acquireVsCodeApi();

const counter = document.getElementById('lines-of-code-counter');

// Check if we have an old state to restore from
const previousState = vscode.getState();
let count = previousState ? previousState.count : 0;
counter.textContent = count;

setInterval(() => {
  counter.textContent = count++;
  // Update the saved state
  vscode.setState({ count });
}, 100);

getState 和 setState 是持久化状态的首选方法，因为它们比 retainContextWhenHidden 具有低得多的性能开销。

序列化

通过实现 WebviewPanelSerializer，你的 webview 可以在 VS Code 重新启动时自动恢复。序列化建立在 getState 和 setState 的基础上，并且仅在你的扩展为你的 webview 注册 WebviewPanelSerializer 时启用。

为了使我们的编码猫在 VS Code 重新启动后仍然存在，首先将 onWebviewPanel 激活事件添加到扩展的 package.json 中

"activationEvents": [
    ...,
    "onWebviewPanel:catCoding"
]

此激活事件确保每当 VS Code 需要恢复 viewType 为 catCoding 的 webview 时，我们的扩展都将被激活。

然后，在扩展的 activate 方法中，调用 registerWebviewPanelSerializer 以注册新的 WebviewPanelSerializer。WebviewPanelSerializer 负责从其持久化状态恢复 webview 的内容。此状态是 webview 内容使用 setState 设置的 JSON blob。

export function activate(context: vscode.ExtensionContext) {
  // Normal setup...

  // And make sure we register a serializer for our webview type
  vscode.window.registerWebviewPanelSerializer('catCoding', new CatCodingSerializer());
}

class CatCodingSerializer implements vscode.WebviewPanelSerializer {
  async deserializeWebviewPanel(webviewPanel: vscode.WebviewPanel, state: any) {
    // `state` is the state persisted using `setState` inside the webview
    console.log(`Got state: ${state}`);

    // Restore the content of our webview.
    //
    // Make sure we hold on to the `webviewPanel` passed in here and
    // also restore any event listeners we need on it.
    webviewPanel.webview.html = getWebviewContent();
  }
}

现在，如果你在打开 cat coding 面板的情况下重新启动 VS Code，则面板将自动恢复到相同的编辑器位置。

retainContextWhenHidden

对于具有非常复杂的 UI 或无法快速保存和恢复的状态的 webview，你可以改为使用 retainContextWhenHidden 选项。此选项使 webview 保留其内容，但即使 webview 本身不再在前台，也使其处于隐藏状态。

虽然很难说 Cat Coding 具有复杂的状态，但让我们尝试启用 retainContextWhenHidden 以查看该选项如何更改 webview 的行为

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  context.subscriptions.push(
    vscode.commands.registerCommand('catCoding.start', () => {
      const panel = vscode.window.createWebviewPanel(
        'catCoding',
        'Cat Coding',
        vscode.ViewColumn.One,
        {
          enableScripts: true,
          retainContextWhenHidden: true
        }
      );
      panel.webview.html = getWebviewContent();
    })
  );
}

function getWebviewContent() {
  return `<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Cat Coding</title>
</head>
<body>
    <img src="https://media.giphy.com/media/JIX9t2j0ZTN9S/giphy.gif" width="300" />
    <h1 id="lines-of-code-counter">0</h1>

    <script>
        const counter = document.getElementById('lines-of-code-counter');

        let count = 0;
        setInterval(() => {
            counter.textContent = count++;
        }, 100);
    </script>
</body>
</html>`;
}

retainContextWhenHidden demo

请注意，当 webview 隐藏然后恢复时，计数器现在不会重置。无需额外的代码！使用 retainContextWhenHidden，webview 的行为类似于 Web 浏览器中的后台选项卡。即使选项卡未激活或不可见，脚本和其他动态内容也会继续运行。当启用 retainContextWhenHidden 时，你还可以向隐藏的 webview 发送消息。

虽然 retainContextWhenHidden 可能很吸引人，但请记住，这会产生很高的内存开销，并且仅应在其他持久化技术不起作用时使用。

辅助功能

在用户使用屏幕阅读器操作 VS Code 的上下文中，类 vscode-using-screen-reader 将添加到你的 webview 的主 body 中。此外，如果用户表示希望减少窗口中的运动量，则类 vscode-reduce-motion 将添加到文档的主 body 元素中。通过观察这些类并相应地调整你的渲染，你的 webview 内容可以更好地反映用户的偏好。

后续步骤

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

04/03/2025