Node.js 常用工具util包

Node.js 常用工具

util 是一個Node.js 核心子產品，提供常用函數的集合，用于彌補核心JavaScript 的功能 過于精簡的不足。

util.isError(obj);

util.isDate(obj);

util.inherits(constr,super);

util.isRegExp(/some regexp/);

util.isArray(obj);

util.inspect(obj);

util.inherits

util.inherits(constructor, superConstructor)是一個實作對象間原型繼承 的函數。

JavaScript 的面向對象特性是基于原型的，與常見的基于類的不同。JavaScript 沒有 提供對象繼承的語言級别特性，而是通過原型複制來實作的。

在這裡我們隻介紹util.inherits 的用法，示例如下：

var util = require('util'); 
function Base() { 
    this.name = 'base'; 
    this.base = 1991; 
    this.sayHello = function() { 
    console.log('Hello ' + this.name); 
    }; 
} 
Base.prototype.showName = function() { 
    console.log(this.name);
}; 
function Sub() { 
    this.name = 'sub'; 
} 
util.inherits(Sub, Base); 
var objBase = new Base(); 
objBase.showName(); 
objBase.sayHello(); 
console.log(objBase); 
var objSub = new Sub(); 
objSub.showName(); 
//objSub.sayHello(); 
console.log(objSub);
      

　　

我們定義了一個基礎對象Base 和一個繼承自Base 的Sub，Base 有三個在構造函數 内定義的屬性和一個原型中定義的函數，通過util.inherits 實作繼承。運作結果如下：

base 
Hello base 
{ name: 'base', base: 1991, sayHello: [Function] } 
sub 
{ name: 'sub' }
      

注意：Sub 僅僅繼承了Base 在原型中定義的函數，而構造函數内部創造的 base 屬 性和 sayHello 函數都沒有被 Sub 繼承。

同時，在原型中定義的屬性不會被console.log 作 為對象的屬性輸出。如果我們去掉 objSub.sayHello(); 這行的注釋，将會看到：

node.js:201 
throw e; // process.nextTick error, or 'error' event on first tick 
^ 
TypeError: Object #<Sub> has no method 'sayHello' 
at Object.<anonymous> (/home/byvoid/utilinherits.js:29:8) 
at Module._compile (module.js:441:26) 
at Object..js (module.js:459:10) 
at Module.load (module.js:348:31) 
at Function._load (module.js:308:12) 
at Array.0 (module.js:479:10) 
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 方法也不會調用。

var util = require('util'); 
function Person() { 
    this.name = 'byvoid'; 
    this.toString = function() { 
    return this.name; 
    }; 
} 
var obj = new Person(); 
console.log(util.inspect(obj)); 
console.log(util.inspect(obj, true));
      

運作結果是：

Person { name: 'byvoid', toString: [Function] }
Person {
  name: 'byvoid',
  toString: 
   { [Function]
     [length]: 0,
     [name]: '',
     [arguments]: null,
     [caller]: null,
     [prototype]: { [constructor]: [Circular] } } }
      

util.isArray(object)

如果給定的參數 "object" 是一個數組傳回true，否則傳回false。

var util = require('util');

util.isArray([])
  // true
util.isArray(new Array)
  // true
util.isArray({})
  // false
      

util.isRegExp(object)

如果給定的參數 "object" 是一個正規表達式傳回true，否則傳回false。

var util = require('util');

util.isRegExp(/some regexp/)
  // true
util.isRegExp(new RegExp('another regexp'))
  // true
util.isRegExp({})
  // false
      

util.isDate(object)

如果給定的參數 "object" 是一個日期傳回true，否則傳回false。

var util = require('util');

util.isDate(new Date())
  // true
util.isDate(Date())
  // false (without 'new' returns a String)
util.isDate({})
  // false
      

util.isError(object)

如果給定的參數 "object" 是一個錯誤對象傳回true，否則傳回false。

var util = require('util');

util.isError(new Error())
  // true
util.isError(new TypeError())
  // true
util.isError({ name: 'Error', message: 'an error occurred' })
  // false
      

 摘自：http://www.runoob.com/nodejs/nodejs-util.html