util.promisify 的那些事儿

发布日期:2019-05-24

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类型的keyutil.promisify.custom

Symbol类型的大家应该都有了解,是一个唯一的值,这里是util.prosimify用来指定自定义的Promise化的结果的,使用方式如下:

const { promisify } = require("util")// 比如我们有一个对象,提供了一个返回多个参数的回调版本的函数const obj = { getData (callback) { callback(null, "Niko", 18) // 返回两个参数,姓名和年龄 }}// 这时使用promisify肯定是不行的// 因为Promise.resolve只接收一个参数,所以我们只会得到 Nikopromisify(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返回的函数地址是一处:

obj.getData[promisify.custom] = async () => ({ name: "Niko", age: 18 })// 上边的赋值为 async 函数也可以改为普通函数,只要保证这个普通函数会返回 Promise 实例即可// 这两种方式与上边的 async 都是完全相等的obj.getData[promisify.custom] = () => Promise.resolve({ name: "Niko", age: 18 })obj.getData[promisify.custom] = () => new Promise(resolve({ name: "Niko", age: 18 }))console.log(obj.getData[promisify.custom] === promisify(obj.getData)) // true

一些内置的 custom 处理

在一些内置包中,也能够找到promisify.custom的踪迹,比如说最常用的child_process.exec就内置了promisify.custom的处理:

const { exec } = require("child_process")const { promisify } = require("util")console.log(typeof exec[promisify.custom]) // function

因为就像前边示例中所提到的曲线救国的方案,官方的做法也是将函数签名中的参数名作为key,将其所有参数存放到一个Object对象中进行返回,比如child_process.exec的返回值抛开error以外会包含两个,stdoutstderr,一个是命令执行后的正确输出,一个是命令执行后的错误输出:

promisify(exec)("ls").then(console.log)// -> { stdout: "XXX", stderr: "" }

或者我们故意输入一些错误的命令,当然了,这个只能在catch模块下才能够捕捉到,一般命令正常执行stderr都会是一个空字符串:

promisify(exec)("lss").then(console.log, console.error)// -> { ..., stdout: "", stderr: "lss: command not found" }

包括像setTimeoutsetImmediate也都实现了对应的promisify.custom之前为了实现sleep的操作,还手动使用Promise封装了setTimeout

const sleep = promisify(setTimeout)console.log(new Date())await sleep(1000)console.log(new Date())

内置的 promisify 转换后函数

如果你的Node版本使用10.x以上的,还可以从很多内置的模块中找到类似.promises的子模块,这里边包含了该模块中常用的回调函数的Promise版本(都是async函数),无需再手动进行promisify转换了。

而且我本人觉得这是一个很好的指引方向,因为之前的工具实现,有的选择直接覆盖原有函数,有的则是在原有函数名后边增加Async进行区分,官方的这种在模块中单独引入一个子模块,在里边实现Promise版本的函数,其实这个在使用上是很方便的,就拿fs模块进行举例:

// 之前引入一些 fs 相关的 API 是这样做的const { readFile, stat } = require("fs")// 而现在可以很简单的改为const { readFile, stat } = require("fs").promises// 或者const { promises: { readFile, stat } } = require("fs")

后边要做的就是将调用promisify相关的代码删掉即可,对于其他使用API的代码来讲,这个改动是无感知的。所以如果你的node版本够高的话,可以在使用内置模块之前先去翻看文档,有没有对应的promises支持,如果有实现的话,就可以直接使用。

promisify 的一些注意事项

    一定要符合Error first callback的约定不能返回多个参数注意进行转换的函数是否包含this的引用

前两个问题,使用前边提到的promisify.custom都可以解决掉。但是第三项可能会在某些情况下被我们所忽视,这并不是promisify独有的问题,就一个很简单的例子:

const obj = { name: "Niko", getName () { return this.name }}obj.getName() // Nikoconst func = obj.getNamefunc() // undefined

类似的,如果我们在进行Promise转换的时候,也是类似这样的操作,那么可能会导致生成后的函数this指向出现问题。修复这样的问题有两种途径:

    使用箭头函数,也是推荐的做法在调用promisify之前使用bind绑定对应的this

不过这样的问题也是建立在promisify转换后的函数被赋值给其他变量的情况下会发生。如果是类似这样的代码,那么完全不必担心this指向的问题:

const obj = { name: "Niko", getName (callback) { callback(null, this.name) }}// 这样的操作是不需要担心 this 指向问题的obj.XXX = promisify(obj.getName)// 如果赋值给了其他变量,那么这里就需要注意 this 的指向了const func = promisify(obj.getName) // 错误的 this

小结

个人认为Promise作为当代javaScript异步编程中最核心的一部分,了解如何将老旧代码转换为Promise是一件很有意思的事儿。而我去了解官方的这个工具,原因是在搜索Redis相关的Promise版本时看到了这个readme:

This package is no longer maintained. node_redis now includes support for promises in core, so this is no longer needed.

然后跳到了node_redis里边的实现方案,里边提到了util.promisify,遂抓过来研究了一下,感觉还挺有意思,总结了下分享给大家。

参考资料

util.promisifychild_process.execfs.promises