扩展宿主
扩展宿主负责运行扩展。
扩展宿主配置
根据 VS Code 的配置,有多个扩展宿主在不同位置运行,使用不同的运行时。
- 本地 – 一个 Node.js 扩展宿主,在用户界面所在的同一台本地机器上运行。
- Web – 一个 Web 扩展宿主,在浏览器中或用户界面所在的同一台本地机器上运行。
- 远程 – 一个 Node.js 扩展宿主,在容器或远程位置远程运行。
下表显示了 VS Code 各种配置中可用的扩展宿主
配置 | 本地扩展宿主 | Web 扩展宿主 | 远程扩展宿主 |
---|---|---|---|
桌面版 VS Code | ✔️ | ✔️ | |
带远程的 VS Code (容器、SSH、WSL、GitHub Codespace、隧道) | ✔️ | ✔️ | ✔️ |
Web 版 VS Code (vscode.dev, github.dev) | ✔️ | ||
带 Codespaces 的 Web 版 VS Code | ✔️ | ✔️ |
扩展宿主运行时
- Node.js - 扩展在 Node.js 运行时中运行。由本地和远程扩展宿主使用。扩展需要一个
main
入口文件才能在其上运行。 - 浏览器 - 扩展在 浏览器 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 和内存。