前端除錯最常用的是 alert 與 debugger,但兩者都有明顯限制:alert 會中斷執行流程,而且在閉包或迴圈中弹出的值有時並不可靠;debugger 則只有部分瀏覽器支援得完整,操作起來頗不便。
比較理想的方式是把執行過程中需要觀察的值輸出到頁面上,或寫進 cookie。這種做法不會因中斷而取到不正確的值,也不受瀏覽器類型限制,缺點是每次都要手動操作 DOM,麻煩。
下面這個元件就是為了解掉這個麻煩。它的設計參考了 log4net 的分級記錄方式,用呼叫 log 的語感來做除錯:
/*
* js 除錯元件
*/
(function () {
var logger = function (level, object, viewType) {
this.level = level;
this.object = object;
this.viewType = viewType;
}
logger.LEVEL_DEBUG = 0;
logger.LEVEL_INFO = 1;
logger.LEVEL_WARN = 2;
logger.LEVEL_ERROR = 3;
logger.LEVEL_FATAL = 4;
logger.VIEW_TYPE_ALERT = 0;
logger.VIEW_TYPE_APPEND = 1;
logger.prototype = {
setLevel: function (level) {
this.level = level;
},
setObject: function (o) {
if (typeof o == 'string') {
this.object = document.getElementById(o);
} else {
this.object = o;
}
},
setViewType: function (type) {
this.viewType = type;
},
log: function (s) { this.message(100, s); },
debug: function (s) { this.message(logger.LEVEL_DEBUG, s); },
info: function (s) { this.message(logger.LEVEL_INFO, s); },
warn: function (s) { this.message(logger.LEVEL_WARN, s); },
error: function (s) { this.message(logger.LEVEL_ERROR, s); },
fatal: function (s) { this.message(logger.LEVEL_FATAL, s); },
message: function (level, s) {
if (level >= this.level) {
if (this.object != null) {
this.object.innerHTML = s;
} else if (this.viewType == logger.VIEW_TYPE_ALERT) {
alert(s);
} else {
document.body.appendChild(document.createTextNode(s));
document.body.appendChild(document.createElement("br"));
}
}
}
};
if (typeof window.Logger == 'undefined' || window.Logger == null)
window.Logger = new logger(logger.LEVEL_DEBUG, null, logger.VIEW_TYPE_APPEND);
})();
這個元件往 window 註冊了 Logger 物件,直接用 Logger.log/debug/info/warn/error/fatal 就能輸出不同等級的訊息:
Logger.debug(new Date()); Logger.debug(new Date().addHours(3));
從此不必每個地方都寫 document.getElementById().innerHTML 或 alert/debugger 來看內容了。
元件的兩個設計細節值得留意:一是整段包在 IIFE 裡,只把 Logger 一個變數洩到全域,其他都是區域的;二是 level >= this.level 的門檻判斷,讓你可以把等級調成 ERROR 以上,就只印錯誤,正式環境要關掉輸出時只要把等級拉高即可,不必回頭刪程式碼。
若要更進一步,可以在 message 裡加上時間戳與呼叫來源(new Error().stack),並把輸出改成 console.log——現代瀏覽器的 DevTools 本身就有分級、篩選與展開物件的能力,往往比自己刻一個頁面輸出更合用。