欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Node.js API详解之 util模块用法实例分析

程序员文章站 2022-03-23 07:57:21
本文实例讲述了node.js api详解之 util模块用法。分享给大家供大家参考,具体如下:node.js api详解之 utilutil 模块主要用于支持 node.js 内部 api 的需求。提...

本文实例讲述了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 – json
%o – object(包括不可枚举的属性方法)
%o – object(不包括不可枚举属性)
%% – 单个百分号('%')不消耗参数。

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程序设计有所帮助。