使用 VS Code 进行远程开发

2019 年 5 月 2 日，VS Code 团队撰写，@code

太长不看

今天，我们很高兴宣布推出 Visual Studio Code 的三款新扩展的预览版，这些扩展支持在容器中、物理机或虚拟机上进行远程开发，以及使用 适用于 Linux 的 Windows 子系统 (WSL) 进行无缝开发。你可以立即通过安装远程开发扩展包来开始使用。

注意：目前你需要使用 Insiders 版本，但远程开发支持最终将在稳定版本中提供。

继续阅读以了解我们如何走到今天。

开发趋势

随着 VS Code 越来越受欢迎，我们有幸与越来越多使用不同开发环境的用户交流，其中许多环境与我们自己的大相径庭，以试图找出如何推动 VS Code 发展以解决开发者真正的痛点。

在这些对话中出现了一个有趣的模式。我们看到许多开发者试图使用 VS Code 针对配置了特定开发和运行时堆栈的容器和远程虚拟机进行开发，仅仅是因为在本地设置这些开发环境太难、太具破坏性，甚至在某些情况下是不可能的。

我们都经历过这个问题。除非我们觉得是时候“清理”这台机器了 :), 我们才会犹豫是否尝试 Rust、Go、Node 或 Python3 等新堆栈，生怕“搞乱”我们当前已精心配置好的环境。

Python 开发者想转用 VS Code，但无法实现，因为他们需要使用针对特定 Python 堆栈配置的容器和虚拟机作为开发环境。

由于代码库非常庞大，我们看到像 Facebook（和 Microsoft！）这样的公司的工程师使用 vim 等编辑器，通过替代的基于云的搜索和导航服务，远程操作安全强大的“开发者虚拟机”，这些服务甚至超越了最好的笔记本电脑的处理能力。

构建和训练数据模型的数据科学家通常需要海量的存储和计算服务来分析大型数据集，这些数据集即使在强大的台式机上也无法存储或处理。

适用于 Linux 的 Windows 子系统 (WSL) 之所以流行，部分原因是它使得设置包含目标操作系统的独立开发环境变得容易。事实上，VS Code 仓库中评论最多的第三个问题就是支持在 Windows 上的 Linux 发行版中从 Bash 终端运行 code。

现有解决方案的挑战

在这些对话中，我们也一直在听到开发者在进行此类开发时面临的相同挑战。

• 远程桌面可以使用，但在某些 Linux 发行版上难以或不可能设置，而且开发体验可能会“延迟”。

• SSH 和 Vim（或带有文件同步的本地工具）可以使用，但它们可能很慢、容易出错，并且通常缺乏现代开发工具的生产力。

• 基于浏览器的工具在多种场景下非常有用，但开发者不想放弃桌面工具提供的丰富性和熟悉度，也不想放弃他们现有的本地安装的工具链。

更糟的是（在我们看来！），开发者不得不牺牲核心的 VS Code 体验，例如 IntelliSense（代码补全）、代码检查和调试，以便在这些环境下工作。

一种不同的方法

听到这些挑战后，我们开始研究 WSL 支持，这看起来足够简单。安装 VS Code 并（当时需要小心！）像平常一样编辑 Windows 文件系统。我们确实努力为 Node.js 启用远程调试，并且我们认为可以简单地安装一个小脚本来支持从 bash shell 启动 code。

但是，这不对。像我们为 Node.js 调试所做的那样，为每个运行时都做特殊工作是没有意义的。如果你在 Windows 上安装了 Python 2.7 和 Flask（或者根本没有安装！），而在 Linux 发行版中安装了 Python 3.7 和 Django，你将无法获得正确的代码补全或代码检查，因为 VS Code 会查看 Windows 版本的一切。不得不在 Windows 和 Linux 上都复制开发环境，这完全违背了使用 WSL 的初衷。

我们确信我们需要的是一种方法，让 VS Code 同时在两个地方运行：在本地运行开发者工具，并连接到在物理机或虚拟机（例如，容器或虚拟机）环境中远程运行的一组开发服务。这可以在远程环境的上下文中为你提供丰富的本地开发体验。

介绍 VS Code 远程扩展

在过去的几个月里，我们一直在努力重新确立代码层之间的适当边界，并消除对本地开发环境的假设。我们构建了三个新的扩展，用于在 WSL、Docker 容器或通过 SSH 连接的物理机和虚拟机中处理远程工作区。

WSL 扩展允许你直接在 VS Code 中将 适用于 Linux 的 Windows 子系统 (WSL) 用作完整的开发环境。这种新的、经过优化的支持允许你

• 使用 Windows 在基于 Linux 的环境中开发，使用特定平台的工具链和实用程序。
• 编辑位于 WSL 或挂载的 Windows 文件系统中的文件（例如 /mnt/c）。
• 在 Windows 上运行和调试基于 Linux 的应用程序。

命令和扩展直接在 Linux 发行版中运行，因此你无需担心路径问题、二进制兼容性或其他跨操作系统挑战。你可以在 WSL 中像在 Windows 中一样使用 VS Code。

观看这个简短的 2 分钟视频，了解在 WSL 中开发有多容易。

欲了解更多信息，请参阅在 WSL 中开发文档。

Remote - SSH 扩展允许你打开托管在任何运行 SSH 服务器的远程机器、虚拟机或容器上的文件夹或工作区。通过 SSH 进行开发允许你

• 在比本地机器更大、更快或更专业的硬件上进行开发。
• 在不同的远程开发环境之间快速切换，并安全地进行更新，而无需担心影响本地机器。
• 调试在其他地方运行的应用程序，例如客户站点或云中。

例如，假设你正在进行深度学习项目。你通常需要一台配备 GPU 的强大虚拟机（例如 Azure 数据科学虚拟机），并配置所有训练模型所需的工具和框架，以及大规模数据集。

你可以通过 SSH 使用 Vim 或 Jupyter Notebooks 编辑远程代码，但这会牺牲本地开发工具的丰富性。相反，使用 Remote - SSH 扩展，你只需连接到虚拟机，安装必要的扩展（例如 Python），然后就可以利用 VS Code 的所有强大功能，例如 IntelliSense（代码补全）、代码导航和调试，就像在本地工作一样。

观看这个简短的 2 分钟视频，了解通过 SSH 在虚拟机上开发有多容易。

欲了解更多信息，请参阅使用 SSH 进行开发文档。

开发容器扩展允许你使用 Docker 容器作为你的开发容器。容器是非常好的开发环境，因为

• 你可以使用一致且易于重现的工具链，在与你部署的目标操作系统相同的环境进行开发。
• 容器是隔离的，这意味着你可以在不同的开发环境之间快速切换，而不会影响本地机器。
• 其他人可以很容易地为你的项目贡献代码，因为他们可以在一致的开发环境中轻松进行开发、构建和测试。

可以使用 devcontainer.json 文件告诉 VS Code 如何配置开发容器，包括要使用的 Dockerfile、要打开的端口以及要在容器中安装的扩展。当 VS Code 在工作区中找到 devcontainer.json 时，它会自动构建（如果需要）镜像、启动容器并连接到它。你的文件会被挂载到容器中，因此你可以打开文件并开始编辑，享受完整的 IntelliSense（代码补全）、代码导航、调试等功能。

观看这个简短的 2 分钟视频，了解开发容器的实际应用。

欲了解更多关于开发容器的信息，请参阅在容器中开发文档，以及包含你现在即可使用的示例的 vscode-remote-try-* 仓库。

管理扩展

进行远程开发时，VS Code 会根据扩展暴露的功能尝试推断应将扩展安装到本地还是远程。扩展分为两类：

• UI 扩展安装在本地。这些扩展仅用于自定义 UI，不访问工作区中的文件，这意味着它们可以完全在本地机器上运行。由于它们是本地安装的，因此无论你在哪个工作区工作，它们都始终可用。UI 扩展的示例包括主题、代码片段、语言语法和键位映射。

• 工作区扩展安装在远程。它们访问工作区中的文件和文件夹进行编辑，提供 IntelliSense（代码补全）、转到定义、调试等功能。这些扩展可能会自定义 UI。这些扩展在远程运行，以便它们完全访问远程主机上的文件系统和工具。

大多数扩展都已更新并在远程环境中正常工作，但如果你遇到一些不正常的扩展，请务必向该扩展提交问题。

扩展作者

如果你正在创建 VS Code 扩展，我们已经实现了新的、支持远程的扩展 API。例如，扩展作者不应使用 open 包来加载浏览器窗口，而应使用 vscode.env.openExternal API，它会在本地打开浏览器。类似地，有一个新的 clipboard 类，它会按预期将内容放置在本地剪贴板上。

更多详细信息可在更新的API 文档中找到，包括如何在远程环境中运行、测试和调试你的扩展。

开始使用

感谢你阅读到这里！

以下是开始使用 Visual Studio Code 远程开发的 3 个快速步骤

1. 安装 Insiders 版本。在远程开发支持在稳定版本中可用之前，你需要此版本。Insiders 版本每天发布，包含最新功能和错误修复。如果你担心稳定性，不必担心！我们使用 Insiders 版本来开发 VS Code，并且它可以与稳定版本并排安装，以防出现问题（并告知我们）。

2. 获取远程开发扩展包，它安装了对 WSL、SSH 和容器的支持，是开始使用的最简单方法。如果你不需要所有这些，可以卸载单个扩展。

3. 阅读文档。尝试开发容器示例。如果你使用 Python 进行开发（你们很多人都是！），请查看 Dan Taylor 关于远程 Python 开发的博客文章。

最后，如果你遇到问题，请提交问题。有关常见问题的解答，请参阅我们的常见问题解答。

告诉我们你的想法！

愉快地编码，

@code 团队