Promise是異步編程的一種解決方案,比傳統的解決方案——回調函數和事件——更合理和更強大。它由社區最先提出和實現,ES6將其寫進了語言標準,統一了用法,原生提供了Promise
對象。javascript
所謂Promise
,簡單說就是一個容器,裏面保存着某個將來纔會結束的事件(一般是一個異步操做)的結果。從語法上說,Promise是一個對象,從它能夠獲取異步操做的消息。Promise提供統一的API,各類異步操做均可以用一樣的方法進行處理。java
Promise
對象有如下兩個特色。ajax
(1)對象的狀態不受外界影響。Promise
對象表明一個異步操做,有三種狀態:Pending
(進行中)、Resolved
(已完成,又稱Fulfilled)和Rejected
(已失敗)。只有異步操做的結果,能夠決定當前是哪種狀態,任何其餘操做都沒法改變這個狀態。這也是Promise
這個名字的由來,它的英語意思就是「承諾」,表示其餘手段沒法改變。編程
(2)一旦狀態改變,就不會再變,任什麼時候候均可以獲得這個結果。Promise
對象的狀態改變,只有兩種可能:從Pending
變爲Resolved
和從Pending
變爲Rejected
。只要這兩種狀況發生,狀態就凝固了,不會再變了,會一直保持這個結果。就算改變已經發生了,你再對Promise
對象添加回調函數,也會當即獲得這個結果。這與事件(Event)徹底不一樣,事件的特色是,若是你錯過了它,再去監聽,是得不到結果的。json
有了Promise
對象,就能夠將異步操做以同步操做的流程表達出來,避免了層層嵌套的回調函數。此外,Promise
對象提供統一的接口,使得控制異步操做更加容易。數組
Promise
也有一些缺點。首先,沒法取消Promise
,一旦新建它就會當即執行,沒法中途取消。其次,若是不設置回調函數,Promise
內部拋出的錯誤,不會反應到外部。第三,當處於Pending
狀態時,沒法得知目前進展到哪個階段(剛剛開始仍是即將完成)。promise
若是某些事件不斷地反覆發生,通常來講,使用stream模式是比部署Promise
更好的選擇。瀏覽器
ES6規定,Promise對象是一個構造函數,用來生成Promise實例。服務器
下面代碼創造了一個Promise實例。app
var promise = new Promise(function(resolve, reject) { // ... some code if (/* 異步操做成功 */){ resolve(value); } else { reject(error); } });
Promise構造函數接受一個函數做爲參數,該函數的兩個參數分別是resolve
和reject
。它們是兩個函數,由JavaScript引擎提供,不用本身部署。
resolve
函數的做用是,將Promise對象的狀態從「未完成」變爲「成功」(即從Pending變爲Resolved),在異步操做成功時調用,並將異步操做的結果,做爲參數傳遞出去;reject
函數的做用是,將Promise對象的狀態從「未完成」變爲「失敗」(即從Pending變爲Rejected),在異步操做失敗時調用,並將異步操做報出的錯誤,做爲參數傳遞出去。
Promise實例生成之後,能夠用then
方法分別指定Resolved
狀態和Reject
狀態的回調函數。
promise.then(function(value) { // success }, function(error) { // failure });
then
方法能夠接受兩個回調函數做爲參數。第一個回調函數是Promise對象的狀態變爲Resolved時調用,第二個回調函數是Promise對象的狀態變爲Reject時調用。其中,第二個函數是可選的,不必定要提供。這兩個函數都接受Promise對象傳出的值做爲參數。
下面是一個Promise對象的簡單例子。
function timeout(ms) { return new Promise((resolve, reject) => { setTimeout(resolve, ms, 'done'); }); } timeout(100).then((value) => { console.log(value); });
上面代碼中,timeout
方法返回一個Promise實例,表示一段時間之後纔會發生的結果。過了指定的時間(ms
參數)之後,Promise實例的狀態變爲Resolved,就會觸發then
方法綁定的回調函數。
Promise新建後就會當即執行。
let promise = new Promise(function(resolve, reject) { console.log('Promise'); resolve(); }); promise.then(function() { console.log('Resolved.'); }); console.log('Hi!'); // Promise // Hi! // Resolved
上面代碼中,Promise新建後當即執行,因此首先輸出的是「Promise」。而後,then
方法指定的回調函數,將在當前腳本全部同步任務執行完纔會執行,因此「Resolved」最後輸出。
下面是異步加載圖片的例子。
function loadImageAsync(url) { return new Promise(function(resolve, reject) { var image = new Image(); image.onload = function() { resolve(image); }; image.onerror = function() { reject(new Error('Could not load image at ' + url)); }; image.src = url; }); }
上面代碼中,使用Promise包裝了一個圖片加載的異步操做。若是加載成功,就調用resolve
方法,不然就調用reject
方法。
下面是一個用Promise對象實現的Ajax操做的例子。
var getJSON = function(url) { var promise = new Promise(function(resolve, reject){ var client = new XMLHttpRequest(); client.open("GET", url); client.onreadystatechange = handler; client.responseType = "json"; client.setRequestHeader("Accept", "application/json"); client.send(); function handler() { if (this.readyState !== 4) { return; } if (this.status === 200) { resolve(this.response); } else { reject(new Error(this.statusText)); } }; }); return promise; }; getJSON("/posts.json").then(function(json) { console.log('Contents: ' + json); }, function(error) { console.error('出錯了', error); });
上面代碼中,getJSON
是對XMLHttpRequest對象的封裝,用於發出一個針對JSON數據的HTTP請求,而且返回一個Promise對象。須要注意的是,在getJSON
內部,resolve
函數和reject
函數調用時,都帶有參數。
若是調用resolve
函數和reject
函數時帶有參數,那麼它們的參數會被傳遞給回調函數。reject
函數的參數一般是Error對象的實例,表示拋出的錯誤;resolve
函數的參數除了正常的值之外,還多是另外一個Promise實例,表示異步操做的結果有多是一個值,也有多是另外一個異步操做,好比像下面這樣。
var p1 = new Promise(function (resolve, reject) { // ... }); var p2 = new Promise(function (resolve, reject) { // ... resolve(p1); })
上面代碼中,p1
和p2
都是Promise的實例,可是p2
的resolve
方法將p1
做爲參數,即一個異步操做的結果是返回另外一個異步操做。
注意,這時p1
的狀態就會傳遞給p2
,也就是說,p1
的狀態決定了p2
的狀態。若是p1
的狀態是Pending
,那麼p2
的回調函數就會等待p1
的狀態改變;若是p1
的狀態已是Resolved
或者Rejected
,那麼p2
的回調函數將會馬上執行。
var p1 = new Promise(function (resolve, reject) { setTimeout(() => reject(new Error('fail')), 3000) }) var p2 = new Promise(function (resolve, reject) { setTimeout(() => resolve(p1), 1000) }) p2 .then(result => console.log(result)) .catch(error => console.log(error)) // Error: fail
上面代碼中,p1
是一個Promise,3秒以後變爲rejected
。p2
的狀態在1秒以後改變,resolve
方法返回的是p1
。此時,因爲p2
返回的是另外一個Promise,因此後面的then
語句都變成針對後者(p1
)。又過了2秒,p1
變爲rejected
,致使觸發catch
方法指定的回調函數。
Promise實例具備then
方法,也就是說,then
方法是定義在原型對象Promise.prototype上的。它的做用是爲Promise實例添加狀態改變時的回調函數。前面說過,then
方法的第一個參數是Resolved狀態的回調函數,第二個參數(可選)是Rejected狀態的回調函數。
then
方法返回的是一個新的Promise實例(注意,不是原來那個Promise實例)。所以能夠採用鏈式寫法,即then
方法後面再調用另外一個then
方法。
getJSON("/posts.json").then(function(json) { return json.post; }).then(function(post) { // ... });
上面的代碼使用then
方法,依次指定了兩個回調函數。第一個回調函數完成之後,會將返回結果做爲參數,傳入第二個回調函數。
採用鏈式的then
,能夠指定一組按照次序調用的回調函數。這時,前一個回調函數,有可能返回的仍是一個Promise對象(即有異步操做),這時後一個回調函數,就會等待該Promise對象的狀態發生變化,纔會被調用。
getJSON("/post/1.json").then(function(post) { return getJSON(post.commentURL); }).then(function funcA(comments) { console.log("Resolved: ", comments); }, function funcB(err){ console.log("Rejected: ", err); });
上面代碼中,第一個then
方法指定的回調函數,返回的是另外一個Promise對象。這時,第二個then
方法指定的回調函數,就會等待這個新的Promise對象狀態發生變化。若是變爲Resolved,就調用funcA
,若是狀態變爲Rejected,就調用funcB
。
若是採用箭頭函數,上面的代碼能夠寫得更簡潔。
getJSON("/post/1.json").then( post => getJSON(post.commentURL) ).then( comments => console.log("Resolved: ", comments), err => console.log("Rejected: ", err) );
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));
下面是一個例子。
var promise = new Promise(function(resolve, reject) { throw new Error('test'); }); promise.catch(function(error) { console.log(error); }); // Error: test
上面代碼中,promise
拋出一個錯誤,就被catch
方法指定的回調函數捕獲。注意,上面的寫法與下面兩種寫法是等價的。
// 寫法一 var promise = new Promise(function(resolve, reject) { try { throw new Error('test'); } catch(e) { reject(e); } }); promise.catch(function(error) { console.log(error); }); // 寫法二 var promise = new Promise(function(resolve, reject) { reject(new Error('test')); }); promise.catch(function(error) { console.log(error); });
比較上面兩種寫法,能夠發現reject
方法的做用,等同於拋出錯誤。
若是Promise狀態已經變成Resolved
,再拋出錯誤是無效的。
var promise = new Promise(function(resolve, reject) { resolve('ok'); throw new Error('test'); }); promise .then(function(value) { console.log(value) }) .catch(function(error) { console.log(error) }); // ok
上面代碼中,Promise在resolve
語句後面,再拋出錯誤,不會被捕獲,等於沒有拋出。
Promise對象的錯誤具備「冒泡」性質,會一直向後傳遞,直到被捕獲爲止。也就是說,錯誤老是會被下一個catch
語句捕獲。
getJSON("/post/1.json").then(function(post) { return getJSON(post.commentURL); }).then(function(comments) { // some code }).catch(function(error) { // 處理前面三個Promise產生的錯誤 });
上面代碼中,一共有三個Promise對象:一個由getJSON
產生,兩個由then
產生。它們之中任何一個拋出的錯誤,都會被最後一個catch
捕獲。
通常來講,不要在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對象拋出的錯誤不會傳遞到外層代碼,即不會有任何反應。
var someAsyncThing = function() { return new Promise(function(resolve, reject) { // 下面一行會報錯,由於x沒有聲明 resolve(x + 2); }); }; someAsyncThing().then(function() { console.log('everything is great'); });
上面代碼中,someAsyncThing
函數產生的Promise對象會報錯,可是因爲沒有指定catch
方法,這個錯誤不會被捕獲,也不會傳遞到外層代碼,致使運行後沒有任何輸出。注意,Chrome瀏覽器不遵照這條規定,它會拋出錯誤「ReferenceError: x is not defined」。
var promise = new Promise(function(resolve, reject) { resolve("ok"); setTimeout(function() { throw new Error('test') }, 0) }); promise.then(function(value) { console.log(value) }); // ok // Uncaught Error: test
上面代碼中,Promise指定在下一輪「事件循環」再拋出錯誤,結果因爲沒有指定使用try...catch
語句,就冒泡到最外層,成了未捕獲的錯誤。由於此時,Promise的函數體已經運行結束了,因此這個錯誤是在Promise函數體外拋出的。
Node.js有一個unhandledRejection
事件,專門監聽未捕獲的reject
錯誤。
process.on('unhandledRejection', function (err, p) { console.error(err.stack) });
上面代碼中,unhandledRejection
事件的監聽函數有兩個參數,第一個是錯誤對象,第二個是報錯的Promise實例,它能夠用來了解發生錯誤的環境信息。。
須要注意的是,catch
方法返回的仍是一個Promise對象,所以後面還能夠接着調用then
方法。
var someAsyncThing = function() { return new Promise(function(resolve, reject) { // 下面一行會報錯,由於x沒有聲明 resolve(x + 2); }); }; someAsyncThing() .catch(function(error) { console.log('oh no', error); }) .then(function() { console.log('carry on'); }); // oh no [ReferenceError: x is not defined] // carry on
上面代碼運行完catch
方法指定的回調函數,會接着運行後面那個then
方法指定的回調函數。若是沒有報錯,則會跳過catch
方法。
Promise.resolve() .catch(function(error) { console.log('oh no', error); }) .then(function() { console.log('carry on'); }); // carry on
上面的代碼由於沒有報錯,跳過了catch
方法,直接執行後面的then
方法。此時,要是then
方法裏面報錯,就與前面的catch
無關了。
catch
方法之中,還能再拋出錯誤。
var someAsyncThing = function() { return new Promise(function(resolve, reject) { // 下面一行會報錯,由於x沒有聲明 resolve(x + 2); }); }; someAsyncThing().then(function() { return someOtherAsyncThing(); }).catch(function(error) { console.log('oh no', error); // 下面一行會報錯,由於y沒有聲明 y + 2; }).then(function() { console.log('carry on'); }); // oh no [ReferenceError: x is not defined]
上面代碼中,catch
方法拋出一個錯誤,由於後面沒有別的catch
方法了,致使這個錯誤不會被捕獲,也不會傳遞到外層。若是改寫一下,結果就不同了。
someAsyncThing().then(function() { return someOtherAsyncThing(); }).catch(function(error) { console.log('oh no', error); // 下面一行會報錯,由於y沒有聲明 y + 2; }).catch(function(error) { console.log('carry on', error); }); // oh no [ReferenceError: x is not defined] // carry on [ReferenceError: y is not defined]
上面代碼中,第二個catch
方法用來捕獲,前一個catch
方法拋出的錯誤。
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
決定,分紅兩種狀況。
(1)只有p1
、p2
、p3
的狀態都變成fulfilled
,p
的狀態纔會變成fulfilled
,此時p1
、p2
、p3
的返回值組成一個數組,傳遞給p
的回調函數。
(2)只要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
方法後面的回調函數。
下面是另外一個例子。
const databasePromise = connectDatabase(); const booksPromise = databaseProimse .then(findAllBooks); const userPromise = databasePromise .then(getCurrentUser); Promise.all([ booksPromise, userPromise ]) .then(([books, user]) => pickTopRecommentations(books, user));
上面代碼中,booksPromise
和userPromise
是兩個異步操做,只有等到它們的結果都返回了,纔會觸發pickTopRecommentations
這個回調函數。
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對象,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對象。
須要注意的是,當即resolve
的Promise對象,是在本輪「事件循環」(event loop)的結束時,而不是在下一輪「事件循環」的開始時。
setTimeout(function () { console.log('three'); }, 0); Promise.resolve().then(function () { console.log('two'); }); console.log('one'); // one // two // three
上面代碼中,setTimeout(fn, 0)
在下一輪「事件循環」開始時執行,Promise.resolve()
在本輪「事件循環」結束時執行,console.log(’one‘)
則是當即執行,所以最早輸出。
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之中、但頗有用的方法。
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
方法用於指定無論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
。
咱們能夠將圖片的加載寫成一個Promise
,一旦加載完成,Promise
的狀態就發生變化。
const preloadImage = function (path) { return new Promise(function (resolve, reject) { var image = new Image(); image.onload = resolve; image.onerror = reject; image.src = path; }); };
使用Generator函數管理流程,遇到異步操做的時候,一般返回一個Promise
對象。
function getFoo () { return new Promise(function (resolve, reject){ resolve('foo'); }); } var g = function* () { try { var foo = yield getFoo(); console.log(foo); } catch (e) { console.log(e); } }; function run (generator) { var it = generator(); function go(result) { if (result.done) return result.value; return result.value.then(function (value) { return go(it.next(value)); }, function (error) { return go(it.throw(error)); }); } go(it.next()); } run(g);
上面代碼的Generator函數g
之中,有一個異步操做getFoo
,它返回的就是一個Promise
對象。函數run
用來處理這個Promise
對象,並調用下一個next
方法。