Bluebird

Bluebird

相关链接

用bluebird实现更加强大的Promise
bluebird中常用的Promise API
官方API
bluebird与原生Promise对象及bluebird模块的中文API文档

Promise API

NodeJs中fs.readFile方法的基本使用方式:

const fs = require('fs'),
path = require('path');

fs.readFile(path.join(__dirname, 'sample.txt'), 'utf-8', (err, data) => {
    if(err){
        console.error(err);
    }else{
        console.log(data);
    }
});

1. Promise.promisifyAll

函数Promise化是指将一个不符合promise规范的API改造成返回promise的API。Bluebird 的 Promise.promisifyAll 方法可以为一个对象的属性中的所有方法创建一个对应的使用Promise的版本。这些新创建方法的名称在已有方法的名称后加上"Async"后缀。
使用 BluebirdPromise.promisifyAll来转换上面的方法:

const Promise = require('bluebird')
fs = require('fs')
path = require('path')
Promise.promisifyAll(fs);
//新方法名后面加了‘Async’后缀, 返回一个Promise对象
fs.readFileAsync(path.join(__dirname, 'sample.txt'), 'utf-8')
  .then(data => console.log(data))
  .catch(err => console.error(err));

2. Promise.promisify

如果不希望把一个对象的所有方法都转换成使用Promise方式,可以使用Promise.promisify来转换单个方法,比如:

Promise.promisify(require("fs").readFile)

3. Promise.fromCallback

对于一个 NodeJS 格式的回调方法,可以使用 Promise.fromCallback 将其转换成一个 Promise。回调方法的结果决定了 Promise 的状态。

4. .spread

spread方法与then方法类似,当Promise的结果为数组时,可以使用spread方法把数组的元素打平(flatten)为回调方法的不同参数:

Promise.resolve([1,2,3])
  .spread((v1, v2, v3) => console.log(v1 + v2 + v3));

5. .catch

catch 方法用来添加已回绝状态时的回调方法,从.then()调用链中产生的任何异常都会被传送到最近的.catch()函数中。
两种使用方式:
捕获所有异常
只添加回调方法,会捕获所有的错误情况

.catch(e => {

})

捕获部分异常
使用错误对象类型或断言来对错误进行过滤

.then(() => {
    ...
}).catch(TypeError, e => {

}).catch(ReferenceError, e => {

}).catch(e => {

})

6. .error

error方法和catch类似,但是error只会处理真正的Error对象。Js中throw语句会抛出任何值,不一定是Error对象。throw抛出的任何值都会被catch处理,但是只有Error对象才会被error处理。

Promise.reject('not an error')
  .error(err => conosle.log('wrong la'))

7. .finally

无论promise调用链的情况如何,.finally都会在最后被调用。最后的返回值不能在句柄中被改变。

Promise.reject(new TypeError('type error'))
  .catch(TypeError, console.error)
  .finally(() => console.log('done'));

catch 只会捕获 TypeError,而 finally 中的逻辑始终会被调用

8. .bind

创建一个promise对象,这个对象与给定的thisArg绑定,对象内部的this将会指向被绑定的值。这个被绑定对象所产生的promise对象也会被绑定到thisArg。Example

9. 状态相关

对于一个Promise对象,可以使用如下方法查看其内部状态:

API Promise状态
isPending 进行中
isFulfilled 已满足
isPending 已拒绝
isPending 已取消
value 获取Promise满足后的结果
reason 获取Promise被拒后的结果

可以使用 cancel 方法来取消一个 Promise,取消 Promise 只是表示 Promise 的回调方法不被调用,并不会自动取消正在进行的异步操作,取消功能默认是禁用的,需要使用 Promise.config 来启用该功能;如要添加自定义取消逻辑,Promise构造方法参数中可以添加onCancel参数,用来注册Promise取消时的回调方法:

Promise.config({
    cancellation: true
});
new Promise((resolve, reject, onCancel) => {
    //
    onCancel(() => {
        //
    });

}).then(console.log).cancel();

10. Promise.join

用于协调多个并行的promise。当需要处理一个不定数量但是规格一致的多个promise时,.all()是较好的选择。但是当我们需要协调固定数量的离散的promise实例时,Promise.join()是一种更加简单(以及更加优雅)的方法。

let Promise = require('bluebird');
Promise.join(getPic(), getComment(), getTweets(), function(pics, comments, tweets){

});

11. Promise.try

通过Promise.try启动一个promise链,并将所有同步异常封装到promise的reject处理中。
Example

12. Promise.method

Promise.method 用来封装一个方法,使其返回 Promise。

13. 定时器

Promise.delay 返回的 Promise 会在指定的时间之后转换到已满足状态,并使用指定的值作为结果。Promise.timeout 用来为一个已有的 Promise 添加超时功能。

Promise.delay(1000, 'hello').then(console.log);
Promise.delay(1000, 'hello')
 .timeout(500, 'timed out')
 .then(console.log)
 .catch(console.error);

集合操作

1. Promise.all

Promise.all 接受一个 Iterable 参数,返回值:一个新的 Promise。结果 Promise 只有在 Iterable 中全部 Promise 对象都变为resolve时,才会返回resolve的Promise实例;任何 Promise 出现错误会导致结果 Promise 被拒绝。新的 Promise 的最终结果是一个包含 Iterable 中 Promise 的结果的数组。该 Iterable 中可以包含任何值。如果值不是 Promise,则其值会直接出现在结果中,并不需要等待 Promise 完成。

var files = [];
for(var i = 0; i < 10; i++){
    files.push(fs.writeFileAsync('file-' + i + ‘.txt’, '', 'utf-8'));
}
Promise.all(files).then(result => {
    //
})

Promise.props,类似于.all,但是针对对象属性的,而不是数组。

2. Promise.map

很多情况下需要把Iterable中对象转为Promise后再等待这些Promise完成。可以使用Promise.map方法:
Promise.map(iterable, mapper, concurrency):
参数:

  • iterable: Iterable对象
  • mapper: 转化为Promise的方法
  • concurrency: 可选参数,控制同时运行的Promise的数量,默认值为Infinity,不限制并发数
//以下代码使用map代替array.push+Promise.all方法
Promise.map(['1.txt', '2.txt', '3.txt'],
   name => fs.readFileAsync(path.join(__dirname, name), 'utf-8')
).then(results => console.log(results.join(', '))).catch(console.error);

如果任何一个promise实例执行失败,则返回状态为reject的Promise实例。
,即当数组的元素对应的promise被解决时,mapper函数会尽快被调用。这意味着由最终解决组成的元素顺序不一定和输入时一样。
Promise.mapSeries 的作用与 Promise.map 相同,只不过 mapSeries 按照 Iterable 中的顺序依次遍历每个元素。

3. Promise.some

在有多个 Promise 时,如果只需要等待其中部分 Promise 完成,可以使用 Promise.some 并指定完成的 Promise 数量。

Promise.some([
 fs.readFileAsync(path.join(__dirname, '1.txt'), 'utf-8'),
 fs.readFileAsync(path.join(__dirname, '2.txt'), 'utf-8'),
 fs.readFileAsync(path.join(__dirname, '3.txt'), 'utf-8')
], 2).then(results => console.log(results.join(', '))).catch(console.error);

Promise.any: 相当于Promise.some并把数量设为1,返回值为单个值(不是长度为1的数组)。
Promise.race: 与any类似,不过 race 的结果有可能是被拒绝的 Promise,因此推荐的做法是使用 any。

4. .filter和.each

Promise.filter 可以等待多个 Promise 的完成,并对结果进行过滤。它实际上的效果相当于在 Promise.map 之后使用 Array 的 filter 方法来进行过滤。

Promise.filter([
 fs.readFileAsync('1.txt', 'utf-8'),
 fs.readFileAsync('2.txt', 'utf-8'),
 fs.readFileAsync('3.txt', 'utf-8')
], value => value.length > 1).then(results => console.log(results.join(', '))).catch(console.error);

.each依次遍历一个数组或者一个数组的promise。遍历函数会被传入四个参数:(total, item, index, arrayLength)。
如果任何一个promise实例执行失败,则返回状态为reject的Promise实例。
如果遍历函数返回了一个promise或者其他含有.then()方法的对象,那么在继续下一个循环之前,这个promise的结果会被延迟。
官网例子(过滤当前目录下可访问的文件夹):

var Promise = require("bluebird");
var E = require("core-error-predicates");
var fs = Promise.promisifyAll(require("fs"));

fs.readdirAsync(process.cwd()).filter(function(fileName) {
    return fs.statAsync(fileName)
        .then(function(stat) {
            return stat.isDirectory();
        })
        .catch(E.FileAccessError, function() {
            return false;
        });
}).each(function(directoryName) {
    console.log(directoryName, " is an accessible directory");
});

5. Promise.reduce

Promise.reduce 把多个 Promise 的结果缩减成单个值。其作用类似 Array 的 reduce 方法,但是可以处理 Promise 对象。

Promise.reduce(['1.txt', '2.txt', '3.txt'],
 (total, name) => {
   return fs.readFileAsync(path.join(__dirname, name), 'utf-8').then(data => total + data.length);
 }, 0)
 .then(result => console.log(`Total size: ${result}`)).catch(console.error);

资源使用

资源释放逻辑一般在finally中添加,但是当Promise相互嵌套时,很容易产生资源没有被释放的情况。Bluebird 提供了更加健壮的资源管理方式,即使用资源释放器(disposer)和 Promise.using 方法。
资源释放器以 Disposer 对象表示,通过 Promise 的 disposer 方法来创建。创建时的参数是一个用来释放资源的方法。该方法的第一个参数是资源对象,第二个参数是 Promise.using 产生的 Promise 对象。Disposer 对象可以传递给 Promise.using 来保证其资源释放逻辑被执行。

class Connection {
 query() {
   return Promise.resolve('query');
 }
 close() {
   console.log('close');
 }
}
class DB {
 connect() {
   return Promise.resolve(new Connection());
 }
}
const disposer = new DB().connect().disposer(connection => connection.close());
Promise.using(disposer, connection => connection.query())
 .then(console.log).catch(console.error);

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,014评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,796评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,484评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,830评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,946评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,114评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,182评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,927评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,369评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,678评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,832评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,533评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,166评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,885评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,128评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,659评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,738评论 2 351

推荐阅读更多精彩内容