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

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

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

项目引用方法： npm install log4js

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

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

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

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

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

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封装的文件内容：

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

3、代码调用：

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

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

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