参加你附近的 ,了解 VS Code 中的 AI 辅助开发。

通过 Visual Studio Code 进行远程 SSH

2019年7月25日,作者:Sana Ajani,@sana_ajani

Remote - SSH:简单、流畅,如同本地开发

如果你错过了,Visual Studio Code 最近发布了远程开发扩展。远程扩展允许你在容器、远程机器或虚拟机 (VM) 以及适用于 Linux 的 Windows 子系统 (WSL) 中进行开发,同时将功能齐全的 VS Code 作为你的开发环境。

Remote SSH architecture

无限可能:不再受本地机器的束缚

越来越多的开发者从事大型复杂项目,这要求他们使用专门的开发虚拟机或服务器,这些设备能提供比普通笔记本电脑更大的存储空间或更强的计算能力。

然而,这种开发方式也带来了不少挑战:

  • 如果你使用远程访问软件(如 VNC),由于用户界面不在本地,你很可能会在编辑时遇到延迟。
  • 如果你使用远程桌面协议 (RDP),管理多个连接可能会很困难。
  • 挂载远程文件系统和执行批量操作可能会很慢。
  • 保持远程和本地环境同步很烦人,而且你经常会遇到在一个地方能正常工作,在另一个地方却不行的问题。
  • 使用 SSH 和 Vim 远程编辑文件意味着你无法再使用自己熟悉的代码编辑器。

如果能打破本地机器的物理限制,同时又不必放弃你惯用的工具,那该多好啊!现在,Remote - SSH 扩展的神奇之处就体现出来了。

使用 Linux 进行远程开发

只要你的 Linux 虚拟机支持 SSH,它就可以托管在任何地方:本地主机、本地机房、Azure 或任何其他云端。你也可以在任何客户端上操作——Windows、macOS 或 Linux。

注意:目前尚不支持 macOS 和 Windows 的 SSH 主机。

在这篇博文中,我们将使用 Windows 客户端并以 Azure 上的 Linux 虚拟机为目标。

开始使用

要开始,你需要完成以下准备工作:

  1. 安装一个兼容 OpenSSH 的 SSH 客户端(不支持 PuTTY)。
  2. 安装 Visual Studio Code
  3. 拥有一个 Azure 订阅(如果你没有 Azure 订阅,请在开始前创建一个免费帐户)。

创建虚拟机

如果你没有现成的 Linux 虚拟机,可以通过 Azure 门户创建一个新的虚拟机。在 Azure 门户中,搜索“虚拟机”,然后选择添加。在这里,你可以选择你的 Azure 订阅并创建一个新的资源组(如果你还没有的话)。

Create a virtual machine

现在你可以指定虚拟机的详细信息,例如名称、大小和基础映像。本例中我们将选择 Ubuntu Server 18.04 LTS,但你也可以选择其他 Linux 发行版的最新版本,并查看我们支持的 SSH 服务器列表

Virtual machine instance details

设置 SSH

登录虚拟机有多种身份验证方法,包括 SSH 公钥/私钥对或用户名和密码。我们强烈建议使用基于密钥的身份验证,这样你每次连接时都无需输入密码。如果你在 Windows 上已经使用 PuttyGen 创建了密钥,可以重用它们

如果你没有 SSH 密钥对,请打开 bash shell 或命令行并输入:

ssh-keygen -t ed25519

这将生成 SSH 密钥。在接下来的提示中按 Enter 键,将密钥保存在默认位置。

ssh-keygen output

然后系统会提示你输入一个安全的密码短语,但你可以将其留空。

将 SSH 密钥添加到你的虚拟机

在上一步中,我们生成了一个 SSH 密钥对。我们将复制 id_ed25519.pub 文件的内容,并将其粘贴到虚拟机的设置中。你还需要允许你的虚拟机接受入站 SSH 流量。

Add SSH public key to VM

使用 Azure 虚拟机的一个很酷的功能是能够启用自动关机(因为我们都承认,我们都会忘记关掉虚拟机……)。如果你进入管理选项卡,可以设置每天关闭虚拟机的时间。

Virtual machine auto-shutdown

选择审阅并创建,Azure 就会为你部署虚拟机!

使用 Remote - SSH 连接

现在我们已经介绍了如何创建 SSH 主机,让我们连接到它吧!

VS Code Remote - SSH 扩展允许你直接在 VS Code 内部通过 SSH 连接到远程机器或虚拟机。如果你尚未安装 Remote - SSH 扩展,可以在扩展视图(Ctrl + Shift + X)中搜索“remote ssh”。

Remote SSH extension

你会注意到状态栏左下角有一个指示器。这个指示器告诉你 VS Code 当前运行的上下文(本地或远程)。点击该指示器可以调出远程扩展命令列表。

Remote extension commands

选择 Remote-SSH: Connect to Host 命令,然后以 user@hostname 的格式输入虚拟机的连接信息来连接到主机。

这里的 user 是你将 SSH 公钥添加到虚拟机时设置的用户名。对于 hostname,请返回 Azure 门户,在我们创建的虚拟机的概述窗格中,复制公共 IP 地址

Virtual machine public IP address

在连接信息文本框中设置用户和主机名。

Set user and host name

VS Code 现在将打开一个新窗口(实例)。然后你会看到一个通知,提示“VS Code Server”正在 SSH 主机上初始化。一旦 VS Code Server 安装在远程主机上,它就可以运行扩展并与你的本地 VS Code 实例通信。

Initializing VS Code Server

通过查看状态栏中的指示器,你就可以知道自己已连接到虚拟机。现在它显示的是我们虚拟机的主机名!

SSH indicator in Status bar

Remote - SSH 扩展还会在你的活动栏上添加一个新图标,点击它会打开 SSH 资源管理器。在这里你可以配置你的 SSH 连接。例如,你可以保存最常连接的主机,并从这里访问它们,而无需每次都输入用户名和主机名。

Remote button on Activity bar

连接到 SSH 主机后,你就可以与远程机器上的文件进行交互并打开文件夹。如果你打开集成终端,你会发现自己正在一个 bash shell 中工作,而你此时仍在使用 Windows。等等,我们已经连接到虚拟机了?这太简单了。这正是重点所在。这些扩展让远程开发感觉简单、流畅,而且……嗯,一点也不“远程”。😃

Checking uname in the terminal

你可以使用 bash shell 浏览虚拟机上的文件系统。使用 mkdir demo 创建一个名为“demo”的新文件夹,然后可以通过文件 > 打开文件夹来浏览和打开远程主目录中的文件夹。

Remote open folder

你还可以在远程 SSH 主机上专门安装扩展。影响 UI 的扩展(如主题和代码片段)会安装在本地,其余的扩展则需要安装在远程 SSH 主机上。你会注意到,打开扩展视图时有两个部分,一个用于本地机器上的扩展,另一个用于远程主机上的扩展。即使你从不同的客户端通过 SSH 连接到你的远程机器,你的远程扩展和设置也会保持不变。当你安装扩展时,VS Code 会自动将其安装在正确的上下文中。

Intellicode extension installed remotely

Hello World

让我们在虚拟机上部署一个基本的“Hello World” Python 应用。我们将使用一个流行的 Python Web 框架 Flask。在你的 bash shell 中,运行以下命令。

sudo apt install python3-flask

在你之前创建的“Demo”文件夹中,创建一个名为 app.py 的新文件(Ctrl + N),其中包含一个基本的 Hello world Flask 应用程序。

from flask import Flask
app = Flask(__name__)

@app.route("/")
def hello():
    return "Hello Remote World! :)"

if __name__ == "__main__":
    app.run()

一旦 VS Code 识别出文件语言是 Python,如果远程机器上尚未安装Microsoft Python 扩展,你会看到一个推荐安装的通知。

Python extension recommendation

选择安装,重新加载 VS Code,你就会在远程机器上看到 VS Code 的 IntelliSense 和代码高亮功能了。

python IntelliSense

要运行该应用,请按 F5,然后选择 Flask 调试配置。在 Python 调试控制台中,你会看到应用正在 localhost 的 5000 端口上运行。然而,这里的 localhost 当前指的是远程服务器,而不是你的本地机器。为了能够在本地机器上浏览这个 Web 应用,我们将利用另一个功能,叫做端口转发

为了能访问远程机器上一个可能未公开的端口,我们需要在本地机器上的一个端口和服务器之间建立一个连接或隧道。在应用仍在运行的情况下,打开 SSH 资源管理器,找到转发的端口视图。点击转发端口链接,并指明我们要转发 5000 端口。

Enter the port to forward

将连接命名为“browser”。

Name the port

现在,服务器会将 5000 端口上的流量转发到我们的本地机器。当你在浏览器中访问 https://:5000 时,你就能看到正在运行的 Web 应用了。

Hello Remote World in a browser

现在,真正的问题是……我们能在 VS Code 中对远程机器进行调试吗?当然可以!在应用仍在运行的情况下,在返回“Hello Remote World”字符串的那一行设置一个断点,然后点击调试控件中的重启按钮。在浏览器中刷新页面,你就会命中这个断点!你获得了与本地开发完全相同的 VS Code 体验,包括编辑、调试以及你所有的设置和扩展。😊

Debugging over SSH

要切换回本地机器进行本地开发,你可以通过文件 > 关闭远程连接来关闭远程连接。

使用 Remote - SSH 扩展,你可以在远程机器上利用 VS Code 的所有生产力功能和扩展来针对虚拟机进行开发。无论你的代码托管在哪里,你都能获得在 VS Code 中所熟知和喜爱的全功能开发体验。

如果你想了解更多关于 VS Code Remote 的信息,可以阅读我们宣布远程开发的博文。你也可以尝试其他远程扩展,如开发容器 (Dev Containers)WSL,并阅读我们完整的远程开发文档

远程编码愉快!

Sana Ajani,VS Code 项目经理 @sana_ajani