Node.js v12.13.1 文档


debugger(调试器)#

中英对照提交修改

稳定性: 2 - 稳定

Node.js 包括一个进程外的调试实用程序,可通过V8检查器和内置调试客户端访问。 要使用它,请使用 inspect 参数启动 Node.js,然后使用要调试的脚本的路径。 将显示一个提示,表明调试器成功启动:

$ node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/80e7a814-7cd3-49fb-921a-2e02228cd5ba
< For help, see: https://nodejs.org/en/docs/inspector
< Debugger attached.
Break on start in myscript.js:1
> 1 (function (exports, require, module, __filename, __dirname) { global.x = 5;
  2 setTimeout(() => {
  3   console.log('world');
debug>

Node.js 的调试器客户端不是一个功能齐全的调试器,但可以进行简单的步骤和检查。

debugger; 语句插入到脚本的源代码,将在代码中的该位置启用断点:

// myscript.js
global.x = 5;
setTimeout(() => {
  debugger;
  console.log('世界');
}, 1000);
console.log('你好');

运行调试器后,第 3 行将出现断点:

$ node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/80e7a814-7cd3-49fb-921a-2e02228cd5ba
< For help, see: https://nodejs.org/en/docs/inspector
< Debugger attached.
Break on start in myscript.js:1
> 1 (function (exports, require, module, __filename, __dirname) { global.x = 5;
  2 setTimeout(() => {
  3   debugger;
debug> cont
< 你好
break in myscript.js:3
  1 (function (exports, require, module, __filename, __dirname) { global.x = 5;
  2 setTimeout(() => {
> 3   debugger;
  4   console.log('世界');
  5 }, 1000);
debug> next
break in myscript.js:4
  2 setTimeout(() => {
  3   debugger;
> 4   console.log('世界');
  5 }, 1000);
  6 console.log('你好');
debug> repl
Press Ctrl + C to leave debug repl
> x
5
> 2 + 2
4
debug> next
< 世界
break in myscript.js:5
  3   debugger;
  4   console.log('世界');
> 5 }, 1000);
  6 console.log('你好');
  7
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 的第一行设置断点。
  • clearBreakpoint('script.js', 1), cb(...) - 清除 script.js 中第一行的断点。

也可以在尚未加载的文件(模块)中设置断点:

$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/4e3db158-9791-4274-8909-914f7facf3bd
< For help, see: https://nodejs.org/en/docs/inspector
< Debugger attached.
Break on start in main.js:1
> 1 (function (exports, require, module, __filename, __dirname) { 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>

信息#

中英对照提交修改

  • backtrace, bt - 打印当前执行帧的回溯。
  • list(5) - 列出具有 5 行上下文的脚本源代码(前后各 5 行)。
  • watch(expr) - 将表达式添加到监视列表。
  • unwatch(expr) - 从监视列表中移除表达式。
  • watchers - 列出所有监视器及其值(在每个断点上自动列出)。
  • repl - 在调试脚本的上下文中打开调试器的 repl 以进行运行。
  • exec expr - 在调试脚本的上下文中执行表达式。

执行控制#

中英对照提交修改

  • run - 运行脚本(在调试器启动时自动运行)。
  • restart - 重启脚本。
  • kill - 杀死脚本。

杂项#

中英对照提交修改

  • scripts - 列出所有已加载的脚本。
  • version - 显示 V8 的版本。

高级用法#

Node.js的V8检查器集成#

中英对照提交修改

V8 检查器集成允许将 Chrome 开发者工具附加到 Node.js 实例以进行调试和性能分析。 它使用 Chrome开发者工具协议

可以通过在启动 Node.js 应用程序时传入 --inspect 标志来启用 V8 检查器。 也可以提供带有该标志的自定义端口,例如 --inspect=9222 将接受端口 9222 上的开发者工具连接。

要在应用代码的第一行断开,请传入 --inspect-brk 标志而不是 --inspect

$ node --inspect index.js
Debugger listening on 127.0.0.1:9229.
To start debugging, open the following URL in Chrome:
    chrome-devtools://devtools/bundled/js_app.html?experiments=true&v8only=true&ws=127.0.0.1:9229/dc9010dd-f8b8-4ac5-a510-c1a114ec7d29

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

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