🚀 在 VS Code 中！

在 WSL 中开发

Visual Studio Code WSL 扩展使您可以直接从 VS Code 使用 适用于 Linux 的 Windows 子系统 (WSL) 作为您的全职开发环境。您可以在基于 Linux 的环境中进行开发，使用特定于 Linux 的工具链和实用程序，并在舒适的 Windows 环境中运行和调试基于 Linux 的应用程序。

该扩展直接在 WSL 中运行命令和其他扩展，因此您可以编辑位于 WSL 或已挂载的 Windows 文件系统（例如 /mnt/c）中的文件，而无需担心路径问题、二进制兼容性或其他跨操作系统挑战。该扩展将在 WSL 内部安装 VS Code Server；该服务器独立于 WSL 中任何现有的 VS Code 安装。

WSL Architecture

这使 VS Code 能够提供本地质量的开发体验 - 包括完整的 IntelliSense（补全）、代码导航和调试 - 无论您的代码托管在哪里。

入门

注意：在查看本主题后，您可以开始学习入门级 WSL 教程。

安装

要开始使用，您需要

  1. 安装 适用于 Linux 的 Windows 子系统 以及您首选的 Linux 发行版。

    注意： WSL 1 对于某些类型的开发确实存在一些 已知限制。此外，由于扩展内部本机源代码中的 glibc 依赖项，在 Alpine Linux 中安装的扩展可能无法工作。有关详细信息，请参阅 远程开发和 Linux 文章。

  2. 在 Windows 端（而不是在 WSL 中）安装 Visual Studio Code。

    注意： 当提示在安装过程中选择其他任务时，请务必选中添加到 PATH 选项，以便您可以使用 code 命令轻松地在 WSL 中打开文件夹。

  3. 安装 WSL 扩展。如果您计划在 VS Code 中使用其他远程扩展，您可以选择安装 远程开发扩展包。

打开远程文件夹或工作区

从 WSL 终端

在 VS Code 中打开适用于 Linux 的 Windows 子系统中的文件夹，与从命令提示符或 PowerShell 中打开 Windows 文件夹非常相似。

  1. 打开一个 WSL 终端窗口（使用开始菜单项或从命令提示符 / PowerShell 中键入 wsl）。

  2. 导航到您想要在 VS Code 中打开的文件夹（包括但不限于 Windows 文件系统挂载点，如 /mnt/c）

  3. 在终端中键入 code .。首次执行此操作时，您应该看到 VS Code 正在获取在 WSL 中运行所需的组件。这应该只需要很短的时间，并且只需要一次。

    注意： 如果此命令不起作用，您可能需要重启终端，或者您在安装 VS Code 时可能没有将其添加到路径中。

  4. 稍等片刻后，将出现一个新的 VS Code 窗口，您将看到一个通知，指示 VS Code 正在 WSL 中打开文件夹。

    WSL Starting notification

    VS Code 现在将继续在 WSL 中配置自身，并在取得进展时让您了解最新情况。

  5. 完成后，您现在将在左下角看到一个 WSL 指示器，并且您可以像平常一样使用 VS Code！

    WSL Status Bar Item

就是这样！您在此窗口中执行的任何 VS Code 操作都将在 WSL 环境中执行，从编辑和文件操作到调试、使用终端等等。

从 VS Code

或者，您可以直接从 VS Code 打开 WSL 窗口

  1. 启动 VS Code。
  2. 按 F1，选择 WSL: 连接到 WSL 以使用默认发行版，或选择 WSL: 使用发行版连接到 WSL 以使用特定发行版。
  3. 使用“文件”菜单打开您的文件夹。

如果您已经打开了一个文件夹，您也可以使用 WSL: 在 WSL 中重新打开文件夹 命令。系统将提示您使用哪个发行版。

如果您在 WSL 窗口中，并且想要在本地窗口中打开当前输入，请使用 WSL: 在 Windows 中重新打开。

从 Windows 命令提示符

要直接从 Windows 提示符打开 WSL 窗口，请使用 --remote 命令行参数

code --remote wsl+<发行版名称> <WSL 中的路径>

例如：code --remote wsl+Ubuntu /home/jim/projects/c

我们需要猜测输入路径是文件还是文件夹。如果它有文件扩展名，则被认为是文件。

要强制打开文件夹，请在路径末尾添加斜杠或使用

code --folder-uri vscode-remote://wsl+Ubuntu/home/ubuntu/folder.with.dot

要强制打开文件，请添加 --goto 或使用

code --file-uri vscode-remote://wsl+Ubuntu/home/ubuntu/fileWithoutExtension

使用 Git

如果您在 WSL 和 Windows 中使用相同的存储库，请务必设置一致的行尾符。有关详细信息，请参阅 技巧和窍门。

您还可以通过配置 WSL 以使用 Windows Git 凭据管理器来避免密码。有关详细信息，请参阅 技巧和窍门。

管理扩展

VS Code 在两个位置之一运行扩展：本地 UI / 客户端，或 WSL 中。虽然影响 VS Code UI 的扩展（如主题和代码片段）本地安装，但大多数扩展将驻留在 WSL 内部。

如果您从“扩展”视图安装扩展，它将自动安装在正确的位置。安装后，您可以根据类别分组判断扩展的安装位置。将有 本地 - 已安装 类别和一个用于 WSL 的类别。

Workspace Extension Category

Local Extension Category

注意： 如果您是扩展作者，并且您的扩展无法正常工作或安装位置错误，请参阅 支持远程开发 了解详细信息。

实际需要在远程运行的本地扩展将在 本地 - 已安装 类别中显示为灰色并禁用。选择 安装 以在远程主机上安装扩展。

Disabled Extensions w/Install Button

您还可以通过转到“扩展”视图并使用 本地 - 已安装 标题栏右侧的云按钮选择 在 WSL 中安装本地扩展: {Name}，从而在 WSL 中安装所有本地安装的扩展。这将显示一个下拉列表，您可以在其中选择要在 WSL 实例中安装的本地安装扩展。

Install all extensions

在 WSL 中打开终端

从 VS Code 在 WSL 中打开终端很简单。在 WSL 中打开文件夹后，您在 VS Code 中打开的任何终端窗口（终端 > 新终端）都将自动在 WSL 而不是本地运行。

您还可以从此终端窗口使用 code 命令行来执行许多操作，例如在 WSL 中打开新文件或文件夹。键入 code --help 以查看命令行中可用的选项。

Using the code CLI

在 WSL 中调试

在 WSL 中打开文件夹后，您可以像在本地运行应用程序时一样使用 VS Code 的调试器。例如，如果您在 launch.json 中选择启动配置并开始调试（F5），应用程序将在远程主机上启动并将调试器附加到它。

有关在 .vscode/launch.json 中配置 VS Code 调试功能的详细信息，请参阅 调试 文档。

WSL 特定设置

当您在 WSL 中打开文件夹时，VS Code 的本地用户设置也会被重用。虽然这保持了您用户体验的一致性，但您可能希望在本地计算机和 WSL 之间更改其中一些设置。幸运的是，连接到 WSL 后，您还可以通过从命令面板 (F1) 运行 首选项: 打开远程设置 命令，或在“设置”编辑器中选择 远程 选项卡来设置 WSL 特定设置。每当您在 WSL 中打开文件夹时，这些设置将覆盖您已设置的任何本地设置。

高级：环境设置脚本

当 VS Code Remote 在 WSL 中启动时，不会运行任何 shell 启动脚本。这样做是为了避免启动脚本针对 shell 进行调整时出现问题。如果您想运行其他命令或修改环境，可以在设置脚本 ~/.vscode-server/server-env-setup（Insiders：~/.vscode-server-insiders/server-env-setup）中完成。如果存在，则在服务器启动之前处理该脚本。

该脚本需要是有效的 Bourne shell 脚本。请注意，无效的脚本将阻止服务器启动。如果您最终得到一个阻止服务器启动的脚本，您将必须使用常规 WSL shell 并删除或重命名设置脚本。

检查 WSL 日志（WSL: 显示日志）以获取输出和错误。

高级：在容器中打开 WSL 2 文件夹

如果您正在使用 WSL 2 和 Docker Desktop 的 WSL 2 后端，则可以使用 开发容器 扩展来处理存储在 WSL 内部的源代码！只需按照以下步骤操作

  1. 如果您尚未这样做，请 安装和设置 Docker Desktop 的 WSL 2 支持。

    提示： 转到 设置 > 资源 > WSL 集成，并启用 Docker 与您将使用的 WSL 发行版的集成。

  2. 如果您尚未这样做，请安装 开发容器 扩展以及 WSL 扩展。

  3. 接下来，像往常一样 在 WSL 中打开您的源代码文件夹。

  4. 在 WSL 中打开文件夹后，从命令面板 (F1) 中选择 开发容器: 在容器中重新打开。

  5. 如果文件夹中没有 .devcontainer/devcontainer.json 文件，系统将要求您从可筛选列表或现有的 Dockerfile 或 Docker Compose 文件（如果存在）中选择一个起点。

    Select a node dev container definition

  6. VS Code 窗口（实例）将重新加载并开始构建开发容器。进度通知提供状态更新。

    Dev Container Progress Notification

  7. 构建完成后，VS Code 将自动连接到容器。您现在可以从容器内部处理您的源代码。

有关更多信息，请参阅 开发容器文档。

已知限制

本节包含 WSL 的常见已知问题列表。目的不是提供完整的问题列表，而是突出显示 WSL 中常见的一些问题。

有关与 WSL 相关的活动问题列表，请参阅 此处。

我看到尝试在 WSL 1 中打开的工作区中重命名文件夹时出现 EACCES: 权限被拒绝错误

这是 WSL 文件系统实现的一个已知问题（Microsoft/WSL#3395, Microsoft/WSL#1956），由 VSCode 激活的文件监视程序引起。此问题仅在 WSL 2 中修复。

要避免此问题，请将 remote.WSL.fileWatcher.polling 设置为 true。但是，基于轮询的文件监视对大型工作区有性能影响。

对于大型工作区，您需要增加轮询间隔：remote.WSL.fileWatcher.pollingInterval 并控制要监视的文件夹：files.watcherExclude。

WSL 2 没有该文件监视程序问题，也不受新设置的影响。

WSL 1 中的 Golang

问题 现有问题
Delve 调试器在 WSL 下不起作用 go-delve/delve#810, Microsoft/vscode-go#926

WSL 1 中的 Node.js

问题 现有问题
NodeJS 错误：spawn EACCES（此错误的不同变体） Microsoft/WSL#3886
Webpack HMR 不起作用 Microsoft/WSL#2709
Firebase 通过 node 在 WSL 上异常缓慢 Microsoft/WSL#2657

Git 限制

如果您使用 SSH 克隆 Git 存储库，并且您的 SSH 密钥有密码，则 VS Code 的拉取和同步功能在远程运行时可能会挂起。可以使用没有密码的 SSH 密钥，使用 HTTPS 克隆，或从命令行运行 git push 以解决此问题。

Docker 扩展限制

虽然 Docker 扩展可以远程和本地运行，但如果它已在本地安装，您将无法在远程 SSH 主机上安装它，除非先在本地卸载它。我们将在未来的 VS Code 版本中解决此问题。

扩展限制

许多扩展无需修改即可在 WSL 中工作。但是，在某些情况下，某些功能可能需要更改。如果您遇到扩展问题，请参阅 此处 了解常见问题和解决方案的摘要，您可以在报告问题时将其告知扩展作者。

此外，当使用基于 Alpine Linux 的发行版时，某些安装在 WSL 中的扩展可能由于扩展内部本机代码中的 glibc 依赖项而无法工作。有关详细信息，请参阅 使用 Linux 进行远程开发 文章。

常见问题

为什么我被要求更改默认发行版？

当使用 WSL: 使用发行版连接到 WSL 并在 Windows 10 2019 年 5 月更新（版本 1903）之前的 WSL 上运行时，系统将要求您切换默认发行版，因为 WSL 命令只能在默认发行版上工作，因为它尚不支持 -d 选项。

您始终可以使用 wslconfig.exe 手动切换默认发行版。

例如

wslconfig /setdefault Ubuntu

您可以使用以下命令查看已安装的发行版

wslconfig /l

我看到关于缺少库或依赖项的错误

某些扩展依赖于某些 WSL Linux 发行版的 vanilla 安装中未找到的库。您可以使用 Linux 发行版的包管理器将其他库添加到 Linux 发行版中。对于基于 Ubuntu 和 Debian 的发行版，运行 sudo apt-get install <package> 以安装所需的库。查看您的扩展或提及的运行时的文档以获取更多安装详细信息。

WSL 扩展的连接要求是什么？

WSL 扩展和 VS Code Server 需要出站 HTTPS（端口 443）连接到

  • update.code.visualstudio.com
  • marketplace.visualstudio.com
  • vscode.blob.core.windows.net
  • *.vo.msecnd.net (Azure CDN)
  • *.gallerycdn.vsassets.io (Azure CDN)

某些扩展（如 C#）从 download.microsoft.com 或 download.visualstudio.microsoft.com 下载辅助依赖项。其他扩展（如 Visual Studio Live Share）可能具有其他连接要求。如果您遇到问题，请查阅扩展的文档以获取详细信息。

服务器和 VS Code 客户端之间的所有其他通信都通过随机本地 TCP 端口完成。您可以在 网络连接文章 中找到 VS Code 本身需要访问的位置列表。

我在代理后面并且遇到连接问题

Windows 或 WSL 端可能缺少代理设置。

当从 VSCode 中打开远程窗口时，WSL 扩展会尝试在 Windows 端下载 VSCode 服务器。因此，它使用 Windows 端代理配置

当远程 VSCode 从 WSL 终端启动时，下载是使用 WSL 发行版中的 wget 完成的。可以在以下位置配置代理设置

服务器启动并运行后，将使用 远程 选项卡上的代理设置。

我可以强制扩展在本地/远程运行吗？

扩展通常被设计和测试为在本地或远程运行，而不是两者都运行。但是，如果扩展支持，您可以强制它在 settings.json 文件中的特定位置运行。

例如，以下设置将强制 Docker 扩展在本地运行，并强制 Remote - SSH：编辑配置文件 扩展远程运行，而不是其默认设置

"remote.extensionKind": {
    "ms-azuretools.vscode-docker": [ "ui" ],
    "ms-vscode-remote.remote-ssh-edit": [ "workspace" ]
}

值 "ui" 而不是 "workspace" 将强制扩展在本地 UI/客户端运行。通常，这仅应用于测试，除非扩展的文档中另有说明，因为它可能会破坏扩展。有关详细信息，请参阅关于 支持远程开发 的文章。

作为扩展作者，我需要做什么？

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

问题或反馈

02/06/2025