天天看點

[前端學習]Promise 對象一網打盡

文章目錄

    • Promise.prototype.finally()
    • Promise.all()
    • Promise.race()
    • Promise.allSettled()
    • Promise.any()
    • Promise.resolve()
    • Promise.reject()
    • Promise.try()

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狀态。

有了Promise對象,就可以将異步操作以同步操作的流程表達出來,避免了層層嵌套的回調函數。此外,Promise對象提供統一的接口,使得控制異步操作更加容易。

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

如果某些事件不斷地反複發生,一般來說,使用 Stream 模式是比部署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('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) {
    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函數調用時,都帶有參數。

如果調用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方法指定的回調函數。

注意,調用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);
})
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 (comments) {
  console.log("resolved: ", comments);
}, function (err){
  console.log("rejected: ", err);
});           

複制

上面代碼中,第一個then方法指定的回調函數,傳回的是另一個Promise對象。這時,第二個then方法指定的回調函數,就會等待這個新的Promise對象狀态發生變化。如果變為resolved,就調用第一個回調函數,如果狀态變為rejected,就調用第二個回調函數。

如果采用箭頭函數,上面的代碼可以寫得更簡潔。

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)或.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.js 有一個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()方法之中,還能再抛出錯誤。

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()方法了,導緻這個錯誤不會被捕獲,也不會傳遞到外層。如果改寫一下,結果就不一樣了。

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.prototype.finally()

finally()方法用于指定不管 Promise 對象最後狀态如何,都會執行的操作。該方法是 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.all()

Promise.all()方法用于将多個 Promise 執行個體,包裝成一個新的 Promise 執行個體。

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()

Promise.race()方法同樣是将多個 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.allSettled()

有時候,我們希望等到一組異步操作都結束了,不管每一個操作是成功還是失敗,再進行下一步操作。但是,現有的 Promise 方法很難實作這個要求。

Promise.all()方法隻适合所有異步操作都成功的情況,如果有一個操作失敗,就無法滿足要求。

const urls = [url_1, url_2, url_3];

const requests = urls.map(x => fetch(x));

try {

await Promise.all(requests);

console.log(‘所有請求都成功。’);

} catch {

console.log(‘至少一個請求失敗,其他請求可能還沒結束。’);

}

上面示例中,Promise.all()可以确定所有請求都成功了,但是隻要有一個請求失敗,它就會報錯,而不管另外的請求是否結束。

為了解決這個問題,ES2020 引入了Promise.allSettled()方法,用來确定一組異步操作是否都結束了(不管成功或失敗)。是以,它的名字叫做”Settled“,包含了”fulfilled“和”rejected“兩種情況。

Promise.allSettled()方法接受一個數組作為參數,數組的每個成員都是一個 Promise 對象,并傳回一個新的 Promise 對象。隻有等到參數數組的所有 Promise 對象都發生狀态變更(不管是fulfilled還是rejected),傳回的 Promise 對象才會發生狀态變更。

const promises = [

fetch(’/api-1’),

fetch(’/api-2’),

fetch(’/api-3’),

];

await Promise.allSettled(promises);

removeLoadingIndicator();

上面示例中,數組promises包含了三個請求,隻有等到這三個請求都結束了(不管請求成功還是失敗),removeLoadingIndicator()才會執行。

該方法傳回的新的 Promise 執行個體,一旦發生狀态變更,狀态總是fulfilled,不會變成rejected。狀态變成fulfilled後,它的回調函數會接收到一個數組作為參數,該數組的每個成員對應前面數組的每個 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 對象。

results的每個成員是一個對象,對象的格式是固定的,對應異步操作的結果。

// 異步操作成功時

{status: ‘fulfilled’, value: value}

// 異步操作失敗時

{status: ‘rejected’, reason: reason}

成員對象的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.any()

ES2021 引入了Promise.any()方法。該方法接受一組 Promise 執行個體作為參數,包裝成一個新的 Promise 執行個體傳回。

Promise.any([

fetch(‘https://v8.dev/’).then(() => ‘home’),

fetch(‘https://v8.dev/blog’).then(() => ‘blog’),

fetch(‘https://v8.dev/docs’).then(() => ‘docs’)

]).then((first) => { // 隻要有一個 fetch() 請求成功

console.log(first);

}).catch((error) => { // 所有三個 fetch() 全部請求失敗

console.log(error);

});

隻要參數執行個體有一個變成fulfilled狀态,包裝執行個體就會變成fulfilled狀态;如果所有參數執行個體都變成rejected狀态,包裝執行個體就會變成rejected狀态。

Promise.any()跟Promise.race()方法很像,隻有一點不同,就是Promise.any()不會因為某個 Promise 變成rejected狀态而結束,必須等到所有參數 Promise 變成rejected狀态才會結束。

下面是Promise()與await指令結合使用的例子。

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()抛出的錯誤,不是一個一般的 Error 錯誤對象,而是一個 AggregateError 執行個體。它相當于一個數組,每個成員對應一個被rejected的操作所抛出的錯誤。下面是 AggregateError 的實作示例。

// new AggregateError() extends Array

const err = new AggregateError();

err.push(new Error(“first error”));

err.push(new Error(“second error”));

// …

throw err;

下面是一個例子。

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 對象,Promise.resolve()方法就起到這個作用。

const 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。

const 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()方法。

const 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()

Promise.reject(reason)方法也會傳回一個新的 Promise 執行個體,該執行個體的狀态為rejected。

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.reject(‘出錯了’)

.catch(e => {

console.log(e === ‘出錯了’)

})

// true

上面代碼中,Promise.reject()方法的參數是一個字元串,後面catch()方法的參數e就是這個字元串。

應用

加載圖檔

我們可以将圖檔的加載寫成一個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方法。

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代碼塊。