早期的 JavaScript 對 IO 的支持很弱,無法把訊息寫進檔案;異常物件 Error 也不統一,印不出完整的呼叫堆疊。自訂異常物件是個不討好的做法,因為通常只看得到 message 屬性,其他自訂屬性還得用效率最差的 for...in 逐一瀏覽。在這種情況下,唯一的出路是求助瀏覽器的私有實作——Firefox 的 console.log 就是這樣誕生的,後來由 Firebug 擴充成完整的除錯工具,最終被各家瀏覽器吸收為標準。
| 方法 | 說明 |
|---|---|
log(obj[, obj, ...]) |
向主控台輸出一則訊息。可傳入多個參數,輸出時以空格分隔。第一個參數可包含格式化文字,例如 log('這裡有%d個%s', count, apple)。格式符號:%s 字串、%d 與 %i 整數、%f 浮點數、%o 超連結物件。 |
debug(obj[, obj, ...]) |
輸出一則訊息,並附帶連到輸出位置的超連結。 |
info(obj[, obj, ...]) |
輸出一則帶資訊圖示與背景色的訊息,附連到輸出位置的連結。 |
warn(obj[, obj, ...]) |
輸出一則帶警告圖示與背景色的訊息,附連到輸出位置的連結。 |
error(obj[, obj, ...]) |
輸出一則帶錯誤圖示與背景色的訊息,附連到輸出位置的連結。 |
assert(expression[, obj, ...]) |
測試一個運算式是否為真,若為假則提交例外訊息到主控台。 |
dir(obj) |
列出物件的所有屬性,以可展開的樹狀結構呈現。 |
dirxml(node) |
列出 HTML 或 XML 元素的原始樹狀結構。 |
trace() |
輸出目前的呼叫堆疊。 |
group(obj[, obj, ...]) |
把後續訊息分組輸出,以 groupEnd() 結束分組。 |
groupEnd() |
結束目前的分組。 |
time(name) / timeEnd(name) |
建立名稱為 name 的計時器開始計時,呼叫 timeEnd(name) 停止並輸出執行時間。 |
profile([title]) / profileEnd() |
開始與結束一段腳本的效能分析,title 為測試標題。 |
count([title]) |
計算某段程式碼被執行的次數,title 作為輸出標題。 |
Firebug 的功能自不必多說。IE8 雖然也有 console.log,但必須先按 F12 進入除錯模式才存在,否則頁面一呼叫就會丟出「console 未定義」的錯誤,讓整個腳本中斷。這在正式環境是很典型的悲劇:除錯訊息忘了刪,使用者那邊就白屏。
解法是在頁面最早的位置補一個空物件把所有方法填成不做任何事的函數:
if (!window.console) {
window.console = {};
var methods = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
"group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"],
noop = function () {};
for (var i = 0, method; method = methods[i++];) {
window.console[method] = noop;
}
}
這段程式有個細節值得注意:迴圈的條件式寫成 method = methods[i++],同時完成赋值與邊界判斷——當 methods[i] 為 undefined 時條件為假,迴圈自然結束。這種寫法簡潔,但也容易讓人誤讀,團隊協作時改成一般的三段式迴圈會更友善。
大約從 Opera 9.5x 之後,Opera 多了一個叫 Dragonfly 的工具。它顯然無法與 Firebug 琳瑯滿目的日誌輸出相比,只提供了一個 opera.postError 方法:
if (window.opera && opera.postError) {
opera.postError(message);
}
Safari 也有 console.log,它基於內建的 Web Inspector 元件,感覺與 Firefox 相當接近。至於瀏覽器新貴 Chrome,當時可以在擴充功能中搜尋並安裝 Firebug Lite 的 Chrome 版本;如今則有功能更完整的 DevTools。
上面這套「補洞」寫法在今天已經是歷史。所有仍在維護的瀏覽器都內建完整的開發者工具,console 一定是存在的。真正需要留意的反而是另一件事:正式環境應該透過建置流程移除除錯訊息,而不是依賴一個空函數把它們吞掉。此外 console.log 印物件時保留的是參考,展開時看到的是「當下」的值而非輸出當時的快照,這類誤會在除錯非同步程式碼時特別容易造成誤判,需要時可用 console.log(JSON.stringify(obj)) 或 console.dir 釐清。