Nodejs调试的各种姿势

2019-09-04

JiangRen Mr

Node.js 调试的手段

下文中涉及到的依赖库及软件版本
  • Node.js - v10.15.3
  • Chrome - v72.0.3626
  • VS Code - v1.13.0
以下代码段为例,用koa起一个简单的http server
const Koa = require('koa');
const app = new Koa();

app.use(async ctx => {
    const time = new Date();
    ctx.body = `hello, hiker! ${time}`;
});

app.listen(3000, () => {
    console.log('nodejs listening 3000.');
});

1. console.log()

对前端人员非常友好,与浏览器中调试一样,console.log()console.error()console.time()等各种console形式,在代码中需要调试的地方直接写上,只是展示形式有所不同,在Node.js中是在终端命令行中打印。这是最简单快速的调试手段,缺点也很明显,对原有代码入侵较大,在特定场景中使用较局限。

举例

app.use(async ctx => {
    const time = new Date();

    console.time('TIME_TAKE');
    console.log('this is time', time);

    ctx.body = `hello, hiker! ${time}`;
    console.timeEnd('TIME_TAKE');
});

app.listen(3000, () => {
    console.log('nodejs listening 3000.');
});

结果

终端起服务:node index.js,并浏览器访问localhost:3000, 即可在终端命令行中看到相应打印的日志。

2. Debugger Protocol (node-inspector)

Nodejs v6.3+ 的版本提供了两个用于调试的协议:v8 Debugger Protocol 和 v8 Inspector Protocol 可以使用第三方的 Client/IDE 等监测和介入 Node(v8) 运行过程,进行调试。

node-inspector是早期可以基于Chrome,有可视化调试界面的调试工具,用的是v8 Debugger Protocol协议,通过 TCP 端口与 Client/IDE 交互通信。但由于v8 Inspector Protocol的推出,这个工具逐渐被替代,后文会介绍相应替代方案。

使用方式

$ npm install -g node-inspector

通过浏览器连接到node-inspector,启动inspector服务:
$ node-inspector

以debug模式运行node.js应用:
$ node --debug=5858 index.js

浏览器打开 http://127.0.0.1:8080/debug?port=5858,后台会提供一个类似于 chrome devtools 的 UI 调试界面。

3. Inspector Protocol + Chrome DevTools

v8 Inspector Protocol 是 nodejs v6.3 新加入的调试协议,通过 websocket与 Client/IDE 交互,同时基于 Chrome/Chromium 浏览器的 devtools 提供了图形化的调试界面。
$ node --inspect=9222 index.js
如果程序执行完会直接结束进程的,那么--inspect会一闪而过,断点信号还没发送出去前就结束了,断点根本不起作用,这种情况可以用--inspect-brk启动调试器,使得脚本可以代码执行之前break

结果

ws://127.0.0.1:9222/a45dc332-2c8c-4614-bf01-1dbf212ae28a这个不是提供给我们在Chrome浏览器中访问的地址,而是Node.js和Chrome之间进行通信的的地址,通过websocket进行通信,从而将调试结果实时展示在Chrome浏览器中。

那么如何获取在chrome浏览器中的调试地址?我们可以访问http://localhost:9222/json/list,可以看到相应信息。其中id为UUID,是一个特定的标识,每一个进程都会分配一个uuid,因此每一次调用会有出现不同的结果。devtoolsFrontendUrl则为我们要访问的chrome地址,新窗口打开这个地址即可调试。

更便捷的调试入口

上述步骤是不是有点麻烦,不要紧,强大的Chrome提供了更方便的调试入口。

node --inspect=9222 index.js起服务后,打开浏览器访问http监听端口页面,并打开调试窗口,可以看到一个绿色的按钮,点开即可下断点调试,是不是很方便?

这个绿油油的按钮究竟打开了什么呢?我们可以继续看。访问chrome://inspect/#devices,可以看到当前浏览器监听的所有inspect

到这里,我们就可以利用Chrome DevTools的各类功能,Sources Panel查看脚本、Profile Panel监测性能等,文中不具体展开。

4. Inspector Protocol + VS Code

对服务端开发来讲,浏览器的使用反而不那么频繁,因此在IDE中调试Nodejs显得格外重要。值得高兴的是,市面上各类IDE对Nodejs的调试还算友好,尤其是VS Code。它内置了Node debugger,支持v8 Debugger Protocolv8 Inspector Protocol两种协议。

launch

在VS Code中,打开调试/添加配置/,如下图,添加launch配置,点击开始调试即可。

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "Launch Program",
            "program": "${workspaceFolder}\\index.js"
        }
    ]
}

下图展示了调试窗口,可以看到,我们可以直接在IDE中下断点,左侧小窗口中可以看到当前作用域的变量(可展开树),调用堆栈,所有断点等,右上方亦可逐步调试函数、重启等功能,非常强大。

Auto Attach

同样VS Code提供了自动附加的功能:Auto Attach。不用配置即可快速调试。

Ctrl+Shift+p打开Auto Attach功能,然后同样的方式在终端命令行中:node --inspect=9222 .\index.js

最后

本文总结了Nodejs的调试方法,基本涵盖了所有的调试手段,包括了命令行调试,Chrome浏览器调试,VS Code编辑器调试,并深入部分调试协议,图文结合,可供其他的Nodejs开发者参考,降低开发人员的学习成本,在项目工程应用中,准确定位问题,提高开发效率。

 

本文章转载自SegmentFault。

近期开课hot
logo

Follow Us

linkedinfacebooktwitterinstagramweiboyoutubebilibilitiktokxigua

We Accept

/image/layout/pay-paypal.png/image/layout/pay-visa.png/image/layout/pay-master-card.png/image/layout/pay-stripe.png/image/layout/pay-alipay.png

地址

Level 10b, 144 Edward Street, Brisbane CBD(Headquarter)
Level 8, 11 York st, Wynyard, Sydney CBD
Business Hub, 155 Waymouth St, Adelaide SA 5000

Disclaimer

footer-disclaimerfooter-disclaimer

JR Academy acknowledges Traditional Owners of Country throughout Australia and recognises the continuing connection to lands, waters and communities. We pay our respect to Aboriginal and Torres Strait Islander cultures; and to Elders past and present. Aboriginal and Torres Strait Islander peoples should be aware that this website may contain images or names of people who have since passed away.

匠人学院网站上的所有内容,包括课程材料、徽标和匠人学院网站上提供的信息,均受澳大利亚政府知识产权法的保护。严禁未经授权使用、销售、分发、复制或修改。违规行为可能会导致法律诉讼。通过访问我们的网站,您同意尊重我们的知识产权。 JR Academy Pty Ltd 保留所有权利,包括专利、商标和版权。任何侵权行为都将受到法律追究。查看用户协议

© 2017-2024 JR Academy Pty Ltd. All rights reserved.

ABN 26621887572