在 VS Code 中试用

远程开发常见问题解答

本文涵盖了每个 Visual Studio Code 远程开发 扩展的常见问题。有关设置和使用各个功能的更多详细信息,请参阅 SSH容器WSL 文章。或者尝试入门 教程 以帮助您快速在远程环境中运行。

关于 GitHub Codespaces 的问题,请参阅 GitHub Codespaces 文档

常见问题

Visual Studio Code 远程开发是什么?

Visual Studio Code 远程开发扩展包 允许您在容器中、远程计算机上(通过 SSH)或 Linux 的 Windows 子系统中打开任何文件夹,并充分利用 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

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

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

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

注入的 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
  • *.vo.msecnd.net (Azure CDN)

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

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

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

  • marketplace.visualstudio.com
  • vscode.blob.core.windows.net
  • *.vo.msecnd.net (Azure CDN)
  • *.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 本身需要访问的地址列表。

使用 Remote - 扩展时,为什么我在 Docker 扩展中看不到我的本地容器?

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

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

在主机上需要安装哪些 Linux 包或库才能使用远程开发?

远程开发需要 kernel >= 4.18、glibc >= 2.28 和 libstdc++ >= 3.4.25。最近基于 glibc 的 x86_64 发行版有最好的支持,但具体要求可能因发行版而异。

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 server 在安装过程中使用 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 会显示一个对话框和横幅消息,提示连接不受支持。

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

是的。远程开发扩展包 为您提供了一种方便的方式来访问所有最新的远程功能。但是,您始终可以从市场或 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 技术栈(编译器、调试器、代码检查器等)。如果您仅在 Windows 上运行 VS Code,则还必须在该处安装相同的 Go 技术栈,才能获得智能完成、调试、转到定义导航等功能。而且由于语言服务运行在 Windows 上,它们不知道 WSL 中的内容。

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

我们决定转而让 VS Code 的一部分在 WSL 中运行,并让运行在 Windows 上的 UI 与运行在 WSL 中的 VS Code 服务器通信。这就是 WSL 扩展所实现的功能,通过它,Go 扩展与其余 Go 工具(编译器、调试器、代码检查器)一起在 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 的问题,我可以问谁?

提交一个问题

GDPR 与 VS Code 远程开发

VS Code 远程开发扩展遵循 Visual Studio Code 本身的 GDPR 政策。有关更多详细信息,请参阅一般常见问题

问题或反馈

有问题或反馈?