使用远程隧道进行开发
Visual Studio Code Remote - Tunnels 扩展允许你通过安全隧道连接到远程计算机,例如台式 PC 或虚拟机 (VM)。你可以从任何地方的 VS Code 客户端连接到该计算机,而无需 SSH。
隧道通过 Microsoft 开发隧道安全地将数据从一个网络传输到另一个网络。
这可以省去在 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 客户端进行开发的远程机器上安装
code
CLI。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 时,系统会提示你登录 GitHub 账户,URL 为
https://github.com/login/oauth/authorize...
。这将对你进行隧道服务身份验证,以确保你有权访问正确的远程机器集。
使用 VS Code UI
-
在你想打开隧道访问的远程机器上打开 VS Code。
-
在 VS Code 帐户菜单中,选择“打开远程隧道访问”选项,如下图所示。你也可以在 VS Code 中打开命令面板(F1)并运行命令“Remote Tunnels: Turn on Remote Tunnel Access...”(远程隧道:打开远程隧道访问...)。
-
系统会提示你登录 GitHub。登录后,隧道将在你当前的机器上启动,你将能够远程连接到这台机器。
-
在你选择的客户端中,你可以从上面的通知中打开 vscode.dev 链接并开始编码!
注意:远程机器只有在 VS Code 保持运行的情况下才能通过隧道访问。一旦你退出 VS Code,就无法再通过隧道连接到它,除非你再次在那里启动 VS Code 或运行
code tunnel
CLI 命令。
远程隧道扩展
你通过 code
CLI 或 VS Code UI 打开的 vscode.dev 实例预装了 Remote - Tunnels 扩展。
如果你已经在 VS Code(桌面版或网页版)中工作,并想连接到远程隧道,可以直接安装和使用 Remote - Tunnels 扩展。安装扩展后,打开命令面板(F1)并运行命令“Remote Tunnels: Connect to Tunnel”(远程隧道:连接到隧道)。你将能够连接到任何具有活动隧道的远程机器。
你还可以在远程资源管理器中查看你的远程机器,你可以通过命令“Remote Explorer: Focus on Remote View”(远程资源管理器:聚焦远程视图)来聚焦它。
像其他远程开发扩展一样,你的远程机器的名称将显示在左下角的绿色远程指示器中。点击此指示器是探索远程隧道命令的另一种方式,以及关闭远程连接或安装 VS Code 桌面版的选项。
在容器中打开远程隧道主机上的文件夹
你可以结合使用 Remote - Tunnels 和 开发容器 扩展,在容器内打开远程主机上的文件夹。你甚至不需要在本地安装 Docker 客户端。
操作步骤如下:
- 按照 安装 步骤在远程主机上安装 Docker,并在本地安装 VS Code 和开发容器扩展。
- 按照 Remote - Tunnels 扩展的 入门 说明设置隧道,连接到它并在其中打开一个文件夹。
- 使用命令面板(F1,⇧⌘P (Windows、Linux Ctrl+Shift+P))中的“Dev Containers: Reopen in Container”(开发容器:在容器中重新打开)命令。
开发容器快速入门的其余部分同样适用。你可以在开发容器扩展的文档中了解更多信息。如果此模型不符合你的需求,你还可以查看在远程 Docker 主机上开发文章中的其他选项。
常见问题
Remote Tunnels、VS Code Server 和远程开发之间有什么关系?
Visual Studio Code 远程开发 允许你使用容器、远程机器或适用于 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 抽象了本地/远程细节,因此大多数扩展无需修改即可工作。然而,鉴于扩展可以使用任何 Node 模块或运行时,有些情况下可能需要进行调整。我们建议你测试你的扩展,以确保不需要更新。有关详细信息,请参阅支持远程开发。
多个用户或客户端可以同时访问同一个远程实例吗?
不可以,服务器实例旨在一次由一个用户或客户端访问。
如何移除隧道或机器?
如果你想停止通过 CLI 运行的隧道,可以使用 Ctrl + C 结束活动的隧道。如果你通过 VS Code UI 启用了隧道,可以在 VS Code 中运行命令“Remote Tunnels: Turn off Remote Tunnel Access...”(远程隧道:关闭远程隧道访问...)。
你可以在该机器上运行 code tunnel unregister
来解除机器与隧道的关联。你还可以打开任何 VS Code 客户端,选择远程资源管理器视图,右键单击要移除的机器,然后选择“注销”。
隧道如何安全?
托管和连接隧道都需要在两端使用相同的 GitHub 或 Microsoft 帐户进行身份验证。在这两种情况下,VS Code 都将向 Azure 中托管的服务发起出站连接;通常无需更改防火墙,VS Code 也不会设置任何网络侦听器。
一旦你从远程 VS Code 实例连接,就会通过隧道创建 SSH 连接,以提供端到端加密。当前此加密的首选密码是 CTR 模式下的 AES 256,实现此功能的代码是开源的。
你可以在其文档中了解有关底层开发隧道服务安全性的更多信息。
隧道服务有使用限制吗?
为避免滥用底层隧道服务,对隧道数量和带宽等资源设置了使用限制。我们预计大多数用户永远不会达到这些限制。
例如,现在你的账户可以注册 10 个隧道。如果你想创建一个新隧道,并且已经注册了 10 个其他隧道,CLI 将随机选择一个未使用的隧道并将其删除。请注意,此限制可能会发生变化。
我可以在我的组织中配置策略吗?
如果你所在的组织希望控制端口转发的访问权限,可以通过允许或拒绝访问域 global.rel.tunnels.api.visualstudio.com
来实现。
对于运行 Windows 设备的用户,你还可以配置并部署开发隧道的组策略设置。你可以在开发隧道文档中了解更多信息。
如何确保隧道持续运行?
你有以下几个选择
- 使用
service
命令作为服务运行。你可以运行code tunnel service install
和code tunnel service uninstall
来安装和移除它们。 - 使用
no-sleep
选项code tunnel --no-sleep
,以防止你的远程机器进入睡眠状态。
如code
CLI 文档中所述,你可以通过 code tunnel --help
探索所有可能的 CLI 命令和选项。