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 语言服务评估内容。有关 JavaScript 支持的更多信息,请参阅 VS Code 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
文件,其中包含一个 start
脚本来运行 node ./bin/www
。这将启动正在运行的 Node.js 应用程序。
从 Express 应用程序文件夹中的终端,运行
npm start
Node.js Web 服务器将启动,您可以浏览到 https://127.0.0.1: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 类型声明(类型定义)文件(例如 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
文件。通过确保 configurations
中的 type
属性设置为 "node"
,来选择 Node.js 环境。首次创建文件时,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 运行任务。显示错误和警告。