远程开发常见问题解答
本文介绍了有关 **Visual Studio Code 远程开发**扩展的常见问题。有关设置和使用各项功能的更多详细信息,请参阅 SSH、容器和 WSL 文章。或者尝试入门教程 教程 以帮助您在远程环境中快速运行。
有关 GitHub Codespaces 的问题,请参阅 GitHub Codespaces 文档。
通用
什么是 Visual Studio Code 远程开发?
Visual Studio Code 远程开发扩展包 允许您在容器中、远程计算机上(通过 SSH)或 Windows Subsystem for Linux 中打开任何文件夹,并利用 VS Code 的完整功能集。这意味着 VS Code 可以提供本地质量的开发体验——包括完整的 IntelliSense(补全)、调试等等——无论您的代码位于何处或托管在哪里。
VS Code 远程开发比本地编辑有哪些优势?
远程开发的一些好处包括:
- 能够在与本地运行的操作系统不同的操作系统上编辑、构建或调试。
- 能够在与目标部署环境匹配的环境中开发。
- 使用比本地计算机更大或更专业的硬件进行开发。
- 能够编辑存储在其他位置的代码,例如在云端或客户站点。
- 分离开发环境以避免冲突,提高安全性并加快上手速度。
与使用网络共享或同步文件相比,VS Code 远程开发提供了显着更好的性能,并更好地控制您的开发环境和工具。
远程开发扩展与 GitHub Codespaces 有何关系?
GitHub Codespaces 是一项提供托管云开发环境的服务,可以通过 VS Code 和新的基于浏览器的编辑器进行访问。该服务还允许 VS Code 和基于浏览器的编辑器访问自托管环境(桌面或服务器),而无需 SSH 服务器甚至直接网络路由。您可以在 GitHub Codespaces 文档 中阅读更多内容。
虽然远程开发和 Codespaces 扩展共享技术和功能,但远程开发扩展是单独发布的,并且可以独立于 GitHub Codespaces 运行。
远程开发扩展如何工作?
Visual Studio Code 远程开发允许您的本地 VS Code 安装通过将某些命令的执行移动到“远程服务器”来透明地与其他机器(无论是虚拟还是物理)上的源代码和运行时环境进行交互。当您连接到远程端点时,**VS Code 服务器**由 VS Code 快速安装,并且可以托管直接与远程工作区、机器和文件系统交互的扩展。
有关扩展的更多详细信息,请参阅 支持远程开发。
远程开发扩展如何保护对远程机器、虚拟机或容器的访问?
Visual Studio Code 远程开发使用现有、众所周知的传输方式,例如 安全外壳 来进行身份验证和保护流量。除了这些众所周知、安全的传输方式使用的端口之外,无需公开任何端口。
注入的 VS Code 服务器以您登录机器时使用的同一用户身份运行,确保 VS Code 及其扩展未经许可不会获得不当的特权访问。服务器由 VS Code 启动和停止,并且不连接到任何用户或全局登录或启动脚本。VS Code 管理服务器的生命周期,因此您无需担心它是否正在运行。
VS Code 服务器可以单独安装或使用吗?
不能。VS Code 服务器是远程开发扩展的一个组件,由 VS Code 客户端管理。当它连接到端点时,VS Code 会自动安装和更新它,如果单独安装,它可能会很快过时。它不打算用于或 授权 其他客户端使用。
VS Code 服务器的连接要求是什么?
安装 VS Code 服务器要求您的本地机器具有到以下地址的出站 HTTPS(端口 443)连接:
update.code.visualstudio.com
vscode.download.prss.microsoft.com
默认情况下,Remote - SSH 将尝试在远程主机上下载,并在连接建立后,如果失败,则退回到在本地下载 VS Code 服务器并远程传输。您可以使用 remote.SSH.localServerDownload 设置更改此行为,以始终在本地下载然后传输,或从不本地下载。
Dev Containers 扩展始终在本地下载并传输到容器中。
您可以使用 **Extensions: Install from VSIX...** 命令手动安装没有互联网连接的扩展,但如果您使用扩展面板或 devcontainer.json
安装扩展,您的本地机器和 VS Code 服务器将需要到以下地址的出站 HTTPS(端口 443)访问:
marketplace.visualstudio.com
*.gallerycdn.vsassets.io
(Azure CDN)
最后,一些扩展(如 C#)从 download.microsoft.com
或 download.visualstudio.microsoft.com
下载次要依赖项。其他扩展(如 Visual Studio Live Share)可能有额外的连接要求。如果你遇到问题,请查阅扩展的文档以获取详细信息。
服务器和 VS Code 客户端之间的所有其他通信通过以下传输通道完成,具体取决于扩展:
- SSH:经过身份验证的安全 SSH 隧道。
- 容器:Docker 配置的通信通道(通过
docker exec
)。 - WSL:随机本地端口。
您可以在 网络连接文章 中找到 VS Code 本身需要访问的位置列表。
为什么在使用 Remote - 扩展时,我在容器工具扩展中看不到我的本地容器?
默认情况下,容器工具扩展将在远程运行。虽然这在某些情况下是一个合理的默认值,但这意味着当 VS Code 连接到远程 SSH 主机、容器或 WSL 时,该扩展可能不会显示本地容器。
您可以使用以下解决方案之一来解决此问题:
-
打开一个新的本地窗口(**文件 > 新窗口**)并使用它来处理本地容器。
-
安装 Dev Containers 扩展,并在需要查看本地容器时使用 远程资源管理器。
-
**仅限 WSL**:使用 WSL 2 的 Docker 技术预览版 或 配置 Docker Desktop 以在 WSL 1 中使用。
-
**仅限 Dev Containers**:在容器中转发 Docker 套接字并安装 Docker CLI(仅)。
-
使用 extensionKind 属性 强制扩展为
ui
。但是,这将阻止某些命令工作。
使用远程开发需要在主机上安装哪些 Linux 包或库?
远程开发需要内核 >= 4.18,glibc >=2.28 和 libstdc++ >= 3.4.25。最近的 x86_64 基于 glibc 的发行版有最好的支持,但具体要求可能因发行版而异。
Dev Containers 和 WSL 扩展支持基于 musl 的 Alpine Linux,Remote - SSH 支持 ARMv7l (AArch32) / ARMv8l (AArch64)。但是,某些扩展中的本机依赖项可能导致它们无法在非 x86_64 glibc 发行版上运行。请注意,实验性的 ARMv8l (AArch64) 仅在 VS Code Insiders 中可用。
有关更多详细信息,请参阅 使用 Linux 进行远程开发。
我可以在旧版 Linux 发行版上运行 VS Code 服务器吗?
从 VS Code 1.99 版本(2025 年 3 月)开始,VS Code 分发的预构建服务器仅与基于 glibc 2.28 或更高版本的 Linux 发行版兼容。例如,这些发行版包括 Debian 10、RHEL 8 或 Ubuntu 20.04。
如果提供了包含这些所需库版本的 sysroot,VS Code 仍然允许用户通过 远程 - SSH 扩展连接到 VS Code 不支持的操作系统(glibc < 2.28 和 libstdc++ < 3.4.25 的操作系统)。这种方法为您和您的组织提供了更多时间迁移到更新的 Linux 发行版。
VS Code 版本 | 基本要求 | 备注 |
---|---|---|
>= 1.99.x | 内核 >= 4.18, glibc >=2.28, libstdc++ >= 3.4.25, binutils >= 2.29 |
此方法是技术上的变通方法,并非官方支持的使用场景。
请按照以下步骤配置您的环境以使用此变通方法:
-
构建 sysroot
我们建议使用 Crosstool-ng 构建 sysroot。以下是一些您可以开始使用的示例配置:
以下示例容器也可以用于拥有一个安装了 Crosstool-ng 的环境:
FROM ubuntu:latest RUN apt-get update RUN apt-get install -y gcc g++ gperf bison flex texinfo help2man make libncurses5-dev \ python3-dev autoconf automake libtool libtool-bin gawk wget bzip2 xz-utils unzip \ patch rsync meson ninja-build # Install crosstool-ng RUN wget http://crosstool-ng.org/download/crosstool-ng/crosstool-ng-1.26.0.tar.bz2 RUN tar -xjf crosstool-ng-1.26.0.tar.bz2 RUN cd crosstool-ng-1.26.0 && ./configure --prefix=/crosstool-ng-1.26.0/out && make && make install ENV PATH=$PATH:/crosstool-ng-1.26.0/out/bin
一旦您拥有一个安装了 Crosstool-ng 并准备好相关配置的环境,运行以下命令生成 sysroot:
mkdir toolchain-dir cd toolchain-dir cp <path-to-config-file> .config ct-ng build
-
VS Code 服务器在安装过程中使用 patchelf 从 sysroot 中获取所需的库。
已知 patchelf v0.17.x
会导致远程服务器出现段错误,我们建议使用 patchelf >=v0.18.x
-
在远程主机上安装 patchelf 二进制文件和 sysroot
-
创建以下 3 个环境变量
现在您可以通过使用 Remote - SSH 扩展连接到远程。成功连接后,VS Code 将显示一个对话框和横幅消息,告知连接不受支持。
我可以安装单个扩展而不是扩展包吗?
是的。远程开发扩展包 为您提供了方便的方式来访问所有最新的远程功能。但是,您始终可以从 Marketplace 或 VS Code 扩展视图安装单个扩展。
如何查看和配置扩展设置?
与 Visual Studio Code 的其他部分一样,您可以通过其设置自定义每个远程开发扩展。以 Dev Containers 为例,您可以通过在“扩展”视图 (⇧⌘X (Windows, Linux Ctrl+Shift+X)) 中打开扩展,然后导航到 **功能贡献** 来查看所有 Dev Containers 设置列表
WSL
与将 WSL 用作终端相比,该扩展有什么优势?
您可以将 WSL 视为在 Windows 上运行的 Linux 机器,您可以在其中安装 Linux 特定框架/工具(例如 Python、Go、Rust 等),而不会影响您的 Windows 设置。然后,您可以使用 VS Code 和 WSL 扩展在 WSL 中安装的内容的上下文中进行开发,与 Windows 上安装的内容隔离。
例如,您可以在 WSL 中安装 Go 堆栈(编译器、调试器、linters 等)。如果您只在 Windows 上运行 VS Code,您还必须在那里安装相同的 Go 堆栈才能获得智能补全、调试、跳转到定义导航等功能。而且由于语言服务在 Windows 上运行,它们不知道 WSL 中有什么。
确实,您可以在 Windows 上从 WSL 运行二进制文件,反之亦然,但常规 VS Code 扩展不知道如何做到这一点。这就是我们开始支持 WSL 调试的方式,但很快意识到我们必须更新所有扩展才能了解 WSL。
我们决定改为让 VS Code 的部分内容在 WSL 中运行,并让在 Windows 上运行的 UI 与在 WSL 中运行的 VS Code 服务器对话。这就是 WSL 扩展所实现的,通过它,Go 扩展与其余 Go 工具(编译器、调试器、linters)一起在 WSL 中运行,而 VS Code 在 Windows 上运行。
通过这种方法,智能补全等语言功能可以直接在 WSL 中运行,而无需在 Windows 上设置任何内容。您无需担心路径问题或在 Windows 上设置不同版本的开发堆栈。如果您要将应用程序部署到 Linux,您可以将 WSL 实例设置为类似于您的运行时环境,同时仍然在 Windows 上获得丰富的编辑体验。
扩展作者
作为扩展作者,我需要做什么?
VS Code 扩展 API 抽象了本地/远程细节,因此大多数扩展无需修改即可工作。但是,鉴于扩展可以使用任何节点模块或运行时,因此在某些情况下可能需要进行调整。我们建议您测试您的扩展(尤其是在容器中)以确保不需要更新。有关详细信息,请参阅 支持远程开发。
当用户远程连接时,扩展是否可以访问本地资源或 API?
当 VS Code 连接到远程环境时,扩展被分类为**UI**或**工作区**扩展。UI 扩展在**本地扩展主机**中运行,可以提供 UI 或个性化功能(例如主题),并且可以访问本地文件或 API。工作区扩展与工作区一起在**远程扩展主机**中运行,并具有对源代码、远程文件系统和远程 API 的完全访问权限。虽然工作区扩展不侧重于 UI 自定义,但它们也可以贡献资源管理器、视图和其他 UI 元素。
当用户安装扩展时,VS Code 会尝试推断正确的位置并根据其类型进行安装。不需要远程运行的扩展(例如主题和其他 UI 自定义)会自动安装在 UI 端。所有其他扩展都被视为工作区扩展,因为它们功能最全。但是,扩展作者也可以使用 `package.json` 中的 `extensionKind` 属性覆盖此位置。
如果您的扩展未按预期运行,有一些步骤可以检查 它是否在正确的位置运行,或者是否应该具有不同的 extensionKind
。另请参阅 支持远程开发,了解有关扩展作者需要了解的远程开发和 Codespaces 的更多详细信息。
许可证和隐私
位置
您可以在此处找到 VS Code 远程开发扩展的许可证:
为什么远程开发扩展或其组件不是开源的?
Visual Studio Code 远程开发扩展及其相关组件采用开放的规划、问题和功能请求流程,但目前不是开源的。这些扩展共享的源代码也用于完全托管的远程开发服务,例如 GitHub Codespaces 及其相关扩展。
有关更多信息,请参阅 Visual Studio Code 与 'Code - OSS' 的区别 和 Microsoft 扩展许可证 文章。
远程开发扩展连接到哪里有限制吗?
您可以自由地将扩展用于个人或公司用途,以连接到您自己的物理机器、虚拟机或容器。这些可以是本地的、您自己的私有云或数据中心中的、Azure 中的,或其他云/非云托管提供商。您不能在扩展或其相关组件之上构建公共产品或服务(请参阅下一个问题)。
我可以使用 VS Code 远程开发扩展来构建自己的产品或服务吗?
您可以将这些扩展与您自己的内部或私有服务一起使用。您不能在 VS Code 远程开发扩展或其相关组件(例如 VS Code 服务器)之上构建公共或商业服务。您不能创建其他扩展来扩展或操作远程开发扩展。虽然许可证声明您不得“以独立或集成产品形式提供软件,或将其与您的任何应用程序结合供他人使用”,但您可以记录如何将扩展与您的服务结合使用。
我可以重新打包或在我自己的公共服务产品中重用 VS Code 服务器吗?
不能。许可证规定您不得“以独立或集成产品形式提供软件,或将其与您的任何应用程序结合供他人使用”,这意味着您不得在 VS Code 服务器之上构建公共产品或服务。
我有一个关于是否可以将扩展用于 X 的问题,我可以问谁?
请提交一个 问题。
GDPR 和 VS Code 远程开发
VS Code 远程开发扩展遵循 Visual Studio Code 本身的 GDPR 策略。有关详细信息,请参阅 一般常见问题解答。
问题或反馈
有问题或反馈?
- 请参阅 提示和技巧。
- 在 Stack Overflow 上搜索。
- 添加功能请求或报告问题。