通过 SSH 进行远程开发
本教程将引导您使用 Visual Studio Code Remote - SSH 扩展在 Azure 上创建虚拟机 (VM) 并连接到该虚拟机。您将创建一个 Node.js Express Web 应用程序,以展示如何在远程计算机上使用 VS Code 进行编辑和调试,就像源代码在本地一样。
注意:您的 Linux VM 可以托管在任何位置 - 在本地主机、本地部署、Azure 或任何其他云中,只要所选的 Linux 发行版满足这些先决条件即可。
先决条件
要开始使用,您需要完成以下步骤
- 安装与 OpenSSH 兼容的 SSH 客户端(不支持 PuTTY)。
- 安装Visual Studio Code。
- 拥有 Azure 订阅(如果您没有 Azure 订阅,请在开始之前创建一个免费帐户)。
安装扩展
Remote - SSH 扩展用于连接到 SSH 主机。
Remote - SSH
安装 Remote - SSH 扩展后,您将在最左侧看到一个新的状态栏项。
远程状态栏项可以快速显示 VS Code 正在哪个上下文中运行(本地或远程),单击该项将弹出 Remote - SSH 命令。
创建虚拟机
如果您没有现有的 Linux 虚拟机,可以通过 Azure 门户创建一个新的 VM。在 Azure 门户中,搜索“虚拟机”,然后选择添加。从那里,您可以选择您的 Azure 订阅并创建一个新的资源组(如果您还没有的话)。
注意:在本教程中,我们使用 Azure,但您的 Linux VM 可以托管在任何位置,只要 Linux 发行版满足这些先决条件即可。
现在您可以指定 VM 的详细信息,例如名称、大小和基本映像。在本示例中选择 Ubuntu Server 18.04 LTS,但您可以选择其他 Linux 发行版的最新版本,并查看 VS Code 的支持的 SSH 服务器。
设置 SSH
有几种身份验证方法可以进入 VM,包括 SSH 公钥/私钥对或用户名和密码。我们建议使用基于密钥的身份验证(如果您使用用户名/密码,扩展程序将提示您多次输入凭据)。如果您在 Windows 上并且已经使用 PuttyGen 创建了密钥,则可以重用它们。
创建 SSH 密钥
如果您没有 SSH 密钥对,请打开 bash shell 或命令行并键入
ssh-keygen -t ed25519
这将生成 SSH 密钥。在以下提示符下按 Enter 以将密钥保存在默认位置(在您的用户目录下,文件夹名为 .ssh
)。
然后,系统将提示您输入安全密码,但您可以将其留空。您现在应该有一个 id_ed25519.pub
文件,其中包含您的新公钥 SSH 密钥。
注意:如果您使用的是不支持 Ed25519 算法的旧版系统,则可以使用 rsa 代替:
ssh-keygen -t rsa -b 4096
。
将 SSH 密钥添加到 VM
在上一步中,您生成了一个 SSH 密钥对。在SSH 公钥源的下拉列表中选择使用现有公钥,以便可以使用刚刚生成的公钥。获取公钥并将其粘贴到您的 VM 设置中,方法是将 id_ed25519.pub
的全部内容复制到SSH 公钥中。您还需要允许您的 VM 接受入站 SSH 流量,方法是选择允许选定的端口并从选择入站端口下拉列表中选择 SSH (22)。
自动关机
使用 Azure VM 的一个很酷的功能是能够启用自动关机(因为让我们面对现实,我们都忘记关闭我们的 VM…)。如果您转到管理选项卡,则可以设置您希望每天关闭 VM 的时间。
选择查看 + 创建,然后选择创建,Azure 将为您部署您的 VM!
部署完成后(可能需要几分钟),转到虚拟机的新的资源视图。
使用 SSH 连接
现在您已经创建了 SSH 主机,让我们连接到它!
您会注意到状态栏左下角有一个指示器。此指示器告诉您 VS Code 正在哪个上下文中运行(本地或远程)。单击指示器以调出远程扩展命令列表。
在 Remote-SSH 部分中选择 连接到主机... 命令,并通过输入以下格式的 VM 连接信息来连接到主机:user@hostname
。
user
是您在将 SSH 公钥添加到 VM 时设置的用户名。对于 hostname
,返回到 Azure 门户,并在您创建的 VM 的概述窗格中,复制公共 IP 地址。
在 Remote - SSH 中连接之前,您可以验证是否可以使用命令提示符通过 ssh user@hostname
连接到您的 VM。
注意:如果您遇到错误
ssh: connect to host <host ip> port 22: Connection timed out
,您可能需要从 VM 的“网络”选项卡中删除 NRMS-Rule-106
在连接信息文本框中设置用户和主机名。
VS Code 现在将打开一个新窗口(实例)。然后,您将看到一条通知,指示“VS Code Server”正在 SSH 主机上初始化。一旦 VS Code Server 安装在远程主机上,它就可以运行扩展并与您的本地 VS Code 实例通信。
您可以通过查看状态栏中的指示器来知道您已连接到您的 VM。它显示您的 VM 的主机名。
Remote - SSH 扩展还在活动栏上贡献了一个新图标,单击它将打开远程资源管理器。从下拉列表中,选择 SSH 目标,您可以在其中配置您的 SSH 连接。例如,您可以保存您最常连接的主机,并从此处访问它们,而无需输入用户和主机名。
连接到 SSH 主机后,您可以与远程计算机上的文件进行交互并打开文件夹。如果您打开集成终端(⌃` (Windows, Linux Ctrl+`)),您将看到您正在 Windows 上的 bash shell 中工作。
您可以使用 bash shell 浏览 VM 上的文件系统。您还可以使用 文件 > 打开文件夹 浏览和打开远程主目录中的文件夹。
创建您的 Node.js 应用程序
在此步骤中,您将创建一个简单的 Node.js 应用程序。您将使用应用程序生成器从终端快速搭建应用程序框架。
安装 Node.js 和 npm
从集成终端(⌃` (Windows, Linux Ctrl+`))更新 Linux VM 中的软件包,然后安装 Node.js,其中包括 Node.js 包管理器 npm。
sudo apt-get update
curl -sL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs
您可以通过运行以下命令来验证安装
node --version
npm --version
安装 Express 生成器
Express 是一个用于构建和运行 Node.js 应用程序的流行框架。您可以使用 Express Generator 工具来搭建(创建)一个新的 Express 应用程序。Express Generator 作为 npm 模块发布,并通过使用 npm 命令行工具 npm
安装。
sudo npm install -g express-generator
-g
开关将 Express Generator 全局安装在您的计算机上,以便您可以从任何位置运行它。
创建一个新的应用程序
您现在可以通过运行以下命令来创建一个名为 myExpressApp
的新 Express 应用程序
express myExpressApp --view pug
--view pug
参数告诉生成器使用 pug 模板引擎。
要安装所有应用程序的依赖项,请转到新文件夹并运行 npm install
。
cd myExpressApp
npm install
运行应用程序
最后,让我们确保应用程序运行。从终端,使用 npm start
命令启动应用程序以启动服务器。
npm start
默认情况下,Express 应用程序在 https://127.0.0.1:3000 上运行。您不会在本地浏览器上的 localhost:3000 上看到任何内容,因为 Web 应用程序正在您的虚拟机上运行。
端口转发
为了能够在您的本地计算机上浏览 Web 应用程序,您可以利用另一个称为端口转发的功能。
为了能够访问远程计算机上可能未公开的端口,您需要在本地计算机上的端口和服务器之间建立连接或隧道。在应用程序仍在运行时,打开 SSH 资源管理器并找到 转发的端口 视图。单击 转发端口 链接,并指示您要转发端口 3000
将连接命名为“browser”
服务器现在会将端口 3000 上的流量转发到您的本地计算机。当您浏览到 https://127.0.0.1:3000 时,您会看到正在运行的 Web 应用程序。
编辑和调试
从 Visual Studio Code 文件资源管理器(⇧⌘E (Windows, Linux Ctrl+Shift+E))导航到您的新 myExpressApp
文件夹,然后双击 app.js
文件以在编辑器中打开它。
IntelliSense
您拥有 JavaScript 文件的语法突出显示以及带有悬停提示的 IntelliSense,就像源代码在本地计算机上一样。
当您开始键入时,您将获得对象方法和属性的智能完成。
调试
通过单击行号左侧的槽或将光标放在行上并按 F9,在 app.js
的第 10 行设置断点。断点将显示为一个红色圆圈。
现在,按 F5 以运行您的应用程序。如果系统询问您如何运行应用程序,请选择 Node.js。
应用程序将启动,您将命中该断点。您可以检查变量、创建监视并导航调用堆栈。
按 F10 单步跳过,或再次按 F5 以完成您的调试会话。
您将获得通过 SSH 连接的 Visual Studio Code 的完整开发体验。
结束您的 SSH 连接
您可以通过 文件 > 关闭远程连接 来结束通过 SSH 的会话并返回到本地运行 VS Code。
恭喜
恭喜,您已成功完成本教程!
接下来,查看其他远程开发扩展。
或者安装远程开发扩展包来获取所有扩展。