Node.js Console

2017-04-28 本文已影响0人小菜荔枝

Console

稳定性：2-Stable

0x01 你真的了解Node.js的console吗

Console模块与浏览器端JavaScript的console的机制是相似的。说起console，大家的脑海里第一时间想到的可能就是console.log()，没错，它是JavaScript常用的调试方法；其实除了console.log()，Node.js的Console还给开发者提供了其他的调试方法，灵活地使用他们，将更好地帮助我们调试程序。
Console分为两部分：

Console类，其方法可以把输出的内容写入到任意的Node.js流，例如console.log()，console.error()和console.warn()等方法
全局对象console，可以把输出的内容写入process.stdout和process.stderr。因为是全局对象，可以直接使用，不需要调用require('console')

警告：全局对象console的方法既不是同步的，例如浏览器端的console APIs；也不是异步的，例如Node.js的流；具体请参考 Note on process I/O 。本文有一些内容涉及到 Node.js 的 Util 模块，如有疑问请参考作者的文章 Node.js Utilities

0x02 Class:Console

Class:Console可以通过配置输出流来创建一个简单的日志功能，可以通过下面两种方式调用

const Console = require('console').Console;
const Console = console.Console;

new Console(stdout[, stderr])

创建一个Console实例，其参数是一个或连个可写流

stdout 是一个可写流，把log或info的输出写入到这个流
stderr 是一个可写流，把warn或error的输出写入到这个流，如果不传这个参数，warn和error的输出将写入到stdout

利用这个构造函数我们可以做一个简单的logger系统

const fs = require('fs')
const Console = console.Console

const output = fs.createWriteStream('./stdout.log')//Node.js可写的文件流
const errorOutput = fs.createWriteStream('./stderr.log')//Node.js可写的文件流
const logger = new Console(output, errorOutput)//构造Console实例

// 写入output，也就是stdout.log
logger.log('log')
logger.info('info')
// 写入errorOutput，也就是文件stderr.log
logger.error('error')
logger.warn('warn')

全局变量console其实是一个特殊的Console实例，它把输出写入到process.stdout和process.stderr，等价于：

new Console(process.stdout, process.stderr);

console.dir(obj[, options])

这个方法等价于console.log(util.inspect(obj[, options]))

const util = require('util')
let obj = {
  obj: 'sdfsdfwer',
  number: 123,
  test:[1,2,3]
}
let opt = {colors:true}
// 下面两行代码是等价的，而且输出的字符是带颜色的，特别醒目
console.dir(obj, opt)
console.log(util.inspect(obj, opt))

console.log([data][, ...args])和console.info([data][, ...args])

console.log和console.info是等价的，把信息输出到stdout，可以传多个参数，类似于linux开发的 printf方法。这里有二个细节，第一，输出的信息结尾都会加上换行符；第二，所有的参数都先传给util.format()进行格式化，然后再输出

const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout

console.error([data][, ...args])和console.warn([data][, ...args])

console.error和console.warn是等价的，把信息输出到stderr，其他的使用方法跟console.log一样

const code = 5;
console.error('error #%d', code);
// Prints: error #5, to stderr
console.error('error', code);
// Prints: error 5, to stderr

console.time(label)和console.timeEnd(label)

这两个方法通常一起使用来计算某些程序的运行时间。调用console.time(label)时会开启一个计时器，计时器通过参数label进行区分，当调用console.timeEnd(label)时，相同label的计时器就会停止，同时，会计算从计时器开始到结束这期间的毫秒数，并将结果输出到stdout，精确度是亚毫秒

console.time('100-elements');
for (let i = 0; i < 100; i++) {
  ;
}
console.timeEnd('100-elements');
// prints 100-elements: 0.060ms

注意：从Node.js v6.0.0起，调用console.timeEnd()会删除计时器以避免其泄露。在之前的版本，计时器将会继续，不会删除。这可能会造成同一个label，调用多次console.timeEnd()的情况，所以这种情况之前Node.js社区的人也没有想到，v6版本以后就不会再出现了

console.trace(message[, ...args])

首先把字符串'Trace: messsage'打印出来，然后再把代码中当前位置的堆栈跟踪信息通过util.format()格式化后打印到stderr。

console.trace('Show me');
// Prints: (stack trace will vary based on where trace is called)
//  Trace: Show me
//    at repl:2:9
//    at REPLServer.defaultEval (repl.js:248:27)
//    at bound (domain.js:287:14)
//    at REPLServer.runBound [as eval] (domain.js:300:12)
//    at REPLServer.<anonymous> (repl.js:412:12)
//    at emitOne (events.js:82:20)
//    at REPLServer.emit (events.js:169:7)
//    at REPLServer.Interface._onLine (readline.js:210:10)
//    at REPLServer.Interface._line (readline.js:549:8)
//    at REPLServer.Interface._ttyWrite (readline.js:826:14)

console.assert(value[, message][, ...args])

这个功能可以做一个简单的断言测试，如果参数value是false，则会抛出一个AssertionError的错误，错误信息都是通过util.format()格式化的

console.assert(true, 'does nothing');
// OK
console.assert(false, 'Whoops %s', 'didn\'t work');
// AssertionError: Whoops didn't work

注意：Node.js的console.assert()与浏览器端的实现是不一样的，详细点说，浏览器端的console.assert()如果断言错误则会打印错误信息到控制台，不会终止运行后续的代码。但在Node.js中，会抛出AssertionError错误。
如果要在Node.js环境实现浏览器端的console.assert()功能，可以扩展Node.js的console来重写console.assert()方法

'use strict';

// Creates a simple extension of console with a
// new impl for assert without monkey-patching.
const myConsole = Object.create(console, {
  assert: {
    value: function assert(assertion, message, ...args) {
      try {
        console.assert(assertion, message, ...args);
      } catch (err) {
        console.error(err.stack);
      }
    },
    configurable: true,
    enumerable: true,
    writable: true,
  },
});

module.exports = myConsole;

再创建一个文件引入myConsole，这时console.assert()与浏览器端的console.assert()是一样的

const console = require('./myConsole');
console.assert(false, 'this message will print, but no error thrown');
console.log('this will also print');//不会抛出AssertionError，代码会继续执行

本文档是根据文档Node.js v6.10.2 Documentation进行总结的，如您在阅读的过程中发现问题，请联系作者，感谢您的支持！

简书作者小菜荔枝转载请联系作者获得授权