Node.js调试大法 — v8_inspector

Node.js 调试基本原理

Node.js 提供了强大的Debugger模块,使用方式如下:

使用debug模式时,Node.js 会启动Debugger模块,然后通过监听默认 5858 端口将命令行的输入传送到内建调试模块以达到调试的目的。

同时支持--debug 和 --debug-brk参数。这两个参数只会启动Debugger监听模式,不会进入命令行调试模式,而且前者会运行完所有代码,通常可用于事件调试,后者会在进入时中断,方便从头开始调试。
进入Debugger监听模式后,可以通过这两种方式连接调试:

node debug <URI> # 通过 URI 连接调试,如 node debug localhost:5858
node debug -p <pid> # 通过 PID 链接调试

命令行调试几乎支持所有调试的功能:断点、单步、步入、步出、变量查看等等。详细说明可参见官方文档

所以无论是IDE 调试工具还是node-inspector都是基于Node.js的Debugger模块进行调试的。

Chrome DevTools与Node.js Debugger结合

Node.js命令行调试因为缺少调试界面,因此使用的人相对比较少。于是就诞生了node-inspector。 它所做的就是让用户可以使用DevTools UI去使用原生的Debugger,使用起来也比较方便

  1. 安装node-inspector
    npm install -g node-inspector
  2. 开启node-inspector服务
    node-inspector
    # node-inspector & ### Running in background
  3. debug 模式启动程序
    node --debug test.js
    # node --debug-brk test.js # Pause your script on the first line
    然后就可以直接用浏览器打开http://127.0.0.1:8080/?port=5858进行调试了。

Node.js原生Debugger模块使用的是V8-Debug Protcol,而且DevTools使用Chrome Debugging Protcol。所以node-inspector在其中起到了翻译和转达的作用。

v8_inspector 诞生

今年5月份,谷歌工程师 ofrobots 提交了一个Add v8_inspector support的PR。同时在5月份的 DevTools Google I/O talk 有提到此功能。

就是说 v8_inspector 可以让 DevTools 直接连接 Node.jsDebugger进行调试。

现如今,新版本的Chrome浏览器和新版本的Node.js支持通过一个新的调试协议能互相直接通讯了,就不再需要node-inspector了。

安装新版本

  1. Node.js 6.3+
    可以从官网安装,目前给官网给到的最新版本是v6.7.0
  2. Chrome 55+
    最新版本的 Chrome 叫 Canary,安装这个版本时不用担心会覆盖老版本的Chrome,会生成另外一个图标。

启用inspect调试模式

  1. 下载好Chrome Canary后,打开chrome://flags/#enable-devtools-experiments
  2. 启用开发者工具实验性功能
  3. 重启Chrome
  4. 打开开发者工具 -> 设置 -> Experiments,按SHIFT键6次,显示隐藏选项后勾选Node debugging

    使用inspect调试
    使用--inspect参数就可以使用最新的调试功能:

Canary中打开链接即可调试。

使用中的问题

在用v6.7.0测试时发现一直在报错Assertion '(inspector->http_parsing_state) == (nullptr)' failed.

发现很多人有出现过这个问题,参见这里
这是一个已经修复的bug,但是v6.7.0中没有包含,解决方案就是安装v7.x版本,两种安装方式:

  1. 下载源码安装
# Install windows-build-tools
npm install --global --production windows-build-tools

# Download source code
git clone https://github.com/nodejs/node.git
cd node
git checkout remotes/origin/v7.x

# Build
# vcbuild nosign x64 # 64-bit build on windows
vcbuild nosign
  1. 下载 v7.0.0-nightly 安装包安装

使用新版本彻底解决了这个问题。

相关文章
相关标签/搜索