扩展主机
扩展主机负责运行扩展。
扩展主机配置
根据 VS Code 的配置,可能会运行多个扩展主机,它们具有不同的运行时,位于不同的位置。
- local – 一个 Node.js 扩展主机在本地运行,与用户界面在同一台机器上。
- web – 一个 Web 扩展主机在浏览器中或本地运行,与用户界面在同一台机器上。
- remote – 一个 Node.js 扩展主机在容器或远程位置远程运行。
下表显示了在 VS Code 的各种配置中可用的扩展主机
配置 | 本地扩展主机 | Web 扩展主机 | 远程扩展主机 |
---|---|---|---|
桌面版 VS Code | ✔️ | ✔️ | |
使用远程的 VS Code (容器, SSH, WSL, GitHub Codespace, Tunnel) | ✔️ | ✔️ | ✔️ |
Web 版 VS Code (vscode.dev, github.dev) | ✔️ | ||
带有 Codespaces 的 Web 版 VS Code | ✔️ | ✔️ |
扩展主机运行时
- Node.js - 扩展在 Node.js 运行时中运行。本地和远程扩展主机使用此运行时。扩展需要一个
main
入口文件才能在其中运行。 - Browser - 扩展在浏览器 WebWorker 运行时中运行。Web 扩展主机使用此运行时。扩展需要一个
browser
入口文件才能在其中运行。有关更多详细信息,请参阅 Web 扩展指南。
首选扩展位置
扩展加载到的扩展主机取决于
- VS Code 配置提供的可用扩展主机。
- 扩展的功能:它是否可以在 Node.js 和/或 Web 中运行?如果未指明,它提供哪些贡献?
- 扩展安装在哪里:在本地机器上、在远程机器上还是两者都有。
- 扩展首选的位置:
extensionKind
属性。
extensionKind
是扩展清单中的一个属性。它允许扩展指定首选的运行位置。可以是具有工作区(workspace
)的机器或用户界面(ui
)。如果扩展可以在两者上运行,它可以指定首选顺序。
"extensionKind": ["workspace"]
— 表示扩展需要访问工作区内容,因此需要在工作区所在的位置运行。这可以在本地机器、远程机器或 Codespace 上。大多数扩展属于此类别。"extensionKind": ["ui", "workspace"]
— 表示扩展首选作为 UI 扩展运行,但对本地资产、设备或功能没有任何硬性要求。当使用 VS Code 时,如果本地存在 VS Code 的本地扩展主机,扩展将在此主机中运行,这意味着用户不必在远程计算机上安装扩展。否则,如果 VS Code 的工作区扩展主机存在,扩展将在其中运行。当使用带有 Codespaces 的 Web 版 VS Code 时,它将始终在远程扩展主机中运行(因为没有本地扩展主机可用)。"extensionKind": ["workspace", "ui"]
— 表示扩展首选作为工作区扩展运行,但对访问工作区内容没有任何硬性要求。当使用 VS Code 时,如果远程工作区中存在 VS Code 的工作区扩展主机,扩展将在此主机中运行,否则如果本地存在 VS Code 的本地扩展主机,扩展将在此主机中运行。当使用带有 Codespaces 的 Web 版 VS Code 时,它将始终在远程扩展主机中运行(因为没有本地扩展主机可用)。"extensionKind": ["ui"]
— 表示扩展必须靠近 UI 运行,因为它需要访问本地资产、设备或功能,或者因为需要低延迟。在使用带有 Codespaces 的 Web 版 VS Code 的情况下,由于没有本地扩展主机可用,此类扩展无法加载,除非它也是一个 Web 扩展。然后它将加载到 Web 扩展主机中,但有一个限制,即它无法实例化 Web Worker。
注意:早期的 VS Code 版本(<1.40)允许扩展将单个位置指定为字符串,但这已被弃用,取而代之的是将多个位置指定为数组。
如果一个扩展可以在 Node.js 和浏览器中运行,则在可用时将选择 Node.js 扩展主机。但有一种例外情况,当配置为带有 Codespaces 的 Web 版 VS Code 且 extensionKind
设置为 ui
时,Web 扩展主机优先于远程扩展主机。
如果一个扩展仅限 Web 使用,它将始终在 Web 扩展主机上运行,而与 extensionKind
设置无关。我们建议在这种情况下不要定义 extensionKind
。
稳定性和性能
VS Code 旨在为用户提供稳定且高性能的编辑器,行为不当的扩展不应影响用户体验。VS Code 中的扩展主机阻止扩展执行以下操作:
- 影响启动性能
- 拖慢 UI 操作
- 修改 UI
此外,VS Code 允许扩展声明其激活事件并延迟加载它们。例如,Markdown 扩展应仅在用户打开 Markdown 文件时加载。这确保了扩展不会消耗不必要的 CPU 和内存。