DIV CSS 佈局教程網

自製 console 類別:讓除錯輸出不再被 IE 綁架
編輯:關於JavaScript     

問題的產生

寫 JavaScript 時為了除錯,常常會散落下大量 console.log、console.info、console.group、console.warn、console.error。上 production 前又因為 IE 不支援 console,得把它們一個個刪掉——一不小心就會刪錯、改壞邏輯,甚至把還需要的程式碼一起刪了。

本文分享作者寫的一個 console 類別,試圖解決這個問題。當然,更好的做法是把測試程式碼另外獨立寫,那樣就不會有這個困擾。

解決思路

既然 IE 不認得 console,那就自己定義一個 console 來覆蓋它。這樣只要在頁面中始終引用這個 JS 檔,程式碼一行都不用改,在 IE 中也不會出錯。

順帶還能提供「把除錯資訊輸出到頁面上」的能力。firebug 的 Console API 定義了哪些功能可以參考官方文件,常用的有 log、info、group、warn、error、profile、time,其中最後兩個是分析程式碼效能用的,比較複雜,本文沒有實作。

第一步:先搭出完整介面

把所有方法都先定義成空函式,這樣直接引用即可保證在 IE 中不出錯。

var console = {
  assert: function(){}, clear: function(){}, count: function(){},
  debug: function(){}, dir: function(){}, dirxml: function(){},
  error: function(){}, exception: function(){},
  group: function(name){}, groupCollapsed: function(){}, groupEnd: function(){},
  info: function(){}, log: function(){},
  memoryProfile: function(){}, memoryProfileEnd: function(){},
  profile: function(){}, profileEnd: function(){},
  table: function(){}, time: function(){}, timeEnd: function(){},
  timeStamp: function(){}, trace: function(){}, warn: function(){}
};

第二步:實作 console.log

這是所有方法中最複雜的一個。從 firebug 的 API 文件可以看到,console.log 不僅能輸出資訊,還提供了類似 string.Format 的格式化功能。完整的佔位符如下:

  • %s:String
  • %d、%i:Integer
  • %f:Floating point number
  • %o:Object hyperlink
  • %c:Style formatting(給輸出加上樣式)

%c 比較特殊,可以這樣寫:

console.log('%cTest output', 'color:white; background-color:blue');

執行後的結果:

%c 也可以與 %s、%d 混用。程式碼中直接用 replace 替換,由於 JavaScript 的 replace 預設只替換第一個匹配項,這裡剛好符合需求:

var args = Array.prototype.slice.call(arguments);

if (args.length > 1){
  var i = 1, hasstyle = false;

  // %c 只處理寫在開頭的情況
  if (args[0].indexOf("%c") == 0){
    args[0] = args[0].replace(/%c/, "");
    i = 2;
    hasstyle = true;
  }

  for (; i < args.length; i++){
    if (/%s|%d|%i|%o/.test(args[0])){
      args[0] = args[0].replace(/%s|%d|%i|%o/, args[i]);
    } else break;
  }

  // 剩下的參數直接接在後面
  if (i < args.length) args[0] = args[0] + " " + args.slice(i).join(" ");

  hasstyle ? consoleHelper.showlog(args[0], args[1])
           : consoleHelper.showlog(args[0]);

} else if (args.length == 1){
  if (arguments[0] instanceof Array)
    consoleHelper.showlog("[" + args[0] + "]");
  else if (arguments[0] instanceof Function)
    consoleHelper.showlog(args[0], null, "console_log_function");
  else
    consoleHelper.showlog(args[0]);

} else {
  consoleHelper.showlog("");
}

因為 console.log 可接受多個參數且個數不確定,所以函式不宣告形參,改把 arguments 轉成陣列再分情況處理:

  • 參數 > 1:把後續參數逐一 replace 進佔位符,剩下的用 join 接成一行輸出。
  • 參數 = 1:再分兩種——陣列在兩端補中括號;函式則用綠色字體標示。
  • 參數 = 0:輸出空字串。

consoleHelper.showlog 是另外寫的輔助方法,負責把結果渲染到頁面上 id 為 showconsole 的 div(若存在)中。其餘方法思路相同,只是樣式不同、功能更簡單,直接把參數 join 起來輸出即可。

輔助模組 consoleHelper

var consoleHelper = {
  showlog: function(val, style, cla){
    this.show(val, style, cla ? "console_log " + cla : "console_log");
  },
  showinfo: function(val, cla){
    this.show(val, null, cla ? "console_info " + cla : "console_info");
  },
  showwarn: function(val, cla){
    this.show(val, null, cla ? "console_warn " + cla : "console_warn");
  },
  showerror: function(val){ this.show(val, null, "console_error"); },
  showgroup: function(val){
    this.show((val || "") + ":", null, "console_group");
  },
  show: function(val, style, cla){
    var container = document.getElementById("showconsole");
    if (!container) return;

    var div = document.createElement("div");
    if (style) div.setAttribute("style", style);
    if (cla)   div.className = cla;
    div.appendChild(document.createTextNode(val));
    container.appendChild(div);
  }
};

想在頁面中看到除錯資訊,只要加一個 id 為 showconsole 的隱藏 div 即可。樣式刻意做得接近 firebug:log 為白底黑框、info 為淺藍底加資訊圖示、warn 為淺黃底加三角圖示、error 為紅字加淺紅底、group 為加大加粗的標題、函式內容則用綠色字。原文中三個圖示直接使用 base64 內嵌,實作時可換成一般的圖片 URL。

這個方案在今天還需要嗎

大部分不需要了。所有現代瀏覽器(含 IE10/11)都內建 console,而 IE9 及以下的市佔早已歸零。更乾淨的做法有兩個:

一、用條件式保護,而不是覆蓋整個 console。如果你只是要防止 console 不存在時報錯,補一個空殼就夠了:

if (!window.console) window.console = {};
['log','info','warn','error','group','groupEnd','table','time','timeEnd']
  .forEach(function(m){ window.console[m] = window.console[m] || function(){}; });

二、用建置流程移除除錯輸出。这才是根本解法。在 webpack 中用 TerserPlugin 的 drop_console,在 Vite 中設定 esbuild: { drop: ['console', 'debugger'] },正式環境的 console 呼叫會在打包時被靜默移除,原始碼裡一行都不用改,也不必自己實作任何格式化邏輯。

這個自製 console 的價值,在於它示範了一個通用技巧:當某個 API 在某些環境不存在時,用「定義同名介面的空實作」來抹平差異——這個手法(俗稱 shim 或 polyfill 的最簡形式)在你今天處理任何跨環境相容問題時都用得上。而它示範的反面教材同樣有價值:覆蓋全域物件是有風險的,一旦你的實作行為與原生有細微差異,除錯時反而會被自己的工具誤導。能交給建置流程解決的,就不要在執行期攔截。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved