使用远程隧道进行开发
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 帐户,网址为
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 和 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 和 Remote Development 之间有什么关系?
Visual Studio Code 远程开发 允许您将容器、远程计算机或适用于 Linux 的 Windows 子系统 (WSL) 用作功能齐全的开发环境。
远程开发通过将某些命令的执行转移到“远程服务器”,即 VS Code Server,使您的本地 VS Code 安装能够透明地与源代码和运行时环境在其他机器(无论是虚拟的还是物理的)上进行交互。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 客户端,选择远程资源管理器视图,右键单击您想要移除的机器,然后选择取消注册。
隧道是如何保证安全的?
托管和连接隧道都需要使用相同的 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 命令和选项。