如何调试nodejs程序?下面本篇文章给大家介绍一下nodejs调试debug的方法,希望对大家有所帮助!
对于开发者来说,在开发应用程序的过程中,往往为了开发方便和解决bug需要借助于编程语言的调试功能。一般来说我们需要借助于强大ide的调试功能来完成这项工作。nodejs也不例外。
今天我们来详细介绍一下如何调试node程序。
开启nodejs的调试还记得之前我们讲到的koa程序吗?本文将会以一个简单的koa服务端程序为例,来展开nodejs的调试。
先看下一个简单的koa服务app.js:
const koa = require('koa');const app = module.exports = new koa();app.use(async function(ctx) { ctx.body = 'hello world';});if (!module.parent) app.listen(3000);
上面的程序开启了3000端口,建立了一个http服务。每次请求的时候,都会返回hello world,非常的简单。
要想运行上面的程序,我们需要执行node app.js。 这会执行app.js但是并不会开启调试功能。
怎么进行调试呢?
我们需要加上 --inspect 参数:
node --inspect app.js
上面的代码将会开启nodejs的调试功能。
我们看下输出结果:
debugger listening on ws://127.0.0.1:9229/88c23ae3-9081-41cd-98b0-d0f7ebceab5afor help, see: https://nodejs.org/en/docs/inspector
结果告诉了我们两件事情,第一件事情就是debugger监听的端口。默认情况下将会开启127.0.0.1的9229端口。并且分配了一个唯一的uuid以供区分。
第二件事情就是告诉我们nodejs使用的调试器是inspector。
inspector是nodejs 8之后引入的,如果是在nodejs 7之前,那么使用的是legacy debugger。
调试的安全性如果debugger连接到了nodejs运行环境中,如果有恶意攻击者的话,这个恶意攻击者可以在nodejs环境中运行任意代码。这会给我们的程序带来很大的安全隐患。
所以我们一定要注意调试的安全性。一般来说,我们不建议进行远程调试。
默认情况下 --inspect 绑定的是127.0.0.1,这样就只允许本地程序访问。并且任何本地运行的程序都有权限进行该程序的调试。
如果我们真的想将debug程序暴露给外部程序的话,那么可以指明本机的外网ip地址或者0.0.0.0(表示任何地址,无限制),这样远程机子就可以进行远程调试了。
如果我们想进行安全的remote debug该怎么处理呢?
首先,我们要开启本地的debug:
node --inspect app.js
然后我们可以搭建一个ssh隧道,将本地的9221端口映射到远程服务器的9229端口:
ssh -l 9221:localhost:9229 user@remote.example.com
这样我们就可以通过连接本地的9221端口,进行远程调试了。
使用webstorm进行nodejs调试jetbrains出品的webstorm可谓是开发nodejs的利器,webstorm自带有debug选项,如果开启该选项,则会在后台开启 --inspect:
使用webstorm来进行调试和使用idea来进行java程序调试类似,这里就不多介绍了。
使用chrome devtools进行调试使用chrome devtools进行调试的前提是我们已经开启了 --inspect模式。
在chrome中输入chrome://inspect:
我们可看到chrome inspect的界面,如果你本地已经有开启inspect的nodejs程序的话,在remote target中就可以直接看到。
选中你要调试的target,点击inspect,即可开启chrome devtools调试工具:
你可以对程序进行profile,也可以进行调试。
这里我们关注的是调试,所以转到source一栏,添加你要调试的程序的源代码:
加入断点即可开始调试了。和在chrome中调试web端的js是一样的。
使用node-inspect来进行调试其实nodejs有一个自带的调试工具,叫做node-inspect,这是一个cli的调试工具。我们看一下怎么使用。
我们直接使用:
node inspect app.js< debugger listening on ws://127.0.0.1:9229/f1c64736-47a1-42c9-9e9e-f2665073d3eb< for help, see: https://nodejs.org/en/docs/inspector< debugger attached.break on start in app.js:1> 1 const koa = require('koa'); 2 const app = module.exports = new koa(); 3 debug>
node inspect 做了两件事情,第一件事情就是生成子程序去运行node --inspect app.js,第二件事情就是在主程序中运行cli调试窗口。
这个cli调试程序为我们提供了一些非常有用的命令:
1、stepping
cont, c: 继续执行next, n: step到下一步step, s: step inout, o: step outpause: 暂停运行的代码2、breakpoints
setbreakpoint(), sb(): 在当前行设置断点setbreakpoint(line), sb(line): 在指定的行设置断点setbreakpoint(‘fn()’), sb(…): 在指定的function中设置断点setbreakpoint(‘script.js’, 1), sb(…): 在指定的脚本文件中设置断点clearbreakpoint(‘script.js’, 1), cb(…): 从文件中清除断点3、information
backtrace, bt: 打印当前execution frame的backtrace信息list(5): 列出源代码前后的5行watch(expr): 添加监听表达式unwatch(expr): 删除监听表达式watchers: 列出所有的watchersrepl: 打开repl表达式exec expr: 执行表达式通过上面的命令,我们可以在cli中进行比较复杂的调试活动。
其他的debug客户端除了上面我们讲到的几个之外,我们还可以使用vscode,visual studio ,eclipse ide 等来进行nodejs的调试,这里就不一一详细介绍了。
感兴趣的朋友可以自行探索。
更多node相关知识,请访问:nodejs 教程!!
以上就是如何开启nodejs调试?如何调试nodejs程序?的详细内容。