Visual Studio Code 中的 Node.js 教程
Node.js 是一个使用 JavaScript 构建快速、可扩展的服务器应用程序的平台。Node.js 是运行时环境,而 npm 是 Node.js 模块的包管理器。
Visual Studio Code 开箱即用地支持 JavaScript 和 TypeScript 语言以及 Node.js 调试。但是,要运行 Node.js 应用程序,您需要在您的计算机上安装 Node.js 运行时。
要开始本演练,请为您的平台安装 Node.js。Node 包管理器包含在 Node.js 发行版中。您需要打开一个新的终端(命令提示符),以便 node
和 npm
命令行工具位于您的 PATH 中。
要测试您是否在计算机上正确安装了 Node.js,请打开一个新终端并输入 node --version
,您应该会看到已安装的当前 Node.js 版本。
Linux:有适用于各种 Linux 发行版的特定 Node.js 包。请参阅通过包管理器安装 Node.js,以查找适合您 Linux 版本的 Node.js 包和安装说明。
适用于 Linux 的 Windows 子系统:如果您在 Windows 上,WSL 是进行 Node.js 开发的好方法。您可以在 Windows 上运行 Linux 发行版,并将 Node.js 安装到 Linux 环境中。当与 WSL 扩展程序结合使用时,您可以在 WSL 的上下文中运行时获得完整的 VS Code 编辑和调试支持。要了解更多信息,请转到在 WSL 中开发或尝试在 WSL 中工作教程。
Hello World
让我们从创建最简单的 Node.js 应用程序“Hello World”开始。
创建一个名为“hello”的空文件夹,导航进入并打开 VS Code
mkdir hello
cd hello
code .
提示: 您可以直接从命令行打开文件或文件夹。句点“.”指的是当前文件夹,因此 VS Code 将启动并打开
Hello
文件夹。
在文件资源管理器工具栏中,按“新建文件”按钮
并将文件命名为 app.js
通过使用 .js
文件扩展名,VS Code 将此文件解释为 JavaScript,并将使用 JavaScript 语言服务评估其内容。请参阅 VS Code 的JavaScript 语言主题以了解有关 JavaScript 支持的更多信息。
在 app.js
中创建一个简单的字符串变量,并将该字符串的内容发送到控制台
var msg = 'Hello World';
console.log(msg);
请注意,当您键入 console.
时,console
对象上的 IntelliSense 会自动呈现给您。
另请注意,VS Code 根据 msg
初始化为 'Hello World'
就知道它是一个字符串。如果您键入 msg.
,您将看到 IntelliSense 显示 msg
上所有可用的字符串函数。
在体验了 IntelliSense 之后,从上面的源代码示例中还原所有多余的更改并保存文件 (⌘S (Windows、Linux 为 Ctrl+S))。
运行 Hello World
用 Node.js 运行 app.js
很简单。在终端中,只需键入
node app.js
您应该会看到“Hello World”输出到终端,然后 Node.js 返回。
集成终端
VS Code 有一个集成终端,您可以用它来运行 shell 命令。您可以直接从那里运行 Node.js,避免在运行命令行工具时切换出 VS Code。
查看 > 终端 (⌃` (Windows、Linux 为 Ctrl+`),使用反引号字符) 将打开集成终端,您可以在其中运行 node app.js
在本演练中,您可以使用外部终端或 VS Code 集成终端来运行命令行工具。
调试 Hello World
如引言中所述,VS Code 附带一个用于 Node.js 应用程序的调试器。让我们来调试我们简单的 Hello World 应用程序。
要在 app.js
中设置断点,请将编辑器光标放在第一行并按 F9,或单击编辑器左侧行号旁边的边栏。一个红圈将出现在边栏中。
要开始调试,请在活动栏中选择运行和调试视图
您现在可以单击调试工具栏的绿色箭头或按 F5 来启动和调试“Hello World”。您的断点将被命中,您可以查看和单步执行这个简单的应用程序。请注意,VS Code 会显示一个不同颜色的状态栏以指示其处于调试模式,并且会显示调试控制台。
现在您已经看到 VS Code 与“Hello World”一起工作的实际效果,下一节将展示如何将 VS Code 用于一个全栈 Node.js Web 应用程序。
注意: 我们已经完成了“Hello World”示例,所以在创建 Express 应用程序之前,请导航出该文件夹。您可以删除“Hello”文件夹,因为本演练的其余部分不需要它。
一个 Express 应用程序
Express 是一个非常流行的应用程序框架,用于构建和运行 Node.js 应用程序。您可以使用 Express 生成器工具来搭建(创建)一个新的 Express 应用程序。Express 生成器作为一个 npm 模块提供,并通过 npm 命令行工具 npm
进行安装。
提示: 要测试您是否在计算机上正确安装了
npm
,请在终端中输入npm --help
,您应该会看到用法文档。
通过在终端中运行以下命令来安装 Express 生成器
npm install -g express-generator
-g
开关会在您的计算机上全局安装 Express 生成器,这样您就可以从任何地方运行它。
我们现在可以通过运行以下命令来搭建一个名为 myExpressApp
的新 Express 应用程序
express myExpressApp --view pug
这会创建一个名为 myExpressApp
的新文件夹,其中包含您的应用程序内容。--view pug
参数告诉生成器使用 pug 模板引擎。
要安装应用程序的所有依赖项(同样作为 npm 模块提供),请进入新文件夹并执行 npm install
cd myExpressApp
npm install
此时,我们应该测试我们的应用程序是否可以运行。生成的 Express 应用程序有一个 package.json
文件,其中包含一个用于运行 node ./bin/www
的 start
脚本。这将启动 Node.js 应用程序运行。
在 Express 应用程序文件夹的终端中,运行
npm start
Node.js Web 服务器将启动,您可以浏览到 https://:3000 查看正在运行的应用程序。
出色的代码编辑
关闭浏览器,在 myExpressApp
文件夹的终端中,按 CTRL+C 停止 Node.js 服务器。
现在启动 VS Code
code .
注意: 如果您一直使用 VS Code 集成终端来安装 Express 生成器和搭建应用程序,您可以使用文件 > 打开文件夹命令从正在运行的 VS Code 实例中打开
myExpressApp
文件夹。
Node.js 和 Express 的文档很好地解释了如何使用该平台和框架构建丰富的应用程序。Visual Studio Code 将通过提供出色的代码编辑和导航体验,让您在开发这些类型的应用程序时更有效率。
打开文件 app.js
并将鼠标悬停在 Node.js 全局对象 __dirname
上。请注意 VS Code 如何理解 __dirname
是一个字符串。更有趣的是,您可以获得针对 Node.js 框架的完整 IntelliSense。例如,您可以 require http
并在 Visual Studio Code 中键入时获得针对 http
类的完整 IntelliSense。
VS Code 使用 TypeScript 类型声明 (typings) 文件(例如 node.d.ts
)向 VS Code 提供关于您在应用程序中使用的基于 JavaScript 的框架的元数据。类型声明文件是用 TypeScript 编写的,因此它们可以表示参数和函数的数据类型,从而使 VS Code 能够提供丰富的 IntelliSense 体验。得益于一个名为“自动类型获取”的功能,您不必担心下载这些类型声明文件,VS Code 会自动为您安装它们。
您还可以编写引用其他文件中模块的代码。例如,在 app.js
中,我们 require 了 ./routes/index
模块,该模块导出了一个 Express.Router
类。如果您在 index
上调出 IntelliSense,您可以看到 Router
类的结构。
调试您的 Express 应用
您需要为您的 Express 应用程序创建一个调试器配置文件 launch.json
。点击活动栏中的运行和调试(⇧⌘D (Windows, Linux Ctrl+Shift+D)),然后选择创建 launch.json 文件链接以创建一个默认的 launch.json
文件。选择 Node.js 环境,确保 configurations
中的 type
属性设置为 "node"
。当文件首次创建时,VS Code 会在 package.json
中查找 start
脚本,并将其值用作启动程序配置的 program
(在本例中是 "${workspaceFolder}\\bin\\www
)。
{
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Launch Program",
"program": "${workspaceFolder}\\bin\\www"
}
]
}
保存新文件,并确保在运行和调试视图顶部的配置下拉菜单中选择了启动程序。打开 app.js
并在文件顶部附近创建 Express 应用对象的位置设置一个断点,方法是单击行号左侧的边栏。按 F5 开始调试应用程序。VS Code 将在一个新终端中启动服务器,并命中我们设置的断点。从那里您可以检查变量、创建监视并单步执行您的代码。
部署您的应用程序
如果您想学习如何部署您的 Web 应用程序,请查看将应用程序部署到 Azure 教程,我们在其中展示了如何在 Azure 中运行您的网站。
后续步骤
Visual Studio Code 还有更多值得探索的地方,请尝试以下主题:
- Node.js 配置文件模板 - 使用一组精选的扩展、设置和代码片段创建一个新的配置文件。
- 设置 - 学习如何根据您的工作方式自定义 VS Code。
- 调试 - 这是 VS Code 真正出彩的地方。
- 视频:VS Code 调试入门 - 学习如何在 VS Code 中使用调试功能。
- Node.js 调试 - 了解有关 VS Code 内置 Node.js 调试的更多信息。
- 调试秘籍 - 适用于客户端和容器调试等场景的示例。
- 任务 - 使用 Gulp、Grunt 和 Jake 运行任务。显示错误和警告。