首页 > 代码库 > 项目日志的管理和应用 log4js－Node.js中的日志管理模块使用与封装

项目日志的管理和应用 log4js－Node.js中的日志管理模块使用与封装

2024-09-25 11:33:39   218人阅读

开发过程中，日志记录是必不可少的事情，尤其是生产系统中经常无法调试，因此日志就成了重要的调试信息来源。

Node.js，已经有现成的开源日志模块，就是log4js，源码地址：点击打开链接

项目引用方法： npm install log4js

1、配置说明（仅以常用的dateFile日志类型举例，更多说明参考log4js-wiki）：

[javascript] view plain copy
  1. {   
  2.   "appenders": [   
  3.   // 下面一行应该是用于跟express配合输出web请求url日志的  
  4.   {"type": "console", "category": "console"},   
  5.   // 定义一个日志记录器  
  6.   {        
  7.     "type": "dateFile",                 // 日志文件类型，可以使用日期作为文件名的占位符  
  8.     "filename": "e:/weblogs/logs/",     // 日志文件名，可以设置相对路径或绝对路径  
  9.     "pattern": "debug/yyyyMMddhh.txt",  // 占位符，紧跟在filename后面  
  10.     "absolute": true,                   // filename是否绝对路径  
  11.     "alwaysIncludePattern": true,       // 文件名是否始终包含占位符  
  12.     "category": "logInfo"               // 记录器名  
  13.   } ],  
  14.   "levels":{ "logInfo": "DEBUG"}        // 设置记录器的默认显示级别，低于这个级别的日志，不会输出  
  15. }  


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文件不支持任何形式的注释// 或 /**/，因此上面的配置代码里的注释要全部移除，不然会编译出错的

[javascript] view plain copy
  1. var log4js = require(‘log4js‘);  
  2.   
  3. // 注：配置里的日志目录要先创建，才能加载配置，不然会出异常  
  4. log4js.configure("./log4js.json");  
  5. var logInfo = log4js.getLogger(‘logInfo‘);  
  6. logInfo.info("测试日志信息");  


上述配置和代码，比较简单，我这边参考之前用的C#版本的日志记录类，重新封装了一下log4js，定义了一个logHelper.js

1、log4js.json配置文件内容（定义了4个日志记录器，分别写入到不同的日志目录；并自定义了2个属性，把一些公共属性提取到自定义属性中）：

[javascript] view plain copy
  1. {  
  2.     "customBaseDir" :"e:/weblogs/logs/",  
  3.     "customDefaultAtt" :{  
  4.         "type": "dateFile",  
  5.         "absolute": true,  
  6.         "alwaysIncludePattern": true  
  7.     },  
  8.     "appenders": [  
  9.             {"type": "console", "category": "console"},  
  10.             {"pattern": "debug/yyyyMMddhh.txt", "category": "logDebug"},  
  11.             {"pattern": "info/yyyyMMddhh.txt", "category": "logInfo"},  
  12.             {"pattern": "warn/yyyyMMddhh.txt", "category": "logWarn"},  
  13.             {"pattern": "err/yyyyMMddhh.txt", "category": "logErr"}  
  14.         ],  
  15.         "replaceConsole": true,  
  16.         "levels":{ "logDebug": "DEBUG", "logInfo": "DEBUG", "logWarn": "DEBUG", "logErr": "DEBUG"}  
  17. }  


2、logHelper.js封装的文件内容：

[javascript] view plain copy
  1. var helper = {};  
  2. exports.helper = helper;  
  3.   
  4. var log4js = require(‘log4js‘);  
  5. var fs = require("fs");  
  6. var path = require("path");  
  7.   
  8. // 加载配置文件  
  9. var objConfig = JSON.parse(fs.readFileSync("log4js.json", "utf8"));  
  10.   
  11. // 检查配置文件所需的目录是否存在，不存在时创建  
  12. if(objConfig.appenders){  
  13.     var baseDir = objConfig["customBaseDir"];  
  14.     var defaultAtt = objConfig["customDefaultAtt"];  
  15.   
  16.     for(var i= 0, j=objConfig.appenders.length; i<j; i++){  
  17.         var item = objConfig.appenders[i];  
  18.         if(item["type"] == "console")  
  19.             continue;  
  20.   
  21.         if(defaultAtt != null){  
  22.             for(var att in defaultAtt){  
  23.                 if(item[att] == null)  
  24.                     item[att] = defaultAtt[att];  
  25.             }  
  26.         }  
  27.         if(baseDir != null){  
  28.             if(item["filename"] == null)  
  29.                 item["filename"] = baseDir;  
  30.             else  
  31.                 item["filename"] = baseDir + item["filename"];  
  32.         }  
  33.         var fileName = item["filename"];  
  34.         if(fileName == null)  
  35.             continue;  
  36.         var pattern = item["pattern"];  
  37.         if(pattern != null){  
  38.             fileName += pattern;  
  39.         }  
  40.         var category = item["category"];  
  41.         if(!isAbsoluteDir(fileName))//path.isAbsolute(fileName))  
  42.             throw new Error("配置节" + category + "的路径不是绝对路径:" + fileName);  
  43.         var dir = path.dirname(fileName);  
  44.         checkAndCreateDir(dir);  
  45.     }  
  46. }  
  47.   
  48. // 目录创建完毕，才加载配置，不然会出异常  
  49. log4js.configure(objConfig);  
  50.   
  51. var logDebug = log4js.getLogger(‘logDebug‘);  
  52. var logInfo = log4js.getLogger(‘logInfo‘);  
  53. var logWarn = log4js.getLogger(‘logWarn‘);  
  54. var logErr = log4js.getLogger(‘logErr‘);  
  55.   
  56. helper.writeDebug = function(msg){  
  57.     if(msg == null)  
  58.         msg = "";  
  59.     logDebug.debug(msg);  
  60. };  
  61.   
  62. helper.writeInfo = function(msg){  
  63.     if(msg == null)  
  64.         msg = "";  
  65.     logInfo.info(msg);  
  66. };  
  67.   
  68. helper.writeWarn = function(msg){  
  69.     if(msg == null)  
  70.         msg = "";  
  71.     logWarn.warn(msg);  
  72. };  
  73.   
  74. helper.writeErr = function(msg, exp){  
  75.     if(msg == null)  
  76.         msg = "";  
  77.     if(exp != null)  
  78.         msg += "\r\n" + exp;  
  79.     logErr.error(msg);  
  80. };  
  81.   
  82. // 配合express用的方法  
  83. exports.use = function(app) {  
  84.     //页面请求日志, level用auto时,默认级别是WARN  
  85.     app.use(log4js.connectLogger(logInfo, {level:‘debug‘, format:‘:method :url‘}));  
  86. }  
  87.   
  88. // 判断日志目录是否存在，不存在时创建日志目录  
  89. function checkAndCreateDir(dir){  
  90.     if(!fs.existsSync(dir)){  
  91.         fs.mkdirSync(dir);  
  92.     }  
  93. }  
  94.   
  95. // 指定的字符串是否绝对路径  
  96. function isAbsoluteDir(path){  
  97.     if(path == null)  
  98.         return false;  
  99.     var len = path.length;  
  100.   
  101.     var isWindows = process.platform === ‘win32‘;  
  102.     if(isWindows){  
  103.         if(len <= 1)  
  104.             return false;  
  105.         return path[1] == ":";  
  106.     }else{  
  107.         if(len <= 0)  
  108.             return false;  
  109.         return path[0] == "/";  
  110.     }  
  111. }  


3、代码调用：

[javascript] view plain copy
  1. var logger = require("./logHelper").helper;  
  2. logger.writeInfo("哈哈1开始记录日志");  
  3. logger.writeErr("出错了，你怎么搞的");  


4、跟express集成，可以输出客户端GET 或 POST的url（如果没用，或者不需要记录url，这段代码忽略）：

[javascript] view plain copy
    1. //在app.js中添加以下代码, 以便在日志中输出url请求，由于加载顺序的原因，放在其他app.use前面  
    2. var app = express();  
    3. var log = require(‘./logHelper‘);  
    4. log.use(app); 

项目日志的管理和应用 log4js－Node.js中的日志管理模块使用与封装


联系
我们