Promise · ES6-NOTE

## Promise 的含義 Promise 是異步編程的一種解決方案，比傳統的解決方案——回調函數和事件——更合理和更強大。它由社區最早提出和實現，ES6 將其寫進了語言標準，統一了用法，原生提供了`Promise`對象。所謂`Promise`，簡單說就是一個容器，里面保存著某個未來才會結束的事件（通常是一個異步操作）的結果。從語法上說，Promise 是一個對象，從它可以獲取異步操作的消息。Promise 提供統一的 API，各種異步操作都可以用同樣的方法進行處理。 `Promise`對象有以下兩個特點。（1）對象的狀態不受外界影響。`Promise`對象代表一個異步操作，有三種狀態：`pending`（進行中）、`fulfilled`（已成功）和`rejected`（已失敗）。只有異步操作的結果，可以決定當前是哪一種狀態，任何其他操作都無法改變這個狀態。這也是`Promise`這個名字的由來，它的英語意思就是“承諾”，表示其他手段無法改變。（2）一旦狀態改變，就不會再變，任何時候都可以得到這個結果。`Promise`對象的狀態改變，只有兩種可能：從`pending`變為`fulfilled`和從`pending`變為`rejected`。只要這兩種情況發生，狀態就凝固了，不會再變了，會一直保持這個結果，這時就稱為 resolved（已定型）。如果改變已經發生了，你再對`Promise`對象添加回調函數，也會立即得到這個結果。這與事件（Event）完全不同，事件的特點是，如果你錯過了它，再去監聽，是得不到結果的。注意，為了行文方便，本章后面的`resolved`統一只指`fulfilled`狀態，不包含`rejected`狀態。 ## 基本用法 ES6 規定，`Promise`對象是一個構造函數，用來生成`Promise`實例。下面代碼創造了一個`Promise`實例。 ~~~javascript const 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`狀態和`rejected`狀態的回調函數。 ~~~javascript promise.then(function(value) { // success }, function(error) { // failure }); ~~~ `then`方法可以接受兩個回調函數作為參數。第一個回調函數是`Promise`對象的狀態變為`resolved`時調用，第二個回調函數是`Promise`對象的狀態變為`rejected`時調用。其中，第二個函數是可選的，不一定要提供。這兩個函數都接受`Promise`對象傳出的值作為參數。下面是一個`Promise`對象的簡單例子。 ~~~javascript 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 新建后就會立即執行。 ~~~javascript 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`最后輸出。如果調用`resolve`函數和`reject`函數時帶有參數，那么它們的參數會被傳遞給回調函數。`reject`函數的參數通常是`Error`對象的實例，表示拋出的錯誤；`resolve`函數的參數除了正常的值以外，還可能是另一個 Promise 實例，比如像下面這樣。 ~~~javascript const p1 = new Promise(function (resolve, reject) { // ... }); const 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`的回調函數將會立刻執行。 ~~~javascript 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`是一個 Promise，3 秒之后變為`rejected`。`p2`的狀態在 1 秒之后改變，`resolve`方法返回的是`p1`。由于`p2`返回的是另一個 Promise，導致`p2`自己的狀態無效了，由`p1`的狀態決定`p2`的狀態。所以，后面的`then`語句都變成針對后者（`p1`）。又過了 2 秒，`p1`變為`rejected`，導致觸發`catch`方法指定的回調函數。注意，調用`resolve`或`reject`并不會終結 Promise 的參數函數的執行。 ~~~javascript new Promise((resolve, reject) => { resolve(1); console.log(2); }).then(r => { console.log(r); }); // 2 // 1 ~~~ 上面代碼中，調用`resolve(1)`以后，后面的`console.log(2)`還是會執行，并且會首先打印出來。這是因為立即 resolved 的 Promise 是在本輪事件循環的末尾執行，總是晚于本輪循環的同步任務。一般來說，調用`resolve`或`reject`以后，Promise 的使命就完成了，后繼操作應該放到`then`方法里面，而不應該直接寫在`resolve`或`reject`的后面。所以，最好在它們前面加上`return`語句，這樣就不會有意外。 ~~~javascript new Promise((resolve, reject) => { return resolve(1); // 后面的語句不會執行 console.log(2); }) ~~~ ## Promise.prototype.catch() `Promise.prototype.catch`方法是`.then(null, rejection)`或`.then(undefined, rejection)`的別名，用于指定發生錯誤時的回調函數。 ~~~javascript getJSON('/posts.json').then(function(posts) { // ... }).catch(function(error) { // 處理 getJSON 和前一個回調函數運行時發生的錯誤 console.log('發生錯誤！', error); }); ~~~ 上面代碼中，`getJSON`方法返回一個 Promise 對象，如果該對象狀態變為`resolved`，則會調用`then`方法指定的回調函數；如果異步操作拋出錯誤，狀態就會變為`rejected`，就會調用`catch`方法指定的回調函數，處理這個錯誤。另外，`then`方法指定的回調函數，如果運行中拋出錯誤，也會被`catch`方法捕獲。 ~~~javascript 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)); ~~~ 下面是一個例子。 ~~~javascript const promise = new Promise(function(resolve, reject) { throw new Error('test'); }); promise.catch(function(error) { console.log(error); }); // Error: test ~~~ 上面代碼中，`promise`拋出一個錯誤，就被`catch`方法指定的回調函數捕獲。注意，上面的寫法與下面兩種寫法是等價的。 ~~~javascript // 寫法一 const promise = new Promise(function(resolve, reject) { try { throw new Error('test'); } catch(e) { reject(e); } }); promise.catch(function(error) { console.log(error); }); // 寫法二 const promise = new Promise(function(resolve, reject) { reject(new Error('test')); }); promise.catch(function(error) { console.log(error); }); ~~~ 比較上面兩種寫法，可以發現`reject`方法的作用，等同于拋出錯誤。如果 Promise 狀態已經變成`resolved`，再拋出錯誤是無效的。 ~~~javascript const 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 的狀態一旦改變，就永久保持該狀態，不會再變了。 Promise 對象的錯誤具有“冒泡”性質，會一直向后傳遞，直到被捕獲為止。也就是說，錯誤總是會被下一個`catch`語句捕獲。 ~~~javascript 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`方法。 ~~~javascript // 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 對象拋出的錯誤不會傳遞到外層代碼，即不會有任何反應。 ~~~javascript const someAsyncThing = function() { return new Promise(function(resolve, reject) { // 下面一行會報錯，因為x沒有聲明 resolve(x + 2); }); }; someAsyncThing().then(function() { console.log('everything is great'); }); setTimeout(() => { console.log(123) }, 2000); // Uncaught (in promise) ReferenceError: x is not defined // 123 ~~~ 上面代碼中，`someAsyncThing`函數產生的 Promise 對象，內部有語法錯誤。瀏覽器運行到這一行，會打印出錯誤提示`ReferenceError: x is not defined`，但是不會退出進程、終止腳本執行，2 秒之后還是會輸出`123`。這就是說，Promise 內部的錯誤不會影響到 Promise 外部的代碼，通俗的說法就是“Promise 會吃掉錯誤”。這個腳本放在服務器執行，退出碼就是`0`（即表示執行成功）。不過，Node 有一個`unhandledRejection`事件，專門監聽未捕獲的`reject`錯誤，上面的腳本會觸發這個事件的監聽函數，可以在監聽函數里面拋出錯誤。 ~~~javascript process.on('unhandledRejection', function (err, p) { throw err; }); ~~~ 上面代碼中，`unhandledRejection`事件的監聽函數有兩個參數，第一個是錯誤對象，第二個是報錯的 Promise 實例，它可以用來了解發生錯誤的環境信息。注意，Node 有計劃在未來廢除`unhandledRejection`事件。如果 Promise 內部有未捕獲的錯誤，會直接終止進程，并且進程的退出碼不為 0。再看下面的例子。 ~~~javascript const 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 指定在下一輪“事件循環”再拋出錯誤。到了那個時候，Promise 的運行已經結束了，所以這個錯誤是在 Promise 函數體外拋出的，會冒泡到最外層，成了未捕獲的錯誤。一般總是建議，Promise 對象后面要跟`catch`方法，這樣可以處理 Promise 內部發生的錯誤。`catch`方法返回的還是一個 Promise 對象，因此后面還可以接著調用`then`方法。 ~~~javascript const 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`方法。 ~~~javascript Promise.resolve() .catch(function(error) { console.log('oh no', error); }) .then(function() { console.log('carry on'); }); // carry on ~~~ 上面的代碼因為沒有報錯，跳過了`catch`方法，直接執行后面的`then`方法。此時，要是`then`方法里面報錯，就與前面的`catch`無關了。 `catch`方法之中，還能再拋出錯誤。 ~~~javascript const 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`方法了，導致這個錯誤不會被捕獲，也不會傳遞到外層。如果改寫一下，結果就不一樣了。 ~~~javascript 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`方法拋出的錯誤。