Node.js 常用工具
Node.js 常用工具
util 是一個Node.js 核心模組,提供常用函式的集合,用於彌補核心 JavaScript 的功能 過於精簡的不足。
使用方法如下:
const util = require('util');
util.callbackify
util.callbackify(original) 將 async
非同步函式(或者一個返回值為 Promise
的函式)轉換成遵循異常優先的回撥風格的函式,例如將 (err, value) => ...
回撥作為最後一個引數。
在回撥函式中,第一個引數為拒絕的原因(如果 Promise
解決,則為 null
),第二個引數則是解決的值。
例項
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 瞭解詳細內容。