util 模块是一类包罗万象的模块。它提供了实用函数来格式化字符串,将对象转换为字符串,检查对象的类型,并执行对输出流的同步写入,以及一些对象继承的增强。
这篇文章主要介绍了如何在 Node.js 应用程序中使用 util 模块。
从类型判断说起
在 JavaScript 中,进行变量的类型校验是一个非常令人头疼的事,如果只是简单的使用 typeof
会到各种各样的问题。
举几个简单的:
console.log(typeof null) // 'object' console.log(typeof new Array) // 'object' console.log(typeof new String) // 'object'
后来,大家发现可以使用 Object.prototype.toString()
方法来进行变量类型的判断。
const getTypeString = obj => Object.prototype.toString.call(obj) getTypeString(null) // '[object Null]' getTypeString('string') //'[object String]' getTypeString(new String) //'[object String]'
对 toString()
方法进行代理,可以得到一个类型字符串,我们就可以在这个字符串上面搞事情。
const getTypeString = obj => { return Object.prototype.toString.call(obj) } const isType = type => { return obj => { return getTypeString(obj) === `[object ${type}]` } } const isArray = isType('Array') // 该方法一般通过 Array.isArray 代替 const isNull = isType('Null') const isObject = isType('Object') const isRegExp = isType('RegExp') const isFunction = isType('Function') const isAsyncFunction = isType('AsyncFunction')
isNull(null) // true isObject({}) // true isRegExp(/w/) // true isFunction(() => {}) // true isAsyncFunction(async () => {}) // true
但是,在 Node.js 中,内部其实是有一组用来判断变量类型的 api 的。而且功能异常丰富,除了基础类型的判断,还支持判断 Promise 对象、Date 对象、各种 ArrayBuffer。
const types = require('util/types') types.isDate(new Date) // true types.isPromise(new Promise(() => {})) // true types.isArrayBuffer(new ArrayBuffer(16)) // true
严格相等
在 JavaScript 中,对象、数组等变量在判断相等的过程中,如果用 ===
通常只会判断这两个变量是否指向同一内存地址。如果想判断对象的键对应的所有值是否相等,需要对两个对象进行遍历。在 util
中,也提供了一个方法可以用来判断两个对象是否严格相等:util.isDeepStrictEqual(val1, val2)
:
const util = require('util') const val1 = { name: 'mybj' } const val2 = { name: 'mybj' } console.log('val1 === val2', val1 === val2) // false console.log('isDeepStrictEqual', util.isDeepStrictEqual(val1, val2)) // true
该方法同样可以用来判断数组,是否严格相等:
const util = require('util') const arr1 = [1, 3, 5] const arr2 = [1, 3, 5] console.log('arr1 === arr2', arr1 === arr2) // false console.log('isDeepStrictEqual', util.isDeepStrictEqual(arr1, arr2)) // true
Error First & Promise
早期的 Node API 都是 Error First
风格的,也就是所有的异步函数都会接受一个回调函数,该回调的一个参数为 error 对象,如果正常返回 error 对象为 null
,后面的参数为成功响应的结果。
// 下面是一个读取文件的示例 const fs = require('fs') fs.readFile('nginx.log', (error, data) => { if (error) { // 读取文件失败 console.error(error) return } // 读取文件成功,打印结果 console.log(data) })
在 Node 8 发布的时候,新增了一个 promisify
接口,用于将 Error First
风格的 API 转为 Promise API。
const fs = require('fs') const util = require('util') const readFile = util.promisify(fs.readFile) readFile('./2021-11-11.log', { encoding: 'utf-8' }) .then(text => console.log(text)) .catch(error => console.error(error))