Node.js Console

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.stdoutprocess.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.stdoutprocess.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.logconsole.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.errorconsole.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])

这个功能可以做一个简单的断言测试,如果参数valuefalse,则会抛出一个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进行总结的,如您在阅读的过程中发现问题,请联系作者,感谢您的支持!

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容

  • Node.js 全局对象 JavaScript 中有一个特殊的对象,称为全局对象(Global Object),它...
    FTOLsXD阅读 399评论 0 2
  • https://nodejs.org/api/documentation.html 工具模块 Assert 测试 ...
    KeKeMars阅读 6,278评论 0 6
  • Node.js是目前非常火热的技术,但是它的诞生经历却很奇特。 众所周知,在Netscape设计出JavaScri...
    w_zhuan阅读 3,603评论 2 41
  • 个人入门学习用笔记、不过多作为参考依据。如有错误欢迎斧正 目录 简书好像不支持锚点、复制搜索(反正也是写给我自己看...
    kirito_song阅读 2,434评论 1 37
  • 谁也不知道另一个人的记忆所止处,这句话出自《边城》。其实我们生活中的矛盾,苦恼多数也是不明白另一个人的记忆所止处。...
    菊子跳跳阅读 1,306评论 0 1