log4js－Node.js中的日志管理模塊使用與封裝【轉】

首先log4js-node將輸出的log分為六個的level，每個level的含義從字面就可以看出， 對於不同的level，log輸出到終端時會使用不同的顏色

 

(trace: 藍色，debug: 青色， info：綠色，warn：黃色，error：紅色， fatal：粉色)。終端是log4js-node的默認輸出地點。

 

默認情況下，log4js-node的每條log輸出格式有如下幾個字段：日志產生時間，level，日志分類，日志內容。如果用戶沒有配置，日志分類字段為“default”。

 

以下轉自：http://blog.csdn.net/youbl/article/details/32708609 ，謝謝分享。

開發過程中，日志記錄是必不可少的事情，尤其是生產系統中經常無法調試，因此日志就成了重要的調試信息來源。

Node.js，已經有現成的開源日志模塊，就是log4js，源碼地址：點擊打開鏈接

項目引用方法： npm install log4js

1、配置說明（僅以常用的dateFile日志類型舉例，更多說明參考log4js-wiki）：

{ 
  "appenders": [ 
  // 下面一行應該是用於跟express配合輸出web請求url日志的
  {"type": "console", "category": "console"}, 
  // 定義一個日志記錄器
  {      
    "type": "dateFile",                 // 日志文件類型，可以使用日期作為文件名的占位符
    "filename": "e:/weblogs/logs/",     // 日志文件名，可以設置相對路徑或絕對路徑
    "pattern": "debug/yyyyMMddhh.txt",  // 占位符，緊跟在filename后面
    "absolute": true,                   // filename是否絕對路徑
    "alwaysIncludePattern": true,       // 文件名是否始終包含占位符
    "category": "logInfo"               // 記錄器名
  } ],
  "levels":{ "logInfo": "DEBUG"}        // 設置記錄器的默認顯示級別，低於這個級別的日志，不會輸出
}

pattern可以使用的占位符說明，不屬於下列占位符格式，均會原樣輸出為文件名（注：不支持單個M、d、h、m）：

yy 兩位年份
yyyy 四位年份
MM 兩位月份
dd  兩位日期
hh  兩位的小時數，按24小時制
mm 兩位的分數數
ss  兩位的秒數
SSS 三位的毫秒數
O    時區，大寫字母O，占位符輸出結果為+0800

 假設當前是2014年6月20月15點，那么上面的配置最終將會記錄到 e:\weblogs\logs\debug\2014062015.txt這個文件中。

 

2、輸出日志代碼，首先請把上面的配置代碼保存為log4js.json文件，用於代碼從文件加載配置（配置獨立也便於修改和發布）：

注意：json文件不支持任何形式的注釋// 或 /**/，因此上面的配置代碼里的注釋要全部移除，不然會編譯出錯的

var log4js = require('log4js');

// 注：配置里的日志目錄要先創建，才能加載配置，不然會出異常
log4js.configure("./log4js.json");
var logInfo = log4js.getLogger('logInfo');
logInfo.info("測試日志信息");

 

上述配置和代碼，比較簡單，我這邊參考之前用的C#版本的日志記錄類，重新封裝了一下log4js，定義了一個logHelper.js

1、log4js.json配置文件內容（定義了4個日志記錄器，分別寫入到不同的日志目錄；並自定義了2個屬性，把一些公共屬性提取到自定義屬性中）：

{
    "customBaseDir" :"e:/weblogs/logs/",
    "customDefaultAtt" :{
        "type": "dateFile",
        "absolute": true,
        "alwaysIncludePattern": true
    },
    "appenders": [
            {"type": "console", "category": "console"},
            {"pattern": "debug/yyyyMMddhh.txt", "category": "logDebug"},
            {"pattern": "info/yyyyMMddhh.txt", "category": "logInfo"},
            {"pattern": "warn/yyyyMMddhh.txt", "category": "logWarn"},
            {"pattern": "err/yyyyMMddhh.txt", "category": "logErr"}
        ],
        "replaceConsole": true,
        "levels":{ "logDebug": "DEBUG", "logInfo": "DEBUG", "logWarn": "DEBUG", "logErr": "DEBUG"}
}

2、logHelper.js封裝的文件內容：

var helper = {};
exports.helper = helper;

var log4js = require('log4js');
var fs = require("fs");
var path = require("path");

// 加載配置文件
var objConfig = JSON.parse(fs.readFileSync("log4js.json", "utf8"));

// 檢查配置文件所需的目錄是否存在，不存在時創建
if(objConfig.appenders){
    var baseDir = objConfig["customBaseDir"];
    var defaultAtt = objConfig["customDefaultAtt"];

    for(var i= 0, j=objConfig.appenders.length; i<j; i++){
        var item = objConfig.appenders[i];
        if(item["type"] == "console")
            continue;

        if(defaultAtt != null){
            for(var att in defaultAtt){
                if(item[att] == null)
                    item[att] = defaultAtt[att];
            }
        }
        if(baseDir != null){
            if(item["filename"] == null)
                item["filename"] = baseDir;
            else
                item["filename"] = baseDir + item["filename"];
        }
        var fileName = item["filename"];
        if(fileName == null)
            continue;
        var pattern = item["pattern"];
        if(pattern != null){
            fileName += pattern;
        }
        var category = item["category"];
        if(!isAbsoluteDir(fileName))//path.isAbsolute(fileName))
            throw new Error("配置節" + category + "的路徑不是絕對路徑:" + fileName);
        var dir = path.dirname(fileName);
        checkAndCreateDir(dir);
    }
}

// 目錄創建完畢，才加載配置，不然會出異常
log4js.configure(objConfig);

var logDebug = log4js.getLogger('logDebug');
var logInfo = log4js.getLogger('logInfo');
var logWarn = log4js.getLogger('logWarn');
var logErr = log4js.getLogger('logErr');

helper.writeDebug = function(msg){
    if(msg == null)
        msg = "";
    logDebug.debug(msg);
};

helper.writeInfo = function(msg){
    if(msg == null)
        msg = "";
    logInfo.info(msg);
};

helper.writeWarn = function(msg){
    if(msg == null)
        msg = "";
    logWarn.warn(msg);
};

helper.writeErr = function(msg, exp){
    if(msg == null)
        msg = "";
    if(exp != null)
        msg += "\r\n" + exp;
    logErr.error(msg);
};

// 配合express用的方法
exports.use = function(app) {
    //頁面請求日志, level用auto時,默認級別是WARN
    app.use(log4js.connectLogger(logInfo, {level:'debug', format:':method :url'}));
}

// 判斷日志目錄是否存在，不存在時創建日志目錄
function checkAndCreateDir(dir){
    if(!fs.existsSync(dir)){
        fs.mkdirSync(dir);
    }
}

// 指定的字符串是否絕對路徑
function isAbsoluteDir(path){
    if(path == null)
        return false;
    var len = path.length;

    var isWindows = process.platform === 'win32';
    if(isWindows){
        if(len <= 1)
            return false;
        return path[1] == ":";
    }else{
        if(len <= 0)
            return false;
        return path[0] == "/";
    }
}

 3、代碼調用：

var logger = require("./logHelper").helper;
logger.writeInfo("哈哈1開始記錄日志");
logger.writeErr("出錯了，你怎么搞的");

4、跟express集成，可以輸出客戶端GET 或 POST的url（如果沒用，或者不需要記錄url，這段代碼忽略）：

//在app.js中添加以下代碼, 以便在日志中輸出url請求，由於加載順序的原因，放在其他app.use前面
var app = express();
var log = require('./logHelper');
log.use(app);