Nodejs 進階：用 debug 模塊打印調試日誌

本文摘錄自《Nodejs學習筆記》，更多章節及更新，請訪問 github主頁地址。歡迎加羣交流，羣號 197339705。

前言

在node程序開發中時，常常須要打印調試日誌。用的比較多的是debug模塊，好比express框架中就用到了。下文簡單舉幾個例子進行說明。文中相關代碼示例，可在這裏找到。

備註：node在0.11.3版本也加入了util.debuglog()用於打印調試日誌，使用方法跟debug模塊大同小異。

基礎例子

首先，安裝debug模塊。

npm install debug複製代碼

使用很簡單，運行node程序時，加上DEBUG=app環境變量便可。

/** * debug基礎例子 */
var debug = require('debug')('app');

// 運行 DEBUG=app node 01.js
// 輸出：app hello +0ms
debug('hello');複製代碼

例子：命名空間

當項目程序變得複雜，咱們須要對日誌進行分類打印，debug支持命令空間，以下所示。

• DEBUG=app,api：表示同時打印出命名空間爲app、api的調試日誌。
• DEBUG=a*：支持通配符，全部命名空間爲a開頭的調試日誌都打印出來。

/** * debug例子：命名空間 */
var debug = require('debug');
var appDebug = debug('app');
var apiDebug = debug('api');

// 分別運行下面幾行命令看下效果
// 
// DEBUG=app node 02.js
// DEBUG=api node 02.js
// DEBUG=app,api node 02.js
// DEBUG=a* node 02.js
// 
appDebug('hello');
apiDebug('hello');複製代碼

例子：命名空間排除

有的時候，咱們想要打印出全部的調試日誌，除了個別命名空間下的。這個時候，能夠經過-來進行排除，以下所示。-account*表示排除全部以account開頭的命名空間的調試日誌。

/** * debug例子：排查命名空間 */
var debug = require('debug');
var listDebug = debug('app:list');
var profileDebug = debug('app:profile');
var loginDebug = debug('account:login');

// 分別運行下面幾行命令看下效果
// 
// DEBUG=* node 03.js
// DEBUG=*,-account* node 03.js
// 
listDebug('hello');
profileDebug('hello');
loginDebug('hello');複製代碼

例子：自定義格式化

debug也支持格式化輸出，以下例子所示。

var debug = require('debug')('app');

debug('my name is %s', 'chyingp');複製代碼

此外，也能夠自定義格式化內容。

/** * debug：自定義格式化 */
var createDebug = require('debug')

createDebug.formatters.h = function(v) {
  return v.toUpperCase();
};

var debug = createDebug('foo');

// 運行 DEBUG=foo node 04.js 
// 輸出 foo My name is CHYINGP +0ms
debug('My name is %h', 'chying');複製代碼

相關連接

debug：github.com/visionmedia…
debuglog：nodejs.org/api/util.ht…