尝试以扩展 VS Code 中的代理模式!

远程开发 FAQ

本文涵盖了每个 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 Server,该服务器可以托管直接与远程工作区、机器和文件系统交互的扩展。

Architecture summary

有关扩展的更多详细信息,请参阅支持远程开发

远程开发扩展如何保护对远程机器、虚拟机或容器的访问?

Visual Studio Code 远程开发使用现有、众所周知的传输方式,如安全外壳 (SSH) 来验证和保护流量。除了这些众所周知的安全传输方式使用的端口外,无需公开任何其他端口。

注入的 VS Code Server 以您用于登录机器的同一用户身份运行,确保 VS Code 及其扩展在未经许可的情况下不会被授予不当的提升权限。该服务器由 VS Code 启动和停止,并且不与任何用户或全局登录或启动脚本相关联。VS Code 管理服务器的生命周期,因此您无需担心它是否正在运行。

VS Code Server 可以单独安装或使用吗?

不可以。VS Code Server 是远程开发扩展的一个组件,由 VS Code 客户端管理。它在连接到端点时由 VS Code 自动安装和更新,如果单独安装,可能会很快过时。它不打算或授权给其他客户端使用。

VS Code Server 的连接要求是什么?

安装 VS Code Server 要求您的本地机器具有到以下地址的出站 HTTPS (端口 443) 连接:

  • update.code.visualstudio.com
  • vscode.download.prss.microsoft.com

默认情况下,Remote - SSH 会尝试在远程主机上下载,如果失败,则会在建立连接后回退到在本地下载 VS Code Server 并将其远程传输。您可以使用 remote.SSH.localServerDownload 设置更改此行为,以始终在本地下载然后传输,或从不在本地下载。

Dev Containers 扩展始终在本地下载并传输到容器中。

您可以使用扩展:从 VSIX 安装... 命令手动安装扩展而无需互联网连接,但如果您使用扩展面板或 devcontainer.json 来安装扩展,您的本地机器和 VS Code Server 将需要到以下地址的出站 HTTPS (端口 443) 访问权限:

  • marketplace.visualstudio.com
  • *.gallerycdn.vsassets.io (Azure CDN)

最后,一些扩展(如 C#)会从 download.microsoft.comdownload.visualstudio.microsoft.com 下载次要依赖项。其他扩展(如 Visual Studio Live Share)可能有额外的连接要求。如果遇到问题,请查阅扩展的文档以获取详细信息。

服务器和 VS Code 客户端之间的所有其他通信都是通过以下传输渠道完成的,具体取决于扩展:

  • SSH:经过身份验证的安全 SSH 隧道。
  • 容器:Docker 配置的通信通道(通过 docker exec)。
  • WSL:一个随机的本地端口。

您可以在网络连接文章中找到 VS Code 本身需要访问的位置列表。

为什么在使用远程扩展时,我在容器工具扩展中看不到我的本地容器?

默认情况下,容器工具扩展将在远程运行。虽然这在某些情况下是合理的默认设置,但这意味着当 VS Code 连接到远程 SSH 主机、容器或 WSL 时,该扩展可能不会显示本地容器。

您可以使用以下解决方案之一来解决此问题:

要在主机上使用远程开发,需要安装哪些 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 Server 吗?

从 VS Code 1.99 版本(2025 年 3 月)开始,VS Code 分发的预构建服务器仅与基于 glibc 2.28 或更高版本的 Linux 发行版兼容。这些发行版包括例如 Debian 10、RHEL 8 或 Ubuntu 20.04。

如果提供了包含这些所需库版本的 sysroot,VS Code 仍将允许用户通过 Remote - SSH 扩展连接到不受 VS Code 支持的操作系统(即 glibc < 2.28 和 libstdc++ < 3.4.25 的操作系统)。这种方法为您和您的组织提供了更多时间来迁移到更新的 Linux 发行版。

VS Code 版本 基本要求 备注
>= 1.99.x kernel >= 4.18, glibc >= 2.28, libstdc++ >= 3.4.25, binutils >= 2.29 <无>
重要

这种方法是一种技术变通方案,并非官方支持的使用场景。

请按照以下步骤配置您的环境以使用此变通方案:

  1. 构建 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
    
  2. VS Code 服务器在安装过程中使用 patchelf 来从 sysroot 中消费所需的库。

重要

已知 patchelf v0.17.x 会导致远程服务器出现段错误,我们建议使用 patchelf >=v0.18.x

  1. 在远程主机上安装 patchelf 二进制文件和 sysroot

  2. 创建以下 3 个环境变量:

    • VSCODE_SERVER_CUSTOM_GLIBC_LINKER 指向 sysroot 中动态链接器的路径(用于 patchelf--set-interpreter 选项)
    • VSCODE_SERVER_CUSTOM_GLIBC_PATH 指向 sysroot 中库位置的路径(用作 patchelf--set-rpath 选项)
    • VSCODE_SERVER_PATCHELF_PATH 指向远程主机上 patchelf 二进制文件的路径

您现在可以使用 Remote - SSH 扩展连接到远程主机。连接成功后,VS Code 将显示一个对话框和横幅消息,告知该连接不受支持。

我可以安装单个扩展而不是扩展包吗?

可以。 远程开发扩展包为您提供了一种方便的方式,可以在发布时访问所有最新的远程功能。但是,您始终可以从 Marketplace 或 VS Code 的“扩展”视图中安装单个扩展。

我如何查看和配置扩展设置?

Visual Studio Code 的其他部分一样,您可以通过其设置来自定义每个远程开发扩展。以 Dev Containers 为例,您可以通过在扩展视图中打开该扩展(⇧⌘X (Windows、Linux Ctrl+Shift+X)),并导航到功能贡献来查看所有 Dev Containers 设置的列表。

List of settings in Feature Contributions

WSL

与使用 WSL 作为终端相比,该扩展有什么优势?

您可以将 WSL 视为在 Windows 上运行的 Linux 机器,您可以在其中安装特定于 Linux 的框架/工具(例如 Python、Go、Rust 等),而不会影响您的 Windows 设置。然后,您可以使用 VS Code 和 WSL 扩展在 WSL 中安装的内容的上下文中进行开发,与 Windows 上安装的内容隔离。

例如,您可能在 WSL 中安装 Go 堆栈(编译器、调试器、linter 等)。如果您只在 Windows 上运行 VS Code,则还必须在那里安装相同的 Go 堆栈才能获得智能补全、调试、跳转到定义等功能。而且由于语言服务在 Windows 上运行,它们不知道 WSL 中有什么。

确实,您可以从 Windows 运行 WSL 中的二进制文件,反之亦然,但常规的 VS Code 扩展不知道如何做到这一点。我们最初就是这样开始支持在 WSL 中进行调试的,但很快意识到我们必须更新所有扩展以了解 WSL。

我们决定改为让 VS Code 的部分在 WSL 中运行,并让在 Windows 上运行的 UI 与在 WSL 中运行的 VS Code 服务器通信。这就是 WSL 扩展所启用的功能,有了它,Go 扩展以及其余的 Go 工具(编译器、调试器、linter)都在 WSL 中运行,而 VS Code 则在 Windows 上运行。

通过这种方法,像智能补全这样的语言功能可以直接针对 WSL 中的内容工作,而无需在 Windows 上进行任何设置。您不必担心路径问题或在 Windows 上设置不同版本的开发堆栈。如果您要将应用程序部署到 Linux,您可以将 WSL 实例设置得像您的运行时环境一样,同时仍然在 Windows 上获得丰富的编辑体验。

扩展开发者

作为扩展作者,我需要做什么?

VS Code 扩展 API 抽象了本地/远程的细节,因此大多数扩展无需修改即可工作。然而,鉴于扩展可以使用任何 Node 模块或运行时,有些情况下可能需要进行调整。我们建议您测试您的扩展(尤其是在容器中),以确保不需要更新。有关详细信息,请参阅支持远程开发

当用户远程连接时,扩展可以访问本地资源或 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 Server)之上构建公共或商业服务。您不能创建其他扩展来扩展或操纵远程开发扩展。虽然许可证规定您不得“将软件作为独立或集成的产品提供,或将其与您的任何应用程序结合供他人使用”,但您可以记录如何将扩展与您的服务结合使用。

我可以在我自己的公共服务产品中重新打包或重用 VS Code Server 吗?

不可以。许可证规定,您不得“将软件作为独立或集成的产品提供,或将其与您的任何应用程序结合供他人使用”,这意味着您不能在 VS Code Server 之上构建公共产品或服务。

我有一个关于我是否可以将扩展用于 X 的问题,我该问谁?

请提交一个问题 (issue)

GDPR 和 VS Code 远程开发

VS Code 远程开发扩展遵循与 Visual Studio Code 本身相同的 GDPR 政策。有关更多详细信息,请参阅通用 FAQ

问题或反馈

有疑问或反馈吗?