Node.js 常用工具 util

本节介绍Node.js常用工具util。

util作为Node.js的一个核心模块，能够提供常用函数的集合，弥补核心JavaScript的功能过于精简的不足。

util.inherits

util.inherits(constructor, superConstructor)是一个实现对象间原型继承的函数。

与常见的基于类的不同，JavaScript的面向对象特性是基于原型的。JavaScript没有提供对象继承的语言级别特性，而是通过原型复制来实现的。

在这里我们只介绍util.inherits的用法，示例如下： 

  1. var util = require('util'); 
  2. function Base() { 
  3.   this.name = 'base'; 
  4.     this.base = 1991; 
  5.     this.sayHello = function() { 
  6.       console.log('Hello ' + this.name); 
  7.     }; 
  8. } 
  9. Base.prototype.showName = function() { 
  10.   console.log(this.name);
  11. }; 
  12. function Sub() { 
  13.     this.name = 'sub'; 
  14. } 
  15. util.inherits(Sub, Base); 
  16. var objBase = new Base(); 
  17. objBase.showName(); 
  18. objBase.sayHello(); 
  19. console.log(objBase); 
  20. var objSub = new Sub(); 
  21. objSub.showName(); 
  22. //objSub.sayHello(); 
  23. console.log(objSub);

我们定义了一个基础对象Base和一个继承自Base的Sub，Base有三个在构造函数内定义的属性和一个原型中定义的函数，通过util.inherits实现继承。运行结果如下：

  1. base 
  2. Hello base 
  3. { name: 'base', base: 1991, sayHello: [Function] } 
  4. sub 
  5. { name: 'sub' }

注意：Sub仅仅继承了Base在原型中定义的函数，而构造函数内部创造的base属性和sayHello函数都没有被Sub继承。

同时，在原型中定义的属性不会被console.log作为对象的属性输出。如果我们去掉objSub.sayHello(); 这行的注释，将会看到：

  1. node.js:201 
  2. throw e; // process.nextTick error, or 'error' event on first tick 
  3. ^ 
  4. TypeError: Object #<Sub> has no method 'sayHello' 
  5. at Object.<anonymous> (/home/byvoid/utilinherits.js:29:8) 
  6. at Module._compile (module.js:441:26) 
  7. at Object..js (module.js:459:10) 
  8. at Module.load (module.js:348:31) 
  9. at Function._load (module.js:308:12) 
  10. at Array.0 (module.js:479:10) 
  11. at EventEmitter._tickCallback (node.js:192:40)

util.inspect

util.inspect(object,[showHidden],[depth],[colors])方法可以将任意对象转换为字符串，通常用于调试和错误输出。它至少接受一个object参数，即要转换的对象。

showHidden是一个可选参数，如果值为true，将会输出更多隐藏信息。

depth表示最大递归的层数，如果对象很复杂，你可以指定层数以控制输出信息的多少。如果不指定depth，则默认递归2层，指定为null时表示将不限递归层数完整遍历对象。 如果color值为true，则输出格式将会以ANSI颜色编码，通常用于在终端显示更漂亮的效果。

特别要指出的是，util.inspect并不会简单地直接把对象转换为字符串，即使该对象定义了toString方法也不会调用。

  1. var util = require('util'); 
  2. function Person() { 
  3.   this.name = 'byvoid'; 
  4.   this.toString = function() { 
  5.  return this.name; 
  6.     }; 
  7. } 
  8. var obj = new Person(); 
  9. console.log(util.inspect(obj)); 
  10. console.log(util.inspect(obj, true));

运行结果是： 

  1. { name: 'byvoid', toString: [Function] } 
  2. { toString: 
  3. { [Function] 
  4. [prototype]: { [constructor]: [Circular] }, 
  5. [caller]: null, 
  6. [length]: 0, 
  7. [name]: '', 
  8. [arguments]: null }, 
  9. name: 'byvoid' }

util.isArray(object)

如果给定的参数 "object" 是一个数组返回true，否则返回false。

  1. var util = require('util');
  2.  
  3. util.isArray([])
  4.   // true
  5. util.isArray(new Array)
  6.   // true
  7. util.isArray({})
  8.   // false

util.isRegExp(object)

如果给定的参数"object"是一个正则表达式返回true，否则返回false。

  1. var util = require('util');
  2.  
  3. util.isRegExp(/some regexp/)
  4.   // true
  5. util.isRegExp(new RegExp('another regexp'))
  6.   // true
  7. util.isRegExp({})
  8.   // false

util.isDate(object)

如果给定的参数 "object" 是一个日期返回true，否则返回false。

  1. var util = require('util');
  2.  
  3. util.isDate(new Date())
  4.   // true
  5. util.isDate(Date())
  6.   // false (without 'new' returns a String)
  7. util.isDate({})
  8.   // false

util.isError(object)

如果给定的参数 "object" 是一个错误对象返回true，否则返回false。

  1. var util = require('util');
  2.  
  3. util.isError(new Error())
  4.   // true
  5. util.isError(new TypeError())
  6.   // true
  7. util.isError({ name: 'Error', message: 'an error occurred' })
  8.   // false

更多详情可以访问 http://nodejs.org/api/util.html 了解详细内容。