使用 ndb 调试你的 Node.js 项目

代码调试按照调试方式大体分为 日志（Log） 和 断点（Breakpoint） 两种办法。其中日志就是手动的在代码中增长日志打印获取过程信息来判断问题。这种方法的好处是调试简单，一个对业务熟练的工程师经过线上良好的日志记录能够很是快的发现业务问题。可是它的缺点也很是明显，获取的内容比较单一，动态调试须要不断的在业务中增长日志打印代码。

因而乎断点调试出现了。断点调试相似于中医的望闻问切，咱们经过在须要观察的点打上断点就能详细的获取到程序运行到该点时的全部上下文，并利用单步调试逐一观察程序运行情况，准确判断出问题的地方。另外利用 Chrome DevTool 咱们也能够随时对线上业务进行调试，能够说是很是方便了。

V8 Inspector

在前端使用 Chrome DevTool 进行断点调试已是很是成熟了，在 Node.js（6.3+） 中也自带了一个相似的调试器，主要是在 Node 内部实现了一套 v8 调试器通讯协议。启动的时候添加 --inspect 参数，咱们就能获得 Chrome DevTools 调试界面了，剩下的调试过程就和正常的 Chrome 调试是同样了。

使用 --inspect 调试极大的方便了 Node.js 开发，让服务端调试也有了相似前端调试同样的体验。除了直接打开 DevTools 调试，VSCode, WebStorm 等开发工具也将其集成到了编辑器中，不过内部的原理是相似的。不过人无完人，在使用过程当中 Node Inspector 调试也存在着一些缺点：

• 须要在 node 命令后增长 --inspect 参数，对于一些第三方命令启动没法直接支持调试，例如 webpack, ava, mocha...
• 多进程调试很是的麻烦，特别是子进程频繁的销毁的时候，须要外部手动的监听进程的建立并手工将进程和调试工具进行通讯对接

注： 虽然 VSCode 使用的是 Inspector Protocol 模式，不过在 1.22 的版本中已经可以自动绑定多进程监听端口了，具体的话能够查看天猪大大的《VSCode 调试 Egg 完美版》。

ndb

两周前 Chrome 实验室开源了一款新的调试工具，也就是咱们今天的主角 —— ndb。它提供了更良好的调试体验，正如官方仓库所说，它为咱们带来了以下一些特性：

1. 子进程自动检测和调试接入
2. 支持在模块加载前进行断电
3. 支持在调试工具中直接编辑文件，保存后自动更新到本地文件
4. 默认状况下，ndb 会对引用的全部项目文件夹外的脚本开启黑盒模式让咱们能更专一业务代码。项目文件夹外的脚本包括 Node.js 自带的模块文件（例如 _stream_wrap.js, async_hooks.js, fs.js 等）。固然你能够在设置中修改“Blackbox anything outside working dir”配置来关闭这个功能。

安装

npm install -g ndb
复制代码

首先要确保你的 Node.js 环境 >= 8.0.0，而后使用 npm install 就能够很是方便的完成安装。因为 ndb 依赖 Puppeteer 安装过程当中会去下载 Chromium 因此下载过程可能会有必定的时间，请各位同窗耐心等待。若是有碰上权限问题官方提示能够尝试增长 --unsafe-perm=true --allow-root 参数解决。

使用

不一样于 node --inspect 的复杂使用，ndb 的使用方式很是的简单。在全部你想要进行调试脚本执行前加入 ndb 命令便可，甚至还能直接使用 ndb 命令启动脚本。如下是从仓库示例中引用的一些启动方式：

ndb node server.js

ndb npm run test

ndb mocha

ndb .
复制代码

和 --inspect 同样，执行命令后就会弹出 Chrome DevTools 调试界面。在这个特制的调试界面中，你能够：

• 断点调试，异步方法单步调试
• 控制台预执行显示(须要 Node.js >= 10）
• JS 样本分析
• 内存分析
• 本地终端

使用 ndb 进行 ThinkJS 调试

下面以基于 ThinkJS 开发的 Node.js 项目 Firekylin 为例，简单看看如何使用 ndb 进行断点调试。

（因为掘金目前暂不支持嵌入视频，因此须要你们跳转到腾讯视频中观看。）
v.qq.com/x/page/t074…

能够看到基本上调试的流程很是的简单，而且自动适配了多进程项目（视频中启了8个进程），解决了以前使用 --inspect 的两个问题。另外在底部的控制台因为是 REPL 环境，能够实时获取到断点处当前环境的数据，例如咱们能够打印 process.memoryUsage() 查看当前的内存使用状况。

除了断点调试以外，ndb 也支持内存和性能分析，能够帮助咱们分析内存泄露和。具体的也能够参考一下官方文档《Chrome DevTool 解决内存问题》。

ndb 的问题

仍是那句话人无完人，ndb 目前使用下来仍是以为有一点不太舒服的地方。主要是表如今文件更新方面，目前代码编写仍是在代码编辑器中，调试须要到 ndb 界面上，频繁的切换感受有点不爽。但愿后续 VSCode 能尽快将 ndb 引入替换现有的调试工具就很是方便了。

有同窗会说为何不在 ndb 上直接编辑文件呢，毕竟支持文件编辑保存也是 ndb 做为调试工具的一大特点。这是由于在多进程环境下每一个进程的调试是相互独立的，你在一个进程上的文件修改只能反映在这个修改的进程上，不能在全部进程上生效，和咱们本地操做文件不太同样，使用上须要注意。不过这个也比较好解决，调试的时候只开启一个进程就能够了。

后记

Node.js 已经有愈来愈多的工具能够帮助咱们进行断点调试了，从早期的 Debug Protocol 到前两年开始支持的 V8 Inspector Protocol 到如今的 ndb，咱们看到了技术正在一步步的朝前走着，固然咱们这里须要先感谢下 Chrome 工程师们，感谢他们开发出了这么棒的工具。固然除了断点单步调试以外，日志调试也有它存在的必要，二者能够相辅相成没有孰好孰坏之分。

最后，送一张图给你们祝你们新的一周改BUG顺利~

参考资料：

• 《Supercharge your debugging experience for Node.js》

• 《DevTrends #32: ndb, what's new in Chrome 68》