如何把函数都用promise方式实现?
我觉得这是一个好问题。当前在我所在的公司,只要用 NodeJS
进行开发,从框架到具体的应用实例到工具,已经全部迁移到以 promise
为中心开发方式。带来的好处是大家都使用 promise
进行异步方案的解决,不用再考虑回调( callback
)。
但是事情总有特例,现实npm
上,还是有很多的库还没有用promise
进行实现,如:node
中的标准库。这样让使用者很难受,用着用着 promise
出现了一个 callback
,你会觉得世界为什么就这么乱呢?
神说要有光,于是就有了光!我也想说,大神说要解决,于是就有了 promoisify
!
1 什么是 promisify
简单来说: promisify
就是把带有 callback
函数,变成重新用 promise
来实现的一种技术方案,它能一劳永逸的解决:如何把函数都用 promise
重新实现的问题。
2 promisify 的使用
promisify
的使用,当然脱离不了某一个 promise
的实现。在这里,我选择 bluebird
。因为它足够强大,学习使用 promise
,就它足够了。
下面来说说:bluebird
中有关promisify
的一些方法。
在bluebird
的API
中,两个方法可以帮助你,它们分别是:promiseify 和 promisifyall。
2.1 promisify
prmoisify
的作是:将一个 nodeCallback
形式函数调用转为 promise
。
这里需要解释一下: nodeCallback
是什么意思。
nodeCallback
是 Nodojs
中的一个常用词。表达是意思是:Nodejs
中,以错误优先的回调函数的总称。
它包括两个意思:
nodeCallback
回调函数签名。nodeCallBack
回调函数出现的位置。
nodeCallback 签名
该回调函数的签名__一定__是这样:
// 这样是对的
function fooCallBack(err, a, b){
// something
console.log(a,b);
}
// 这样不对
function foo1CallBack(a,b,err){
}
可以看到,fooCallBack
函数的调用参数中,第一个参数是: err
, 也就是说的 noodeCallBack
函数的第一个参数__一定__传入的是 err
,而不能是别的参数。只要满足了这个条件,都可叫 nodeCallback
。
nodeCallBack 出现的顺序
nodeCallBack
一定出现在异步函数的最后一个,也就是这样:
// 这样是对的。
function foo(a,b,nodeCallback){
// pass
}
// 这样就不是 nodeCallback
function foo(a,nodeCallback,b){
// pass
}
只要满足了签名和顺序,就可以叫做 nodeCallBack
。
那 nodeCallback
存在哪里呢?告诉你吧,所有的 NodeJS
标准包中异步的地方都是它。
好了说了这么多 nodeCallback
,现在来说说 promosify
怎样使用:
const Promise = require('bluebird');
const fs = require('fs');
// 回调形式,这里的callback 就是 nodeCallback
fs.readFile('./test.js',function(err,data){
console.log(data);
});
// promisify 形式
const readFileAsync = Promise.promisify(fs.readFile);
readFileAsync('./test.js').then(function(data){
console.log(data);
}).catch(console.log);
很简单吧。具体实现就不说了,想要了解的去 google
吧。
2.2 promisifyall
如果说 promisify
只能一次转一个函数,那 promisifyall
的作用就是一次把一个库的文件转完。
说的更清楚一点,promisifyall
能把一个库中有函数全部变成 promise
的形式,改变后的函数都带上了 Async
的后缀。看代码:
const Promise = require('bluebird');
const fs = Promise.promisifyall(require('fs'));
fs.readFileAsync('./test.js').then(function(data){
console.log(data);
}).catch(console.log);
从上面可以知道:fs
这个标准库,经过 promisifyall
, 所有的函数都已经被 promise
化了。而被 promise
化的函数名变成了:原来的函数名+Async
。
3 结论
当学会使用 promisify
和 promisifyall
这两个方法,我相信大家以后都对:如何把函数都用promise方式实现?
这样的问题胸有成竹了吧。
那请问,如果是自己实现的函数,也是通过这种方式做转换么?还是自己直接把函数定义成promise型式的?
不喜欢 bluebird 的可以看下这个 https://github.com/magicdawn/promise.ify 不绑定 Promise 实现, 支持没有 err 的情况
@magicdawn 为何不喜欢bluebird?感觉没什么缺点是promise里最好的了
magicdawn可能是闽南人。bluebird蓝鸟,闽南话叫懒觉,也是JB的意思。(^∇^)
@andyhu @welchwsy 开始感觉很好, 后来不爽… 因为
- https://github.com/magicdawn/promise.map#why
- https://github.com/petkaantonov/bluebird/issues/508#issuecomment-193173681
像这种 warn 还有很多, 我认为很主观… 这个比较严重, 而且 co 虽然 fix 了, 但是没有发布新版, 4.6 版本都好久了… 于是写 node 我就用原生的 Promise …
一开始接触 Promise -> 看到 bluebird -> 看到 Promise.coroutine -> 接触 generator -> 使用 co -> 烦bluebird warning -> 使用 co + native Promise 蓝鸟也还不错, warning 可以关掉, 但是它有一些很多非 Promise/A+ 规范的东西, 用了之后你就很难切换到其他的 Promise 库…
@welchwsy 66666
@magicdawn node原生Promise功能少,速度也慢很多啊,另外业主要是你用的方式太冷门了,那个issue里别人都提及了
var co = require("bluebird").coroutine;
- 少没关系啊~我可以自己造啊 https://cnodejs.org/topic/573b2d64fcf698421d20359d
- co.wrap / bluebird.coroutine 嗯, co 我是看了源码, 觉得写的不错, bluebird 代码感觉很乱… so …
😂
哦, 已经用上了。bluebird