目录
本指南将帮助你开始学习调试 Node.js 程序和脚本。
启用检查器
当使用 --inspect
开关符启动检查器时,一个 Node.js 进程开始侦听调试客户端。默认情况下侦听 127.0.0.1:9229 的域名和端口号;每个进程都有一个唯一的 UUID 标示符。
检查器的客户端必须知晓并制定连接的域名地址、端口号以及 UUID。一个完整的 URL 看上去如:ws://127.0.0.1:9229/0f2c936f-b1cd-4ac9-aab3-f63b0f33d55e
。
要想启动调试器,我们需要在启动 Node.js 应用程序时传入 --inspect 标志,也可以使用该标志提供自定义的端口,例如 --inspect=9222
将会在 9222 端口上接受开发者工具的连接。
监视器客户端
一些商业和开源工具可以连接到 Node 的监视器上,关于它们基本信息如下:
server.js
const http = require('http')
const server = http.createServer((request, response) => {
debugger
console.log(request);
console.log(response);
})
server.listen(8080, () => {
console.log('localhost:8080');
})
1. Node 监视器
- 由 Node.js 基础库,使用检查器协议支持的 CLI 调试器。
- 和 Node 绑定在一起的版本,并且可以使用
node inspect server.js
。 - 最新的版本同样可以单独通过(例如
npm install -g node-inspect
)方式安装,并使用node-inspect server.js
的方式即可实现调试代码。
操作如下
-
npm install -g node-inspect
-
node-inspect server.js
-
浏览器访问启动的服务
http://localhost:8080/
,打开控制台,可以看到Node.js开发者工具
点击打开Node.js开发者工具即可进行代码调试了,如下:
2. Chrome 开发工具 55+
- 选项 1: 在基于 Chromium 内核的浏览器下打开
chrome://inspect
。点击配置按钮确保你的目标宿主和端口号列入其中。 - 选项 2: 从
/json/list
中拷贝devtoolsFrontendUrl
(见上),或者加上--inspect
以检查提示文本并粘贴到 Chrome 中。
请注意:Node.js 和 Chrome 必须在同一个平台上运行。
执行命令
node --inspect server.js
浏览器访问启动的服务 http://localhost:8080/,打开控制台,可以看到Node.js开发者工具
点击打开Node.js开发者工具即可进行代码调试了,如下:
可以访问 chrome://inspect 点击配置按钮确保你的目标宿主和端口号列入其中。
3.1 Visual Studio Code 1.10+
- 在 Debug 面板中,点击设置按钮打开
.vscode/launch.json
,选择 “Node.js” 进行初始化构建。
3.2 Visual Studio 2017+
- 从菜单中或者单击 F5, “Debug > Start Debugging”。
- 详细指导
浏览器访问启动的服务 http://localhost:8080/,会自动打开 vscode进入调试模式,如下:
4. JetBrains WebStorm 2017.1+ 以及其它版本
- 创建一个新的 Node.js 调试配置,点击调试。在 Node.js 7 版本上默认会加上
--inspect
开关。禁用 uncheckjs.debugger.node.use.inspect
IDE 注册表。
使用 WebStorm
的调试模式,点击左侧打断点
浏览器访问启动的服务 http://localhost:8080/,会自动打开 webstorm 进入调试模式,如下:
命令行选项
以下命令表列出了在调试状态下不同标示符的影响:
标示符 | 含义 |
---|---|
–inspect | 启用监视器代理在默认地址和端口上监听(127.0.0.1:9229) |
–inspect=[host:port] | 启用监视器代理绑定地址或主机名宿主 (默认:127.0.0.1)监听端口 (默认:9229) |
–inspect-brk | 启用监视器代理监听默认地址和端口(127.0.0.1:9229)在用户代码启动前终止 |
–inspect-brk=[host:port] | 启用监视器代理绑定地址和主机名宿主(默认:127.0.0.1)监听端口(默认:9229)在用户代码启动前终止 |
Node 监视*script.js* | 通过 --inspect 标志生成一个新的子进程,使用主进程运行 CLI 调试器。 |
node inspect --port=xxxx *script.js* | 通过 --inspect 标志生成一个新的子进程,使用主进程运行 CLI 调试器。监听端口(默认:9229) |
参阅:Node.js 调试指南
服务热更新
安装
npm install -g nodemon
# 或
npm install --save-dev nodemon
使用
nodemon server.js