所謂Promise
,簡單說就是一個容器,里面保存着某個未來才會結束的事件(通常是一個異步操作)的結果。從語法上說,Promise是一個對象,從它可以獲取異步操作的消息。Promise提供統一的API,各種異步操作都可以用同樣的方法進行處理。
Promise
也有一些缺點。
- 無法取消
Promise
,一旦新建它就會立即執行,無法中途取消。 - 如果不設置回調函數,
Promise
內部拋出的錯誤,不會反應到外部。 - 當處於
Pending
狀態時,無法得知目前進展到哪一個階段(剛剛開始還是即將完成)。
如果某些事件不斷地反復發生,一般來說,使用stream模式是比部署Promise
更好的選擇。
基本用法
Promise構造函數接受一個函數作為參數,該函數的兩個參數分別是resolve
和reject
。它們是兩個函數,由JavaScript引擎提供,不用自己部署。
var promise = new Promise(function(resolve, reject) { // ... some code if (/* 異步操作成功 */){ resolve(value); } else { reject(error); } });
Promise實例生成以后,可以用then方法分別指定Resolved狀態和Reject狀態的回調函數。
promise.then(function(value) { // success }, function(error) { // failure });
then
方法可以接受兩個回調函數作為參數。第一個回調函數是Promise對象的狀態變為Resolved時調用,第二個回調函數是Promise對象的狀態變為Reject時調用。其中,第二個函數是可選的,不一定要提供。這兩個函數都接受Promise對象傳出的值作為參數。
Promise.prototype.catch()
Promise.prototype.catch
方法是.then(null, rejection)
的別名,用於指定發生錯誤時的回調函數。
getJSON("/posts.json").then(function(posts) { // ... }).catch(function(error) { // 處理 getJSON 和 前一個回調函數運行時發生的錯誤 console.log('發生錯誤!', error); });
上面代碼中,getJSON
方法返回一個Promise對象,如果該對象狀態變為Resolved
,則會調用then
方法指定的回調函數;如果異步操作拋出錯誤,狀態就會變為Rejected
,就會調用catch
方法指定的回調函數,處理這個錯誤。另外,then
方法指定的回調函數,如果運行中拋出錯誤,也會被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));
一般來說,不要在then
方法里面定義Reject狀態的回調函數(即then
的第二個參數),總是使用catch
方法。
// bad promise .then(function(data) { // success }, function(err) { // error }); // good promise .then(function(data) { //cb // success }) .catch(function(err) { // error });
上面代碼中,第二種寫法要好於第一種寫法,理由是第二種寫法可以捕獲前面then
方法執行中的錯誤,也更接近同步的寫法(try/catch
)。因此,建議總是使用catch
方法,而不使用then
方法的第二個參數。
跟傳統的try/catch
代碼塊不同的是,如果沒有使用catch
方法指定錯誤處理的回調函數,Promise對象拋出的錯誤不會傳遞到外層代碼,即不會有任何反應。
Promise.all()
Promise.all
方法用於將多個Promise實例,包裝成一個新的Promise實例。
var p = Promise.all([p1, p2, p3]);
上面代碼中,Promise.all
方法接受一個數組作為參數,p1
、p2
、p3
都是Promise對象的實例,如果不是,就會先調用下面講到的Promise.resolve
方法,將參數轉為Promise實例,再進一步處理。(Promise.all
方法的參數可以不是數組,但必須具有Iterator接口,且返回的每個成員都是Promise實例。)
p
的狀態由p1
、p2
、p3
決定,分成兩種情況。
- 只有
p1
、p2
、p3
的狀態都變成fulfilled
,p
的狀態才會變成fulfilled
,此時p1
、p2
、p3
的返回值組成一個數組,傳遞給p
的回調函數。 - 只要
p1
、p2
、p3
之中有一個被rejected
,p
的狀態就變成rejected
,此時第一個被reject
的實例的返回值,會傳遞給p
的回調函數。
下面是一個具體的例子。
// 生成一個Promise對象的數組 var promises = [2, 3, 5, 7, 11, 13].map(function (id) { return getJSON("/post/" + id + ".json"); }); Promise.all(promises).then(function (posts) { // ... }).catch(function(reason){ // ... });
上面代碼中,promises
是包含6個Promise實例的數組,只有這6個實例的狀態都變成fulfilled
,或者其中有一個變為rejected
,才會調用Promise.all
方法后面的回調函數。
Promise.race()
Promise.race
方法同樣是將多個Promise實例,包裝成一個新的Promise實例。
var p = Promise.race([p1,p2,p3]);
上面代碼中,只要p1
、p2
、p3
之中有一個實例率先改變狀態,p
的狀態就跟着改變。那個率先改變的Promise實例的返回值,就傳遞給p
的回調函數。
Promise.race
方法的參數與Promise.all
方法一樣,如果不是Promise實例,就會先調用下面講到的Promise.resolve
方法,將參數轉為Promise實例,再進一步處理。
下面是一個例子,如果指定時間內沒有獲得結果,就將Promise的狀態變為reject
,否則變為resolve
。
var p = Promise.race([ fetch('/resource-that-may-take-a-while'), new Promise(function (resolve, reject) { setTimeout(() => reject(new Error('request timeout')), 5000) }) ]) p.then(response => console.log(response)) p.catch(error => console.log(error))
上面代碼中,如果5秒之內fetch
方法無法返回結果,變量p
的狀態就會變為rejected
,從而觸發catch
方法指定的回調函數。
Promise.resolve()
有時需要將現有對象轉為Promise對象,Promise.resolve
方法就起到這個作用。
var jsPromise = Promise.resolve($.ajax('/whatever.json'));
上面代碼將jQuery生成的deferred
對象,轉為一個新的Promise對象。
Promise.resolve
等價於下面的寫法。
Promise.resolve('foo') // 等價於 new Promise(resolve => resolve('foo'))
Promise.resolve
方法的參數分成四種情況。
(1)參數是一個Promise實例
如果參數是Promise實例,那么Promise.resolve
將不做任何修改、原封不動地返回這個實例。
(2)參數是一個thenable
對象
thenable
對象指的是具有then
方法的對象,比如下面這個對象。
let thenable = { then: function(resolve, reject) { resolve(42); } };
Promise.resolve
方法會將這個對象轉為Promise對象,然后就立即執行thenable
對象的then
方法。
let thenable = { then: function(resolve, reject) { resolve(42); } }; let p1 = Promise.resolve(thenable); p1.then(function(value) { console.log(value); // 42 });
上面代碼中,thenable
對象的then
方法執行后,對象p1
的狀態就變為resolved
,從而立即執行最后那個then
方法指定的回調函數,輸出42。
(3)參數不是具有then
方法的對象,或根本就不是對象
如果參數是一個原始值,或者是一個不具有then
方法的對象,則Promise.resolve
方法返回一個新的Promise對象,狀態為Resolved
。
var p = Promise.resolve('Hello'); p.then(function (s){ console.log(s) }); // Hello
上面代碼生成一個新的Promise對象的實例p
。由於字符串Hello
不屬於異步操作(判斷方法是它不是具有then方法的對象),返回Promise實例的狀態從一生成就是Resolved
,所以回調函數會立即執行。Promise.resolve
方法的參數,會同時傳給回調函數。
(4)不帶有任何參數
Promise.resolve
方法允許調用時不帶參數,直接返回一個Resolved
狀態的Promise對象。
所以,如果希望得到一個Promise對象,比較方便的方法就是直接調用Promise.resolve
方法。
var p = Promise.resolve(); p.then(function () { // ... });
上面代碼的變量p
就是一個Promise對象。
Promise.reject()
Promise.reject(reason)
方法也會返回一個新的Promise實例,該實例的狀態為rejected
。它的參數用法與Promise.resolve
方法完全一致。
var p = Promise.reject('出錯了'); // 等同於 var p = new Promise((resolve, reject) => reject('出錯了')) p.then(null, function (s){ console.log(s) }); // 出錯了
上面代碼生成一個Promise對象的實例p
,狀態為rejected
,回調函數會立即執行。
兩個有用的附加方法
ES6的Promise API提供的方法不是很多,有些有用的方法可以自己部署。下面介紹如何部署兩個不在ES6之中、但很有用的方法。
done()
Promise對象的回調鏈,不管以then
方法或catch
方法結尾,要是最后一個方法拋出錯誤,都有可能無法捕捉到(因為Promise內部的錯誤不會冒泡到全局)。因此,我們可以提供一個done
方法,總是處於回調鏈的尾端,保證拋出任何可能出現的錯誤。
asyncFunc() .then(f1) .catch(r1) .then(f2) .done();
它的實現代碼相當簡單。
Promise.prototype.done = function (onFulfilled, onRejected) { this.then(onFulfilled, onRejected) .catch(function (reason) { // 拋出一個全局錯誤 setTimeout(() => { throw reason }, 0); }); };
從上面代碼可見,done
方法的使用,可以像then
方法那樣用,提供Fulfilled
和Rejected
狀態的回調函數,也可以不提供任何參數。但不管怎樣,done
都會捕捉到任何可能出現的錯誤,並向全局拋出。
finally()
finally
方法用於指定不管Promise對象最后狀態如何,都會執行的操作。它與done
方法的最大區別,它接受一個普通的回調函數作為參數,該函數不管怎樣都必須執行。
下面是一個例子,服務器使用Promise處理請求,然后使用finally
方法關掉服務器。
server.listen(0) .then(function () { // run test }) .finally(server.stop);
它的實現也很簡單。
Promise.prototype.finally = function (callback) { let P = this.constructor; return this.then( value => P.resolve(callback()).then(() => value), reason => P.resolve(callback()).then(() => { throw reason }) ); };
上面代碼中,不管前面的Promise是fulfilled
還是rejected
,都會執行回調函數callback
。