Node.js API詳解之 util模塊用法實例分析

本文實例講述了Node.js API詳解之 util模塊用法。分享給大家供大家參考，具體如下：
Node.js API詳解之 util
util 模塊主要用於支持 Node.js 內部 API 的需求。提供了大部分實用工具。
通過 const util = require(‘util'); 的方式引用util模塊
util.callbackify(original)
說明：
original：傳遞一個 async 函數，或者是一個返回Promise的異步函數。
callbackify會返回一個方法，執行該方法時傳遞一個回調函數，回調函數的第一個參數是err，第二個是異步函數的返回值。
demo：
const util = require('util'); async function fn() { return await Promise.resolve('hello isjs'); } const callbackFunction = util.callbackify(fn); callbackFunction((err, ret) => { if (err) throw err; console.log(ret); }); //輸出： hello isjs
util.debuglog(section)
說明：
util.debuglog() 方法用於創建一個函數，基於 NODE_DEBUG 環境變量的存在與否有條件地寫入調試信息到 stderr。
如果 section 名稱在環境變量的值中，則返回的函數類似於 console.error()。 否則，返回的函數是一個空操作。
section：一個字符串，指定要為應用的哪些部分創建 debuglog 函數。
demo：
const util = require('util'); const debuglog = util.debuglog('foo'); debuglog('hello from foo [%d]', 123);
util.deprecate(function, string)
說明：
該方法會包裝給定的 function 或類，並標記為廢棄的。
demo:
const util = require('util'); function isBoolean(obj){ return (obj === true || obj === false); } isBoolean = util.deprecate(isBoolean, 'isBoolean 方法已被廢棄'); isBoolean(true); //輸出：(node:9911) DeprecationWarning: isBoolean 方法已被廢棄
util.format(format[, …args])
說明：
util.format() 方法返回一個格式化後的字符串，
format：第一個參數是一個字符串，包含零個或多個佔位符。
每個佔位符會被對應參數轉換後的值所替換。 支持的佔位符有：
%s：字符串
%d：數值（整數或浮點數）
%i：整數
%f：浮點數
%j �C JSON
%o �C Object（包括不可枚舉的屬性方法）
%O �C Object（不包括不可枚舉屬性）
%% �C 單個百分號（'%'）不消耗參數。
demo：
const util = require('util'); var formatString = util.format('%s %d %i %f %j', 'hello', 1.123, 123, 2.1, "{'name': 'xiao', 'age': '18'}"); console.log(formatString); //e輸出： hello 1.123 123 2.1 "{'name': 'xiao', 'age': '18'}" //如果佔位符沒有對應的參數，則佔位符不被替換。 formatString = util.format('%s , %s', 'hello'); console.log(formatString); //輸出： hello , %s //如果傳入的參數比佔位符的數量多，則多出的參數會被強制轉換為字符串， //然後拼接到返回的字符串，參數之間用一個空格分隔。 formatString = util.format('%s , %s', 'hello', 'isjs', '!'); console.log(formatString); //輸出： hello , isjs ! //如果第一個參數不是一個字符串，則返回一個所有參數用空格分隔並連在一起的字符串 formatString = util.format(1, 2, 3); console.log(formatString); //輸出： 1 2 3 //如果只傳入佔位符而不傳入參數，則原樣返回 formatString = util.format('%% , %s'); console.log(formatString); //輸出： %% , %s
util.inherits(constructor, superConstructor)
說明：
注意，不建議使用 util.inherits()。 請使用 ES6 的 class 和 extends 關鍵詞獲得語言層面的繼承支持。
從一個構造函數中繼承原型方法到另一個。
constructor 的 prototype 會被設置到一個從 superConstructor 創建的新對象上。
superConstructor 可通過 constructor.super_ 屬性訪問
demo：
const util = require('util'); const EventEmitter = require('events'); function MyStream() { EventEmitter.call(this); } util.inherits(MyStream, EventEmitter); MyStream.prototype.write = function(data) { this.emit('data', data); }; const stream = new MyStream(); console.log(stream instanceof EventEmitter); // true console.log(MyStream.super_ === EventEmitter); // true stream.on('data', (data) => { console.log(`接收的數據："${data}"`); }); stream.write('運作良好！'); // 接收的數據："運作良好！" //建議使用 ES6 的 class 和 extends： const EventEmitter = require('events'); class MyStream extends EventEmitter { write(data) { this.emit('data', data); } } const stream = new MyStream(); stream.on('data', (data) => { console.log(`接收的數據："${data}"`); }); stream.write('使用 ES6');
util.inspect(object[, options])
說明：
方法返回 object 的字符串表示，主要用於調試。
object: 任何 JavaScript 原始值或對象
options: 可用於改變格式化字符串的某些方面。
demo:
const util = require('util'); const inspectOpt = { showHidden: false,//如果為 true，則 object 的不可枚舉的符號與屬性也會被包括在格式化後的結果中。 depth: 2,//指定格式化 object 時遞歸的次數。 默認為 2。 若要無限地遞歸則傳入 null。 colors: false,//如果為 true，則輸出樣式使用 ANSI 顏色代碼。 默認為 false。 customInspect: true,//如果為 false，則 object 上自定義的 inspect(depth, opts) 函數不會被調用。 默認為 true showProxy: false,//如果為 true，則 Proxy 對象的對象和函數會展示它們的 target 和 handler 對象。 默認為 false maxArrayLength: 100,//指定格式化時數組和 TypedArray 元素能包含的最大數量。 默認為 100。 設為 null 則顯式全部數組元素。 設為 0 或負數則不顯式數組元素。 breakLength: 60//一個對象的鍵被拆分成多行的長度。 設為 Infinity 則格式化一個對象為單行。 默認為 60。 }; console.log(util.inspect(util, inspectOpt));
util.inspect.styles, util.inspect.colors
說明：
可以通過 util.inspect.styles 和 util.inspect.colors 屬性全局地自定義 util.inspect 的顏色輸出（如果已啟用）。
預定義的顏色代碼有：white、grey、black、blue、cyan、green、magenta、red 和 yellow。
還有 bold、italic、underline 和 inverse 代碼。
顏色樣式使用 ANSI 控制碼，可能不是所有終端都支持。
demo：
const util = require('util'); console.log(util.inspect.styles); // { special: 'cyan', // number: 'yellow', // boolean: 'yellow', // undefined: 'grey', // null: 'bold', // string: 'green', // symbol: 'green', // date: 'magenta', // regexp: 'red' } console.log(util.inspect.colors); // { bold: [ 1, 22 ], // italic: [ 3, 23 ], // underline: [ 4, 24 ], // inverse: [ 7, 27 ], // white: [ 37, 39 ], // grey: [ 90, 39 ], // black: [ 30, 39 ], // blue: [ 34, 39 ], // cyan: [ 36, 39 ], // green: [ 32, 39 ], // magenta: [ 35, 39 ], // red: [ 31, 39 ], // yellow: [ 33, 39 ] }
util.inspect.custom
說明：
util.inspect.custom是一個符號，可被用於聲明自定義的查看函數:[util.inspect.custom](depth, opts)
自定義 inspect 方法的返回值可以使任何類型的值，它會被 util.inspect() 格式化。
demo：
const util = require('util'); class Box { [util.inspect.custom](depth, options) { return "myInspect"; } } const box = new Box(); console.log(util.inspect(box)); // 輸出：myInspect
util.inspect.defaultOptions
說明：
defaultOptions 值允許對 util.inspect 使用的默認選項進行自定義。
它需被設為一個對象，包含一個或多個有效的 util.inspect() 選項。 也支持直接設置選項的屬性。
demo:
const util = require('util'); util.inspect.defaultOptions = { showHidden: true, depth:3 }; util.inspect.defaultOptions.breakLength = 30; console.log(util.inspect.defaultOptions); // { showHidden: true, // depth: 3, // colors: false, // customInspect: true, // showProxy: false, // maxArrayLength: 100, // breakLength: 30 }
util.promisify(original)
說明：
讓一個遵循通常的 Node.js error first回調風格的函數，回調函數是最後一個參數, 返回一個返回值是一個 promise 版本的函數。
demo:
const util = require('util'); const fs = require('fs'); const stat = util.promisify(fs.stat); stat('.').then((stats) => { // Do something with `stats` }).catch((error) => { // Handle the error. });
util.promisify.custom
說明：
使用util.promisify.custom符號可以自定義promisified功能。
demo:
const util = require('util'); function doSomething(foo, callback) { // ... } doSomething[util.promisify.custom] = function(foo) { return getPromiseSomehow(); }; const promisified = util.promisify(doSomething); console.log(promisified === doSomething[util.promisify.custom]); // 輸出： true
類：util.TextEncoder
說明：
該類用來對文本進行編碼
textEncoder.encode([input])
說明：
對input字符串進行編碼並返回一個Uint8Array包含編碼字節的字符串
textEncoder.encoding
說明：
TextEncoder實例支持的編碼。總是設置為'utf-8'。
demo：
const encoder = new TextEncoder(); const uint8array = encoder.encode('this is some data'); console.log(encoder.encoding) //utf-8
類：util.TextDecoder
說明：
該類用來解析編碼後的文本
new TextDecoder([encoding[, options]])
說明：
創建一個TextDecoder實例。
encoding： 編碼方式，默認'utf-8′
options: 選項
fatal: 解碼發生的錯誤將導致 TypeError被拋出。默認為 false
ignoreBOM: 解碼結果中是否會包含字節順序標記。默認為false。僅當encoding的值為'utf-8'，'utf-16be'或'utf-16le'時有效。
textDecoder.decode([input[, options]])
說明：
解碼input並返回一個字符串。
input: 待解碼數據
options.stream: 如果需要額外的數據塊，設置為true。默認為false。
textDecoder.encoding
說明：
返回textDecoder實例支持的編碼。
textDecoder.fatal
說明：
返回textDecoder實例的fatal屬性，
textDecoder.ignoreBOM
說明：
返回解碼結果是否包含字節順序標記
希望本文所述對大家node.js程序設計有所幫助。