在 VS Code 中试用

通过 SSH 进行远程开发

本教程将指导你使用 Visual Studio Code 远程 - SSH 扩展在 Azure 上创建并连接到虚拟机 (VM)。你将创建一个 Node.js Express Web 应用,以展示如何在 VS Code 中像处理本地源代码一样在远程计算机上进行编辑和调试。

注意:你的 Linux VM 可以托管在任何地方——本地主机、本地部署、Azure 或任何其他云中,只要所选的 Linux 发行版符合这些先决条件

先决条件

要开始,你需要完成以下步骤:

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

安装扩展

远程 - SSH 扩展用于连接 SSH 主机。

安装远程 - SSH 扩展

Remote - SSH extension

远程 - SSH

安装远程 - SSH 扩展后,你会在最左侧看到一个新的状态栏项。

Remote Status bar item

远程状态栏项可以快速显示 VS Code 正在运行的上下文(本地或远程),单击该项将显示远程 - SSH 命令。

Remote - SSH commands

创建虚拟机

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

注意:在本教程中,我们使用 Azure,但你的 Linux VM 可以托管在任何地方,只要 Linux 发行版符合这些先决条件

Create a virtual machine

现在你可以指定 VM 的详细信息,例如名称、大小和基础镜像。本例中选择 Ubuntu Server 18.04 LTS,但你可以选择其他 Linux 发行版的最新版本,并查看 VS Code 的支持的 SSH 服务器

Virtual machine instance details

设置 SSH

有几种身份验证方法可以登录到 VM,包括 SSH 公钥/私钥对或用户名和密码。我们建议使用基于密钥的身份验证(如果你使用用户名/密码,扩展程序会多次提示你输入凭据)。如果你使用 Windows 并且已经使用 PuttyGen 创建了密钥,可以重复使用它们

创建 SSH 密钥

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

ssh-keygen -t ed25519

这将生成 SSH 密钥。在以下提示符下按 Enter 将密钥保存到默认位置(在用户目录下,名为 .ssh 的文件夹中)。

ssh-keygen output

然后会提示你输入安全密码,但你可以将其留空。现在你应该有一个包含新公共 SSH 密钥的 id_ed25519.pub 文件。

注意:如果你使用的是不支持 Ed25519 算法的旧系统,则可以使用 rsa 代替:ssh-keygen -t rsa -b 4096

将 SSH 密钥添加到 VM

在上一步中,你生成了一个 SSH 密钥对。在SSH 公钥来源下拉菜单中选择使用现有公钥,以便使用你刚刚生成的公钥。复制 id_ed25519.pub 的全部内容,将其粘贴到 VM 设置中的SSH 公钥字段。你还需要通过选择允许选定端口并从选择入站端口下拉列表中选择SSH (22) 来允许你的 VM 接受入站 SSH 流量。

Add SSH public key to VM

自动关机

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

Virtual machine auto-shutdown

选择审阅 + 创建,然后选择创建,Azure 将为你部署 VM!

部署完成后(可能需要几分钟),转到虚拟机的新资源视图。

使用 SSH 连接

现在你已经创建了一个 SSH 主机,让我们连接到它!

你会在状态栏的左下角看到一个指示器。此指示器会告诉你 VS Code 正在运行的上下文(本地或远程)。单击该指示器会显示远程扩展命令列表。

Remote extension commands

Remote-SSH 部分选择连接到主机... 命令,然后以 user@hostname 的格式输入 VM 的连接信息以连接到主机。

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

Virtual machine public IP address

在远程 - SSH 中连接之前,你可以使用 ssh user@hostname 通过命令提示符验证是否能够连接到你的 VM。

注意:如果你遇到错误 ssh: connect to host <host ip> port 22: Connection timed out,你可能需要从 VM 的网络选项卡中删除 NRMS-Rule-106。

Virtual machine list of NRMS rules

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

Set user and host name

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

Initializing VS Code Server

通过查看状态栏中的指示器,你会知道你已连接到 VM。它显示你的 VM 的主机名。

SSH indicator in Status bar

远程 - SSH 扩展还在活动栏中贡献了一个新图标,单击它可以打开远程资源管理器。从下拉列表中,选择SSH 目标,你可以在其中配置 SSH 连接。例如,你可以保存你最常连接的主机,并从此处访问它们,而不是输入用户和主机名。

Remote button on Activity bar

连接到 SSH 主机后,你可以与远程计算机上的文件交互并打开文件夹。如果你打开集成终端(⌃` (Windows、Linux Ctrl+`)),你会看到你正在一个 bash shell 中工作,即使你是在 Windows 上

Checking uname in the terminal

你可以使用 bash shell 浏览 VM 上的文件系统。你还可以通过文件 > 打开文件夹浏览并打开远程主目录中的文件夹。

Remote open folder

创建 Node.js 应用程序

在此步骤中,你将创建一个简单的 Node.js 应用程序。你将使用应用程序生成器从终端快速搭建应用程序骨架。

安装 Node.js 和 npm

从集成终端(⌃` (Windows、Linux Ctrl+`))更新 Linux VM 中的包,然后安装 Node.js(其中包含 npm,Node.js 包管理器)。

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 生成器工具来搭建(创建)一个新的 Express 应用程序骨架。Express 生成器作为 npm 模块提供,并通过 npm 命令行工具 npm 安装。

sudo npm install -g express-generator

-g 开关将 Express 生成器全局安装到你的机器上,这样你就可以从任何地方运行它。

创建新应用程序

你现在可以通过运行以下命令来创建一个名为 myExpressApp 的新 Express 应用程序:

express myExpressApp --view pug

--view pug 参数告诉生成器使用 pug 模板引擎。

要安装应用程序的所有依赖项,请进入新文件夹并运行 npm install

cd myExpressApp
npm install

运行应用程序

最后,我们确保应用程序运行。从终端使用 npm start 命令启动应用程序以启动服务器。

npm start

Express 应用默认在 http://localhost:3000 上运行。你不会在本地浏览器上的 localhost:3000 看到任何内容,因为该 Web 应用正在你的虚拟机上运行。

端口转发

为了能够在你的本地机器上浏览 Web 应用,你可以利用另一个功能,称为端口转发

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

Enter the port to forward

将连接命名为“browser”

Name the port

服务器现在会将端口 3000 上的流量转发到你的本地机器。当你浏览到 http://localhost:3000 时,你将看到正在运行的 Web 应用。

Running Express Application

编辑和调试

从 Visual Studio Code 文件资源管理器(⇧⌘E (Windows、Linux Ctrl+Shift+E))中,导航到新的 myExpressApp 文件夹,然后双击 app.js 文件以在编辑器中打开它。

IntelliSense

你将拥有 JavaScript 文件的语法高亮以及带有悬停提示的 IntelliSense,就像源代码在本地机器上一样。

Express app.js hover

当你开始输入时,你会获得对象方法和属性的智能补全。

Express app.js smart completions

调试

通过单击行号左侧的槽或将光标放在该行并按 F9,在 app.js 的第 10 行设置一个断点。断点将显示为红色圆圈。

set breakpoint

现在,按 F5 运行你的应用程序。如果系统询问如何运行应用程序,请选择Node.js

应用程序将启动,你会命中断点。你可以检查变量、创建监视以及导航调用堆栈。

F10 单步执行或再次按 F5 结束调试会话。

VS Code debug view

你将获得通过 SSH 连接的 Visual Studio Code 的完整开发体验。

结束你的 SSH 连接

你可以结束 SSH 会话,并通过文件 > 关闭远程连接返回本地运行 VS Code。

恭喜

恭喜,你已成功完成本教程!

接下来,查看其他远程开发扩展。

或者安装远程开发扩展包以获取所有这些扩展。