DIV CSS 佈局教程網

JavaScript 日誌對象的獲取與調試輸出的規範寫法
編輯:JavaScript綜合知識     

到處散落著 alert() 和 console.log() 的代碼,排查問題時往往比沒有日誌更難讀。稍微規範一點的做法是引入一個日誌對象,把「要不要輸出」和「輸出什麼」分開控制。

基本用法

var log = new Logger('***.js');

if (log.isDebugEnabled()) {
    log.debug('xxxxx');
}

這段結構借鑑了 Java 裡 Log4j 的思路,包含兩個要點:

1. 日誌器帶名字。new Logger('***.js') 中的參數是這個日誌器的名稱,通常填當前文件名或模塊名。輸出時能一眼看出消息來自哪裡,這在多文件項目裡價值很大。

2. 級別開關前置判斷。先問 isDebugEnabled() 再拼消息,避免在關閉調試時仍然執行字符串拼接。看起來囉嗦,但在消息需要多次拼接或涉及對象序列化時,這個判斷能省下真正的開銷。

用 console 搭一個簡易版本

如果不想引入類庫,幾行就能實現同等效果:

var Logger = function (name) {
    this.name = name;
    this.enabled = false;      // 全局開關
};

Logger.prototype.isDebugEnabled = function () {
    return this.enabled;
};

Logger.prototype._output = function (level, args) {
    if (!this.enabled) return;
    var msg = '[' + level + '] [' + this.name + '] ' +
              Array.prototype.slice.call(args).join(' ');
    console.log(msg);
};

Logger.prototype.debug = function () {
    this._output('DEBUG', arguments);
};

Logger.prototype.info = function () {
    this._output('INFO', arguments);
};

Logger.prototype.error = function () {
    this._output('ERROR', arguments);
};

使用時通過一個全局開關統一控制,上線前把 enabled 設為 false 即可,不必到處刪 console.log:

var log = new Logger('user.js');
Logger.prototype.enabled = true;    // 或者按 URL 參數動態決定

log.debug('用戶 id =', userId);
log.error('請求失敗', err);

現代做法

ES6 classes 讓上面的實現更簡潔,而打包工具(Webpack、Vite)提供的 define 或 import.meta.env.DEV 可以在編譯期就把調試代碼整段移除,比運行時判斷更徹底:

if (import.meta.env.DEV) {
    console.debug('[user]', userId);
}

另外,各瀏覽器控制台都支持的方法遠比 log 豐富,值得用起来:

console.table(users);          // 把數組或對象渲染成表格
console.group('加載流程');      // 分組折疊
console.time('fetch');
fetchData();
console.timeEnd('fetch');      // 輸出耗時
console.assert(x > 0, 'x 必須為正');   // 斷言失敗才輸出

最後提醒一句:日誌裡經常不知不覺帶上用戶敏感信息(手機號、token、完整請求體)。上線前清理調試輸出,既是為了性能,也是為了合規。

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