一探前端開(kāi)發(fā)中的JS調(diào)試技巧
友情提示:文中涉及較多Gif演示動(dòng)畫,移動(dòng)端請(qǐng)盡量在Wifi環(huán)境中閱讀
前言:調(diào)試技巧,在任何一項(xiàng)技術(shù)研發(fā)中都可謂是必不可少的技能。掌握各種調(diào)試技巧,必定能在工作中起到事半功倍的效果。譬如,快速定位問(wèn)題、降低故障概率、幫助分析邏輯錯(cuò)誤等等。而在互聯(lián)網(wǎng)前端開(kāi)發(fā)越來(lái)越重要的今天,如何在前端開(kāi)發(fā)中降低開(kāi)發(fā)成本,提升工作效率,掌握前端開(kāi)發(fā)調(diào)試技巧尤為重要。
本文將一一講解各種前端JS調(diào)試技巧,也許你已經(jīng)熟練掌握,那讓我們一起來(lái)溫習(xí),也許有你沒(méi)見(jiàn)過(guò)的方法,不妨一起來(lái)學(xué)習(xí),也許你尚不知如何調(diào)試,趕緊趁此機(jī)會(huì)填補(bǔ)空白。
骨灰級(jí)調(diào)試大師Alert
那還是互聯(lián)網(wǎng)剛剛起步的時(shí)代,網(wǎng)頁(yè)前端還主要以內(nèi)容展示為主,瀏覽器腳本還只能為頁(yè)面提供非常簡(jiǎn)單的輔助功能的時(shí)候。那個(gè)時(shí)候,網(wǎng)頁(yè)主要運(yùn)行在以IE6為主的瀏覽器中,JS的調(diào)試功能還非常弱,只能通過(guò)內(nèi)置于Window對(duì)象中的alert方法來(lái)調(diào)試,那時(shí)候看起來(lái)應(yīng)該是這個(gè)樣子:
需要說(shuō)明一點(diǎn),這里看到的效果,并非當(dāng)年的IE瀏覽器中看到的效果,而是在高版本IE中的效果。此外,當(dāng)年貌似還沒(méi)有這么高級(jí)的控制臺(tái),而alert的使用也是在真實(shí)的頁(yè)面JS代碼中。雖然,alert的調(diào)試方式很原始,但當(dāng)時(shí)確實(shí)有它不可磨滅的價(jià)值,甚至到今天,已然有其用武之地。
新一代調(diào)試王者Console
隨著JS在Web前端中能做的事情越來(lái)越多,責(zé)任越來(lái)越大,而地位也越來(lái)越重要。傳統(tǒng)的alert調(diào)試方式已經(jīng)漸漸不能滿足前端開(kāi)發(fā)的種種場(chǎng)景。而且alert調(diào)試方式彈出的調(diào)試信息,那個(gè)窗口著實(shí)不太美觀,而且會(huì)遮擋部分頁(yè)面內(nèi)容,著實(shí)有些不太友好。
另一方面,alert的調(diào)試信息,必須在程序邏輯中添加類似”alert(xxxxx)”這樣的語(yǔ)句,才能正常工作,并且alert會(huì)阻礙頁(yè)面的繼續(xù)渲染。這就意味著開(kāi)發(fā)人員調(diào)試完成后,必須手動(dòng)清除這些調(diào)試代碼,實(shí)在有些麻煩。
所以,新一代的瀏覽器Firefox、Chrome,包括IE,都相繼推出了JS調(diào)試控制臺(tái),支持使用類似”console.log(xxxx)”的形式,在控制臺(tái)打印調(diào)試信息,而不直接影響頁(yè)面顯示。以IE為例,它看起來(lái)像這樣:
好吧,再見(jiàn)丑陋的alert彈出框。而以Chrome瀏覽器為首的后起之秀,為Console擴(kuò)展了更豐富的功能:
你以為這樣就滿足了?Chrome開(kāi)發(fā)團(tuán)隊(duì)的想象力實(shí)在不得不讓人佩服:
好了,稍微多說(shuō)了一點(diǎn)點(diǎn)題外話??傊?,控制臺(tái)以及瀏覽器內(nèi)置Console對(duì)象的出現(xiàn),給前端開(kāi)發(fā)調(diào)試帶來(lái)了極大的便利。
有人會(huì)問(wèn),這樣的調(diào)試代碼不一樣需要在調(diào)試完成后進(jìn)行清理嗎?
關(guān)于這個(gè)問(wèn)題,如果在使用console對(duì)象之前先進(jìn)性存在性驗(yàn)證,其實(shí)不刪除也不會(huì)對(duì)業(yè)務(wù)邏輯造成破壞。當(dāng)然,為了代碼整潔,在調(diào)試完成后,還是應(yīng)盡可能刪除這些與業(yè)務(wù)邏輯無(wú)關(guān)的調(diào)試代碼。
JS斷點(diǎn)調(diào)試
斷點(diǎn),調(diào)試器的功能之一,可以讓程序中斷在需要的地方,從而方便其分析。也可以在一次調(diào)試中設(shè)置斷點(diǎn),下一次只需讓程序自動(dòng)運(yùn)行到設(shè)置斷點(diǎn)位置,便可在上次設(shè)置斷點(diǎn)的位置中斷下來(lái),極大的方便了操作,同時(shí)節(jié)省了時(shí)間。——百度百科
JS斷點(diǎn)調(diào)試,即是在瀏覽器開(kāi)發(fā)者工具中為JS代碼添加斷點(diǎn),讓JS執(zhí)行到某一特定位置停住,方便開(kāi)發(fā)者對(duì)該處代碼段的分析與邏輯處理。為了能夠觀察到斷點(diǎn)調(diào)試的效果,我們預(yù)先隨意準(zhǔn)備一段JS代碼:
代碼很簡(jiǎn)單,就是定義一個(gè)函數(shù),傳入兩個(gè)數(shù),分別加上一個(gè)亂七八糟的隨機(jī)整數(shù)后,再返回兩個(gè)數(shù)的總和。以Chrome開(kāi)發(fā)者工具為例,我們來(lái)看一下JS斷點(diǎn)調(diào)試的基本方法。
Sources斷點(diǎn)
首先,測(cè)試代碼中我們通過(guò)上圖console的輸出結(jié)果可以看出代碼應(yīng)該是正常運(yùn)行了,但是為什么是應(yīng)該呢?因?yàn)楹瘮?shù)中加了一個(gè)隨機(jī)數(shù),而最終結(jié)果是否真的是正確的呢?這是毫無(wú)意義的猜想,但是假設(shè)我現(xiàn)在就是要驗(yàn)證一下:函數(shù)傳入的兩個(gè)數(shù)、被加的隨機(jī)數(shù),以及最終的總和。那么該怎么操作呢?
方法一,前面講過(guò)最普通的,無(wú)論使用alert還是console,我們可以這么來(lái)驗(yàn)證:
從上圖發(fā)現(xiàn),我們?cè)诖a中新增了三行console代碼,用以打印我們關(guān)心的數(shù)據(jù)變量,而最終我們從控制臺(tái)(Console面板)中的輸出結(jié)果,可以很清楚的驗(yàn)證整個(gè)計(jì)算過(guò)程是否正常,進(jìn)而達(dá)到我們題設(shè)的驗(yàn)證要求。
方法二,方法一的驗(yàn)證過(guò)程存在很明顯的弊端就是,添加了很多冗余代碼,接下來(lái)我們看一下使用斷點(diǎn)進(jìn)行驗(yàn)證,是否更加方便,先看一個(gè)如何加斷點(diǎn),以及斷點(diǎn)后是什么效果:
如圖,給一段代碼添加斷點(diǎn)的流程是“F12(Ctrl + Shift + I)打開(kāi)開(kāi)發(fā)工具”——“點(diǎn)擊Sources菜單”——“左側(cè)樹中找到相應(yīng)文件”——“點(diǎn)擊行號(hào)列”即完成在當(dāng)前行添加/刪除斷點(diǎn)操作。當(dāng)斷點(diǎn)添加完畢后,刷新頁(yè)面JS執(zhí)行到斷點(diǎn)位置停住,在Sources界面會(huì)看到當(dāng)前作用域中所有變量和值,只需對(duì)每個(gè)值進(jìn)行驗(yàn)證即可完成我們題設(shè)驗(yàn)證要求。
那問(wèn)題來(lái)了,仔細(xì)的朋友會(huì)發(fā)現(xiàn)當(dāng)我的代碼執(zhí)行到斷點(diǎn)的時(shí)候,顯示的變量a和b的值是已經(jīng)進(jìn)行過(guò)加法運(yùn)算后的,我們看不到調(diào)用sum函數(shù)時(shí)初始傳入的10和20。那么該怎么辦呢?這就要回過(guò)頭來(lái)先學(xué)習(xí)一下斷點(diǎn)調(diào)試的一些基礎(chǔ)知識(shí)了。我們打開(kāi)Sources面板后其實(shí)會(huì)在界面中看到如下內(nèi)容,我們跟著鼠標(biāo)軌跡逐一看看都是什么意思:
從左到右,各個(gè)圖標(biāo)表示的功能分別為:
- Pause/Resume script execution:暫停/恢復(fù)腳本執(zhí)行(程序執(zhí)行到下一斷點(diǎn)停止)。
- Step over next function call:執(zhí)行到下一步的函數(shù)調(diào)用(跳到下一行)。
- Step into next function call:進(jìn)入當(dāng)前函數(shù)。
- Step out of current function:跳出當(dāng)前執(zhí)行函數(shù)。
- Deactive/Active all breakpoints:關(guān)閉/開(kāi)啟所有斷點(diǎn)(不會(huì)取消)。
- Pause on exceptions:異常情況自動(dòng)斷點(diǎn)設(shè)置。
到此,斷點(diǎn)調(diào)試的功能鍵介紹得差不多了,接下來(lái)我們就可以一行一行去看我們的程序代碼,查看每一行執(zhí)行完畢之后,我們各個(gè)變量的變化情況了,如下圖所示:
如上,我們可以看到a、b變量從最初值,到中間加上隨機(jī)值,再到***計(jì)算總和并輸出最終結(jié)果的整個(gè)過(guò)程,完成題設(shè)驗(yàn)證要求不在話下。
其余幾個(gè)功能鍵,我們稍微改動(dòng)一下我們的測(cè)試代碼,用一張gif圖來(lái)演示他們的使用方法:
這里需要注意一點(diǎn),直接在代碼區(qū)打印變量值的功能是在較新版本的Chrome瀏覽器中才新增的功能,如果你還在使用較老版本的Chrome瀏覽器,可能無(wú)法直接在斷點(diǎn)的情況下查看變量信息,此時(shí)你可以將鼠標(biāo)移動(dòng)到變量名上短暫停頓則會(huì)出現(xiàn)變量值。也可以用鼠標(biāo)選中變量名稱,然后右鍵“Add to watch”在Watch面板查看,此方法同樣適用于表達(dá)式。此外,你還可以在斷點(diǎn)情況下,切換到Console面板,直接在控制臺(tái)輸入變量名稱,回車查看變量信息。該部分比較簡(jiǎn)單,考慮篇幅問(wèn)題,不在做圖演示。
Debugger斷點(diǎn)
所謂的Debugger斷點(diǎn),其實(shí)是我自己給它命名的,專業(yè)術(shù)語(yǔ)我也不知道怎么說(shuō)。具體的說(shuō)就是通過(guò)在代碼中添加”debugger;”語(yǔ)句,當(dāng)代碼執(zhí)行到該語(yǔ)句的時(shí)候就會(huì)自動(dòng)斷點(diǎn)。接下去的操作就跟在Sources面板添加斷點(diǎn)調(diào)試幾乎一模一樣,唯一的區(qū)別在于調(diào)試完后需要?jiǎng)h除該語(yǔ)句。
既然除了設(shè)置斷點(diǎn)的方式不一樣,功能和Sources面板添加斷點(diǎn)效果一樣,那么為什么還會(huì)存在這種方式呢?我想原因應(yīng)該是這樣的:我們?cè)陂_(kāi)發(fā)中偶爾會(huì)遇到異步加載html片段(包含內(nèi)嵌JS代碼)的情況,而這部分JS代碼在Sources樹種無(wú)法找到,因此無(wú)法直接在開(kāi)發(fā)工具中直接添加斷點(diǎn),那么如果想給異步加載的腳本添加斷點(diǎn),此時(shí)”debugger;”就發(fā)揮作用了。我們直接通過(guò)gif圖看看他的效果:
DOM斷點(diǎn)調(diào)試
DOM斷點(diǎn),顧名思義就是在DOM元素上添加斷點(diǎn),進(jìn)而達(dá)到調(diào)試的目的。而在實(shí)際使用中斷點(diǎn)的效果最終還是落地到JS邏輯之內(nèi)。我們依次來(lái)看一下每一種DOM斷點(diǎn)的具體效果。
當(dāng)節(jié)點(diǎn)內(nèi)部子節(jié)點(diǎn)變化時(shí)斷點(diǎn)(Break on subtree modifications)
在前端開(kāi)發(fā)越來(lái)越復(fù)雜的今天,前端JS代碼越來(lái)越多,邏輯越來(lái)越復(fù)雜,一個(gè)看似簡(jiǎn)單的Web頁(yè)面,通常伴隨著大段大段的JS代碼,涉及諸多DOM節(jié)點(diǎn)增、刪、改的操作。難免遇到直接通過(guò)JS代碼很難定位代碼段的情況,而我們卻可以通過(guò)開(kāi)發(fā)者工具的Elements面板,快速定位到相關(guān)DOM節(jié)點(diǎn),這時(shí)候通過(guò)DOM斷點(diǎn)定位腳本就顯得尤其重要了。具體我們還是通過(guò)gif演示來(lái)看一下吧:
上圖演示了對(duì)ul子節(jié)點(diǎn)(li)的增加、刪除以及交換順序操作觸發(fā)斷點(diǎn)的效果。但需要注意的是,對(duì)子節(jié)點(diǎn)進(jìn)行屬性修改和內(nèi)容修改并不會(huì)觸發(fā)斷點(diǎn)。
當(dāng)節(jié)點(diǎn)屬性發(fā)生變化時(shí)斷點(diǎn)(Break on attributes modifications)
另一方面,由于前端處理的業(yè)務(wù)邏輯越來(lái)越復(fù)雜,對(duì)一些數(shù)據(jù)的存儲(chǔ)依賴越來(lái)越強(qiáng)烈,而將臨時(shí)數(shù)據(jù)存儲(chǔ)于DOM節(jié)點(diǎn)的(自定義)屬性中,是很多情況下開(kāi)發(fā)者優(yōu)先選擇的方式。特別是在HTML5標(biāo)準(zhǔn)增強(qiáng)自定義屬性支持(例:dataset、data-*之類)之后,屬性設(shè)置應(yīng)用越來(lái)越多,因此Chrome開(kāi)發(fā)者工具也提供了屬性變化斷點(diǎn)支持,其效果大致如下:
此方式同樣需要注意,對(duì)子節(jié)點(diǎn)的屬性進(jìn)行任何操作也不會(huì)觸發(fā)節(jié)點(diǎn)本身的斷點(diǎn)。
當(dāng)節(jié)點(diǎn)被移除時(shí)斷點(diǎn)(Break on node removal)
這個(gè)DOM斷點(diǎn)設(shè)置很簡(jiǎn)單,觸發(fā)方式很明確——當(dāng)節(jié)點(diǎn)被刪除時(shí)。所以通常情況應(yīng)該是在執(zhí)行”parentNode.removeChild(childNode)”語(yǔ)句的時(shí)候使用此方式。此方式使用不多。
前面介紹到的基本上是我們?cè)谌粘i_(kāi)發(fā)中經(jīng)常用到的調(diào)試手段,運(yùn)用得當(dāng)它們也幾乎能應(yīng)對(duì)我們?nèi)粘i_(kāi)發(fā)中的幾乎所有問(wèn)題。但是,開(kāi)發(fā)者工具還考慮到了更多的情況,提供更多的斷點(diǎn)方式,如圖:
XHR Breakpoints
這幾年前端開(kāi)發(fā)發(fā)生了翻天覆地的變化,從當(dāng)初的名不見(jiàn)經(jīng)傳到如今的盛極一時(shí),Ajax驅(qū)動(dòng)Web富應(yīng)用,移動(dòng)WebApp單頁(yè)應(yīng)用風(fēng)生水起。這一切都離不開(kāi)XMLHttpRequest對(duì)象,而“XHR Breakpoints”正是專為異步而生的斷點(diǎn)調(diào)試功能。
我們可以通過(guò)“XHR Breakpoints”右側(cè)的“+”號(hào)為異步斷點(diǎn)添加斷點(diǎn)條件,當(dāng)異步請(qǐng)求觸發(fā)時(shí)的URL滿足此條件,JS邏輯則會(huì)自動(dòng)產(chǎn)生斷點(diǎn)。演示動(dòng)畫中并沒(méi)有演示到斷點(diǎn)位置,這是因?yàn)?,演示使用的是jQuery封裝好的ajax方法,代碼已經(jīng)過(guò)壓縮,看不到什么效果,而事實(shí)上XHR斷點(diǎn)的產(chǎn)生位置是”xhr.send()”語(yǔ)句。
XHR斷點(diǎn)的強(qiáng)大之處是可以自定義斷點(diǎn)規(guī)則,這就意味著我們可以針對(duì)某一批、某一個(gè),乃至所有異步請(qǐng)求進(jìn)行斷點(diǎn)設(shè)置,非常強(qiáng)大。但是,似乎這個(gè)功能在日常開(kāi)發(fā)中用得并不多,至少我用得不多。想想原因大概有兩點(diǎn):其一,這類型的斷點(diǎn)調(diào)試需求在日常業(yè)務(wù)中本身涉及不多;其二,現(xiàn)階段的前端開(kāi)發(fā)大多基于JS框架進(jìn)行,最基本的jQuery也已經(jīng)對(duì)Ajax進(jìn)行了良好封裝,極少有人自己封裝Ajax方法,而項(xiàng)目為了減少代碼體積,通常選擇壓縮后的代碼庫(kù),使得XHR斷點(diǎn)跟蹤相對(duì)不那么容易了。
Event Listener Breakpoints
事件監(jiān)聽(tīng)器斷點(diǎn),即根據(jù)事件名稱進(jìn)行斷點(diǎn)設(shè)置。當(dāng)事件被觸發(fā)時(shí),斷點(diǎn)到事件綁定的位置。事件監(jiān)聽(tīng)器斷點(diǎn),列出了所有頁(yè)面及腳本事件,包括:鼠標(biāo)、鍵盤、動(dòng)畫、定時(shí)器、XHR等等。極大的降低了事件方面業(yè)務(wù)邏輯的調(diào)試難度。
演示實(shí)例演示了當(dāng)click事件被觸發(fā)時(shí)和當(dāng)setTimeout被設(shè)置時(shí)的斷點(diǎn)效果。實(shí)例顯示,當(dāng)選中click事件斷點(diǎn)之后,兩個(gè)按鈕的被點(diǎn)擊時(shí)都觸發(fā)了斷點(diǎn),而當(dāng)setTimeout被設(shè)置時(shí),“Set Timer”斷點(diǎn)被觸發(fā)。
調(diào)試,是在項(xiàng)目開(kāi)發(fā)中非常重要的環(huán)節(jié),不僅可以幫助我們快速定位問(wèn)題,還能節(jié)省我們的開(kāi)發(fā)時(shí)間。熟練掌握各種調(diào)試手段,定當(dāng)為你的職業(yè)發(fā)展帶來(lái)諸多利益,但是,在如此多的調(diào)試手段中,如何選擇一個(gè)適合自己當(dāng)前應(yīng)用場(chǎng)景的,這需要經(jīng)驗(yàn),需要不斷嘗試積累。