模块概览

console模块提供了基础的调试功能。使用很简单，常用的API主要有 console.log()、console.error()。

此外，可以基于Console类，方便的扩展出自己的console实例，比如把调试信息打印到文件里，而部署输出在控制台上。

直接看例子。

基础例子

无特殊说明，日志都是默认打印到控制台。最常用的是console.log()、console.error()两个方法。

  • console.log(msg)：普通日志打印。
  • console.error(msg)：错误日志打印。
  • console.info(msg)：等同于console.log(msg)
  • console.warn(msg)：等同于console.error(msg)

例子如下：

  1. console.log('log: hello');
  2. console.log('log: hello', 'chyingp');
  3. console.log('log: hello %s', 'chyingp');
  5. console.error('error: hello');
  6. console.error('error: hello', 'chyingp');
  7. console.error('error: hello %s', 'chyingp');
  9. // 输出如下：
  10. // log: hello
  11. // log: hello chyingp
  12. // log: hello chyingp
  13. // error: hello
  14. // error: hello chyingp
  15. // error: hello chyingp

自定义stdout

可以通过 new console.Console(stdout, stderr) 来创建自定义的console实例，这个功能很实用。

比如你想将调试信息打印到本地文件，那么，就可以通过如下代码实现。

  1. var fs = require('fs');
  2. var file = fs.createWriteStream('./stdout.txt');
  4. var logger = new console.Console(file, file);
  6. logger.log('hello');
  7. logger.log('word');
  9. // 备注：内容输出到 stdout.txt里，而不是打印到控制台

计时

通过console.time(label)和console.timeEnd(label)，来打印出两个时间点之间的时间差，单位是毫秒，例子如下。

  1. var timeLabel = 'hello'
  3. console.time(timeLabel);
  5. setTimeout(console.timeEnd, 1000, timeLabel);
  6. // 输入出入：
  7. // hello: 1005.505ms

断言

通过 console.assert(value, message) 进行断言。如果value不为true，那么抛出AssertionError异常，并中断程序执行。

如下代码所示，第二个断言报错，程序停止执行。

  1. console.assert(true, '1、right');
  2. console.assert(false, '2、right', '2、wrong');
  4. // 输出如下：
  5. // assert.js:90
  6. //   throw new assert.AssertionError({
  7. //     ^
  8. //     AssertionError: 2、right 2、wrong
  9. //         at Console.assert (console.js:95:23)

为避免程序异常退出，需要对上面的异常进行处理，比如：

  1. try{
  2.     console.assert(false, 'error occurred');
  3. }catch(e){
  4.     console.log(e.message);
  5. }
  7. // 输出如下：
  8. // error occurred

打印错误堆栈：console.trace(msg)

将msg打印到标准错误输出流里，包含当前代码的位置和堆栈信息。

  1. console.trace('trace is called');
  3. // 输出如下：
  4. // Trace: trace is called
  5. //     at Object.<anonymous> (/Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.12.01-console/trace.js:1:71)
  6. //     at Module._compile (module.js:541:32)
  7. //     at Object.Module._extensions..js (module.js:550:10)
  8. //     at Module.load (module.js:456:32)
  9. //     at tryModuleLoad (module.js:415:12)
  10. //     at Function.Module._load (module.js:407:3)
  11. //     at Function.Module.runMain (module.js:575:10)
  12. //     at startup (node.js:160:18)
  13. //     at node.js:445:3

深层打印

很少关注 console.dir(obj)，因为大部分时候表现跟 console.log(obj) 差不多，看例子

  1. var obj = {
  2.     nick: 'chyingp'
  3. };
  5. console.log(obj);  // 输出：{ nick: 'chyingp' }
  6. console.dir(obj);  // 输出：{ nick: 'chyingp' }

但当obj的层级比较深时，用处就出来了。可以通过depth自定义打印的层级数，默认是2，这对于调试很有帮助。

  1. var obj2 = {
  2.     human: {
  3.         man: {
  4.             info: {
  5.                 nick: 'chyingp'
  6.             }
  7.         }
  8.     }
  9. };
  11. console.log(obj2);  // 输出：{ human: { man: { info: [Object] } } }
  12. console.dir(obj2);  // 输出：{ human: { man: { info: [Object] } } }
  14. console.dir(obj2, {depth: 3});  // 输出：{ human: { man: { info: { nick: 'chyingp' } } } }

相关链接

官方文档：https://nodejs.org/api/console.html