Promise
含義
Promise 是異步編程的一種解決方案,比傳統(tǒng)的解決方案——回調(diào)函數(shù)和事件——更合理和更強(qiáng)大。
所謂Promise,簡單說就是一個容器,里面保存著某個未來才會結(jié)束的事件(通常是一個異步操作)的結(jié)果踊东。從語法上說,Promise 是一個對象刚操,從它可以獲取異步操作的消息闸翅。Promise 提供統(tǒng)一的 API,各種異步操作都可以用同樣的方法進(jìn)行處理菊霜。
Promise對象有以下兩個特點(diǎn)坚冀。
- 對象的狀態(tài)不受外界影響。
有三種狀態(tài):pending(進(jìn)行中)鉴逞、fulfilled(已成功)和rejected(已失敿悄场),從pending變?yōu)閒ulfilled和從pengding變?yōu)閞ejected构捡。
- 一旦狀態(tài)改變液南,就不會再變,任何時(shí)候都可以得到這個結(jié)果勾徽。
如果改變已經(jīng)發(fā)生了滑凉,你再對Promise對象添加回調(diào)函數(shù),也會立即得到這個結(jié)果。這與事件(Event)完全不同畅姊,事件的特點(diǎn)是咒钟,如果你錯過了它,再去監(jiān)聽若未,是得不到結(jié)果的朱嘴。
Promise也有一些缺點(diǎn)。首先粗合,無法取消Promise萍嬉,一旦新建它就會立即執(zhí)行,無法中途取消隙疚。其次帚湘,如果不設(shè)置回調(diào)函數(shù),Promise內(nèi)部拋出的錯誤甚淡,不會反應(yīng)到外部。第三捅厂,當(dāng)處于pending狀態(tài)時(shí)贯卦,無法得知目前進(jìn)展到哪一個階段(剛剛開始還是即將完成)。
基本用法
Promise構(gòu)造函數(shù)接受一個函數(shù)作為參數(shù)焙贷,該函數(shù)的兩個參數(shù)分別是resolve和reject撵割。它們是兩個函數(shù),由 JavaScript 引擎提供辙芍,不用自己部署啡彬。
resolve將狀態(tài)變?yōu)橐殉晒Γ诋惒讲僮鞒晒r(shí)調(diào)用故硅,并將異步操作的結(jié)果作為參數(shù)傳遞出去庶灿。
reject將狀態(tài)變?yōu)橐咽。诋惒讲僮魇r(shí)調(diào)用吃衅,并將異步操作報(bào)錯的錯誤作為參數(shù)傳遞出去往踢。
Promise實(shí)例生成以后,可以用then方法分別指定resolved狀態(tài)和rejected狀態(tài)的回調(diào)函數(shù)徘层。
Promise 新建后就會立即執(zhí)行峻呕。
let promise = new Promise(function(resolve, reject) {
console.log('Promise');
resolve();
});
promise.then(function() {
console.log('resolved.');
});
console.log('Hi!');
// Promise
// Hi!
// resolved
resolve函數(shù)的參數(shù)除了正常的值以外,還可能是另一個 Promise 實(shí)例趣效,比如像下面這樣瘦癌。
const p1 = new Promise(function (resolve, reject) {
setTimeout(() => reject(new Error('fail')), 3000)
})
const p2 = new Promise(function (resolve, reject) {
setTimeout(() => resolve(p1), 1000)
})
p2
.then(result => console.log(result))
.catch(error => console.log(error))
// Error: fail
p1和p2都是 Promise 的實(shí)例,但是p2的resolve方法將p1作為參數(shù)跷敬,即一個異步操作的結(jié)果是返回另一個異步操作讯私。
注意,這時(shí)p1的狀態(tài)就會傳遞給p2,也就是說妄帘,p1的狀態(tài)決定了p2的狀態(tài)楞黄。如果p1的狀態(tài)是pending,那么p2的回調(diào)函數(shù)就會等待p1的狀態(tài)改變抡驼;如果p1的狀態(tài)已經(jīng)是resolved或者rejected鬼廓,那么p2的回調(diào)函數(shù)將會立刻執(zhí)行。由p1的狀態(tài)決定p2的狀態(tài)致盟。所以碎税,后面的then語句都變成針對后者(p1)。又過了 2 秒馏锡,p1變?yōu)閞ejected雷蹂,導(dǎo)致觸發(fā)catch方法指定的回調(diào)函數(shù)。
注意杯道,調(diào)用resolve或reject并不會終結(jié) Promise 的參數(shù)函數(shù)的執(zhí)行匪煌。
一般來說,調(diào)用resolve或reject以后党巾,Promise 的使命就完成了萎庭,后繼操作應(yīng)該放到then方法里面,而不應(yīng)該直接寫在resolve或reject的后面齿拂。所以驳规,最好在它們前面加上return語句,這樣就不會有意外署海。
new Promise((resolve, reject) => {
resolve(1);
console.log(2);
}).then(r => {
console.log(r);
});
// 2
// 1
new Promise((resolve, reject) => {
return resolve(1);
// 后面的語句不會執(zhí)行
console.log(2);
})
Promise.prototype.then()
then方法的第一個參數(shù)是resolved狀態(tài)的回調(diào)函數(shù)吗购,第二個參數(shù)(可選)是rejected狀態(tài)的回調(diào)函數(shù)。
then方法返回的是一個新的Promise實(shí)例(注意砸狞,不是原來那個Promise實(shí)例)捻勉。因此可以采用鏈?zhǔn)綄懛ǎ磘hen方法后面再調(diào)用另一個then方法趾代。
getJSON("/posts.json").then(function(json) {
return json.post;
}).then(function(post) {
// ... 此時(shí)的post 就是 json.post
},function(err){
});
采用鏈?zhǔn)降膖hen贯底,可以指定一組按照次序調(diào)用的回調(diào)函數(shù)。這時(shí)撒强,前一個回調(diào)函數(shù)禽捆,有可能返回的還是一個Promise對象(即有異步操作),這時(shí)后一個回調(diào)函數(shù)飘哨,就會等待該P(yáng)romise對象的狀態(tài)發(fā)生變化胚想,才會被調(diào)用。
Promise.prototype.catch()
Promise.prototype.catch方法是.then(null, rejection)或.then(undefined, rejection)的別名芽隆,用于指定發(fā)生錯誤時(shí)的回調(diào)函數(shù)浊服。
同時(shí)then方法指定的回調(diào)函數(shù)统屈,如果運(yùn)行中拋出錯誤,也會被catch方法捕獲牙躺。
p.then((val) => console.log('fulfilled:', val))
.catch((err) => console.log('rejected', err));
// 等同于
p.then((val) => console.log('fulfilled:', val))
.then(null, (err) => console.log("rejected:", err));
// 并不等同于
p.then((val) => console.log('fulfilled:', val), err => console.log("rejected:", err))
Promise 對象的錯誤具有“冒泡”性質(zhì)愁憔,會一直向后傳遞,直到被捕獲為止孽拷。也就是說吨掌,錯誤總是會被下一個catch語句捕獲。
getJSON('/post/1.json').then(function(post) {
return getJSON(post.commentURL);
}).then(function(comments) {
// some code
}).catch(function(error) {
// 一個由getJSON產(chǎn)生脓恕,兩個由then產(chǎn)生膜宋。
// 處理前面三個Promise產(chǎn)生的錯誤
});
一般來說,不要在then方法里面定義 Reject 狀態(tài)的回調(diào)函數(shù)(即then的第二個參數(shù))炼幔,總是使用catch方法秋茫。理由可以捕獲前面then方法執(zhí)行中的錯誤,也更接近同步的寫法(try/catch)
跟傳統(tǒng)的try/catch代碼塊不同的是乃秀,如果沒有使用catch方法指定錯誤處理的回調(diào)函數(shù)肛著,Promise 對象拋出的錯誤不會傳遞到外層代碼,即不會有任何反應(yīng)跺讯。
const someAsyncThing = function() {
return new Promise(function(resolve, reject) {
// 下面一行會報(bào)錯策泣,因?yàn)閤沒有聲明
resolve(x + 2);
});
};
someAsyncThing().then(function() {
console.log('everything is great');
// 不會執(zhí)行,因?yàn)橐獔?zhí)行也執(zhí)行catch 而catch沒有定義抬吟。
});
setTimeout(() => { console.log(123) }, 2000);
// Uncaught (in promise) ReferenceError: x is not defined
// 123
會打印出錯誤提示ReferenceError: x is not defined,但是不會退出進(jìn)程统抬、終止腳本執(zhí)行火本,2 秒之后還是會輸出123。這就是說聪建,Promise 內(nèi)部的錯誤不會影響到 Promise 外部的代碼钙畔,通俗的說法就是“Promise 會吃掉錯誤”。
這個腳本放在服務(wù)器執(zhí)行金麸,退出碼就是0(即表示執(zhí)行成功)擎析。不過,Node 有一個unhandledRejection事件挥下,專門監(jiān)聽未捕獲的reject錯誤揍魂,上面的腳本會觸發(fā)這個事件的監(jiān)聽函數(shù),可以在監(jiān)聽函數(shù)里面拋出錯誤棚瘟。
process.on('unhandledRejection', function (err, p) {
// 第一個是錯誤對象
// 第二個是報(bào)錯的 Promise 實(shí)例现斋,它可以用來了解發(fā)生錯誤的環(huán)境信息。
throw err;
});
注意偎蘸,Node 有計(jì)劃在未來廢除unhandledRejection事件庄蹋。如果 Promise 內(nèi)部有未捕獲的錯誤瞬内,會直接終止進(jìn)程,并且進(jìn)程的退出碼不為 0限书。
const promise = new Promise(function (resolve, reject) {
resolve('ok');
setTimeout(function () { throw new Error('test') }, 0)
});
promise.then(function (value) { console.log(value) })
.catch(err => {
console.log('err', err);
// 不會執(zhí)行
});
// ok
// Uncaught Error: test
上面代碼中虫蝶,Promise 指定在下一輪“事件循環(huán)”再拋出錯誤。到了那個時(shí)候倦西,Promise 的運(yùn)行已經(jīng)結(jié)束了能真,所以這個錯誤是在 Promise 函數(shù)體外拋出的,會冒泡到最外層调限,成了未捕獲的錯誤舟陆。
一般總是建議,Promise 對象后面要跟catch方法耻矮,這樣可以處理 Promise 內(nèi)部發(fā)生的錯誤秦躯。catch方法返回的還是一個 Promise 對象,因此后面還可以接著調(diào)用then方法裆装。即使catch沒有被執(zhí)行踱承,這個后面接著catch后面又接著調(diào)用的then方法還是會執(zhí)行,此時(shí)如果這個then方法報(bào)錯了哨免,就與前面的catch無關(guān)了茎活。
catch方法之中,還能再拋出錯誤琢唾。如果之后沒有別的catch方法载荔,就會導(dǎo)致這個錯誤不會被捕捉。
Promise.prototype.finally()
finally方法用于指定不管 Promise 對象最后狀態(tài)如何采桃,都會執(zhí)行的操作懒熙。該方法是 ES2018 引入標(biāo)準(zhǔn)的。
finally方法的回調(diào)函數(shù)不接受任何參數(shù)普办,這意味著沒有辦法知道工扎,前面的 Promise 狀態(tài)到底是fulfilled還是rejected。這表明衔蹲,finally方法里面的操作肢娘,應(yīng)該是與狀態(tài)無關(guān)的,不依賴于 Promise 的執(zhí)行結(jié)果舆驶。即無論P(yáng)romise是執(zhí)行then操作還是執(zhí)行catch操作都需要執(zhí)行的代碼橱健,可以放在finally方法中。常用場景:發(fā)起請求時(shí)沙廉,激活loading畴博,而無論你請求成功與否都需要關(guān)閉loading。
promise
.then(result => {···})
.catch(error => {···})
.finally(() => {···});
它的實(shí)現(xiàn)也很簡單蓝仲。
Promise.prototype.finally = function (callback) {
let P = this.constructor;
return this.then(
value => P.resolve(callback()).then(() => value),
// 這個then的參數(shù)其實(shí)就是callback的返回值俱病,但是這里沒有使用這個參數(shù)官疲,而是返回了上一個Promise的值
reason => P.resolve(callback()).then(() => { throw reason })
);
};
new Promise(function(resolve){
resolve();
})
.then(result => {})
.catch(error => {})
.finally(() => {console.log('finally')}) // finally
.then(val => {
console.log(val); // undefined
});
上面代碼中,不管前面的 Promise 是fulfilled還是rejected亮隙,都會執(zhí)行回調(diào)函數(shù)callback途凫。
Promise.all()
Promise.all方法用于將多個 Promise 實(shí)例,包裝成一個新的 Promise 實(shí)例溢吻。
const p = Promise.all([p1, p2, p3]);
Promise.all方法接受一個數(shù)組作為參數(shù)维费,p1、p2促王、p3都是 Promise 實(shí)例犀盟,如果不是,就會先調(diào)用下面講到的Promise.resolve方法蝇狼,將參數(shù)轉(zhuǎn)為 Promise 實(shí)例阅畴,再進(jìn)一步處理。(Promise.all方法的參數(shù)可以不是數(shù)組迅耘,但必須具有 Iterator 接口贱枣,且返回的每個成員都是 Promise 實(shí)例。)
p的狀態(tài)由p1颤专、p2纽哥、p3決定,分成兩種情況栖秕。
(1)只有p1春塌、p2、p3的狀態(tài)都變成fulfilled簇捍,p的狀態(tài)才會變成fulfilled摔笤,此時(shí)p1、p2垦写、p3的返回值組成一個數(shù)組,傳遞給p的回調(diào)函數(shù)彰触。
(2)只要p1梯投、p2、p3之中有一個被rejected况毅,p的狀態(tài)就變成rejected分蓖,此時(shí)第一個被reject的實(shí)例的返回值,會傳遞給p的回調(diào)函數(shù)尔许。
// 生成一個Promise對象的數(shù)組
const promises = [2, 3, 5, 7, 11, 13].map(function (id) {
return getJSON('/post/' + id + ".json");
});
Promise.all(promises).then(function (posts) {
// 如果promises數(shù)組所有的getJSON異步操作都成功
// 則posts是一個數(shù)組么鹤,里面包含6個異步操作成功的結(jié)果。
}).catch(function(reason){
// 如果promises數(shù)組只要有一個getJSON異步操作都失敗
// 就會將錯誤返回給catch
});
注意味廊,如果作為參數(shù)的 Promise 實(shí)例蒸甜,自己定義了catch方法棠耕,那么它一旦被rejected,并不會觸發(fā)Promise.all()的catch方法柠新。
const p1 = new Promise((resolve, reject) => {
resolve('hello');
})
.then(result => result)
.catch(e => e);
const p2 = new Promise((resolve, reject) => {
throw new Error('報(bào)錯了');
})
.then(result => result)
.catch(e => e);
// p2定義的Promise會執(zhí)行reject窍荧,然后觸發(fā)catch方法,
// catch方法返回一個新的Promise實(shí)例給了p2變量恨憎,該實(shí)例即此時(shí)的p2的狀態(tài)也會變成resolved
Promise.all([p1, p2])
.then(result => console.log(result)) // ["hello", Error: 報(bào)錯了]
.catch(e => console.log(e)); // 只有p2沒有catch方法蕊退,才會觸發(fā)Promise.all的catch
上面代碼中,p1會resolved憔恳,p2首先會rejected瓤荔,但是p2有自己的catch方法,該方法返回的是一個新的 Promise 實(shí)例钥组,p2指向的實(shí)際上是這個實(shí)例输硝。該實(shí)例執(zhí)行完catch方法后,也會變成resolved者铜,導(dǎo)致Promise.all()方法參數(shù)里面的兩個實(shí)例都會resolved腔丧,因此會調(diào)用then方法指定的回調(diào)函數(shù),而不會調(diào)用catch方法指定的回調(diào)函數(shù)作烟。
Promise.race()
Promise.race方法同樣是將多個 Promise 實(shí)例愉粤,包裝成一個新的 Promise 實(shí)例。
const p = Promise.race([p1, p2, p3]);
上面代碼中拿撩,只要p1衣厘、p2、p3之中有一個實(shí)例率先改變狀態(tài)压恒,p的狀態(tài)就跟著改變影暴。那個率先改變的 Promise 實(shí)例的返回值,就傳遞給p的回調(diào)函數(shù)探赫。
Promise.race方法的參數(shù)如果不是 Promise 實(shí)例型宙,就會先調(diào)用Promise.resolve方法,將參數(shù)轉(zhuǎn)為 Promise 實(shí)例伦吠,再進(jìn)一步處理妆兑。
下面是一個例子,如果指定時(shí)間內(nèi)沒有獲得結(jié)果毛仪,就將 Promise 的狀態(tài)變?yōu)閞eject搁嗓,否則變?yōu)閞esolve。
const p = Promise.race([
fetch('/resource-that-may-take-a-while'),
new Promise(function (resolve, reject) {
setTimeout(() => reject(new Error('request timeout')), 5000)
})
]);
p
.then(console.log)
.catch(console.error);
// 如果 5 秒之內(nèi)fetch方法無法返回結(jié)果箱靴,則setTimeout就會執(zhí)行并拋出錯誤腺逛,率先改變狀態(tài)
// 變量p的狀態(tài)就會變?yōu)閞ejected,從而觸發(fā)catch方法指定的回調(diào)函數(shù)衡怀。
Promise.resolve()
有時(shí)需要將現(xiàn)有對象轉(zhuǎn)為 Promise 對象棍矛,Promise.resolve方法就起到這個作用安疗。
// 將 jQuery 生成的deferred對象,轉(zhuǎn)為一個新的 Promise 對象茄靠。
const jsPromise = Promise.resolve($.ajax('/whatever.json'));
Promise.resolve('foo')
// 等價(jià)于
new Promise(resolve => resolve('foo'))
Promise.resolve方法的參數(shù)分成四種情況茂契。
參數(shù)是一個 Promise 實(shí)例,那么Promise.resolve將不做任何修改慨绳、原封不動地返回這個實(shí)例掉冶。
參數(shù)是一個thenable對象,thenable對象指的是具有then方法的對象脐雪,比如下面這個對象厌小。Promise.resolve方法會將這個對象轉(zhuǎn)為 Promise 對象,然后就立即執(zhí)行thenable對象的then方法战秋。
let thenable = {
then: function(resolve, reject) {
resolve(42);
}
};
let p1 = Promise.resolve(thenable);
p1.then(function(value) {
console.log(value); // 42
});
- 參數(shù)不是具有then方法的對象璧亚,或根本就不是對象,則Promise.resolve方法返回一個新的 Promise 對象脂信,狀態(tài)為resolved癣蟋。Promise.resolve方法的參數(shù),會同時(shí)傳給回調(diào)函數(shù)狰闪。
const p = Promise.resolve('Hello');
p.then(function (s){
console.log(s)
});
// Hello
- 不帶有任何參數(shù)
Promise.resolve()方法允許調(diào)用時(shí)不帶參數(shù)疯搅,直接返回一個resolved狀態(tài)的 Promise 對象。
所以埋泵,如果希望得到一個 Promise 對象幔欧,比較方便的方法就是直接調(diào)用Promise.resolve()方法。
const p = Promise.resolve();
p.then(function () {
// ...即then回調(diào)中也接受不到參數(shù)
});
Promise.reject()
Promise.reject(reason)方法也會返回一個新的 Promise 實(shí)例丽声,該實(shí)例的狀態(tài)為rejected礁蔗。
const p = Promise.reject('出錯了');
// 等同于
const p = new Promise((resolve, reject) => reject('出錯了'))
p.then(null, function (s) {
console.log(s) // 出錯了
});
注意,Promise.reject()方法的參數(shù)雁社,會原封不動地作為reject的理由浴井,變成后續(xù)方法的參數(shù)。這一點(diǎn)與Promise.resolve方法不一致霉撵。
const thenable = {
then(resolve, reject) {
reject('出錯了');
}
};
Promise.reject(thenable)
.catch(e => {
console.log(e === thenable)
})
// true
// Promise.reject方法的參數(shù)是一個thenable對象磺浙,執(zhí)行以后
// 后面catch方法的參數(shù)不是reject拋出的“出錯了”這個字符串,而是thenable對象喊巍。
Promise.try()
實(shí)際開發(fā)中,經(jīng)常遇到一種情況:不知道或者不想?yún)^(qū)分箍鼓,函數(shù)f是同步函數(shù)還是異步操作崭参,但是想用 Promise 來處理它。因?yàn)檫@樣就可以不管f是否包含異步操作款咖,都用then方法指定下一步流程何暮,用catch方法處理f拋出的錯誤奄喂。
但是有一個缺點(diǎn),就是如果f是同步函數(shù)海洼,那么它會在本輪事件循環(huán)的末尾執(zhí)行跨新。
const f = () => console.log('now');
Promise.resolve().then(f);
console.log('next');
// next
// now
那么有沒有一種方法,讓同步函數(shù)同步執(zhí)行坏逢,異步函數(shù)異步執(zhí)行域帐,并且讓它們具有統(tǒng)一的 API 呢?回答是可以的是整,并且還有兩種寫法肖揣。
第一種寫法是用async函數(shù)來寫。
const f = () => console.log('now');
(async () => f())()
.then(...)
.catch(...);
console.log('next');
// now
// next
// 因?yàn)閍sync函數(shù)總是返回一個Promise
// 如果async函數(shù)的執(zhí)行有返回值浮入,那么這個返回這就會被傳遞到then方法的參數(shù)中
// 同時(shí)如果f是同步函數(shù)龙优,那么就會async 函數(shù)中同步執(zhí)行
// 如若是異步,那么在then方法中的代碼也能正確處理這種情況
第二種寫法是使用new Promise()事秀。
const f = () => console.log('now');
(
() => new Promise(
resolve => resolve(f())
// Promise 新建后的參數(shù)(傳入的函數(shù))就會立即執(zhí)行彤断,是同步隊(duì)列, resolve(f())就會被立即執(zhí)行
// 如果是異步易迹,就會將f()函數(shù)調(diào)用之后的返回值傳遞給then函數(shù)正確處理
)
)();
console.log('next');
// now
// next
鑒于這是一個很常見的需求宰衙,所以現(xiàn)在有一個提案,提供Promise.try方法替代上面的寫法赴蝇。
const f = () => console.log('now');
Promise.try(f);
console.log('next');
// now
// next
下面代碼中菩浙,database.users.get()返回一個 Promise 對象,如果拋出異步錯誤句伶,可以用catch方法捕獲劲蜻,就像下面這樣寫
function getUsername(userId) {
return database.users.get({id: userId})
.then(function(user) {
return user.name;
});
}
database.users.get({id: userId})
.then(...)
.catch(...)
但是database.users.get()可能還會拋出同步錯誤(比如數(shù)據(jù)庫連接錯誤,具體要看實(shí)現(xiàn)方法)考余,這時(shí)你就不得不用try...catch去捕獲先嬉。
try {
database.users.get({id: userId})
.then(...)
.catch(...)
} catch (e) {
// ...
}
使用這樣的寫法就很笨拙了,這時(shí)就可以統(tǒng)一用promise.catch()捕獲所有同步和異步的錯誤楚堤。
Promise.try(() => database.users.get({id: userId}))
.then(...)
.catch(...)
事實(shí)上疫蔓,Promise.try就是模擬try代碼塊,就像promise.catch模擬的是catch代碼塊身冬。