深入理解 ES6 Promise

az44yao發表於2020-09-28

 

JS Promise.jpeg

https://segmentfault.com/a/1190000020934044

引語

最近一段時間在重溫ES6,Promise應該是是ES6新特性中非常重要的一部分內容。其實Promise在我日常開發中已經用得比較多,但大多數時候只是知道Promise可以用來實現非同步程式設計,也只限於單純地會用罷了,並沒有時間深入去學習過,而且網上得資料大多都比較瑣碎。我就自己花時間做了一個關於Promise比較完整的整理,深入學習一下Promise,加深印象。

在開始深入學習Promise前,熟悉JS Event Loop的機制是非常有必要的,如果你對Event Loop還不熟悉,非常推薦你先閱讀JavaScript之多執行緒和Event Loop這篇文章,會對你更好理解Promise執行順序幫助很大!

為什麼需要Promise

JavaScript 由於某種原因是被設計為單執行緒的,同時由於 JavaScript 在設計之初是用於瀏覽器的 GUI 程式設計,這也就需要執行緒不能進行阻塞。

所以在後續的發展過程中基本都採用非同步非阻塞的程式設計模式。

簡單來說,非同步程式設計就是在執行一個指令之後不是馬上得到結果,而是繼續執行後面的指令,等到特定的事件觸發後,才得到結果。

也正是因為這樣,我們常常會說: JavaScript 是由事件驅動的。

用 JavaScript 構建一個應用的時候經常會遇到非同步程式設計,不管是 Node 服務端還是 Web 前端。

那如何去進行非同步程式設計呢?回撥函式就是非同步執行最基礎的實現。如果你曾經寫過一點的 Node, 可能經常會遇到這樣的程式碼:

connection.query(sql, (err, result) => {
    if(err) {
        console.err(err)
    } else {
        connection.query(sql, (err, result) => {
            if(err) {
                console.err(err)
            } else {
                …
            }
        })
    }
})

如此,connection.query() 是一個非同步的操作,我們在呼叫他的時候,不會馬上得到結果,而是會繼續執行後面的程式碼。這樣,如果我們需要在查到結果之後才做某些事情的話,就需要把相關的程式碼寫在回撥裡面。

這樣的程式碼看層級少了當然還是可以湊合看的,但是在某些場景下,我們就需要一次又一次的回撥…回撥到最後,會發現我們的程式碼就會變成金字塔形狀?這種情況被親切地稱為回撥地獄

回撥地獄不僅看起來很不舒服,可讀性比較差,難以維護,除此之外還有比較重要的一點就是對異常的捕獲無法支援。無論是開發者自身還是同事來接手專案,都是極其無奈的!

有沒有更好的寫法?比如寫成這樣的鏈式呼叫:

let con = connection.query(…
con.success(…)
    .fail(…)

於是乎,出現了Promise!

什麼是Promise?

Promise的含義

Promise 是非同步程式設計的一種解決方案,比傳統的解決方案——回撥函式和事件——更合理和更強大。它由社群最早提出和實現,ES6 將其寫進了語言標準,統一了用法,原生提供了Promise物件。

古人云:“君子一諾千金”,所謂Promise,正如其中文含義,簡單說就是一個承諾,“承諾將來會執行”約定的事情。

從語法上說,Promise 是一個物件,裡面儲存著某個未來才會結束的事件(通常是一個非同步操作)的結果,從它可以獲取非同步操作的訊息。Promise 提供統一的 API,各種非同步操作都可以用同樣的方法進行處理。

Promise也有一些缺點。首先,無法取消Promise,一旦新建它就會立即執行,無法中途取消。其次,如果不設定回撥函式,Promise內部丟擲的錯誤,不會反應到外部。第三,當處於pending狀態時,無法得知目前進展到哪一個階段(剛剛開始還是即將完成)。

約定

不同於“老式”的傳入回撥,在使用 Promise 時,會有以下約定:

  • 在本輪 Javascript event loop(事件迴圈)執行完成之前,回撥函式是不會被呼叫的。
  • 通過then()新增的回撥函式總會被呼叫,即便它是在非同步操作完成之後才被新增的函式。
  • 通過多次呼叫then(),可以新增多個回撥函式,它們會按照插入順序一個接一個獨立執行。

因此,Promise 最直接的好處就是鏈式呼叫chaining)。

Promise的使用

一個Promise的三種狀態

在開始使用Promise之前,我們首先需要了解Promise的三種狀態:

  • pending: 初始狀態,既不是成功,也不是失敗狀態。
  • fulfilled: 意味著操作成功完成。
  • rejected: 意味著操作失敗。

pending 狀態的 Promise 物件可能會變為fulfilled 狀態並傳遞一個值給相應的狀態處理方法,也可能變為失敗狀態(rejected)並傳遞失敗資訊。當其中任一種情況出現時,Promise 物件的 then 方法繫結的處理方法(handlers )就會被呼叫(then方法包含兩個引數:onfulfilled 和 onrejected,它們都是 Function 型別。當Promise狀態為fulfilled時,呼叫 then 的 onfulfilled 方法,當Promise狀態為rejected時,呼叫 then 的 onrejected 方法, 所以在非同步操作的完成和繫結處理方法之間不存在競爭)。

因為Promise.prototype.thenPromise.prototype.catch方法返回promise 物件, 所以它們可以被鏈式呼叫

截圖2019-11-0623.52.57.png

Promise的這三種狀態有兩個特點:

  • 物件的狀態不受外界影響。
    只有非同步操作的結果,可以決定當前是哪一種狀態,任何其他操作都無法改變這個狀態。這也是Promise這個名字的由來,它的英語意思就是“承諾”,表示其他手段無法改變。
  • 一旦狀態改變,就不會再變,任何時候都可以得到這個結果。
    Promise物件的狀態改變,只有兩種可能:從pending變為fulfilled和從pending變為rejected。只要這兩種情況發生,狀態就凝固了,不會再變了,會一直保持這個結果,這時就稱為 resolved(已定型)。如果改變已經發生了,你再對Promise物件新增回撥函式,也會立即得到這個結果。這與事件(Event)完全不同,事件的特點是,如果你錯過了它,再去監聽,是得不到結果的。

Promise基本用法

ES6 規定,Promise物件是一個建構函式,用來生成Promise例項。

下面程式碼創造了一個Promise例項。

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狀態的回撥函式。

promise.then(function(value) {
  // success
}, function(error) {
  // failure
});

then方法可以接受兩個回撥函式作為引數。第一個回撥函式是Promise物件的狀態變為resolved時呼叫,第二個回撥函式是Promise物件的狀態變為rejected時呼叫。其中,第二個函式是可選的,不一定要提供。這兩個函式都接受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('1');
  resolve();
});

promise.then(function() {
  console.log('2');
});

console.log('3');

// => 1
// => 3
// => 2

上面程式碼中,Promise 新建後立即執行,所以首先輸出的是1。然後,then方法指定的回撥函式,將在當前指令碼所有同步任務執行完才會執行,所以2最後輸出。

注意,呼叫resolve或reject並不會終結 Promise 的引數函式的執行。

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語句,這樣就不會有意外。

new Promise((resolve, reject) => {
  return resolve(1);
  // 後面的語句不會執行
  console.log(2);
})

下面是非同步載入圖片的例子。

function loadImageAsync(url) {
  return new Promise(function(resolve, reject) {
    const 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 操作的例子。

const getJSON = function(url) {
  const promise = new Promise(function(resolve, reject){
    const handler = function() {
      if (this.readyState !== 4) {
        return;
      }
      if (this.status === 200) {
        resolve(this.response);
      } else {
        reject(new Error(this.statusText));
      }
    };
    const client = new XMLHttpRequest();
    client.open("GET", url);
    client.onreadystatechange = handler;
    client.responseType = "json";
    client.setRequestHeader("Accept", "application/json");
    client.send();

  });

  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函式呼叫時,都帶有引數。

深入Promise原型

對於Promise的基本用法有了一定認識之後,我們來深入學習一下Promise原型方法。

Promise.prototype.then(onFulfilled, onRejected)

上面的例子中已經提到,Promise 例項具有then方法,也就是說,then方法是定義在原型物件Promise.prototype上的。它的作用是為 Promise 例項新增狀態改變時的回撥函式。then方法的第一個引數是resolved狀態的回撥函式,第二個引數(可選)是rejected狀態的回撥函式。

鏈式呼叫

連續執行兩個或者多個非同步操作是一個常見的需求,在上一個操作執行成功之後,開始下一個的操作,並帶著上一步操作所返回的結果。我們可以通過創造一個 Promise 鏈來實現這種需求。

then方法返回的是一個新的Promise例項(注意,不是原來那個Promise例項)。因此可以採用鏈式呼叫寫法,即then方法後面再呼叫另一個then方法。

const promise = doSomething();
const promise2 = promise.then(successCallback, failureCallback);

或者

const promise2 = doSomething().then(successCallback, failureCallback);

第二個物件(promise2)不僅表示 doSomething() 函式的完成,也代表了你傳入的 successCallback 或者 failureCallback 的完成,successCallback 或 failureCallback 有可能返回一個 Promise 物件,從而形成另一個非同步操作。這樣的話,任何一個 promise2 新增的回撥函式,都會被依次排在由上一個successCallback 或 failureCallback 執行後所返回的 Promise 物件的後面。

基本上,每一個 Promise 都代表了鏈中另一個非同步過程的完成。

正如文章開頭提到過的,在過去,要想做多重的非同步操作,會導致經典的回撥地獄:

doSomething(function(result) {
  doSomethingElse(result, function(newResult) {
    doThirdThing(newResult, function(finalResult) {
      console.log('Got the final result: ' + finalResult);
    }, failureCallback);
  }, failureCallback);
}, failureCallback);

通過新的功能方法,我們把回撥繫結到被返回的 Promise 上代替以往的做法,形成一個 Promise 鏈:

doSomething().then(function(result) {
  return doSomethingElse(result);
})
.then(function(newResult) {
  return doThirdThing(newResult);
})
.then(function(finalResult) {
  console.log('Got the final result: ' + finalResult);
})
.catch(failureCallback);

then裡的引數是可選的,如下所示,我們也可以用箭頭函式來表示:

doSomething()
.then(result => doSomethingElse(result))
.then(newResult => doThirdThing(newResult))
.then(finalResult => {
  console.log(`Got the final result: ${finalResult}`);
})
.catch(failureCallback);

注意:一定要有返回值,否則,callback 將無法獲取上一個 Promise 的結果。(如果使用箭頭函式,() => x 比 () => { return x; } 更簡潔一些,但後一種保留 return 的寫法才支援使用多個語句。)。

Promise.prototype.catch(onRejected)

新增一個拒絕(rejection) 回撥到當前 promise, 返回一個新的promise。當這個回撥函式被呼叫,新 promise 將以它的返回值來resolve,否則如果當前promise 進入fulfilled狀態,則以當前promise的完成結果作為新promise的完成結果。

Promise.prototype.catch方法是.then(null, rejection)或.then(undefined, 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));

下面是一個例子。

const promise = new Promise(function(resolve, reject) {
  throw new Error('test');
});
promise.catch(function(error) {
  console.log(error);
});
// Error: test

上面程式碼中,promise丟擲一個錯誤,就被catch方法指定的回撥函式捕獲。注意,上面的寫法與下面兩種寫法是等價的。

// 寫法一
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,再丟擲錯誤是無效的。

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語句捕獲。

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 物件丟擲的錯誤不會傳遞到外層程式碼,即不會有任何反應。

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錯誤,上面的指令碼會觸發這個事件的監聽函式,可以在監聽函式裡面丟擲錯誤。

process.on('unhandledRejection', function (err, p) {
  throw err;
});

上面程式碼中,unhandledRejection事件的監聽函式有兩個引數,第一個是錯誤物件,第二個是報錯的 Promise 例項,它可以用來了解發生錯誤的環境資訊。

注意,Node 有計劃在未來廢除unhandledRejection事件。如果 Promise 內部有未捕獲的錯誤,會直接終止程式,並且程式的退出碼不為 0。

再看下面的例子。

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方法。

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方法。

Promise.resolve()
.catch(function(error) {
  console.log('oh no', error);
})
.then(function() {
  console.log('carry on');
});
// carry on

上面的程式碼因為沒有報錯,跳過了catch方法,直接執行後面的then方法。此時,要是then方法裡面報錯,就與前面的catch無關了。
Catch方法之中,有可能會在一個回撥失敗之後繼續使用鏈式操作,即使用一個 catch,這對於在鏈式操作中丟擲一個失敗之後,再次進行新的操作很有用。

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);
  // 丟擲一個錯誤
  throw new Error('有哪裡不對了');
  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);
    // 丟擲一個錯誤
  throw new Error('有哪裡不對了');
  console.log('carry on');

}).catch(function(error) {
  console.log('carry on', error);
});
// oh no [ReferenceError: x is not defined]
// carry on 有哪裡不對了

上面程式碼中,第二個catch方法用來捕獲前一個catch方法丟擲的錯誤。

也許你發現了,最後~carry on~並沒有被輸出,這是因為丟擲了錯誤 ~有哪裡不對了~

在之前的回撥地獄示例中,你可能記得有 3 次 failureCallback 的呼叫,而在 Promise 鏈中只有尾部的一次呼叫。

doSomething()
.then(result => doSomethingElse(value))
.then(newResult => doThirdThing(newResult))
.then(finalResult => console.log(`Got the final result: ${finalResult}`))
.catch(failureCallback);

通常,一遇到異常丟擲,Promise 鏈就會停下來,直接呼叫鏈式中的 catch 處理程式來繼續當前執行。這看起來和以下的同步程式碼的執行很相似。

try {
  let result = syncDoSomething();
  let newResult = syncDoSomethingElse(result);
  let finalResult = syncDoThirdThing(newResult);
  console.log(`Got the final result: ${finalResult}`);
} catch(error) {
  failureCallback(error);
}

在 ECMAScript 2017 標準的async/await語法糖中,這種同步形式程式碼的對稱性得到了極致的體現:

async function foo() {
  try {
    let result = await doSomething();
    let newResult = await doSomethingElse(result);
    let finalResult = await doThirdThing(newResult);
    console.log(`Got the final result: ${finalResult}`);
  } catch(error) {
    failureCallback(error);
  }
}

這個例子是在 Promise 的基礎上構建的,例如,doSomething() 與之前的函式是相同的。

通過捕獲所有的錯誤,甚至丟擲異常和程式錯誤,Promise 解決了回撥地獄的基本缺陷。這對於構建非同步操作的基礎功能而言是很有必要的。

Promise.prototype.finally(onFinally)

新增一個事件處理回撥於當前promise物件,並且在原promise物件解析完畢後,返回一個新的promise物件。回撥會在當前promise執行完畢後被呼叫,無論當前promise的狀態是完成(fulfilled)還是失敗(rejected)。該方法是 ES2018 引入標準的。

promise
.then(result => {···})
.catch(error => {···})
.finally(() => {···});

上面程式碼中,不管promise最後的狀態,在執行完then或catch指定的回撥函式以後,都會執行finally方法指定的回撥函式。

下面是一個例子,伺服器使用 Promise 處理請求,然後使用finally方法關掉伺服器。

server.listen(port)
  .then(function () {
    // …
  })
  .finally(server.stop);

Finally方法的回撥函式不接受任何引數,這意味著沒有辦法知道,前面的 Promise 狀態到底是fulfilled還是rejected。這表明,finally方法裡面的操作,應該是與狀態無關的,不依賴於 Promise 的執行結果。

finally本質上是then方法的特例。

promise
.finally(() => {
  // 語句
});

// 等同於
promise
.then(
  result => {
    // 語句
    return result;
  },
  error => {
    // 語句
    throw error;
  }
);

上面程式碼中,如果不使用finally方法,同樣的語句需要為成功和失敗兩種情況各寫一次。有了finally方法,則只需要寫一次。

它的實現也很簡單。

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。

從上面的實現還可以看到,finally方法總是會返回原來的值。

// resolve 的值是 undefined
Promise.resolve(2).then(() => {}, () => {})

// resolve 的值是 2
Promise.resolve(2).finally(() => {})

// reject 的值是 undefined
Promise.reject(3).then(() => {}, () => {})

// reject 的值是 3
Promise.reject(3).finally(() => {})

Promise 拒絕事件

當 Promise 被拒絕時,會有下文所述的兩個事件之一被派發到全域性作用域(通常而言,就是window;如果是在 web worker 中使用的話,就是 Worker 或者其他 worker-based 介面)。這兩個事件如下所示:

rejectionhandled
當 Promise 被拒絕、並且在 reject 函式處理該 rejection 之後會派發此事件。
unhandledrejection
當 Promise 被拒絕,但沒有提供 reject 函式來處理該 rejection 時,會派發此事件。
以上兩種情況中,PromiseRejectionEvent 事件都有兩個屬性,一個是 promise 屬性,該屬性指向被駁回的 Promise,另一個是 reason 屬性,該屬性用來說明 Promise 被駁回的原因。

因此,我們可以通過以上事件為 Promise 失敗時提供補償處理,也有利於除錯 Promise 相關的問題。在每一個上下文中,該處理都是全域性的,因此不管原始碼如何,所有的錯誤都會在同一個handler中被捕捉處理。

一個特別有用的例子:當你使用 Node.js 時,有些依賴模組可能會有未被處理的 rejected promises,這些都會在執行時列印到控制檯。你可以在自己的程式碼中捕捉這些資訊,然後新增與 unhandledrejection 相應的 handler 來做分析和處理,或只是為了讓你的輸出更整潔。舉例如下:

window.addEventListener("unhandledrejection", event => {
  /* 你可以在這裡新增一些程式碼,以便檢查
     event.promise 中的 promise 和
     event.reason 中的 rejection 原因 */

  event.preventDefault();
}, false);

呼叫 event 的preventDefault()方法是為了告訴 JavaScript 引擎當 promise 被拒絕時不要執行預設操作,預設操作一般會包含把錯誤列印到控制檯。

理想情況下,在忽略這些事件之前,我們應該檢查所有被拒絕的 Promise,來確認這不是程式碼中的 bug。

狀態傳遞

如果呼叫resolve函式和reject函式時帶有引數,那麼它們的引數會被傳遞給回撥函式。reject函式的引數通常是Error物件的例項,表示丟擲的錯誤;resolve函式的引數除了正常的值以外,還可能是另一個 Promise 例項,比如像下面這樣。

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的回撥函式將會立刻執行。

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方法指定的回撥函式。

Promise方法

Promise.all(iterable)

這個方法返回一個新的promise物件,該promise物件在iterable引數物件裡所有的promise物件都成功的時候才會觸發成功,一旦有任何一個iterable裡面的promise物件失敗則立即觸發該promise物件的失敗。這個新的promise物件在觸發成功狀態以後,會把一個包含iterable裡所有promise返回值的陣列作為成功回撥的返回值,順序跟iterable的順序保持一致;如果這個新的promise物件觸發了失敗狀態,它會把iterable裡第一個觸發失敗的promise物件的錯誤資訊作為它的失敗錯誤資訊。Promise.all方法常被用於處理多個promise物件的狀態集合(可以參考jQuery.when方法)。

這段話有點長,我們舉個具體例子來說明:

const 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物件的陣列
const 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 = databasePromise
  .then(findAllBooks);

const userPromise = databasePromise
  .then(getCurrentUser);

Promise.all([
  booksPromise,
  userPromise
])
.then(([books, user]) => pickTopRecommendations(books, user));

上面程式碼中,booksPromise和userPromise是兩個非同步操作,只有等到它們的結果都返回了,才會觸發pickTopRecommendations這個回撥函式。

注意,如果作為引數的 Promise 例項,自己定義了catch方法,那麼它一旦被rejected,並不會觸發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('報錯了');
})
.then(result => result)
.catch(e => e);

Promise.all([p1, p2])
.then(result => console.log(result))
.catch(e => console.log(e));
// ["hello", Error: 報錯了]

上面程式碼中,p1會resolved,p2首先會rejected,但是p2有自己的catch方法,該方法返回的是一個新的 Promise 例項,p2指向的實際上是這個例項。該例項執行完catch方法後,也會變成resolved,導致Promise.all()方法引數裡面的兩個例項都會resolved,因此會呼叫then方法指定的回撥函式,而不會呼叫catch方法指定的回撥函式。

如果p2沒有自己的catch方法,就會呼叫Promise.all()的catch方法。

const p1 = new Promise((resolve, reject) => {
  resolve('hello');
})
.then(result => result);

const p2 = new Promise((resolve, reject) => {
  throw new Error('報錯了');
})
.then(result => result);

Promise.all([p1, p2])
.then(result => console.log(result))
.catch(e => console.log(e));
// Error: 報錯了

Promise.race(iterable)

Promise.race()方法同樣是將多個 Promise 例項,包裝成一個新的 Promise 例項。當iterable引數裡的任意一個子promise被成功或失敗後,父promise馬上也會用子promise的成功返回值或失敗詳情作為引數呼叫父promise繫結的相應控制程式碼,並返回該promise物件。

const p = Promise.race([p1, p2, p3]);

上面程式碼中,只要p1、p2、p3之中有一個例項率先改變狀態,p的狀態就跟著改變。那個率先改變的 Promise 例項的返回值,就傳遞給p的回撥函式。

Promise.race()方法的引數與Promise.all()方法一樣,如果不是 Promise 例項,就會先呼叫下面講到的Promise.resolve()方法,將引數轉為 Promise 例項,再進一步處理。

下面是一個例子,如果指定時間內沒有獲得結果,就將 Promise 的狀態變為reject,否則變為resolve。

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 秒之內fetch方法無法返回結果,變數p的狀態就會變為rejected,從而觸發catch方法指定的回撥函式。

Promise.resolve(value)

返回一個狀態由給定value決定的Promise物件。如果該值是thenable(即,帶有then方法的物件),返回的Promise物件的最終狀態由then方法執行決定;否則的話(該value為空,基本型別或者不帶then方法的物件),返回的Promise物件狀態為fulfilled,並且將該value傳遞給對應的then方法。

通常而言,如果你不知道一個值是否是Promise物件,使用Promise.resolve(value) 來返回一個Promise物件,這樣就能將該value以Promise物件形式使用。

const jsPromise = Promise.resolve($.ajax('/whatever.json'));

上面程式碼將 jQuery 生成的deferred物件,轉為一個新的 Promise 物件。

Promise.resolve()等價於下面的寫法。

Promise.resolve('foo')
// 等價於
new Promise(resolve => resolve('foo'))

現在我們來具體說說Promise.resolve方法的引數分成四種情況。

* 引數是一個 Promise 例項
如果引數是 Promise 例項,那麼Promise.resolve將不做任何修改、原封不動地返回這個例項。
* 引數是一個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。

* 引數不是具有then方法的物件,或根本就不是物件
如果引數是一個原始值,或者是一個不具有then方法的物件,則Promise.resolve方法返回一個新的 Promise 物件,狀態為resolved。
const p = Promise.resolve('Hello');

p.then(function (s){
  console.log(s)
});
// Hello
上面程式碼生成一個新的 Promise 物件的例項p。由於字串Hello不屬於非同步操作(判斷方法是字串物件不具有 then 方法),返回 Promise 例項的狀態從一生成就是resolved,所以回撥函式會立即執行。Promise.resolve方法的引數,會同時傳給回撥函式。

* 不帶有任何引數
Promise.resolve()方法允許呼叫時不帶引數,直接返回一個resolved狀態的 Promise 物件。
所以,如果希望得到一個 Promise 物件,比較方便的方法就是直接呼叫Promise.resolve()方法。
const p = Promise.resolve();

p.then(function () {
  // ...
});
上面程式碼的變數p就是一個 Promise 物件。

需要注意的是,立即resolve()的 Promise 物件,是在本輪“事件迴圈”(event loop)的結束時執行,而不是在下一輪“事件迴圈”的開始時。
setTimeout(function () {
  console.log('3');
}, 0);

Promise.resolve().then(function () {
  console.log('2');
});

console.log('1');

// 1
// 2
// 3
上面程式碼中,setTimeout(fn, 0)在下一輪“事件迴圈”開始時執行,Promise.resolve()在本輪“事件迴圈”結束時執行,console.log('one')則是立即執行,因此最先輸出。

Promise.reject(reason)

返回一個狀態為失敗的Promise物件,並將給定的失敗資訊傳遞給對應的處理方法。

const p = Promise.reject('出錯了');
// 等同於
const p = new Promise((resolve, reject) => reject('出錯了'))

p.then(null, function (s) {
  console.log(s)
});
// 出錯了

上面程式碼生成一個 Promise 物件的例項p,狀態為rejected,回撥函式會立即執行。

注意,Promise.reject()方法的引數,會原封不動地作為reject的理由,變成後續方法的引數。這一點與Promise.resolve方法不一致。

const thenable = {
  then(resolve, reject) {
    reject('出錯了');
  }
};

Promise.reject(thenable)
.catch(e => {
  console.log(e === thenable)
})
// true

上面程式碼中,Promise.reject方法的引數是一個thenable物件,執行以後,後面catch方法的引數不是reject丟擲的“出錯了”這個字串,而是thenable物件。

Promise.allSettled(iterable)

Promise.allSettled()方法接受一組 Promise 例項作為引數,包裝成一個新的 Promise 例項。只有等到所有這些引數例項都返回結果,不管是fulfilled還是rejected,包裝例項才會結束。該方法由 ES2020 引入。

const promises = [
  fetch('/api-1'),
  fetch('/api-2'),
  fetch('/api-3'),
];

await Promise.allSettled(promises);
removeLoadingIndicator();

上面程式碼對伺服器發出三個請求,等到三個請求都結束,不管請求成功還是失敗,載入的滾動圖示就會消失。

該方法返回的新的 Promise 例項,一旦結束,狀態總是fulfilled,不會變成rejected。狀態變成fulfilled後,Promise 的監聽函式接收到的引數是一個陣列,每個成員對應一個傳入Promise.allSettled()的 Promise 例項。

const resolved = Promise.resolve(42);
const rejected = Promise.reject(-1);

const allSettledPromise = Promise.allSettled([resolved, rejected]);

allSettledPromise.then(function (results) {
  console.log(results);
});
// [
//    { status: 'fulfilled', value: 42 },
//    { status: 'rejected', reason: -1 }
// ]

上面程式碼中,Promise.allSettled()的返回值allSettledPromise,狀態只可能變成fulfilled。它的監聽函式接收到的引數是陣列results。該陣列的每個成員都是一個物件,對應傳入Promise.allSettled()的兩個 Promise 例項。每個物件都有status屬性,該屬性的值只可能是字串fulfilled或字串rejected。fulfilled時,物件有value屬性,rejected時有reason屬性,對應兩種狀態的返回值。

下面是返回值用法的例子。

const promises = [ fetch('index.html'), fetch('https://does-not-exist/') ];
const results = await Promise.allSettled(promises);

// 過濾出成功的請求
const successfulPromises = results.filter(p => p.status === 'fulfilled');

// 過濾出失敗的請求,並輸出原因
const errors = results
  .filter(p => p.status === 'rejected')
  .map(p => p.reason);

有時候,我們不關心非同步操作的結果,只關心這些操作有沒有結束。這時,Promise.allSettled()方法就很有用。如果沒有這個方法,想要確保所有操作都結束,就很麻煩。Promise.all()方法無法做到這一點。

const urls = [ /* ... */ ];
const requests = urls.map(x => fetch(x));

try {
  await Promise.all(requests);
  console.log('所有請求都成功。');
} catch {
  console.log('至少一個請求失敗,其他請求可能還沒結束。');
}

上面程式碼中,Promise.all()無法確定所有請求都結束。想要達到這個目的,寫起來很麻煩,有了Promise.allSettled(),這就很容易了。

Promise.any(iterable)

Promise.any()方法接受一組 Promise 例項作為引數,包裝成一個新的 Promise 例項。只要引數例項有一個變成fulfilled狀態,包裝例項就會變成fulfilled狀態;如果所有引數例項都變成rejected狀態,包裝例項就會變成rejected狀態。該方法目前是一個第三階段的提案 。

Promise.any()跟Promise.race()方法很像,只有一點不同,就是不會因為某個 Promise 變成rejected狀態而結束。

const promises = [
  fetch('/endpoint-a').then(() => 'a'),
  fetch('/endpoint-b').then(() => 'b'),
  fetch('/endpoint-c').then(() => 'c'),
];
try {
  const first = await Promise.any(promises);
  console.log(first);
} catch (error) {
  console.log(error);
}

上面程式碼中,Promise.any()方法的引數陣列包含三個 Promise 操作。其中只要有一個變成fulfilled,Promise.any()返回的 Promise 物件就變成fulfilled。如果所有三個操作都變成rejected,那麼就會await命令就會丟擲錯誤。

Promise.any()丟擲的錯誤,不是一個一般的錯誤,而是一個 AggregateError 例項。它相當於一個陣列,每個成員對應一個被rejected的操作所丟擲的錯誤。下面是 AggregateError 的實現示例。

new AggregateError() extends Array -> AggregateError

const err = new AggregateError();
err.push(new Error("first error"));
err.push(new Error("second error"));
throw err;

捕捉錯誤時,如果不用try...catch結構和 await 命令,可以像下面這樣寫。

Promise.any(promises).then(
  (first) => {
    // Any of the promises was fulfilled.
  },
  (error) => {
    // All of the promises were rejected.
  }
);

下面是一個例子。

var resolved = Promise.resolve(42);
var rejected = Promise.reject(-1);
var alsoRejected = Promise.reject(Infinity);

Promise.any([resolved, rejected, alsoRejected]).then(function (result) {
  console.log(result); // 42
});

Promise.any([rejected, alsoRejected]).catch(function (results) {
  console.log(results); // [-1, Infinity]
});
Promise.resolve()

Promise.try()

實際開發中,經常遇到一種情況:不知道或者不想區分,函式f是同步函式還是非同步操作,但是想用 Promise 來處理它。因為這樣就可以不管f是否包含非同步操作,都用then方法指定下一步流程,用catch方法處理f丟擲的錯誤。一般就會採用下面的寫法。

Promise.resolve().then(f)

上面的寫法有一個缺點,就是如果f是同步函式,那麼它會在本輪事件迴圈的末尾執行。

const f = () => console.log('now');
Promise.resolve().then(f);
console.log('next');
// next
// now

上面程式碼中,函式f是同步的,但是用 Promise 包裝了以後,就變成非同步執行了。

那麼有沒有一種方法,讓同步函式同步執行,非同步函式非同步執行,並且讓它們具有統一的 API 呢?回答是可以的,並且還有兩種寫法。第一種寫法是用async函式來寫。

const f = () => console.log('now');
(async () => f())();
console.log('next');
// now
// next

上面程式碼中,第二行是一個立即執行的匿名函式,會立即執行裡面的async函式,因此如果f是同步的,就會得到同步的結果;如果f是非同步的,就可以用then指定下一步,就像下面的寫法。

(async () => f())()
.then(...)

需要注意的是,async () => f()會吃掉f()丟擲的錯誤。所以,如果想捕獲錯誤,要使用promise.catch方法。

(async () => f())()
.then(...)
.catch(...)

第二種寫法是使用new Promise()。

const f = () => console.log('now');
(
  () => new Promise(
    resolve => resolve(f())
  )
)();
console.log('next');
// now
// next

上面程式碼也是使用立即執行的匿名函式,執行new Promise()。這種情況下,同步函式也是同步執行的。

鑑於這是一個很常見的需求,所以現在有一個提案,提供Promise.try方法替代上面的寫法。

const f = () => console.log('now');
Promise.try(f);
console.log('next');
// now
// next

事實上,Promise.try存在已久,Promise 庫Bluebird、Q和when,早就提供了這個方法。

由於Promise.try為所有操作提供了統一的處理機制,所以如果想用then方法管理流程,最好都用Promise.try包裝一下。這樣有許多好處,其中一點就是可以更好地管理異常。

function getUsername(userId) {
  return database.users.get({id: userId})
  .then(function(user) {
    return user.name;
  });
}

上面程式碼中,database.users.get()返回一個 Promise 物件,如果丟擲非同步錯誤,可以用catch方法捕獲,就像下面這樣寫。

database.users.get({id: userId})
.then(...)
.catch(...)

但是database.users.get()可能還會丟擲同步錯誤(比如資料庫連線錯誤,具體要看實現方法),這時你就不得不用try...catch去捕獲。

try {
  database.users.get({id: userId})
  .then(…)
  .catch(…)
} catch (e) {
  // ...
}

上面這樣的寫法就很笨拙了,這時就可以統一用promise.catch()捕獲所有同步和非同步的錯誤。

Promise.try(() => database.users.get({id: userId}))
  .then(...)
  .catch(...)

事實上,Promise.try就是模擬try程式碼塊,就像promise.catch模擬的是catch程式碼塊。

應用

載入圖片

我們可以將圖片的載入寫成一個Promise,一旦載入完成,Promise的狀態就發生變化。

const preloadImage = function (path) {
  return new Promise(function (resolve, reject) {
    const image = new Image();
    image.onload  = resolve;
    image.onerror = reject;
    image.src = path;
  });
};

Generator 函式與 Promise 的結合

使用 Generator 函式管理流程,遇到非同步操作的時候,通常返回一個Promise物件。

function getFoo () {
  return new Promise(function (resolve, reject){
    resolve('foo');
  });
}

const g = function* () {
  try {
    const foo = yield getFoo();
    console.log(foo);
  } catch (e) {
    console.log(e);
  }
};

function run (generator) {
  const 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方法。

實戰

跳轉:ES6 Promise筆試題

完結

對的Promise更深入的理解關鍵還是平時要多寫多練多思考!

整理這篇ES6 Promise的文章,過程包括查閱各種文章和文件、自己深入理解、實際執行程式碼,整理排版,我用了整整一天的時間,對ES6 Promise的介紹相對來說已經比較完整,希望大家看完也能和我一樣有所收穫。

文章很長,你能看到這裡,你確實很棒!感謝閱讀!我會在這個部落格持續地更新前端技術博文,分享我自己在開發過程中遇到的問題和整理的技術筆記,大家的關注點贊就是我最大動力,感謝!

擴充閱讀

【專題:JavaScript進階之路】
JavaScript之多執行緒和Event Loop
ES6 尾呼叫和尾遞迴

參考文獻:

ECMAScript 6入門
Promise - 廖雪峰的官方網站
Promise - javaScript | MDN
使用 Promise - JavaScript | MDN

 

相關文章