Node.js 常用工具

util 是一個Node.js 核心模塊,提供常用函數的集合,用於彌補核心 JavaScript 的功能 過於精簡的不足。

使用方法如下:

const util = require('util');

util.callbackify

util.callbackify(original)async 異步函數(或者一個返回值為 Promise 的函數)轉換成遵循異常優先的回調風格的函數,例如將 (err, value) => ... 回調作為最後一個參數。 在回調函數中,第一個參數為拒絕的原因(如果 Promise 解決,則為 null),第二個參數則是解決的值。

實例

const util = require('util');

async function fn() {
  return 'hello world';
}
const callbackFunction = util.callbackify(fn);

callbackFunction((err, ret) => {
  if (err) throw err;
  console.log(ret);
});

以上代碼輸出結果為:

hello world

回調函數是異步執行的,並且有異常堆棧錯誤追蹤。 如果回調函數拋出一個異常,進程會觸發一個 'uncaughtException' 異常,如果沒有被捕獲,進程將會退出。

null 在回調函數中作為一個參數有其特殊的意義,如果回調函數的首個參數為 Promise 拒絕的原因且帶有返回值,且值可以轉換成布爾值 false,這個值會被封裝在 Error 對象裏,可以通過屬性 reason 獲取。

function fn() {
  return Promise.reject(null);
}
const callbackFunction = util.callbackify(fn);

callbackFunction((err, ret) => {
  // 當 Promise 被以 `null` 拒絕時,它被包裝為 Error 並且原始值存儲在 `reason` 中。
  err && err.hasOwnProperty('reason') && err.reason === null;  // true
});

original 為 async 異步函數。該函數返回傳統回調函數。


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 表示將不限遞歸層數完整遍曆對象。 如果 colors 值為 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

更多詳情可以訪問 http://nodejs.org/api/util.html 了解詳細內容。