1.含義

ES2017 標準引入了 async 函數，使得異步操作變得更加方便。

async 函數是什么？一句話，它就是 Generator 函數的語法糖，號稱異步的終極解決方案。

前文有一個 Generator 函數，依次讀取兩個文件。

1 const fs = require('fs'); 2 3 const readFile = function (fileName) { 4 return new Promise(function (resolve, reject) { 5 fs.readFile(fileName, function(error, data) { 6 if (error) return reject(error); 7 resolve(data); 8 }); 9 }); 10 }; 11 12 const gen = function* () { 13 const f1 = yield readFile('/etc/fstab'); 14 const f2 = yield readFile('/etc/shells'); 15 console.log(f1.toString()); 16 console.log(f2.toString()); 17 };

上面代碼的函數gen可以寫成async函數，就是下面這樣。

const asyncReadFile = async function () {const f1 = await readFile('/etc/fstab');const f2 = await readFile('/etc/shells');console.log(f1.toString());console.log(f2.toString()); };

一比較就會發現，async函數就是將 Generator 函數的星號（*）替換成async，將yield替換成await，僅此而已。

async函數對 Generator 函數的改進，體現在以下四點。

（1）內置執行器。

Generator 函數的執行必須靠執行器，所以才有了co模塊，而async函數自帶執行器。也就是說，async函數的執行，與普通函數一模一樣，只要一行。

asyncReadFile();

上面的代碼調用了asyncReadFile函數，然后它就會自動執行，輸出最后結果。這完全不像 Generator 函數，需要調用next方法，或者用co模塊，才能真正執行，得到最后結果。

（2）更好的語義。

async和await，比起星號和yield，語義更清楚了。async表示函數里有異步操作，await表示緊跟在后面的表達式需要等待結果。

（3）更廣的適用性。

co模塊約定，yield命令后面只能是 Thunk 函數或 Promise 對象，而async函數的await命令后面，可以是 Promise 對象和原始類型的值（數值、字符串和布爾值，但這時會自動轉成立即 resolved 的 Promise 對象）。

（4）返回值是 Promise。

async函數的返回值是 Promise 對象，這比 Generator 函數的返回值是 Iterator 對象方便多了。你可以用then方法指定下一步的操作。

進一步說，async函數完全可以看作多個異步操作，包裝成的一個 Promise 對象，而await命令就是內部then命令的語法糖。

2.基本用法

async函數返回一個 Promise 對象，可以使用then方法添加回調函數。當函數執行的時候，一旦遇到await就會先返回，等到異步操作完成，再接著執行函數體內后面的語句。

async function getStockPriceByName(name) {const symbol = await getStockSymbol(name);const stockPrice = await getStockPrice(symbol);return stockPrice; }getStockPriceByName('goog').then(function (result) {console.log(result); });

上面代碼是一個獲取股票報價的函數，函數前面的async關鍵字，表明該函數內部有異步操作。調用該函數時，會立即返回一個Promise對象。

1 function timeout(ms) { 2 return new Promise((resolve) => { 3 setTimeout(resolve, ms); 4 }); 5 } 6 7 async function asyncPrint(value, ms) { 8 await timeout(ms); 9 console.log(value); 10 } 11 12 asyncPrint('hello world', 50);

上面代碼指定 50 毫秒以后，輸出hello world。

由于async函數返回的是 Promise 對象，可以作為await命令的參數。所以，上面的例子也可以寫成下面的形式。

1 async function timeout(ms) { 2 await new Promise((resolve) => { 3 setTimeout(resolve, ms); 4 }); 5 } 6 7 async function asyncPrint(value, ms) { 8 await timeout(ms); 9 console.log(value); 10 } 11 12 asyncPrint('hello world', 50);

async 函數有多種使用形式。

1 // 函數聲明 2 async function foo() {} 3 4 // 函數表達式 5 const foo = async function () {}; 6 7 // 對象的方法 8 let obj = { async foo() {} }; 9 obj.foo().then(...) 10 11 // Class 的方法 12 class Storage { 13 constructor() { 14 this.cachePromise = caches.open('avatars'); 15 } 16 17 async getAvatar(name) { 18 const cache = await this.cachePromise; 19 return cache.match(`/avatars/${name}.jpg`); 20 } 21 } 22 23 const storage = new Storage(); 24 storage.getAvatar('jake').then(…); 25 26 // 箭頭函數 27 const foo = async () => {};

3.語法

async函數的語法規則總體上比較簡單，難點是錯誤處理機制。

返回 Promise 對象?

async函數返回一個 Promise 對象。

async函數內部return語句返回的值，會成為then方法回調函數的參數。

async function f() {return 'hello world'; }f().then(v => console.log(v)) // "hello world"

上面代碼中，函數f內部return命令返回的值，會被then方法回調函數接收到。

async函數內部拋出錯誤，會導致返回的 Promise 對象變為reject狀態。拋出的錯誤對象會被catch方法回調函數接收到。

async function f() {throw new Error('出錯了'); }f().then(v => console.log(v),e => console.log(e) ) // Error: 出錯了

Promise 對象的狀態變化

async函數返回的 Promise 對象，必須等到內部所有await命令后面的 Promise 對象執行完，才會發生狀態改變，除非遇到return語句或者拋出錯誤。也就是說，只有async函數內部的異步操作執行完，才會執行then方法指定的回調函數。

async function getTitle(url) {let response = await fetch(url);let html = await response.text();return html.match(/<title>([\s\S]+)<\/title>/i)[1]; } getTitle('https://tc39.github.io/ecma262/').then(console.log) // "ECMAScript 2017 Language Specification"

上面代碼中，函數getTitle內部有三個操作：抓取網頁、取出文本、匹配頁面標題。只有這三個操作全部完成，才會執行then方法里面的console.log。

await 命令

正常情況下，await命令后面是一個 Promise 對象，返回該對象的結果。如果不是 Promise 對象，就直接返回對應的值。

async function f() {// 等同于// return 123;return await 123; }f().then(v => console.log(v)) // 123

上面代碼中，await命令的參數是數值123，這時等同于return 123。

另一種情況是，await命令后面是一個thenable對象（即定義then方法的對象），那么await會將其等同于 Promise 對象。

1 class Sleep { 2 constructor(timeout) { 3 this.timeout = timeout; 4 } 5 then(resolve, reject) { 6 const startTime = Date.now(); 7 setTimeout( 8 () => resolve(Date.now() - startTime), 9 this.timeout 10 ); 11 } 12 } 13 14 (async () => { 15 const actualTime = await new Sleep(1000); 16 console.log(actualTime); 17 })();

上面代碼中，await命令后面是一個Sleep對象的實例。這個實例不是 Promise 對象，但是因為定義了then方法，await會將其視為Promise處理。

await命令后面的 Promise 對象如果變為reject狀態，則reject的參數會被catch方法的回調函數接收到。

async function f() {await Promise.reject('出錯了'); }f() .then(v => console.log(v)) .catch(e => console.log(e)) // 出錯了

注意，上面代碼中，await語句前面沒有return，但是reject方法的參數依然傳入了catch方法的回調函數。這里如果在await前面加上return，效果是一樣的。

任何一個await語句后面的 Promise 對象變為reject狀態，那么整個async函數都會中斷執行。

async function f() {await Promise.reject('出錯了');await Promise.resolve('hello world'); // 不會執行 }

上面代碼中，第二個await語句是不會執行的，因為第一個await語句狀態變成了reject。

有時，我們希望即使前一個異步操作失敗，也不要中斷后面的異步操作。這時可以將第一個await放在try...catch結構里面，這樣不管這個異步操作是否成功，第二個await都會執行。

async function f() {try {await Promise.reject('出錯了');} catch(e) {}return await Promise.resolve('hello world'); }f() .then(v => console.log(v)) // hello world

另一種方法是await后面的 Promise 對象再跟一個catch方法，處理前面可能出現的錯誤。

async function f() {await Promise.reject('出錯了').catch(e => console.log(e));return await Promise.resolve('hello world'); }f() .then(v => console.log(v)) // 出錯了 // hello world

錯誤處理

如果await后面的異步操作出錯，那么等同于async函數返回的 Promise 對象被reject。

async function f() {await new Promise(function (resolve, reject) {throw new Error('出錯了');}); }f() .then(v => console.log(v)) .catch(e => console.log(e)) // Error：出錯了

上面代碼中，async函數f執行后，await后面的 Promise 對象會拋出一個錯誤對象，導致catch方法的回調函數被調用，它的參數就是拋出的錯誤對象。具體的執行機制，可以參考后文的“async 函數的實現原理”。

防止出錯的方法，也是將其放在try...catch代碼塊之中。

async function f() {try {await new Promise(function (resolve, reject) {throw new Error('出錯了');});} catch(e) {}return await('hello world'); }

如果有多個await命令，可以統一放在try...catch結構中。

1 async function main() { 2 try { 3 const val1 = await firstStep(); 4 const val2 = await secondStep(val1); 5 const val3 = await thirdStep(val1, val2); 6 7 console.log('Final: ', val3); 8 } 9 catch (err) { 10 console.error(err); 11 } 12 }

下面的例子使用try...catch結構，實現多次重復嘗試。

1 const superagent = require('superagent'); 2 const NUM_RETRIES = 3; 3 4 async function test() { 5 let i; 6 for (i = 0; i < NUM_RETRIES; ++i) { 7 try { 8 await superagent.get('http://google.com/this-throws-an-error'); 9 break; 10 } catch(err) {} 11 } 12 console.log(i); // 3 13 } 14 15 test();

上面代碼中，如果await操作成功，就會使用break語句退出循環；如果失敗，會被catch語句捕捉，然后進入下一輪循環。這個操作很神奇啊。

使用注意點?

第一點，前面已經說過，await命令后面的Promise對象，運行結果可能是rejected，所以最好把await命令放在try...catch代碼塊中。

1 async function myFunction() { 2 try { 3 await somethingThatReturnsAPromise(); 4 } catch (err) { 5 console.log(err); 6 } 7 } 8 9 // 另一種寫法 10 11 async function myFunction() { 12 await somethingThatReturnsAPromise() 13 .catch(function (err) { 14 console.log(err); 15 }); 16 }

第二點，多個await命令后面的異步操作，如果不存在繼發關系，最好讓它們同時觸發。

let foo = await getFoo(); let bar = await getBar();

上面代碼中，getFoo和getBar是兩個獨立的異步操作（即互不依賴），被寫成繼發關系。這樣比較耗時，因為只有getFoo完成以后，才會執行getBar，完全可以讓它們同時觸發。

// 寫法一 let [foo, bar] = await Promise.all([getFoo(), getBar()]);// 寫法二 let fooPromise = getFoo(); let barPromise = getBar(); let foo = await fooPromise; let bar = await barPromise;

上面兩種寫法，getFoo和getBar都是同時觸發，這樣就會縮短程序的執行時間。

第三點，await命令只能用在async函數之中，如果用在普通函數，就會報錯。

async function dbFuc(db) {let docs = [{}, {}, {}];// 報錯docs.forEach(function (doc) {await db.post(doc);}); }

上面代碼會報錯，因為await用在普通函數之中了。但是，如果將forEach方法的參數改成async函數，也有問題。

function dbFuc(db) { //這里不需要 asynclet docs = [{}, {}, {}];// 可能得到錯誤結果docs.forEach(async function (doc) {await db.post(doc);}); }

上面代碼可能不會正常工作，原因是這時三個db.post操作將是并發執行，也就是同時執行，而不是繼發執行。正確的寫法是采用for循環。

async function dbFuc(db) {let docs = [{}, {}, {}];for (let doc of docs) {await db.post(doc);} }

如果確實希望多個請求并發執行，可以使用Promise.all方法。當三個請求都會resolved時，下面兩種寫法效果相同。

1 async function dbFuc(db) { 2 let docs = [{}, {}, {}]; 3 let promises = docs.map((doc) => db.post(doc)); 4 5 let results = await Promise.all(promises); 6 console.log(results); 7 } 8 9 // 或者使用下面的寫法 10 11 async function dbFuc(db) { 12 let docs = [{}, {}, {}]; 13 let promises = docs.map((doc) => db.post(doc)); 14 15 let results = []; 16 for (let promise of promises) { 17 results.push(await promise); 18 } 19 console.log(results); 20 }

目前，esm模塊加載器支持頂層await，即await命令可以不放在 async 函數里面，直接使用。

// async 函數的寫法 const start = async () => {const res = await fetch('google.com');return res.text(); };start().then(console.log);// 頂層 await 的寫法 const res = await fetch('google.com'); console.log(await res.text());

上面代碼中，第二種寫法的腳本必須使用esm加載器，才會生效。

第四點，async 函數可以保留運行堆棧。

const a = () => {b().then(() => c()); };

上面代碼中，函數a內部運行了一個異步任務b()。當b()運行的時候，函數a()不會中斷，而是繼續執行。等到b()運行結束，可能a()早就運行結束了，b()所在的上下文環境已經消失了。如果b()或c()報錯，錯誤堆棧將不包括a()。

現在將這個例子改成async函數。

const a = async () => {await b();c(); };

上面代碼中，b()運行的時候，a()是暫停執行，上下文環境都保存著。一旦b()或c()報錯，錯誤堆棧將包括a()。

4.async 函數的實現原理

async 函數的實現原理，就是將 Generator 函數和自動執行器，包裝在一個函數里。

async function fn(args) {// ... }// 等同于function fn(args) {return spawn(function* () {// ... }); }

所有的async函數都可以寫成上面的第二種形式，其中的spawn函數就是自動執行器。

下面給出spawn函數的實現，基本就是前文自動執行器的翻版。

1 function spawn(genF) { 2 return new Promise(function(resolve, reject) { 3 const gen = genF(); 4 function step(nextF) { 5 let next; 6 try { 7 next = nextF(); 8 } catch(e) { 9 return reject(e); 10 } 11 if(next.done) { 12 return resolve(next.value); 13 } 14 Promise.resolve(next.value).then(function(v) { 15 step(function() { return gen.next(v); }); 16 }, function(e) { 17 step(function() { return gen.throw(e); }); 18 }); 19 } 20 step(function() { return gen.next(undefined); }); 21 }); 22 }

5.與其他異步處理方法的比較

我們通過一個例子，來看 async 函數與 Promise、Generator 函數的比較。

假定某個 DOM 元素上面，部署了一系列的動畫，前一個動畫結束，才能開始后一個。如果當中有一個動畫出錯，就不再往下執行，返回上一個成功執行的動畫的返回值。

首先是 Promise 的寫法。

1 function chainAnimationsPromise(elem, animations) { 2 3 // 變量ret用來保存上一個動畫的返回值 4 let ret = null; 5 6 // 新建一個空的Promise 7 let p = Promise.resolve(); 8 9 // 使用then方法，添加所有動畫 10 for(let anim of animations) { 11 p = p.then(function(val) { 12 ret = val; 13 return anim(elem); 14 }); 15 } 16 17 // 返回一個部署了錯誤捕捉機制的Promise 18 return p.catch(function(e) { 19 /* 忽略錯誤，繼續執行 */ 20 }).then(function() { 21 return ret; 22 }); 23 24 }

雖然 Promise 的寫法比回調函數的寫法大大改進，但是一眼看上去，代碼完全都是 Promise 的 API（then、catch等等），操作本身的語義反而不容易看出來。

接著是 Generator 函數的寫法。

1 function chainAnimationsGenerator(elem, animations) { 2 3 return spawn(function*() { 4 let ret = null; 5 try { 6 for(let anim of animations) { 7 ret = yield anim(elem); 8 } 9 } catch(e) { 10 /* 忽略錯誤，繼續執行 */ 11 } 12 return ret; 13 }); 14 15 }

上面代碼使用 Generator 函數遍歷了每個動畫，語義比 Promise 寫法更清晰，用戶定義的操作全部都出現在spawn函數的內部。這個寫法的問題在于，必須有一個任務運行器，自動執行 Generator 函數，上面代碼的spawn函數就是自動執行器，它返回一個 Promise 對象，而且必須保證yield語句后面的表達式，必須返回一個 Promise。

最后是 async 函數的寫法。

1 async function chainAnimationsAsync(elem, animations) { 2 let ret = null; 3 try { 4 for(let anim of animations) { 5 ret = await anim(elem); 6 } 7 } catch(e) { 8 /* 忽略錯誤，繼續執行 */ 9 } 10 return ret; 11 }

可以看到 Async 函數的實現最簡潔，最符合語義，幾乎沒有語義不相關的代碼。它將 Generator 寫法中的自動執行器，改在語言層面提供，不暴露給用戶，因此代碼量最少。如果使用 Generator 寫法，自動執行器需要用戶自己提供。

6.實例：按順序完成異步操作

實際開發中，經常遇到一組異步操作，需要按照順序完成。比如，依次遠程讀取一組 URL，然后按照讀取的順序輸出結果。

Promise 的寫法如下。

1 function logInOrder(urls) { 2 // 遠程讀取所有URL 3 const textPromises = urls.map(url => { 4 return fetch(url).then(response => response.text()); 5 }); 6 7 // 按次序輸出 8 textPromises.reduce((chain, textPromise) => { 9 return chain.then(() => textPromise) 10 .then(text => console.log(text)); 11 }, Promise.resolve()); 12 }

上面代碼使用fetch方法，同時遠程讀取一組 URL。每個fetch操作都返回一個 Promise 對象，放入textPromises數組。然后，reduce方法依次處理每個 Promise 對象，然后使用then，將所有 Promise 對象連起來，因此就可以依次輸出結果。

這種寫法不太直觀，可讀性比較差。下面是 async 函數實現。

async function logInOrder(urls) {for (const url of urls) {const response = await fetch(url);console.log(await response.text());} }

上面代碼確實大大簡化，問題是所有遠程操作都是繼發。只有前一個 URL 返回結果，才會去讀取下一個 URL，這樣做效率很差，非常浪費時間。我們需要的是并發發出遠程請求。

1 async function logInOrder(urls) { 2 // 并發讀取遠程URL 3 const textPromises = urls.map(async url => { 4 const response = await fetch(url); 5 return response.text(); 6 }); 7 8 // 按次序輸出 9 for (const textPromise of textPromises) { 10 console.log(await textPromise); 11 } 12 }

上面代碼中，雖然map方法的參數是async函數，但它是并發執行的，因為只有async函數內部是繼發執行，外部不受影響。后面的for..of循環內部使用了await，因此實現了按順序輸出。

7.異步遍歷器

《遍歷器》一章說過，Iterator 接口是一種數據遍歷的協議，只要調用遍歷器對象的next方法，就會得到一個對象，表示當前遍歷指針所在的那個位置的信息。next方法返回的對象的結構是{value, done}，其中value表示當前的數據的值，done是一個布爾值，表示遍歷是否結束。

這里隱含著一個規定，next方法必須是同步的，只要調用就必須立刻返回值。也就是說，一旦執行next方法，就必須同步地得到value和done這兩個屬性。如果遍歷指針正好指向同步操作，當然沒有問題，但對于異步操作，就不太合適了。目前的解決方法是，Generator 函數里面的異步操作，返回一個 Thunk 函數或者 Promise 對象，即value屬性是一個 Thunk 函數或者 Promise 對象，等待以后返回真正的值，而done屬性則還是同步產生的。

ES2018?引入了“異步遍歷器”（Async Iterator），為異步操作提供原生的遍歷器接口，即value和done這兩個屬性都是異步產生。

異步遍歷的接口

異步遍歷器的最大的語法特點，就是調用遍歷器的next方法，返回的是一個 Promise 對象。

asyncIterator.next().then(({ value, done }) => /* ... */);

上面代碼中，asyncIterator是一個異步遍歷器，調用next方法以后，返回一個 Promise 對象。因此，可以使用then方法指定，這個 Promise 對象的狀態變為resolve以后的回調函數。回調函數的參數，則是一個具有value和done兩個屬性的對象，這個跟同步遍歷器是一樣的。

我們知道，一個對象的同步遍歷器的接口，部署在Symbol.iterator屬性上面。同樣地，對象的異步遍歷器接口，部署在Symbol.asyncIterator屬性上面。不管是什么樣的對象，只要它的Symbol.asyncIterator屬性有值，就表示應該對它進行異步遍歷。

下面是一個異步遍歷器的例子。

1 const asyncIterable = createAsyncIterable(['a', 'b']); 2 const asyncIterator = asyncIterable[Symbol.asyncIterator](); 3 4 asyncIterator 5 .next() 6 .then(iterResult1 => { 7 console.log(iterResult1); // { value: 'a', done: false } 8 return asyncIterator.next(); 9 }) 10 .then(iterResult2 => { 11 console.log(iterResult2); // { value: 'b', done: false } 12 return asyncIterator.next(); 13 }) 14 .then(iterResult3 => { 15 console.log(iterResult3); // { value: undefined, done: true } 16 });

了解一下，異步遍歷器不再深究。

for await...of

前面介紹過，for...of循環用于遍歷同步的 Iterator 接口。新引入的for await...of循環，則是用于遍歷異步的 Iterator 接口。

async function f() {for await (const x of createAsyncIterable(['a', 'b'])) {console.log(x);} } // a // b

異步 Generator 函數

?就像 Generator 函數返回一個同步遍歷器對象一樣，異步 Generator 函數的作用，是返回一個異步遍歷器對象。

yield* 語句

yield*語句也可以跟一個異步遍歷器。

async function* gen1() {yield 'a';yield 'b';return 2; }async function* gen2() {// result 最終會等于 2const result = yield* gen1(); }

上面代碼中，gen2函數里面的result變量，最后的值是2。

與同步 Generator 函數一樣，for await...of循環會展開yield*。

沒有最好的方法，只有最適合的方法。

轉載于:https://www.cnblogs.com/jixiaohua/p/10674686.html

總結

以上是生活随笔為你收集整理的ES6学习笔记（十六）async函数的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。