Promise對象 · ECMAScript 6入門

## Promise的含義 Promise在JavaScript語言早有實現，ES6將其寫進了語言標準，統一了用法，原生提供了Promise對象。所謂Promise，就是一個對象，用來傳遞異步操作的消息。它代表了某個未來才會知道結果的事件（通常是一個異步操作），并且這個事件提供統一的API，可供進一步處理。 Promise對象有以下兩個特點。（1）對象的狀態不受外界影響。Promise對象代表一個異步操作，有三種狀態：Pending（進行中）、Resolved（已完成，又稱Fulfilled）和Rejected（已失敗）。只有異步操作的結果，可以決定當前是哪一種狀態，任何其他操作都無法改變這個狀態。這也是Promise這個名字的由來，它的英語意思就是“承諾”，表示其他手段無法改變。（2）一旦狀態改變，就不會再變，任何時候都可以得到這個結果。Promise對象的狀態改變，只有兩種可能：從Pending變為Resolved和從Pending變為Rejected。只要這兩種情況發生，狀態就凝固了，不會再變了，會一直保持這個結果。就算改變已經發生了，你再對Promise對象添加回調函數，也會立即得到這個結果。這與事件（Event）完全不同，事件的特點是，如果你錯過了它，再去監聽，是得不到結果的。有了Promise對象，就可以將異步操作以同步操作的流程表達出來，避免了層層嵌套的回調函數。此外，Promise對象提供統一的接口，使得控制異步操作更加容易。 Promise也有一些缺點。首先，無法取消Promise，一旦新建它就會立即執行，無法中途取消。其次，如果不設置回調函數，Promise內部拋出的錯誤，不會反應到外部。第三，當處于Pending狀態時，無法得知目前進展到哪一個階段（剛剛開始還是即將完成）。如果某些事件不斷地反復發生，一般來說，使用stream模式是比部署Promise更好的選擇。 ## 基本用法 ES6規定，Promise對象是一個構造函數，用來生成Promise實例。下面代碼創造了一個Promise實例。 ~~~ 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(value) { // failure }); ~~~ then方法可以接受兩個回調函數作為參數。第一個回調函數是Promise對象的狀態變為Resolved時調用，第二個回調函數是Promise對象的狀態變為Reject時調用。其中，第二個函數是可選的，不一定要提供。這兩個函數都接受Promise對象傳出的值作為參數。下面是一個Promise對象的簡單例子。 ~~~ function timeout(ms) { return new Promise((resolve) => { setTimeout(resolve, ms, 'done'); }); } timeout(100).then((value) => { console.log(value); }); ~~~ 上面代碼中，timeout方法返回一個Promise實例，表示一段時間以后才會發生的結果。過了指定的時間（ms參數）以后，Promise實例的狀態變為Resolved，就會觸發then方法綁定的回調函數。下面是一個用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.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的回調函數將會立刻執行。 ## Promise.prototype.then() 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() Promise.prototype.catch方法是`.then(null, rejection)`的別名，用于指定發生錯誤時的回調函數。 ~~~ getJSON("/posts.json").then(function(posts) { // ... }).catch(function(error) { // 處理前一個回調函數運行時發生的錯誤 console.log('發生錯誤！', error); }); ~~~ 上面代碼中，getJSON方法返回一個Promise對象，如果該對象狀態變為Resolved，則會調用then方法指定的回調函數；如果異步操作拋出錯誤，狀態就會變為Rejected，就會調用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方法指定的回調函數捕獲。如果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捕獲。跟傳統的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方法，這個錯誤不會被捕獲，也不會傳遞到外層代碼，導致運行后沒有任何輸出。 ~~~ 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指定在下一輪“事件循環”再拋出錯誤，結果由于沒有指定catch語句，就冒泡到最外層，成了未捕獲的錯誤。 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().then(function() { return someOtherAsyncThing(); }).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方法之中，還能再拋出錯誤。 ~~~ 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.all方法用于將多個Promise實例，包裝成一個新的Promise實例。 ~~~ var p = Promise.all([p1,p2,p3]); ~~~ 上面代碼中，Promise.all方法接受一個數組作為參數，p1、p2、p3都是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){ // ... }); ~~~ ## Promise.race() Promise.race方法同樣是將多個Promise實例，包裝成一個新的Promise實例。 ~~~ var p = Promise.race([p1,p2,p3]); ~~~ 上面代碼中，只要p1、p2、p3之中有一個實例率先改變狀態，p的狀態就跟著改變。那個率先改變的Promise實例的返回值，就傳遞給p的回調函數。如果Promise.all方法和Promise.race方法的參數，不是Promise實例，就會先調用下面講到的Promise.resolve方法，將參數轉為Promise實例，再進一步處理。 ## Promise.resolve() 有時需要將現有對象轉為Promise對象，Promise.resolve方法就起到這個作用。 ~~~ var jsPromise = Promise.resolve($.ajax('/whatever.json')); ~~~ 上面代碼將jQuery生成deferred對象，轉為一個新的Promise對象。如果Promise.resolve方法的參數，不是具有then方法的對象（又稱thenable對象），則返回一個新的Promise對象，且它的狀態為Resolved。 ~~~ var p = Promise.resolve('Hello'); p.then(function (s){ console.log(s) }); // Hello ~~~ 上面代碼生成一個新的Promise對象的實例p。由于字符串Hello不屬于異步操作（判斷方法是它不是具有then方法的對象），返回Promise實例的狀態從一生成就是Resolved，所以回調函數會立即執行。Promise.resolve方法的參數，會同時傳給回調函數。 Promise.resolve方法允許調用時不帶參數。所以，如果希望得到一個Promise對象，比較方便的方法就是直接調用Promise.resolve方法。 ~~~ var p = Promise.resolve(); p.then(function () { // ... }); ~~~ 上面代碼的變量p就是一個Promise對象。如果Promise.resolve方法的參數是一個Promise實例，則會被原封不動地返回。 ## Promise.reject() Promise.reject(reason)方法也會返回一個新的Promise實例，該實例的狀態為rejected。Promise.reject方法的參數reason，會被傳遞給實例的回調函數。 ~~~ var p = Promise.reject('出錯了'); p.then(null, function (s){ console.log(s) }); // 出錯了 ~~~ 上面代碼生成一個Promise對象的實例p，狀態為rejected，回調函數會立即執行。 ## Generator函數與Promise的結合使用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(value)); }); } go(it.next()); } run(g); ~~~ 上面代碼的Generator函數g之中，有一個異步操作getFoo，它返回的就是一個Promise對象。函數run用來處理這個Promise對象，并調用下一個next方法。 ## async函數 async函數與Promise、Generator函數一樣，是用來取代回調函數、解決異步操作的一種方法。它本質上是Generator函數的語法糖。async函數并不屬于ES6，而是被列入了ES7，但是traceur、Babel.js、regenerator等轉碼器已經支持這個功能，轉碼后立刻就能使用。 async函數的詳細介紹，請看《異步操作》一章。