ES6 Promise

引語

最近一段時間在重溫ES6,Promise應該是是ES6新特性中很是重要的一部份內容。其實Promise在我平常開發中已經用得比較多,但大多數時候只是知道Promise能夠用來實現異步編程,也只限於單純地會用罷了,並無時間深刻去學習過,並且網上得資料大多都比較瑣碎。我就本身花時間作了一個關於Promise比較完整的整理,深刻學習一下Promise,加深印象。javascript

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

爲何須要Promise

JavaScript 因爲某種緣由是被設計爲單線程的,同時因爲 JavaScript 在設計之初是用於瀏覽器的 GUI 編程,這也就須要線程不能進行阻塞。前端

因此在後續的發展過程當中基本都採用異步非阻塞的編程模式。java

簡單來講,異步編程就是在執行一個指令以後不是立刻獲得結果,而是繼續執行後面的指令,等到特定的事件觸發後,才獲得結果。git

也正是由於這樣,咱們經常會說: JavaScript 是由事件驅動的。es6

用 JavaScript 構建一個應用的時候常常會遇到異步編程,無論是 Node 服務端仍是 Web 前端。github

那如何去進行異步編程呢?回調函數就是異步執行最基礎的實現。若是你曾經寫過一點的 Node, 可能常常會遇到這樣的代碼:web

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

如此,connection.query() 是一個異步的操做,咱們在調用他的時候,不會立刻獲得結果,而是會繼續執行後面的代碼。這樣,若是咱們須要在查到結果以後才作某些事情的話,就須要把相關的代碼寫在回調裏面。ajax

這樣的代碼看層級少了固然仍是能夠湊合看的,可是在某些場景下,咱們就須要一次又一次的回調…回調到最後,會發現咱們的代碼就會變成金字塔形狀?這種狀況被親切地稱爲回調地獄sql

回調地獄不只看起來很不舒服,可讀性比較差,難以維護,除此以外還有比較重要的一點就是對異常的捕獲沒法支持。不管是開發者自身仍是同事來接手項目,都是極其無奈的!

有沒有更好的寫法?好比寫成這樣的鏈式調用:

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()方法接受一個數組做爲參數,p一、p二、p3都是 Promise 實例,若是不是,就會先調用下面講到的Promise.resolve方法,將參數轉爲 Promise 實例,再進一步處理。另外,Promise.all()方法的參數能夠不是數組,但必須具備 Iterator 接口,且返回的每一個成員都是 Promise 實例。
P的狀態由p一、p二、p3決定,分紅兩種狀況。

(1)只有p一、p二、p3的狀態都變成fulfilled,p的狀態纔會變成fulfilled,此時p一、p二、p3的返回值組成一個數組,傳遞給p的回調函數。
(2)只要p一、p二、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]);

上面代碼中,只要p一、p二、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


我是Cloudy,年輕的前端攻城獅一枚,愛專研,愛技術,愛分享。
我的筆記,整理不易,感謝關注、閱讀、點贊和收藏。
文章有任何問題歡迎你們指出,也歡迎你們一塊兒交流前端各類問題!
相關文章
相關標籤/搜索