async 函數(shù)
含義
ES2017 標準引入了 async 函數(shù),使得異步操作變得更加方便。
async函數(shù)對 Generator 函數(shù)的改進,體現(xiàn)在以下四點。
(1)內置執(zhí)行器。
Generator 函數(shù)的執(zhí)行必須靠執(zhí)行器,所以才有了co模塊,而async函數(shù)自帶執(zhí)行器。也就是說,async函數(shù)的執(zhí)行,與普通函數(shù)一模一樣,只要一行。
(2)更好的語義
async和await,比起星號和yield,語義更清楚了。async表示函數(shù)里有異步操作,await表示緊跟在后面的表達式需要等待結果。
(3)更廣的適用性。
co模塊約定,yield命令后面只能是 Thunk 函數(shù)或 Promise 對象,而async函數(shù)的await命令后面,可以是 Promise 對象和原始類型的值(數(shù)值、字符串和布爾值,但這時會自動轉成立即 resolved 的 Promise 對象)。
(4)返回值是 Promise。
async函數(shù)的返回值是 Promise 對象,這比 Generator 函數(shù)的返回值是 Iterator 對象方便多了。你可以用then方法指定下一步的操作。
進一步說,async函數(shù)完全可以看作多個異步操作,包裝成的一個 Promise 對象,而await命令就是內部then命令的語法糖。
基本用法
async函數(shù)返回一個 Promise 對象,可以使用then方法添加回調函數(shù)。當函數(shù)執(zhí)行的時候,一旦遇到await就會先返回,等到異步操作完成,再接著執(zhí)行函數(shù)體內后面的語句。
返回 Promise 對象
async函數(shù)返回一個 Promise 對象。
async函數(shù)內部return語句返回的值,會成為then方法回調函數(shù)的參數(shù)
async function f() {
return 'hello world';
}
f().then(v => console.log(v))
// "hello world"
上面代碼中,函數(shù)f內部return命令返回的值,會被then方法回調函數(shù)接收到。
async函數(shù)內部拋出錯誤,會導致返回的 Promise 對象變?yōu)?code>reject狀態(tài)。拋出的錯誤對象會被catch方法回調函數(shù)接收到。
Promise 對象的狀態(tài)變化
async函數(shù)返回的 Promise 對象,必須等到內部所有await命令后面的 Promise 對象執(zhí)行完,才會發(fā)生狀態(tài)改變,除非遇到return語句或者拋出錯誤。也就是說,只有async函數(shù)內部的異步操作執(zhí)行完,才會執(zhí)行then方法指定的回調函數(shù)。
await 命令
正常情況下,await命令后面是一個 Promise 對象,返回該對象的結果。如果不是 Promise 對象,就直接返回對應的值。
另一種情況是,await命令后面是一個thenable對象(即定義then方法的對象),那么await會將其等同于 Promise 對象。
有時,我們希望即使前一個異步操作失敗,也不要中斷后面的異步操作。這時可以將第一個await放在try...catch結構里面,這樣不管這個異步操作是否成功,第二個await都會執(zhí)行。
錯誤處理
如果await后面的異步操作出錯,那么等同于async函數(shù)返回的 Promise 對象被reject。 防止出錯的方法,也是將其放在try...catch代碼塊之中。
async 函數(shù)的實現(xiàn)原理
async 函數(shù)的實現(xiàn)原理,就是將 Generator 函數(shù)和自動執(zhí)行器,包裝在一個函數(shù)里。
Promise 的含義
Promise 是異步編程的一種解決方案,比傳統(tǒng)的解決方案——回調函數(shù)和事件——更合理和更強大。它由社區(qū)最早提出和實現(xiàn),ES6 將其寫進了語言標準,統(tǒng)一了用法,原生提供了Promise對象。
所謂Promise,簡單說就是一個容器,里面保存著某個未來才會結束的事件(通常是一個異步操作)的結果。從語法上說,Promise 是一個對象,從它可以獲取異步操作的消息。Promise 提供統(tǒng)一的 API,各種異步操作都可以用同樣的方法進行處理。
Promise對象有以下兩個特點。
(1)對象的狀態(tài)不受外界影響。Promise對象代表一個異步操作,有三種狀態(tài):pending(進行中)、fulfilled(已成功)和rejected(已失敗)。只有異步操作的結果,可以決定當前是哪一種狀態(tài),任何其他操作都無法改變這個狀態(tài)。這也是Promise這個名字的由來,它的英語意思就是“承諾”,表示其他手段無法改變。
(2)一旦狀態(tài)改變,就不會再變,任何時候都可以得到這個結果。Promise對象的狀態(tài)改變,只有兩種可能:從pending變?yōu)?code>fulfilled和從pending變?yōu)?code>rejected。只要這兩種情況發(fā)生,狀態(tài)就凝固了,不會再變了,會一直保持這個結果,這時就稱為 resolved(已定型)。如果改變已經(jīng)發(fā)生了,你再對Promise對象添加回調函數(shù),也會立即得到這個結果。這與事件(Event)完全不同,事件的特點是,如果你錯過了它,再去監(jiān)聽,是得不到結果的。
注意,為了行文方便,本章后面的resolved統(tǒng)一只指fulfilled狀態(tài),不包含rejected狀態(tài)。
有了Promise對象,就可以將異步操作以同步操作的流程表達出來,避免了層層嵌套的回調函數(shù)。此外,Promise對象提供統(tǒng)一的接口,使得控制異步操作更加容易。
Promise也有一些缺點。首先,無法取消Promise,一旦新建它就會立即執(zhí)行,無法中途取消。其次,如果不設置回調函數(shù),Promise內部拋出的錯誤,不會反應到外部。第三,當處于pending狀態(tài)時,無法得知目前進展到哪一個階段(剛剛開始還是即將完成)。
基本用法
ES6 規(guī)定,Promise對象是一個構造函數(shù),用來生成Promise實例。
下面代碼創(chuàng)造了一個Promise實例。
const promise = new Promise(function(resolve, reject) {
// ... some code
if (/* 異步操作成功 */){
resolve(value);
} else {
reject(error);
}
});
Promise構造函數(shù)接受一個函數(shù)作為參數(shù),該函數(shù)的兩個參數(shù)分別是resolve和reject。它們是兩個函數(shù),由 JavaScript 引擎提供,不用自己部署。
resolve函數(shù)的作用是,將Promise對象的狀態(tài)從“未完成”變?yōu)椤俺晒Α保磸?pending 變?yōu)?resolved),在異步操作成功時調用,并將異步操作的結果,作為參數(shù)傳遞出去;reject函數(shù)的作用是,將Promise對象的狀態(tài)從“未完成”變?yōu)椤笆 保磸?pending 變?yōu)?rejected),在異步操作失敗時調用,并將異步操作報出的錯誤,作為參數(shù)傳遞出去。
Promise實例生成以后,可以用then方法分別指定resolved狀態(tài)和rejected狀態(tài)的回調函數(shù)。
promise.then(function(value) {
// success
}, function(error) {
// failure
});
then方法可以接受兩個回調函數(shù)作為參數(shù)。第一個回調函數(shù)是Promise對象的狀態(tài)變?yōu)?code>resolved時調用,第二個回調函數(shù)是Promise對象的狀態(tài)變?yōu)?code>rejected時調用。其中,第二個函數(shù)是可選的,不一定要提供。這兩個函數(shù)都接受Promise對象傳出的值作為參數(shù)。
下面是一個Promise對象的簡單例子。
function timeout(ms) {
return new Promise((resolve, reject) => {
setTimeout(resolve, ms, 'done');
});
}
timeout(100).then((value) => {
console.log(value);
});
上面代碼中,timeout方法返回一個Promise實例,表示一段時間以后才會發(fā)生的結果。過了指定的時間(ms參數(shù))以后,Promise實例的狀態(tài)變?yōu)?code>resolved,就會觸發(fā)then方法綁定的回調函數(shù)。
Promise 新建后就會立即執(zhí)行。
let promise = new Promise(function(resolve, reject) {
console.log('Promise');
resolve();
});
promise.then(function() {
console.log('resolved.');
});
console.log('Hi!');
// Promise
// Hi!
// resolved
上面代碼中,Promise 新建后立即執(zhí)行,所以首先輸出的是Promise。然后,then方法指定的回調函數(shù),將在當前腳本所有同步任務執(zhí)行完才會執(zhí)行,所以resolved最后輸出。
new Promise((resolve, reject) => {
resolve(1);
console.log(2);
}).then(r => {
console.log(r);
});
// 2
// 1
上面代碼中,調用resolve(1)以后,后面的console.log(2)還是會執(zhí)行,并且會首先打印出來。這是因為立即 resolved 的 Promise 是在本輪事件循環(huán)的末尾執(zhí)行,總是晚于本輪循環(huán)的同步任務。
一般來說,調用resolve或reject以后,Promise 的使命就完成了,后繼操作應該放到then方法里面,而不應該直接寫在resolve或reject的后面。所以,最好在它們前面加上return語句,這樣就不會有意外。
new Promise((resolve, reject) => {
return resolve(1);
// 后面的語句不會執(zhí)行
console.log(2);
})
Promise.prototype.then()
Promise 實例具有then方法,也就是說,then方法是定義在原型對象Promise.prototype上的。它的作用是為 Promise 實例添加狀態(tài)改變時的回調函數(shù)。前面說過,then方法的第一個參數(shù)是resolved狀態(tài)的回調函數(shù),第二個參數(shù)(可選)是rejected狀態(tài)的回調函數(shù)。
then方法返回的是一個新的Promise實例(注意,不是原來那個Promise實例)。因此可以采用鏈式寫法,即then方法后面再調用另一個then方法。
getJSON("/posts.json").then(function(json) {
return json.post;
}).then(function(post) {
// ...
});
上面的代碼使用then方法,依次指定了兩個回調函數(shù)。第一個回調函數(shù)完成以后,會將返回結果作為參數(shù),傳入第二個回調函數(shù)。
Promise.prototype.catch()
Promise.prototype.catch方法是.then(null, rejection)或.then(undefined, rejection)的別名,用于指定發(fā)生錯誤時的回調函數(shù)。
getJSON('/posts.json').then(function(posts) {
// ...
}).catch(function(error) {
// 處理 getJSON 和 前一個回調函數(shù)運行時發(fā)生的錯誤
console.log('發(fā)生錯誤!', error);
});
上面代碼中,getJSON方法返回一個 Promise 對象,如果該對象狀態(tài)變?yōu)?code>resolved,則會調用then方法指定的回調函數(shù);如果異步操作拋出錯誤,狀態(tài)就會變?yōu)?code>rejected,就會調用catch方法指定的回調函數(shù),處理這個錯誤。另外,then方法指定的回調函數(shù),如果運行中拋出錯誤,也會被catch方法捕獲。
Promise.prototype.finally()
finally方法用于指定不管 Promise 對象最后狀態(tài)如何,都會執(zhí)行的操作。該方法是 ES2018 引入標準的。
promise
.then(result => {···})
.catch(error => {···})
.finally(() => {···});
上面代碼中,不管promise最后的狀態(tài),在執(zhí)行完then或catch指定的回調函數(shù)以后,都會執(zhí)行finally方法指定的回調函數(shù)。
Promise.all()
Promise.all()方法用于將多個 Promise 實例,包裝成一個新的 Promise 實例。
const p = Promise.all([p1, p2, p3]);
上面代碼中,Promise.all()方法接受一個數(shù)組作為參數(shù),p1、p2、p3都是 Promise 實例,如果不是,就會先調用下面講到的Promise.resolve方法,將參數(shù)轉為 Promise 實例,再進一步處理。另外,Promise.all()方法的參數(shù)可以不是數(shù)組,但必須具有 Iterator 接口,且返回的每個成員都是 Promise 實例。
p的狀態(tài)由p1、p2、p3決定,分成兩種情況。
(1)只有p1、p2、p3的狀態(tài)都變成fulfilled,p的狀態(tài)才會變成fulfilled,此時p1、p2、p3的返回值組成一個數(shù)組,傳遞給p的回調函數(shù)。
(2)只要p1、p2、p3之中有一個被rejected,p的狀態(tài)就變成rejected,此時第一個被reject的實例的返回值,會傳遞給p的回調函數(shù)。
Promise.race()
Promise.race()方法同樣是將多個 Promise 實例,包裝成一個新的 Promise 實例。
const p = Promise.race([p1, p2, p3]);
上面代碼中,只要p1、p2、p3之中有一個實例率先改變狀態(tài),p的狀態(tài)就跟著改變。那個率先改變的 Promise 實例的返回值,就傳遞給p的回調函數(shù)。
Promise.race()方法的參數(shù)與Promise.all()方法一樣,如果不是 Promise 實例,就會先調用下面講到的Promise.resolve()方法,將參數(shù)轉為 Promise 實例,再進一步處理。
下面是一個例子,如果指定時間內沒有獲得結果,就將 Promise 的狀態(tài)變
Promise.allSettled()
Promise.allSettled()方法接受一組 Promise 實例作為參數(shù),包裝成一個新的 Promise 實例。只有等到所有這些參數(shù)實例都返回結果,不管是fulfilled還是rejected,包裝實例才會結束。該方法由 ES2020 引入。
const promises = [
fetch('/api-1'),
fetch('/api-2'),
fetch('/api-3'),
];
await Promise.allSettled(promises);
removeLoadingIndicator();
上面代碼對服務器發(fā)出三個請求,等到三個請求都結束,不管請求成功還是失敗,加載的滾動圖標就會消失。
該方法返回的新的 Promise 實例,一旦結束,狀態(tài)總是fulfilled,不會變成rejected。狀態(tài)變成fulfilled后,Promise 的監(jiān)聽函數(shù)接收到的參數(shù)是一個數(shù)組,每個成員對應一個傳入Promise.allSettled()的 Promise 實例。
Promise.any()
Promise.any()方法接受一組 Promise 實例作為參數(shù),包裝成一個新的 Promise 實例。只要參數(shù)實例有一個變成fulfilled狀態(tài),包裝實例就會變成fulfilled狀態(tài);如果所有參數(shù)實例都變成rejected狀態(tài),包裝實例就會變成rejected狀態(tài)。該方法目前是一個第三階段的提案 。
Promise.any()跟Promise.race()方法很像,只有一點不同,就是不會因為某個 Promise 變成rejected狀態(tài)而結束。
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()方法的參數(shù)數(shù)組包含三個 Promise 操作。其中只要有一個變成fulfilled,Promise.any()返回的 Promise 對象就變成fulfilled。如果所有三個操作都變成rejected,那么就會await命令就會拋出錯誤。
Promise.any()拋出的錯誤,不是一個一般的錯誤,而是一個 AggregateError 實例。它相當于一個數(shù)組,每個成員對應一個被rejected的操作所拋出的錯誤。
Promise.resolve()
有時需要將現(xiàn)有對象轉為 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方法的參數(shù)分成四種情況。
(1)參數(shù)是一個 Promise 實例
如果參數(shù)是 Promise 實例,那么Promise.resolve將不做任何修改、原封不動地返回這個實例。
(2)參數(shù)是一個thenable對象
thenable對象指的是具有then方法的對象,比如下面這個對象。
let thenable = {
then: function(resolve, reject) {
resolve(42);
}
};
Promise.resolve方法會將這個對象轉為 Promise 對象,然后就立即執(zhí)行thenable對象的then方法。
(3)參數(shù)不是具有then方法的對象,或根本就不是對象
如果參數(shù)是一個原始值,或者是一個不具有then方法的對象,則Promise.resolve方法返回一個新的 Promise 對象,狀態(tài)為resolved。
const p = Promise.resolve('Hello');
p.then(function (s){
console.log(s)
});
// Hello
上面代碼生成一個新的 Promise 對象的實例p。由于字符串Hello不屬于異步操作(判斷方法是字符串對象不具有 then 方法),返回 Promise 實例的狀態(tài)從一生成就是resolved,所以回調函數(shù)會立即執(zhí)行。Promise.resolve方法的參數(shù),會同時傳給回調函數(shù)。
(4)不帶有任何參數(shù)
Promise.resolve()方法允許調用時不帶參數(shù),直接返回一個resolved狀態(tài)的 Promise 對象。
所以,如果希望得到一個 Promise 對象,比較方便的方法就是直接調用Promise.resolve()方法。
Promise.reject()
Promise.reject(reason)方法也會返回一個新的 Promise 實例,該實例的狀態(tài)為rejected。
const p = Promise.reject('出錯了');
// 等同于
const p = new Promise((resolve, reject) => reject('出錯了'))
p.then(null, function (s) {
console.log(s)
});
// 出錯了
上面代碼生成一個 Promise 對象的實例p,狀態(tài)為rejected,回調函數(shù)會立即執(zhí)行。
注意,Promise.reject()方法的參數(shù),會原封不動地作為reject的理由,變成后續(xù)方法的參數(shù)。這一點與Promise.resolve方法不一致。