開始學nodejs —— 調試篇


新學習一種技術,肯定會遇到很多坑,我們需要找到這些坑,弄清楚這些坑出現的原因和其中的原理。這種操作就叫做調試。

程序調試的方法和工具多種多樣,在這里我總結一下我在學習nodejs的過程中,學到的和用到的調試方法。

log

在JavaScript代碼中直接console.log,可以在控制台中打印信息。但是這樣的功能太單調,項目中模塊很多,功能繁雜,如果沒有一個約定好的console.log方法,很容易就導致打印的信息十分雜亂,可讀性很差。

nodejs有一個debug模塊,提供:

定義log模塊,選擇特定模塊log輸出

模塊文字顏色高亮

log時間記錄

輸出log到文件等功能

首先

npm init、npm install debug --save  新建一個nodejs項目並安裝debug模塊

然后新建

app.js

var debug=require("debug")("mydebug:http"),
    work=require("./work"),
    http=require("http");
http.createServer(function(req,res){
    debug(req.method + ' ' + req.url);
    res.end('hello\n');
}).listen(3000,function(){
    debug("listening");
});

work.js

var debug=require("debug")("mydebug:work");
setInterval(function(){
    debug("doing some work @ %s —— %s",new Date().getTime(),"with supervisor");
},2000);

上面兩個文件中分別創建了 mydebug:http  和 mydebug:work 兩個log模塊,在啟動項目的時候可以配置要打印的log模塊,這個配置是支持通配符匹配的

 在linux中啟動:

DEBUG=mydebug:* node app.js

在windows中啟動

set DEBUG=mydebug:* & node app.js

 

這樣就可以看到不同模塊的日志打印了,同時也可以看到日志輸出時間。

在瀏覽器中訪問 localhost:3000 也可以看到打印出的訪問信息

此外debug模塊還提供把日志輸出到文件的功能

set DEBUG=mydebug:*  &  node app.js mydebug:work> debug.log

nodejs debug模塊文檔:https://github.com/visionmedia/debug

debug

光有log還不夠,當程序出現問題時通過log可以定位到錯誤位置,但是當我們想查看錯誤現場的變量時,log就無能為力了,一般情況下我們不會把所有的變量都打印出來。此時就需要斷點的功能了,在程序里邊打上斷點,直接定位到錯誤位置,分析錯誤現場確認錯誤原因。

nodejs內部提供一個debug機制,可以讓程序進入debug模式,供開發者一步一步分析代碼發現問題。

共有3中啟動參數可以讓程序進入debug模式

node debug app.js
node --debug app.js
node --debug-brk app.js

3種模式在調試形式上有一定區別。

node debug app.js

1.這種方式啟動程序,程序會進入debug模式,並運行到啟動文件的第1行就停止,等待開發者下發往下走的命令

2.這種方式啟動程序,直接在當前cmd中進入調試模式

node --debug app.js

1.這種方式啟動程序,程序會進入debug模式,並運行完所有代碼。這種啟動方式往往用於程序啟動的過程中不需要調試,通過觸發時間進入回調函數的情況,比如在某個http請求中打上斷點,等待客戶端訪問后進入斷點

2.這種方式啟動程序,會開啟一個TCP的端口監聽,在本cmd中不進入調試模式,需要另外開啟終端用node debug 命令連接調試端口

  命令為 node debug localhost debug端口

  或者   node debug p node進程id

node --debug-brk app.js

1.這種方式啟動程序,程序會進入debug模式,但是不會運行代碼,直到有一個終端連接到了debug端口,才開始執行代碼,並在第1行進入斷點

2.這種方式啟動程序,會開啟一個TCP的端口監聽,在本cmd中不進入調試模式,需要另外開啟終端用node debug 命令連接調試端口

進入debug模式后,可以通過一些命令來設置斷點、取消斷點以及控制程序執行流程

命令文檔:https://nodejs.org/api/debugger.html#debugger_commands_reference

  流程控制相關

  • contc - Continue execution
  • nextn - Step next
  • steps - Step in
  • outo - Step out
  • pause - Pause running code (like pause button in Developer Tools)

    斷點設置取消相關

  • setBreakpoint()sb() - Set breakpoint on current line
  • setBreakpoint(line)sb(line) - Set breakpoint on specific line
  • setBreakpoint('fn()')sb(...) - Set breakpoint on a first statement in functions body
  • setBreakpoint('script.js', 1)sb(...) - Set breakpoint on first line of script.js
  • clearBreakpoint('script.js', 1)cb(...) - Clear breakpoint in script.js on line 1

    變量查看相關

  • backtracebt - Print backtrace of current execution frame
  • list(5) - List scripts source code with 5 line context (5 lines before and after)
  • watch(expr) - Add expression to watch list
  • unwatch(expr) - Remove expression from watch list
  • watchers - List all watchers and their values (automatically listed on each breakpoint)
  • repl - Open debugger's repl for evaluation in debugging script's context

  repl模式下可以輸入變量名查看變量內容

node debug

 從第一行代碼開始進入斷點,命令n進入下一行

node --debug

cmd1  開啟調試端口

cmd2   連接調試端口

設置斷點,取消斷點

cmd1 過了一分鍾才繼續打印

用進程id的方式連接調試模塊

  上圖可以看到pid為4436

repl模式

調試相關的工具和模塊

上面的調試過程還是略顯麻煩,有一些工具和node模塊可以用來輔助調試。

supervisor

supervisor是一個node模塊,用來啟動node項目。

supervisor可以監控一些文件,當這些文件發生變化時自動刷新程序,不用重新啟動node程序。

當程序崩潰時,supervisor會重新啟動程序。
還有其他的一些配置,可以在supervisor文檔中看到  https://github.com/petruisfan/node-supervisor/
安裝supervisor
npm install -g supervisor

監控work.js的變化並啟動node程序

把work中的debug信息修改一下

在任務管理器中結束app.js的node進程,可以看到supervisor自動重啟了app.js的進程

webstorm

webstorm提供了比較方便的debug工具

在菜單中  run-debug-app.js

可以直接在行號的地方點擊,打上斷點

瀏覽器訪問 localhost:3000,進入斷點

可以看到webstorm提供的一些調試工具

實際上webstorm的調試功能也是基於 --debug-brk來實現的,使用了63797端口來調試

node-inspector

如果不喜歡webstorm的調試工具,還可以使用我們熟悉的chrome調試工具來調試node代碼,不過需要安裝一個node模塊——node-inspector

npm install -g node-inspector

安裝完成后,開啟一個node調試端口 12345

然后新開一個cmd,開始一個node-inspector調試服務,連接到剛剛開啟的調試端口

根據提示訪問地址,即可使用我們比較熟悉的chrome的調試工具來調試nodejs代碼

 

 

 

調試的技巧有很多,很多細節問題都需要不同的調試技巧來實現,以后用到新的了再補充吧~

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM