Node.js 教程
util 是一個Node.js 核心模塊,提供常用函數(shù)的集合,用于彌補核心 JavaScript 的功能 過于精簡的不足。
使用方法如下:
const util = require('util');
util.callbackify(original) 將 async
異步函數(shù)(或者一個返回值為 Promise
的函數(shù))轉(zhuǎn)換成遵循異常優(yōu)先的回調(diào)風(fēng)格的函數(shù),例如將 (err, value) => ...
回調(diào)作為最后一個參數(shù)。
在回調(diào)函數(shù)中,第一個參數(shù)為拒絕的原因(如果 Promise
解決,則為 null
),第二個參數(shù)則是解決的值。
以上代碼輸出結(jié)果為:
hello world
回調(diào)函數(shù)是異步執(zhí)行的,并且有異常堆棧錯誤追蹤。 如果回調(diào)函數(shù)拋出一個異常,進(jìn)程會觸發(fā)一個 'uncaughtException' 異常,如果沒有被捕獲,進(jìn)程將會退出。
null 在回調(diào)函數(shù)中作為一個參數(shù)有其特殊的意義,如果回調(diào)函數(shù)的首個參數(shù)為 Promise 拒絕的原因且?guī)в蟹祷刂?,且值可以轉(zhuǎn)換成布爾值 false,這個值會被封裝在 Error 對象里,可以通過屬性 reason 獲取。
function fn() { return Promise.reject(null); } const callbackFunction = util.callbackify(fn); callbackFunction((err, ret) => { // 當(dāng) Promise 被以 `null` 拒絕時,它被包裝為 Error 并且原始值存儲在 `reason` 中。 err && err.hasOwnProperty('reason') && err.reason === null; // true });
original 為 async 異步函數(shù)。該函數(shù)返回傳統(tǒng)回調(diào)函數(shù)。
util.inherits(constructor, superConstructor) 是一個實現(xiàn)對象間原型繼承的函數(shù)。
JavaScript 的面向?qū)ο筇匦允腔谠偷?,與常見的基于類的不同。JavaScript 沒有提供對象繼承的語言級別特性,而是通過原型復(fù)制來實現(xiàn)的。
在這里我們只介紹 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);
我們定義了一個基礎(chǔ)對象 Base 和一個繼承自 Base 的 Sub,Base 有三個在構(gòu)造函數(shù)內(nèi)定義的屬性和一個原型中定義的函數(shù),通過util.inherits 實現(xiàn)繼承。運行結(jié)果如下:
base Hello base { name: 'base', base: 1991, sayHello: [Function] } sub { name: 'sub' }
注意:Sub 僅僅繼承了Base 在原型中定義的函數(shù),而構(gòu)造函數(shù)內(nèi)部創(chuàng)造的 base 屬 性和 sayHello 函數(shù)都沒有被 Sub 繼承。
同時,在原型中定義的屬性不會被 console.log 作 為對象的屬性輸出。如果我們?nèi)サ?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(object,[showHidden],[depth],[colors]) 是一個將任意對象轉(zhuǎn)換 為字符串的方法,通常用于調(diào)試和錯誤輸出。它至少接受一個參數(shù) object,即要轉(zhuǎn)換的對象。
showHidden 是一個可選參數(shù),如果值為 true,將會輸出更多隱藏信息。
depth 表示最大遞歸的層數(shù),如果對象很復(fù)雜,你可以指定層數(shù)以控制輸出信息的多 少。如果不指定depth,默認(rèn)會遞歸 2 層,指定為 null 表示將不限遞歸層數(shù)完整遍歷對象。 如果 colors 值為 true,輸出格式將會以 ANSI 顏色編碼,通常用于在終端顯示更漂亮 的效果。
特別要指出的是,util.inspect 并不會簡單地直接把對象轉(zhuǎn)換為字符串,即使該對 象定義了 toString 方法也不會調(diào)用。
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));
運行結(jié)果是:
Person { name: 'byvoid', toString: [Function] } Person { name: 'byvoid', toString: { [Function] [length]: 0, [name]: '', [arguments]: null, [caller]: null, [prototype]: { [constructor]: [Circular] } } }
如果給定的參數(shù) "object" 是一個數(shù)組返回 true,否則返回 false。
var util = require('util'); util.isArray([]) // true util.isArray(new Array) // true util.isArray({}) // false
如果給定的參數(shù) "object" 是一個正則表達(dá)式返回true,否則返回false。
var util = require('util'); util.isRegExp(/some regexp/) // true util.isRegExp(new RegExp('another regexp')) // true util.isRegExp({}) // false
如果給定的參數(shù) "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 了解詳細(xì)內(nèi)容。