使用得心應(yīng)手的IDE來(lái)開發(fā)應(yīng)用程序，可以使我們的工作事半功倍。而調(diào)試則更可以讓我們準(zhǔn)確的定位BUG，發(fā)現(xiàn)問題。
本文講述如何使用 WebStorm 這個(gè)怪獸級(jí)JavaScript IDE來(lái)調(diào)試 Chat of Pomelo。
如果你更喜歡 Eclipse 等其他IDE，希望本文也可以有一些幫助。
前言
-
首先我們需要知道，NodeJS應(yīng)用程序可以在運(yùn)行命令中加入--debug=5858參數(shù)，可以使得NodeJS程序監(jiān)聽本地5858端口，并開啟調(diào)試模式。
-
其次，Pomelo的運(yùn)行原理是：pomelo start時(shí)，啟動(dòng)了master服務(wù)器，然后其先讀取配置文件，再啟動(dòng)由game-server/config/servers.json文件中經(jīng)過配置的各個(gè)服務(wù)器進(jìn)程。其中，你看到的id、host、port等等都是子服務(wù)器的啟動(dòng)參數(shù)，這些參數(shù)都會(huì)放到啟動(dòng)命令行中app.js的后面。
-
再次，Pomelo的設(shè)計(jì)人員最初已經(jīng)考慮到了直接在node后app.js前添加參數(shù)的簡(jiǎn)便方法：在服務(wù)器配置文件中，配置條目中插入"args": " 你想要的參數(shù) "后，便可以你指定的參數(shù)運(yùn)行node。
修改配置以啟動(dòng)帶有調(diào)試模式的服務(wù)器
一、打開文件
打開game-server/config/servers.json。為了便于便于開發(fā)，我們將服務(wù)器數(shù)目縮減至每功能1個(gè)運(yùn)行實(shí)例。這樣你就會(huì)看到：
二、修改并保存
我們對(duì)gate服務(wù)器的負(fù)載分配原理產(chǎn)生了興趣，想要調(diào)試它。這時(shí)，我們只需要在{"id": "gate-server-1", ...的行末，花括號(hào)}前，插入下面代碼, "args": " --debug=32312 "。使gate服務(wù)器的配置組變成這樣：
當(dāng)再次啟動(dòng)服務(wù)器時(shí)，master服務(wù)器會(huì)讀取新的配置，并以這個(gè)配置運(yùn)行gate-server-1服務(wù)器。
而該服務(wù)器的進(jìn)程，會(huì)監(jiān)聽32312端口，以便調(diào)試器連接。將端口設(shè)置的偏高是為了減少端口沖突的可能性。開發(fā)過程中，如果啟動(dòng)后發(fā)現(xiàn)有報(bào)ADDRINUSE（端口已被占用）的錯(cuò)誤，請(qǐng)使用pomelo kill --force殺光Pomelo程序，并調(diào)整此處的端口值。
配置IDE的調(diào)試器
一、打開Edit Configurations...對(duì)話框
可以從運(yùn)行、調(diào)試按鈕前面的小三角進(jìn)入，或者從工具欄中選擇Run - Edit Configurations...。
二、新增一條Node.js Remote Debug
Name欄名字可以隨意起，但最好選擇明確易懂的。然后選中Single instance only，這樣只會(huì)啟動(dòng)一個(gè)調(diào)試器。而不會(huì)有很多相同的調(diào)試器都連到后面指定的調(diào)試端口。
下面的Host寫本地127.0.0.1，Debug Port填入剛剛上面指定的端口號(hào)，我這里用32312，與前面配置文件中的完全一致。Local directory指定當(dāng)前的game-server/app.js目錄所在目錄。
附：運(yùn)行配置
當(dāng)然你可能已經(jīng)注意到了，這里的Configurations不僅包含調(diào)試，還包括運(yùn)行配置。運(yùn)行配置方法跟一般的NodeJS程序配置方法相同。NodeJS新人可以參考圖片中配置。注意被框的內(nèi)容。
準(zhǔn)備調(diào)試
一、分別啟動(dòng)Web、Chat服務(wù)器
如果你有做過運(yùn)行Chat和Web服務(wù)器的配置，現(xiàn)在就可以從運(yùn)行、調(diào)試按鈕前面的配置下拉菜單中，分別選擇Chat以及Web后，點(diǎn)擊[►]運(yùn)行按鈕。運(yùn)行后，可以從IDE下方的控制臺(tái)輸出中查看日志輸出，可以檢查一下這兩個(gè)服務(wù)器的啟動(dòng)是否成功。如果出現(xiàn)紅字，多半表示啟動(dòng)失敗。你可以根據(jù)提示的報(bào)錯(cuò)信息Google或者 提交Issue ，以查找解決方案。
二、連接調(diào)試器
再?gòu)呐渲孟吕藛沃羞x擇剛剛的調(diào)試配置gate study，之后點(diǎn)擊[☼]調(diào)試按鈕。檢查窗口下方的Debugger，可以看到有提示說Connected to 127.0.0.1:32312。
三、設(shè)置斷點(diǎn)
由于我們想調(diào)試gate服務(wù)器中，與connector分配相關(guān)的代碼，所以在IDE中，打開app/servers/gate/handler/gateHandler.js。定位到第30行 ，在此處下一個(gè)斷點(diǎn)。
實(shí)踐
瀏覽器中打開 http://127.0.0.1:3001/index.html 會(huì)看到 Chat of Pomelo標(biāo)題的登錄頁(yè)面。填入兩欄表單后，點(diǎn)擊【JOIN】按鈕。
此時(shí)，頁(yè)面將不會(huì)做出任何反應(yīng)，是因?yàn)榉?wù)器端的代碼被斷點(diǎn)攔下了。而IDE會(huì)因?yàn)檎{(diào)試器而被激活：
下方窗口中，除了常規(guī)調(diào)試用到的StepOver、StepInto、StepOut等必須功能外，有很多好用的工具，比如即時(shí)表達(dá)式求值、切換異常發(fā)生時(shí)自動(dòng)中斷……這里就不深入探討了。
可用的聊天應(yīng)用
常識(shí)
Web服務(wù)器啟動(dòng)成功后我們可以看到它提示說可以訪問http://127.0.0.1:3001/index.html了。但我們都知道127.0.0.1是本機(jī)IP地址，如果真正要跟其他人“聊天”的話，這樣是不行的。因?yàn)閯e人不一定能打開127.0.0.1:3001，即便打開了，也無(wú)法跟你在一起聊天。
所以將這里的127.0.0.1換成你自己電腦的可被網(wǎng)絡(luò)上其他成員訪問到的地址，我這里的地址是192.168.1.61。OK，我可以在瀏覽器里打開http://192.168.1.61:3001/index.html，因?yàn)楸緳C(jī)調(diào)試沒有任何問題，所以我也信心滿滿的將這個(gè)地址告訴了與我同一網(wǎng)絡(luò)的同事。
發(fā)現(xiàn)問題
這時(shí)出現(xiàn)了一個(gè)問題，我自己可以登錄到聊天界面，而其他任何人都無(wú)法登錄。
根據(jù)其他人的瀏覽器Console輸出，可以看到他們都連接一下192.168.1.61:3014端口后，又去連接127.0.0.1:3050，所以他們才無(wú)法登錄的。
而3014端口剛好是gate服務(wù)器，問題就出在這里，還是繼續(xù)調(diào)試一下吧。
在經(jīng)過一番斷點(diǎn)切換后，可以發(fā)現(xiàn)gateHandler.queryEntry最后跑到了 第39行 的 next函數(shù)上。
var res = dispatcher.dispatch(uid, connectors);
next(null, {
code: 200,
host: res.host,
port: res.clientPort
});
可以看到，返回內(nèi)容的 host 使用了res.host，res又來(lái)自connectors，connectors來(lái)自配置文件。
而game-server/config/servers.json下connector服務(wù)器的 配置條目 ，可以清楚的看見"host":"127.0.0.1"。
解決問題
源頭找到了，立刻將這里的127.0.0.1全部替換成我本機(jī)192.168.1.61。并且重啟Chat服務(wù)器。
同事再刷新訪問的時(shí)候，便可以登錄進(jìn)來(lái)了。
寫在后面
細(xì)心的人或許發(fā)現(xiàn)，調(diào)試器連接的IP地址，是127.0.0.1，但你或許在想，既然是叫"Remote Deubgger"，應(yīng)該可以連接除127.0.0.1以外的IP吧？ 我也是這么想的。但是，在不借助其他工具的情況下，不能辦到。
就是說，不借助一個(gè)代理工具，是沒辦法連接到除了127.0.0.1地址的調(diào)試端口的。
你可以借助NodeJS官方 Wiki 文章結(jié)尾（Ctrl-F后，搜索"You probably noticed"）的方法及代碼，來(lái)完成一個(gè)代理工具。以便調(diào)試部署在遠(yuǎn)端服務(wù)器上運(yùn)行的代碼。
同時(shí)這篇文章也是 Eclipse 的調(diào)試指導(dǎo)文章。