最全面的JavaScript除錯技巧總結

miragele發表於2016-04-15

前言:除錯技巧,在任何一項技術研發中都可謂是必不可少的技能。掌握各種除錯技巧,必定能在工作中起到事半功倍的效果。譬如,快速定位問題、降低故障概率、幫助分析邏輯錯誤等等。而在網際網路前端開發越來越重要的今天,如何在前端開發中降低開發成本,提升工作效率,掌握前端開發除錯技巧尤為重要。

本文將一一講解各種前端JS除錯技巧,也許你已經熟練掌握,那讓我們一起來溫習,也許有你沒見過的方法,不妨一起來學習,也許你尚不知如何除錯,趕緊趁此機會填補空白。

骨灰級除錯大師Alert

那還是網際網路剛剛起步的時代,網頁前端還主要以內容展示為主,瀏覽器指令碼還只能為頁面提供非常簡單的輔助功能的時候。那個時候,網頁主要執行在以IE6為主的瀏覽器中,JS的除錯功能還非常弱,只能通過內建於Window物件中的alert方法來除錯,那時候看起來應該是這個樣子:

Alert除錯效果

需要說明一點,這裡看到的效果,並非當年的IE瀏覽器中看到的效果,而是在高版本IE中的效果。此外,當年貌似還沒有這麼高階的控制檯,而alert的使用也是在真實的頁面JS程式碼中。雖然,alert的除錯方式很原始,但當時確實有它不可磨滅的價值,甚至到今天,已然有其用武之地。

新一代除錯王者Console

隨著JS在Web前端中能做的事情越來越多,責任越來越大,而地位也越來越重要。傳統的alert除錯方式已經漸漸不能滿足前端開發的種種場景。而且alert除錯方式彈出的除錯資訊,那個視窗著實不太美觀,而且會遮擋部分頁面內容,著實有些不太友好。

另一方面,alert的除錯資訊,必須在程式邏輯中新增類似”alert(xxxxx)”這樣的語句,才能正常工作,並且alert會阻礙頁面的繼續渲染。這就意味著開發人員除錯完成後,必須手動清除這些除錯程式碼,實在有些麻煩。

所以,新一代的瀏覽器Firefox、Chrome,包括IE,都相繼推出了JS除錯控制檯,支援使用類似”console.log(xxxx)”的形式,在控制檯列印除錯資訊,而不直接影響頁面顯示。以IE為例,它看起來像這樣:

Console除錯效果

好吧,再見醜陋的alert彈出框。而以Chrome瀏覽器為首的後起之秀,為Console擴充套件了更豐富的功能:

更豐富的Console

你以為這樣就滿足了?Chrome開發團隊的想象力實在不得不讓人佩服:

花式Console.log

好了,稍微多說了一點點題外話。總之,控制檯以及瀏覽器內建Console物件的出現,給前端開發除錯帶來了極大的便利。

有人會問,這樣的除錯程式碼不一樣需要在除錯完成後進行清理嗎?

關於這個問題,如果在使用console物件之前先進性存在性驗證,其實不刪除也不會對業務邏輯造成破壞。當然,為了程式碼整潔,在除錯完成後,還是應儘可能刪除這些與業務邏輯無關的除錯程式碼。

JS斷點除錯

斷點,偵錯程式的功能之一,可以讓程式中斷在需要的地方,從而方便其分析。也可以在一次除錯中設定斷點,下一次只需讓程式自動執行到設定斷點位置,便可在上次設定斷點的位置中斷下來,極大的方便了操作,同時節省了時間。——百度百科

JS斷點除錯,即是在瀏覽器開發者工具中為JS程式碼新增斷點,讓JS執行到某一特定位置停住,方便開發者對該處程式碼段的分析與邏輯處理。為了能夠觀察到斷點除錯的效果,我們預先隨意準備一段JS程式碼:

斷點除錯測試程式碼

程式碼很簡單,就是定義一個函式,傳入兩個數,分別加上一個亂七八糟的隨機整數後,再返回兩個數的總和。以Chrome開發者工具為例,我們來看一下JS斷點除錯的基本方法。

Sources斷點

首先,測試程式碼中我們通過上圖console的輸出結果可以看出程式碼應該是正常執行了,但是為什麼是應該呢?因為函式中加了一個隨機數,而最終結果是否真的是正確的呢?這是毫無意義的猜想,但是假設我現在就是要驗證一下:函式傳入的兩個數、被加的隨機數,以及最終的總和。那麼該怎麼操作呢?

方法一,前面講過最普通的,無論使用alert還是console,我們可以這麼來驗證:

通過console進行上述驗證

從上圖發現,我們在程式碼中新增了三行console程式碼,用以列印我們關心的資料變數,而最終我們從控制檯(Console皮膚)中的輸出結果,可以很清楚的驗證整個計算過程是否正常,進而達到我們題設的驗證要求。

方法二,方法一的驗證過程存在很明顯的弊端就是,新增了很多冗餘程式碼,接下來我們看一下使用斷點進行驗證,是否更加方便,先看一個如何加斷點,以及斷點後是什麼效果:

斷點除錯效果一

如圖,給一段程式碼新增斷點的流程是“F12(Ctrl + Shift + I)開啟開發工具”——“點選Sources選單”——“左側樹中找到相應檔案”——“點選行號列”即完成在當前行新增/刪除斷點操作。當斷點新增完畢後,重新整理頁面JS執行到斷點位置停住,在Sources介面會看到當前作用域中所有變數和值,只需對每個值進行驗證即可完成我們題設驗證要求。

那問題來了,仔細的朋友會發現當我的程式碼執行到斷點的時候,顯示的變數a和b的值是已經進行過加法運算後的,我們看不到呼叫sum函式時初始傳入的10和20。那麼該怎麼辦呢?這就要回過頭來先學習一下斷點除錯的一些基礎知識了。我們開啟Sources皮膚後其實會在介面中看到如下內容,我們跟著滑鼠軌跡逐一看看都是什麼意思:

斷點除錯功能選項介紹

從左到右,各個圖示表示的功能分別為:

  • Pause/Resume script execution:暫停/恢復指令碼執行(程式執行到下一斷點停止)。
  • Step over next function call:執行到下一步的函式呼叫(跳到下一行)。
  • Step into next function call:進入當前函式。
  • Step out of current function:跳出當前執行函式。
  • Deactive/Active all breakpoints:關閉/開啟所有斷點(不會取消)。
  • Pause on exceptions:異常情況自動斷點設定。

到此,斷點除錯的功能鍵介紹得差不多了,接下來我們就可以一行一行去看我們的程式程式碼,檢視每一行執行完畢之後,我們各個變數的變化情況了,如下圖所示:

斷點除錯,逐行驗證

如上,我們可以看到a、b變數從最初值,到中間加上隨機值,再到最後計算總和並輸出最終結果的整個過程,完成題設驗證要求不在話下。

其餘幾個功能鍵,我們稍微改動一下我們的測試程式碼,用一張gif圖來演示他們的使用方法:

斷點進入、跳出函式演示

這裡需要注意一點,直接在程式碼區列印變數值的功能是在較新版本的Chrome瀏覽器中才新增的功能,如果你還在使用較老版本的Chrome瀏覽器,可能無法直接在斷點的情況下檢視變數資訊,此時你可以將滑鼠移動到變數名上短暫停頓則會出現變數值。也可以用滑鼠選中變數名稱,然後右鍵“Add to watch”在Watch皮膚檢視,此方法同樣適用於表示式。此外,你還可以在斷點情況下,切換到Console皮膚,直接在控制檯輸入變數名稱,回車檢視變數資訊。該部分比較簡單,考慮篇幅問題,不在做圖演示。

Debugger斷點

所謂的Debugger斷點,其實是我自己給它命名的,專業術語我也不知道怎麼說。具體的說就是通過在程式碼中新增”debugger;”語句,當程式碼執行到該語句的時候就會自動斷點。接下去的操作就跟在Sources皮膚新增斷點除錯幾乎一模一樣,唯一的區別在於除錯完後需要刪除該語句。

既然除了設定斷點的方式不一樣,功能和Sources皮膚新增斷點效果一樣,那麼為什麼還會存在這種方式呢?我想原因應該是這樣的:我們在開發中偶爾會遇到非同步載入html片段(包含內嵌JS程式碼)的情況,而這部分JS程式碼在Sources樹種無法找到,因此無法直接在開發工具中直接新增斷點,那麼如果想給非同步載入的指令碼新增斷點,此時”debugger;”就發揮作用了。我們直接通過gif圖看看他的效果:

Debugger斷點使用演示

DOM斷點除錯

DOM斷點,顧名思義就是在DOM元素上新增斷點,進而達到除錯的目的。而在實際使用中斷點的效果最終還是落地到JS邏輯之內。我們依次來看一下每一種DOM斷點的具體效果。

當節點內部子節點變化時斷點(Break on subtree modifications)

在前端開發越來越複雜的今天,前端JS程式碼越來越多,邏輯越來越複雜,一個看似簡單的Web頁面,通常伴隨著大段大段的JS程式碼,涉及諸多DOM節點增、刪、改的操作。難免遇到直接通過JS程式碼很難定位程式碼段的情況,而我們卻可以通過開發者工具的Elements皮膚,快速定位到相關DOM節點,這時候通過DOM斷點定位指令碼就顯得尤其重要了。具體我們還是通過gif演示來看一下吧:

子節點發生變化時斷點

上圖演示了對ul子節點(li)的增加、刪除以及交換順序操作觸發斷點的效果。但需要注意的是,對子節點進行屬性修改和內容修改並不會觸發斷點。

當節點屬性發生變化時斷點(Break on attributes modifications)

另一方面,由於前端處理的業務邏輯越來越複雜,對一些資料的儲存依賴越來越強烈,而將臨時資料儲存於DOM節點的(自定義)屬性中,是很多情況下開發者優先選擇的方式。特別是在HTML5標準增強自定義屬性支援(例:dataset、data-*之類)之後,屬性設定應用越來越多,因此Chrome開發者工具也提供了屬性變化斷點支援,其效果大致如下:

節點屬性變化時斷點演示

此方式同樣需要注意,對子節點的屬性進行任何操作也不會觸發節點本身的斷點。

當節點被移除時斷點(Break on node removal)

這個DOM斷點設定很簡單,觸發方式很明確——當節點被刪除時。所以通常情況應該是在執行”parentNode.removeChild(childNode)”語句的時候使用此方式。此方式使用不多。

前面介紹到的基本上是我們在日常開發中經常用到的除錯手段,運用得當它們也幾乎能應對我們日常開發中的幾乎所有問題。但是,開發者工具還考慮到了更多的情況,提供更多的斷點方式,如圖:

XHR和事件監聽斷點

XHR Breakpoints

這幾年前端開發發生了翻天覆地的變化,從當初的名不見經傳到如今的盛極一時,Ajax驅動Web富應用,移動WebApp單頁應用風生水起。這一切都離不開XMLHttpRequest物件,而“XHR Breakpoints”正是專為非同步而生的斷點除錯功能。

XHR Breakpoints演示

我們可以通過“XHR Breakpoints”右側的“+”號為非同步斷點新增斷點條件,當非同步請求觸發時的URL滿足此條件,JS邏輯則會自動產生斷點。演示動畫中並沒有演示到斷點位置,這是因為,演示使用的是jQuery封裝好的ajax方法,程式碼已經過壓縮,看不到什麼效果,而事實上XHR斷點的產生位置是”xhr.send()”語句。

XHR斷點的強大之處是可以自定義斷點規則,這就意味著我們可以針對某一批、某一個,乃至所有非同步請求進行斷點設定,非常強大。但是,似乎這個功能在日常開發中用得並不多,至少我用得不多。想想原因大概有兩點:其一,這型別的斷點除錯需求在日常業務中本身涉及不多;其二,現階段的前端開發大多基於JS框架進行,最基本的jQuery也已經對Ajax進行了良好封裝,極少有人自己封裝Ajax方法,而專案為了減少程式碼體積,通常選擇壓縮後的程式碼庫,使得XHR斷點跟蹤相對不那麼容易了。

Event Listener Breakpoints

事件監聽器斷點,即根據事件名稱進行斷點設定。當事件被觸發時,斷點到事件繫結的位置。事件監聽器斷點,列出了所有頁面及指令碼事件,包括:滑鼠、鍵盤、動畫、定時器、XHR等等。極大的降低了事件方面業務邏輯的除錯難度。

事件監聽器斷點演示

演示例項演示了當click事件被觸發時和當setTimeout被設定時的斷點效果。例項顯示,當選中click事件斷點之後,兩個按鈕的被點選時都觸發了斷點,而當setTimeout被設定時,“Set Timer”斷點被觸發。

除錯,是在專案開發中非常重要的環節,不僅可以幫助我們快速定位問題,還能節省我們的開發時間。熟練掌握各種除錯手段,定當為你的職業發展帶來諸多利益,但是,在如此多的除錯手段中,如何選擇一個適合自己當前應用場景的,這需要經驗,需要不斷嘗試積累。

相關文章