关于node.js:你不知道的-Nodejs-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

But，在 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: 'shenfq'}
const val2 = {name: 'shenfq'}

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))

不过，起初也有很多人感觉这些原生 API 反对 Promise 的形式太过繁琐，每个 API 都须要独自的包装一层 promisify 办法。在 Node 10 公布的时候，原生模块都新增了一个 .promises 属性，该属性下的所有 API 都 Promise 格调的。

const fs = require('fs').promises
fs.readFile('./2021-11-11.log', { encoding: 'utf-8'})
  .then(text => console.log(text)) 
    .catch(error => console.error(error))

留神 ：Node 14 后，promises API 又新增了一种引入形式，通过批改包名的形式引入。

const fs = require('fs/promises')
fs.readFile('./2021-11-11.log', { encoding: 'utf-8'})
  .then(text => console.log(text)) 
    .catch(error => console.error(error))

除了将 Error First 格调的 API 转为 Promise API，util 中还提供 callbackify 办法，用于将 async 函数转换为 Error First 格调的函数。

上面通过 callbackify 将 promise 化的 fs 还原为 Error First 格调的函数。

const fs = require('fs/promises')
const util = require('util')

const readFile = util.callbackify(fs.readFile)
readFile('./2021-11-12.log', { encoding: 'utf-8'}, (error, text) => {if (error) {console.error(error)
    return
  }
  console.log(text)
})

调试与输入

如果有开发过 Node 服务，应该都用过 debug 模块，通过该模块能够在控制台看到更加清晰的调试信息。

const debug = require('debug')
const log = debug('app')

const user = {name: 'shenfq'}

log('以后用户: %o', user)

其实，通过 util.debug 也能实现相似的成果：

const debug = require('debug')
const log = debug('app')

const user = {name: 'shenfq'}

log('以后用户: %o', user)

只是在启动时，须要将 DEBUG 环境变量替换为 NODE_DEBUG。

如果你有认真看下面的代码，应该会发现，在 log('以后用户: %o', user) 办法后面的字符串中，有一个 %o 占位符，示意这个中央将会填充一个对象（object）。这与 C 语言或 python 中的，printf 相似。同样，在 util 模块中，间接提供了格式化的办法：util.format。

const {format} = require('util')

console.log(
  format('以后用户: %o', {name: 'shenfq', age: 25})
)

除了 %o 占位符，不同的数据类型应应用不同的占位符。

JavaScript 中的对象是一个很简单的货色，除了间接应用 util.format 外加 %o 占位符的形式格式化对象，util 中还提供了一个叫做 inspect 办法来进行对象格式化。

const {inspect} = require('util')

const user = {
  age: 25,
  name: 'shenfq',
  work: {
    name: 'coding',
    seniority: 5
  }
}

console.log(inspect(user))

这么看 inspect 如同什么都没做，然而 inspect 办法还有第二个参数，用来进行格式化时的一些个性化配置。

• depth: number：管制显示层级；
• sorted: boolean|Function: 是否依照 key 的编码值进行排序；
• compact: boolean：是否进行单行显示；

当然下面只是一部分配置，更具体的配置可查阅 node 文档，上面咱们写几个案例：

所有的属性都换行显示：

inspect(user, {compact: false})

只格式化对象第一层的值：

inspect(user, {
  depth: 0,
    compact: false
})

依照 key 值的编码倒序输入：

inspect(user, {
    compact: false,
  sorted: (a, b) => a < b ? 1 : -1
})