使用远程隧道进行开发
Visual Studio Code Remote - Tunnels 扩展允许您通过安全隧道连接到远程计算机(如台式电脑或虚拟机 (VM))。您可以在任何地方通过 VS Code 客户端连接到该计算机,而无需使用 SSH。
隧道技术通过 Microsoft 开发隧道 (dev tunnels) 安全地将数据从一个网络传输到另一个网络。
这可以免去将源代码放在 VS Code 客户端机器上的需要,因为该扩展直接在远程机器上运行命令和其他扩展。该扩展会在远程操作系统上安装 VS Code Server;该服务器独立于远程操作系统上任何现有的 VS Code 安装。

无论您的代码托管在哪里,VS Code 都可以提供本地品质的开发体验——包括完整的 IntelliSense(代码补全)、代码导航和调试。
入门指南
您有两种使用隧道的方法
- 运行
code命令行界面 (CLI) 的tunnel命令。 - 通过 VS Code 桌面版 UI 启用隧道。
这两种方法都会产生相同的隧道功能 —— 您可以使用最适合您的工具。如果您无法在远程机器上安装完整的 VS Code 桌面版,CLI 是一个极佳的选择。如果您已经在 VS Code 中进行了一些工作,并希望为当前机器启用隧道,那么使用 VS Code 桌面版 UI 会很方便。
我们将在以下部分中介绍这两种方法。
使用 'code' CLI
您可以通过 code CLI 创建和使用隧道。
-
在您想要从 VS Code 客户端进行开发的远程机器上安装
codeCLI。该 CLI 在 VS Code 客户端和您的远程机器之间建立隧道。该 CLI 已自动内置到 VS Code 桌面版中,无需进行额外的设置。其他下载方式
或者,您可以通过我们下载页面上的独立安装获取 CLI,它与 VS Code 桌面版安装是分开的

您也可以通过远程机器的终端安装并解压 CLI。如果您的远程机器有 UI,这可能会特别有用
curl -Lk 'https://vscode.js.cn/sha/download?build=stable&os=cli-alpine-x64' --output vscode_cli.tar.gz tar -xf vscode_cli.tar.gz注意:如果您使用的是独立安装或终端安装,以下部分中的命令将以
./code开头,而不是code。 -
使用
tunnel命令创建安全隧道code tunnel此命令会在该机器上下载并启动 VS Code Server,然后创建通往该服务器的隧道。
注意:首次在机器上启动隧道时,系统会提示您接受服务器许可条款。您也可以在命令行中传入
--accept-server-license-terms以跳过此提示。 -
此 CLI 将输出一个绑定到此远程机器的 vscode.dev URL,例如
https://vscode.dev/tunnel/<machine_name>/<folder_name>. 您可以在您选择的客户端上打开此 URL。 -
在此客户端上首次打开 vscode.dev URL 时,系统会提示您在
https://github.com/login/oauth/authorize...URL 处登录您的 GitHub 帐户。这会向隧道服务进行身份验证,以确保您有权访问正确的远程机器集合。
使用 VS Code UI
-
在您想要开启隧道访问的远程机器上打开 VS Code。
-
在 VS Code 账户菜单中,选择开启远程隧道访问 (Turn on Remote Tunnel Access) 选项,如下图所示。您也可以在 VS Code 中打开命令面板 (F1) 并运行命令 Remote Tunnels: Turn on Remote Tunnel Access...。

-
系统会提示您登录 GitHub。登录后,当前机器上将启动一个隧道,您将能够远程连接到这台机器。

-
在您选择的客户端中,您可以打开上述通知中的 vscode.dev 链接并开始编写代码!
注意:只有在远程机器上的 VS Code 保持运行状态时,才能通过隧道访问该远程机器。一旦您退出 VS Code,将无法再通过隧道连接到它,除非您在那里重新启动 VS Code 或运行
code tunnelCLI 命令。
Remote Tunnels 扩展
您通过 code CLI 或 VS Code UI 打开的 vscode.dev 实例已预装了 Remote - Tunnels 扩展。
如果您已经在 VS Code(桌面版或网页版)中工作并希望连接到远程隧道,您可以直接安装并使用 Remote - Tunnels 扩展。安装扩展后,打开命令面板 (F1) 并运行命令 Remote Tunnels: Connect to Tunnel。您将能够连接到任何具有活动隧道的远程机器。
您还可以在远程资源管理器 (Remote Explorer) 中查看您的远程机器,您可以通过命令 Remote Explorer: Focus on Remote View 将焦点切换到该视图

与其他远程开发扩展一样,您的远程机器名称将列在左下角的绿色远程指示器中。点击此指示器是探索 Remote Tunnels 命令的另一种方法,其中还包含关闭远程连接或安装 VS Code 桌面版的选项。

在容器中打开 Remote Tunnels 主机上的文件夹
您可以结合使用 Remote - Tunnels 和 Dev Containers 扩展,在容器内部打开远程主机上的文件夹。您甚至不需要在本地安装 Docker 客户端。
要做到这一点
- 按照在远程主机上安装 Docker 以及在本地安装 VS Code 和 Dev Containers 扩展的安装步骤进行操作。
- 按照 Remote - Tunnels 扩展的入门说明设置隧道、连接到隧道并在其中打开文件夹。
- 从命令面板(F1,⇧⌘P (Windows, Linux Ctrl+Shift+P))使用 开发容器:在容器中重新打开 命令。
其余的 Dev Containers 快速入门内容完全适用。您可以在其文档中了解有关 Dev Containers 扩展的更多信息。如果此模型不满足您的需求,您还可以参阅在远程 Docker 主机上开发一文以了解其他选项。
常见问题
Remote Tunnels、VS Code Server 和远程开发之间是什么关系?
Visual Studio Code 远程开发 (Remote Development) 允许您将容器、远程机器或适用于 Linux 的 Windows 子系统 (WSL) 用作功能齐全的开发环境。
远程开发允许您本地的 VS Code 安装通过将某些命令的执行转移到“远程服务器”(即 VS Code Server),来透明地与其它机器(无论是虚拟的还是物理的)上的源代码和运行时环境进行交互。当您连接到远程端点时,VS Code 会快速安装 VS Code Server,该服务器可以托管直接与远程工作区、机器和文件系统交互的扩展。
我们已将此 VS Code Server 后端组件发布为一项您可以自行运行的服务(您可以在其文档中阅读更多相关信息),而不仅仅是由远程开发扩展来安装和管理。
访问 VS Code Server 涉及几个组件
- VS Code Server:使 VS Code 远程体验成为可能的后端服务器。
- Remote - Tunnels 扩展:促进与远程机器连接的扩展,在该机器上运行着服务器的一个实例。
作为扩展作者,我需要做什么?
VS Code 扩展 API 抽象了本地/远程细节,因此大多数扩展无需修改即可工作。但是,考虑到扩展可以使用它们想要的任何节点模块或运行时,有时可能需要进行调整。我们建议你测试你的扩展,以确保不需要更新。有关详细信息,请参阅支持远程开发。
多个用户或客户端可以同时访问同一个远程实例吗?
不可以,服务器的一个实例设计为一次只能由一个用户或客户端访问。
如何删除隧道或机器?
如果您想停止通过 CLI 运行的隧道,可以使用 Ctrl + C 结束活动隧道。如果您通过 VS Code UI 启用了隧道,则可以在 VS Code 中运行命令 Remote Tunnels: Turn off Remote Tunnel Access...。
您可以通过在该机器上运行 code tunnel unregister 来解除机器与隧道的关联。您也可以打开任何 VS Code 客户端,选择“远程资源管理器”视图,右键单击要移除的机器,然后选择 unregister。
隧道是如何确保安全的?
托管和连接到隧道都需要在两端使用相同的 Github 或 Microsoft 帐户进行身份验证。在这两种情况下,VS Code 都会向托管在 Azure 中的服务发出出站连接;通常不需要更改防火墙,并且 VS Code 不会设置任何网络监听器。
从远程 VS Code 实例连接后,将在隧道上创建 SSH 连接以提供端到端 encryption。当前首选的加密密码是 CTR 模式下的 AES 256,实现此功能的代码是开源的。
您可以在底层 dev tunnels 服务的文档中了解更多关于其安全性的信息。
隧道服务是否有使用限制?
为避免滥用底层隧道服务,针对隧道数量和带宽等资源设置了使用限制。我们预计大多数用户永远不会达到这些限制。
例如,目前您的帐户最多可以注册 10 个隧道。如果您想创建一个新隧道并且已经注册了其他 10 个隧道,CLI 将随机选择一个未使用的隧道并将其删除。请注意,此限制可能会更改。
我可以在整个组织中配置策略吗?
如果您所在的组织希望控制对端口转发的访问,您可以通过允许或拒绝访问域名 global.rel.tunnels.api.visualstudio.com 来实现。
对于运行 Windows 设备的的用户,您还可以配置并部署 dev tunnels 的组策略设置。您可以在 dev tunnels 文档中了解更多信息。
如何确保我的隧道持续运行?
您有以下几种选择
- 使用
service命令作为服务运行。您可以运行code tunnel service install和code tunnel service uninstall来安装和卸载它们。 - 使用
no-sleep选项code tunnel --no-sleep,以防止您的远程机器进入睡眠状态。
如 code CLI 文档中所述,您可以通过 code tunnel --help 探索所有可能的 CLI 命令和选项。