大型專案裡的函式呼叫關係往往層層相扣,除錯時經常需要確認「這個函式到底是誰呼叫的」。釐清呼叫順序,對理解資料流向與狀態變化極有幫助。
Firebug 提供了 console.trace(),只要在需要追查的位置加上一行,就能印出當時的呼叫上下鏈。但像 IE6 這類環境完全沒有這類工具,一旦必須在裡面除錯,就得自己動手實作。
建議將以下內容另存為 console.trace.js,再以外部引入的方式掛進頁面。
/**
* 獲取函數名稱
*
* @param {Function} func 函數引用
* @return {String} 函數名稱
*/
function getFunctionName(func) {
if (typeof func == 'function' || typeof func == 'object') {
var name = ('' + func).match(/function\s*([\w\$]*)\s*\(/);
}
return name && name[1];
}
if (!('console' in window)) {
window.console = {};
}
if (!console.trace) {
/**
* 顯示函數堆棧
* 為了和 Firebug 統一,將 trace 方法添加到 console 對象中
*
* @param {Function} func 函數引用
*
* @example
* function a() { b(); }
* function b() { c(); }
* function c() { d(); }
* function d() { console.trace(); }
* a();
*/
console.trace = function () {
var stack = [], caller = arguments.callee.caller;
while (caller) {
stack.unshift(getFunctionName(caller));
caller = caller && caller.caller;
}
alert('functions on stack:' + '\n' + stack.join('\n'));
};
}
核心概念是 arguments.callee.caller:透過它取得呼叫目前函式的那個函式,再用 while 迴圈一路往上回溯,直到沒有呼叫者為止。每取得一層就用 unshift 插入到陣列前端,如此一來輸出順序就會與真實的呼叫方向一致,最外層在最上面。
getFunctionName 這支輔助函式則用正則表達式從函式的字串表示法中擷取名稱,匿名函式會得到空字串,這是此做法的已知限制。
最適合套用的時機是「事件突然被觸發,卻不知道從哪來」的狀況——例如某個全域事件被多處綁定、某個回呼被意料之外的地方呼叫。在該函式開頭放一行 console.trace(),呼叫鏈立刻一目了然。
現代瀏覽器早已內建 console.trace(),但理解它背後靠 caller 鏈回溯的實作方式,仍有助於建立對執行環境的直覺。碰到不支援 console 的環境時,這段程式碼也能作為降級方案直接使用。