log.js

github地址：传送门

简介

这是一个日志记录的模块。具体有两个功能： 输入和输出。

输入

这里所说的输入，指的是输入到文件夹，或者显示在控制台上。所以，严格来说，这是一个记录日志的功能。
首先是定义了好几个不同级别的输出模式。在初始化的时候传入某个级别（默认是debug模式），在这个等级之上都可以输出到stream（控制台或者文件）
其中的核心方法是 this.log

log: function(levelStr, args) {
    if (exports[levelStr] <= this.level) {
      var msg = fmt.apply(null, args);
      this.stream.write(
          '[' + new Date + ']'
        + ' ' + levelStr
        + ' ' + msg
        + '\n'
      );
    }
  }

在初始化的时候，默认等级是exports.debug(7),调用者可以自定义输出不同等级的信息，如 log.info(1) ，因为info比 debug在数值上要小，符合 exports[levelStr] <= this.level,所以会被输出。
各种级别的数值如下

exports.ALERT = 1;
exports.CRITICAL = 2;
exports.ERROR = 3;
exports.WARNING = 4;
exports.NOTICE = 5;
exports.INFO = 6;
exports.DEBUG = 7;

输出

原理：读取文件，然后按照一定格式显示在控制台上
核心方法如下：

read: function(){
    var buf = ''
      , self = this
      , stream = this.stream;

    stream.setEncoding('utf8');
    stream.on('data', function(chunk){
      buf += chunk;
      if ('\n' != buf[buf.length - 1]) return;
      buf.split('\n').map(function(line){
        if (!line.length) return;
        try {
          var captures = line.match(/^\[([^\]]+)\] (\w+) (.*)/);
          var obj = {
              date: new Date(captures[1])
            , level: exports[captures[2]]
            , levelString: captures[2]
            , msg: captures[3]
          };
          self.emit('line', obj);
        } catch (err) {
          // Ignore
        }
      });
      buf = '';
    });
    stream.on('end', function(){
      self.emit('end');
    });
  }

这个方法里面有三个操作：

1. 设置编码格式（utf8）
2. data事件 将读取的数据，进行分割（\n标志），然后将每行记录转化成一个object，再打印出来。这里用到一个 self.emit('line')事件，然后再外层增加 on('line')事件捕获，然后打印出来。
3. end事件（我没有完全看懂，应该是通知调用者，数据读完啦）

stream

上面输入输出功能都会涉及到stream。这个是可配置的，在初始化的时候，可以指定是哪一种流。在给出的example中，分别为文件流和process.stdout，前者操作文件，后者操作控制台。

最后

这个Log类继承于EventEmitter，得到了它的事件功能。源码是这样的：

Log.prototype.__proto__ = EventEmitter.prototype;

我对这种写法不太感冒，钥匙我来写的话，应该是这样的

require('util').inherits(EventEmitter);

两种写法的效果差不多的，当然，还有别的方法，比如 prototype

小结

这个日志模块还是挺简单地，在实际项目中，可能不会用到，但这里提供了一个很好的学习机会。通过阅读此源码，我们可以知道一般的日志模块是怎么工作的，可以去阅读更大型的日志模块，如 log4js，甚至可以自己修改或者重写，打造一个更加适用自己的插件。