1、参考:Node.js 常用工具 | 菜鸟教程
2、实践、截图
util 模块是 Node.js 的一个内置模块,包含了实用工具函数,用于支持 JavaScript 编程中的调试、错误处理、格式化等功能。
util 提供常用函数的集合,用于弥补核心 JavaScript 的功能过于精简的不足。
util 模块中的功能涵盖了从对象检查、继承到格式化字符串等多个方面。
导入 util 模块
首先,你需要导入 util 模块:
const util = require('util');
应用实例
util.format() - 字符串格式化
util.format() 用于生成格式化字符串,支持占位符如 %s、%d 和 %j,分别代表字符串、数字和 JSON。
const util = require('util');
const name = 'Alice';
const age = 25;
console.log(util.format('Name: %s, Age: %d', name, age)); // 输出: Name: Alice, Age: 25
util.promisify() - 转换回调函数为 Promise
util.promisify() 将传统回调风格的函数转换为返回 Promise 的函数,从而可以与 async/await 一起使用。
const util = require('util');
const fs = require('fs');
// 将回调风格的 fs.readFile 转换为返回 Promise 的函数
const readFileAsync = util.promisify(fs.readFile);
(async () => {
try {
const data = await readFileAsync('example.txt', 'utf8');
console.log(data);
} catch (err) {
console.error(err);
}
})();
util.callbackify() - 将 Promise 转换为回调
util.callbackify() 将返回 Promise 的函数转换为回调风格的函数,便于在需要回调的代码环境中使用。
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);
});
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 实现继承。运行结果如下:
注意:Sub 仅仅继承了Base 在原型中定义的函数,而构造函数内部创造的 base 属 性和 sayHello 函数都没有被 Sub 继承。
同时,在原型中定义的属性不会被 console.log 作 为对象的属性输出。如果我们去掉 objSub.sayHello(); 这行的注释,将会看到:
注意:在 ES6 出现之前,util.inherits 是 Node.js 中实现继承的主要方法。但是,ES6 之后推荐使用 class 和 extends 语法,这样继承的代码更具可读性。
util.isArray(object)
如果给定的参数 "object" 是一个数组返回 true,否则返回 false。
var util = require('util');
console.log(util.isArray([]))
// true
console.log(util.isArray(new Array))
// true
console.log(util.isArray({}))
// false
util.isRegExp(object)
如果给定的参数 "object" 是一个正则表达式返回true,否则返回false。
var util = require('util');
console.log(util.isRegExp(/some regexp/))
// true
console.log(util.isRegExp(new RegExp('another regexp')))
// true
console.log(util.isRegExp({}))
util.isDate(object)
如果给定的参数 "object" 是一个日期返回true,否则返回false。
var util = require('util');
console.log(util.isDate(new Date()))
// true
console.log(util.isDate(Date()))
// false (without 'new' returns a String)
console.log(util.isDate({}))
// false