log4js-Node.js中的日誌管理模組使用與封裝
阿新 • • 發佈:2019-01-06
開發過程中,日誌記錄是必不可少的事情,尤其是生產系統中經常無法除錯,因此日誌就成了重要的除錯資訊來源。
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);