util.promisify是在node.js 8.x版本中新增的一个工具,用于将老式的Error first callback转换为Promise对象,让老项目改造变得更为轻松。
在官方推出这个工具之前,民间已经有很多类似的工具了,比如es6-promisify、thenify、bluebird.promisify。
以及很多其他优秀的工具,都是实现了这样的功能,帮助我们在处理老项目的时候,不必费神将各种代码使用Promise再重新实现一遍。
工具实现的大致思路首先要解释一下这种工具大致的实现思路,因为在Node中异步回调有一个约定:Error first,也就是说回调函数中的第一个参数一定要是Error对象,其余参数才是正确时的数据。
知道了这样的规律以后,工具就很好实现了,在匹配到第一个参数有值的情况下,触发reject,其余情况触发resolve,一个简单的示例代码:
function util (func) { return (...arg) => new Promise((resolve, reject) => { func(...arg, (err, arg) => { if (err) reject(err) else resolve(arg) }) }) }调用工具函数返回一个匿名函数,匿名函数接收原函数的参数。
匿名函数被调用后根据这些参数来调用真实的函数,同时拼接一个用来处理结果的callback。
检测到err有值,触发reject,其他情况触发resolve
resolve 只能传入一个参数,所以callback中没有必要使用...arg获取所有的返回值
常规的使用方式拿一个官方文档中的示例
const { promisify } = require('util') const fs = require('fs') const statAsync = promisify(fs.stat) statAsync('.').then(stats => { // 拿到了正确的数据 }, err => { // 出现了异常 })以及因为是Promise,我们可以使用await来进一步简化代码:
const { promisify } = require('util') const fs = require('fs') const statAsync = promisify(fs.stat) // 假设在 async 函数中 try { const stats = await statAsync('.') // 拿到正确结果 } catch (e) { // 出现异常 }用法与其他工具并没有太大的区别,我们可以很轻易的将回调转换为Promise,然后应用于新的项目中。
自定义的 Promise 化有那么一些场景,是不能够直接使用promisify来进行转换的,有大概这么两种情况:
没有遵循Error first callback约定的回调函数
返回多个参数的回调函数
首先是第一个,如果没有遵循我们的约定,很可能导致reject的误判,得不到正确的反馈。
而第二项呢,则是因为Promise.resolve只能接收一个参数,多余的参数会被忽略。
所以为了实现正确的结果,我们可能需要手动实现对应的Promise函数,但是自己实现了以后并不能够确保使用方不会针对你的函数调用promisify。
所以,util.promisify还提供了一个Symbol类型的key,util.promisify.custom。
Symbol类型的大家应该都有了解,是一个唯一的值,这里是util.prosimify用来指定自定义的Promise化的结果的,使用方式如下:
const { promisify } = require('util') // 比如我们有一个对象,提供了一个返回多个参数的回调版本的函数 const obj = { getData (callback) { callback(null, 'Niko', 18) // 返回两个参数,姓名和年龄 } } // 这时使用promisify肯定是不行的 // 因为Promise.resolve只接收一个参数,所以我们只会得到 Niko promisify(obj.getData)().then(console.log) // Niko // 所以我们需要使用 promisify.custom 来自定义处理方式 obj.getData[promisify.custom] = async () => ({ name: 'Niko', age: 18 }) // 当然了,这是一个曲线救国的方式,无论如何 Promise 不会返回多个参数过来的 promisify(obj.getData)().then(console.log) // { name: 'Niko', age: 18 }关于Promise为什么不能resolve多个值,我有一个大胆的想法,一个没有经过考证,强行解释的理由:如果能resolve多个值,你让async函数怎么return(当个乐子看这句话就好,不要当真)
不过应该确实跟return有关,因为Promise是可以链式调用的,每个Promise中执行then以后都会将其返回值作为一个新的Promise对象resolve的值,在JavaScript中并没有办法return多个参数,所以即便第一个Promise可以返回多个参数,只要经过return的处理就会丢失
在使用上就是很简单的针对可能会被调用promisify的函数上添加promisify.custom对应的处理即可。
当后续代码调用promisify时就会进行判断:
如果目标函数存在promisify.custom属性,则会判断其类型:
如果不是一个可执行的函数,抛出异常
如果是可执行的函数,则直接返回其对应的函数
如果目标函数不存在对应的属性,按照Error first callback的约定生成对应的处理函数然后返回
添加了这个custom属性以后,就不用再担心使用方针对你的函数调用promisify了。
而且可以验证,赋值给custom的函数与promisify返回的函数地址是一处: