调试器| Node.js v18.18.2 文档

调试器#

Node.js 包含一个命令行调试实用程序。Node.js 调试器客户端不是功能齐全的调试器，但可以进行简单的单步执行和检查。

要使用它，请使用inspect参数启动 Node.js，后跟要调试的脚本的路径。

$ node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/621111f9-ffcb-4e82-b718-48a145fa5db8
< For help, see: https://nodejs.org/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
<
 ok
Break on start in myscript.js:2
  1 // myscript.js
> 2 global.x = 5;
  3 setTimeout(() => {
  4   debugger;
debug>

调试器会自动在第一个可执行行处中断。要改为运行直到第一个断点（由debugger语句指定），请将NODE_INSPECT_RESUME_ON_START环境变量设置为1。

$ cat myscript.js
// myscript.js
global.x = 5;
setTimeout(() => {
  debugger;
  console.log('world');
}, 1000);
console.log('hello');
$ NODE_INSPECT_RESUME_ON_START=1 node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/f1ed133e-7876-495b-83ae-c32c6fc319c2
< For help, see: https://nodejs.org/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
<
< hello
<
break in myscript.js:4
  2 global.x = 5;
  3 setTimeout(() => {
> 4   debugger;
  5   console.log('world');
  6 }, 1000);
debug> next
break in myscript.js:5
  3 setTimeout(() => {
  4   debugger;
> 5   console.log('world');
  6 }, 1000);
  7 console.log('hello');
debug> repl
Press Ctrl+C to leave debug repl
> x
5
> 2 + 2
4
debug> next
< world
<
break in myscript.js:6
  4   debugger;
  5   console.log('world');
> 6 }, 1000);
  7 console.log('hello');
  8
debug> .exit
$

repl命令允许远程评估代码。next命令进入下一行。输入help查看其他可用命令。

按enter而不输入命令将重复之前的调试器命令。

观察者#

可以在调试时观察表达式和变量值。在每个断点上，观察者列表中的每个表达式都将在当前上下文中进行计算，并立即显示在断点的源代码列表之前。

要开始观看表达式，请输入watch('my_expression')。命令 watchers将打印事件观察者。要删除观察者，请输入 unwatch('my_expression')。

命令参考#

单步#

cont , c : 继续执行
next , n：下一步
step、s：介入
out、o：走出去
pause：暂停正在运行的代码（如开发者工具中的暂停按钮）

断点#

setBreakpoint() , sb() : 在当前行设置断点
setBreakpoint(line) , sb(line) : 在特定行设置断点
setBreakpoint('fn()')、sb(...)：在函数体中的第一个语句上设置断点
setBreakpoint('script.js', 1)、sb(...)：在 script.js的第一行设置断点
setBreakpoint('script.js', 1, 'num < 4')、sb(...) ：在script.js的第一行设置条件断点，仅当num < 4 计算结果为true时中断
clearBreakpoint('script.js', 1)、cb(...)：清除第 1 行script.js中的断点

还可以在尚未加载的文件（模块）中设置断点：

$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/48a5b28a-550c-471b-b5e1-d13dd7165df9
< For help, see: https://nodejs.org/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
<
Break on start in main.js:1
> 1 const mod = require('./mod.js');
  2 mod.hello();
  3 mod.hello();
debug> setBreakpoint('mod.js', 22)
Warning: script 'mod.js' was not loaded yet.
debug> c
break in mod.js:22
 20 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 21
>22 exports.hello = function() {
 23   return 'hello from module';
 24 };
debug>

还可以设置一个条件断点，仅在给定表达式的计算结果为true时中断：

$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/ce24daa8-3816-44d4-b8ab-8273c8a66d35
< For help, see: https://nodejs.org/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
Break on start in main.js:7
  5 }
  6
> 7 addOne(10);
  8 addOne(-1);
  9
debug> setBreakpoint('main.js', 4, 'num < 0')
  1 'use strict';
  2
  3 function addOne(num) {
> 4   return num + 1;
  5 }
  6
  7 addOne(10);
  8 addOne(-1);
  9
debug> cont
break in main.js:4
  2
  3 function addOne(num) {
> 4   return num + 1;
  5 }
  6
debug> exec('num')
-1
debug>

信息#

backtrace , bt : 打印当前执行帧的回溯
list(5)：列出具有 5 行上下文的脚本源代码（前后各 5 行）
watch(expr)：将表达式添加到监视列表
unwatch(expr)：从监视列表中删除表达式
unwatch(index)：从监视列表中删除特定索引处的表达式
watchers：列出所有观察者及其值（在每个断点上自动列出）
repl：打开调试器的 repl 以在调试脚本的上下文中进行评估
exec expr、p expr：在调试脚本的上下文中执行表达式并打印其值
profile：启动 CPU 分析会话
profileEnd：停止当前的 CPU 分析会话
profiles：列出所有已完成的 CPU 分析会话
profiles[n].save(filepath = 'node.cpuprofile')：将 CPU 分析会话以 JSON 格式保存到磁盘
takeHeapSnapshot(filepath = 'node.heapsnapshot')：拍摄堆快照并以 JSON 格式保存到磁盘

执行控制#

run：运行脚本（在调试器启动时自动运行）
restart：重新启动脚本
kill：终止脚本

各种各样的#

scripts：列出所有加载的脚本
version：显示 V8 的版本

高级用法#

Node.js 的 V8 检查器集成#

V8 Inspector 集成允许将 Chrome DevTools 附加到 Node.js 实例以进行调试和分析。它使用 Chrome DevTools 协议。

可以通过在启动 Node.js 应用程序时传递--inspect标志来启用 V8 Inspector。还可以提供带有该标志的自定义端口，例如--inspect=9222将接受端口 9222 上的 DevTools 连接。

要在应用程序代码的第一行中断，请传递--inspect-brk 标志而不是--inspect。

$ node --inspect index.js
Debugger listening on ws://127.0.0.1:9229/dc9010dd-f8b8-4ac5-a510-c1a114ec7d29
For help, see: https://nodejs.org/en/docs/inspector

（在上面的示例中，URL 末尾的 UUID dc9010dd-f8b8-4ac5-a510-c1a114ec7d29 是动态生成的，它在不同的调试会话中有所不同。）

如果 Chrome 浏览器版本低于 66.0.3345.0，请在上述网址中使用inspector.html而不是js_app.html 。

Chrome DevTools 尚不支持调试工作线程。 ndb可用于调试它们。