VSCode For Web 深入浅出 -- VS Code Server 设计

最近收到了一些来自社区的反馈，希望我能够对 VSCode Server 的的设计思路以及内部实现进行一些解析。因此，本篇文章将会对 VSCode Server 的原理、架构、使用场景等方面进行一些分析与探讨。

什么是 VS Code Server

VS Code Server 是一个运行在远程服务器上的 VS Code 实例，它可以通过浏览器访问，提供了与本地 VS Code 相同的编辑体验。它基于远程开发扩展所使用的服务器构建，还具备交互式 CLI 等额外功能。

通过在远程机器上运行 VS Code Server，开发者可以在本地 VS Code 客户端中编辑和调试远程的代码，拥有本地般的开发体验，包括智能感知、代码导航和调试等等。这种方式可以让开发者在不同的设备上保持一致的开发环境，同时也可以在不同的设备上共享开发环境。

接下来我们介绍一下组成一个完整的 VSCode Server 体验的两个重要组成部分。

一个是在服务器上下载并构建一个独立的 VS Code Server，让所有的 VS Code 交互都通过请求该 Server 来实现，使得任意的远程 client (甚至无需是 VS Code)，只要能发送网络请求，都能实现远程 VS Code 体验。

VS Code Server 的架构图如下：

另一个是通过 VS Code 扩展: Remote - Tunnels extension ，通过在 server 与 client 之间建立一个可信安全的 tunnel，使得 VS Code 能将远程服务器中的目录结构挂载映射到本地的客户端来实现。

VS Code Tunnel 实现原理

在上面的介绍中，我们发现一个很有意思的地方，VS Code Server 与客户端之间支持不直接通过 SSH 连接。因此，它理论上可以在无需安装 VS Code 的情况下运行，甚至可以在不支持 SSH 命令的环境中运行，例如在浏览器中运行。那么它是如何做到的呢？

这里就不得不提到 VS Code tunnel 了。VS Code tunnel 是微软实现的一种隧道技术，我们可以在 MS Learn 隧道服务（点对点访问） 这里找到更多信息。

VS Code tunnel 本质上是在服务器和客户端上各启动了一个服务，并相互使用 HTTPS 连接，同时监听了服务器上的部分端口（通常是 443 等）的 https / wss 通信，从而使得客户端可以通过这个通道获取到服务器上的相关请求以及信息。在此过程中，服务器并不需要向外暴露任何端口或者 IP 地址，从而保证了服务器自身的安全性。

当然，由于 VS Code Server 本身自动更新，安装扩展等需要，如果服务器在受限环境的情况下，还是需要为一些域名开放白名单的，详情可参考这里。

在实现上，VS Code Server 提供了一个专门的 code CLI。通过 code tunnel 命令，将会自动下载 VS Code Server 相关代码并启动隧道服务。其实它本质上并不需要连接的客户端也一定是 VS Code，仅需要保证连接双方匹配上同一个隧道即可。

配对与身份校验

那么问题就来了，VS Code tunnel 是如何配对的呢？这里其实是复用了之前介绍过的 VS Code 账户体系，通过校验客户端与服务器上登录 VS Code 账户(目前仅允许 Github 或 Microsoft 帐户)进行身份验证。

在校验了身份后，会使用该账号在 Azure 同一 workspace 下创建隧道服务（点对点访问），在这种情况下，VS Code 将与 Azure 托管的隧道服务建立出站连接。

隧道成功匹配后即可通过在隧道内创建 SSH 连接实现端到端加密。目前 VS Code Tunnel 使用 AES 256 in CTR 模式，我们可以在这里 找到相关的加密算法。

在无 SSH 环境下的连接

那么，如果当客户端没有可用 terminal 环境（如浏览器）该如何连接呢？这里可以参考 VS Code For Web 与 Github Codespaces 的实现办法。本质上，隧道开启时，服务端会生成一个特殊的 URL

https://vscode.dev/tunnel/<machine_name>/<path>

客户端访问这个 URL 时将重定向到特定的隧道服务，该服务会将客户端与服务器之间的连接进行匹配，从而实现 VS Code Server 与客户端之间的连接。当然，该 URL 的安全性也由上述的账号身份验证保证。

使用限制

由于 VS Code Server 的实现本质上是利用了点对点的隧道服务，这项特性显然会带来不小的成本以及被滥用的可能。因此，VS Code Server 对隧道数量和带宽等资源设置了使用限制。

目前 VS Code Server 仅支持在 Azure 上运行，且需要使用 Microsoft 或 Github 账户进行登录。对于每个账户，仅能注册至多 10 个隧道。如果要创建新隧道并且已经注册了 10 个其他隧道，CLI 将随机选择一个未使用的隧道并将其删除。

另外，一个 VS Code Server 实例仅设计为供单个用户访问。因此多租户的使用场景并不适用。如果需要多用户访问，可以考虑使用多个 VS Code Server 实例。

与其他 VS Code 特性对比

与 SSH 连接的关系

如果你不愿意接受 VS Code Server 的隧道服务，例如需要更多连接数，或者有多用户服务器的需求，也可以直接使用 SSH 连接到远程服务器。

Visual Studio Code Remote - SSH 扩展允许你使用 SSH 连接到远程服务器，并在远程服务器上运行 VS Code Server。

VS Code Server 本身也同样支持 SSH 连接，只需要在远程服务器上安装 SSH 服务，并在 VS Code 中配置好 SSH 连接信息即可。由于强需求 SSH 环境，并不在 VSCode for Web 系列的支持范围内，因此不是本系列文章的重点，在此就不多赘述了。

与 Dev Container 的组合使用

Dev Containers 是 VS Code 的另外一项重要特性。它允许 VSCode 可以在 Docker 容器中运行开发环境。

VS Code Server 与 Dev Containers 是两个独立的功能，我们知道 VS Code Server 可以在远程服务器上运行 VS Code 实例，因此它们可以很好的结合使用。

通过在远程服务器上运行一个 Dev Containers，并利用 VS Code Tunnel 访问该 Dev Container，从而实现远程容器的开发体验，对开发环境的同一管理效率又提升了一个 level。

总结

在本篇文章中，我们介绍了 VS Code Server 的设计思路以及实现原理。通过 VS Code Tunnel，我们可以在任意客户端上连接远程服务器的 VS Code 实例，从而实现远程开发的体验。

参考资料

• Visual Studio Code Server