ECMAScript 6 異步操作和Async函數(shù)

2018-09-20 17:16 更新

異步編程對JavaScript語言太重要。Javascript語言的執(zhí)行環(huán)境是“單線程”的,如果沒有異步編程,根本沒法用,非卡死不可。

ES6誕生以前,異步編程的方法,大概有下面四種。

  • 回調(diào)函數(shù)
  • 事件監(jiān)聽
  • 發(fā)布/訂閱
  • Promise 對象

ES6將JavaScript異步編程帶入了一個全新的階段,ES7的Async函數(shù)更是提出了異步編程的終極解決方案。

基本概念

異步

所謂"異步",簡單說就是一個任務(wù)分成兩段,先執(zhí)行第一段,然后轉(zhuǎn)而執(zhí)行其他任務(wù),等做好了準(zhǔn)備,再回過頭執(zhí)行第二段。

比如,有一個任務(wù)是讀取文件進(jìn)行處理,任務(wù)的第一段是向操作系統(tǒng)發(fā)出請求,要求讀取文件。然后,程序執(zhí)行其他任務(wù),等到操作系統(tǒng)返回文件,再接著執(zhí)行任務(wù)的第二段(處理文件)。這種不連續(xù)的執(zhí)行,就叫做異步。

相應(yīng)地,連續(xù)的執(zhí)行就叫做同步。由于是連續(xù)執(zhí)行,不能插入其他任務(wù),所以操作系統(tǒng)從硬盤讀取文件的這段時間,程序只能干等著。

回調(diào)函數(shù)

JavaScript語言對異步編程的實(shí)現(xiàn),就是回調(diào)函數(shù)。所謂回調(diào)函數(shù),就是把任務(wù)的第二段單獨(dú)寫在一個函數(shù)里面,等到重新執(zhí)行這個任務(wù)的時候,就直接調(diào)用這個函數(shù)。它的英語名字callback,直譯過來就是"重新調(diào)用"。

讀取文件進(jìn)行處理,是這樣寫的。

fs.readFile('/etc/passwd', function (err, data) {
  if (err) throw err;
  console.log(data);
});

上面代碼中,readFile函數(shù)的第二個參數(shù),就是回調(diào)函數(shù),也就是任務(wù)的第二段。等到操作系統(tǒng)返回了/etc/passwd這個文件以后,回調(diào)函數(shù)才會執(zhí)行。

一個有趣的問題是,為什么Node.js約定,回調(diào)函數(shù)的第一個參數(shù),必須是錯誤對象err(如果沒有錯誤,該參數(shù)就是null)?原因是執(zhí)行分成兩段,在這兩段之間拋出的錯誤,程序無法捕捉,只能當(dāng)作參數(shù),傳入第二段。

Promise

回調(diào)函數(shù)本身并沒有問題,它的問題出現(xiàn)在多個回調(diào)函數(shù)嵌套。假定讀取A文件之后,再讀取B文件,代碼如下。

fs.readFile(fileA, function (err, data) {
  fs.readFile(fileB, function (err, data) {
    // ...
  });
});

不難想象,如果依次讀取多個文件,就會出現(xiàn)多重嵌套。代碼不是縱向發(fā)展,而是橫向發(fā)展,很快就會亂成一團(tuán),無法管理。這種情況就稱為"回調(diào)函數(shù)噩夢"(callback hell)。

Promise就是為了解決這個問題而提出的。它不是新的語法功能,而是一種新的寫法,允許將回調(diào)函數(shù)的嵌套,改成鏈?zhǔn)秸{(diào)用。采用Promise,連續(xù)讀取多個文件,寫法如下。

var readFile = require('fs-readfile-promise');

readFile(fileA)
.then(function(data){
  console.log(data.toString());
})
.then(function(){
  return readFile(fileB);
})
.then(function(data){
  console.log(data.toString());
})
.catch(function(err) {
  console.log(err);
});

上面代碼中,我使用了fs-readfile-promise模塊,它的作用就是返回一個Promise版本的readFile函數(shù)。Promise提供then方法加載回調(diào)函數(shù),catch方法捕捉執(zhí)行過程中拋出的錯誤。

可以看到,Promise 的寫法只是回調(diào)函數(shù)的改進(jìn),使用then方法以后,異步任務(wù)的兩段執(zhí)行看得更清楚了,除此以外,并無新意。

Promise 的最大問題是代碼冗余,原來的任務(wù)被Promise 包裝了一下,不管什么操作,一眼看去都是一堆 then,原來的語義變得很不清楚。

那么,有沒有更好的寫法呢?

Generator函數(shù)

協(xié)程

傳統(tǒng)的編程語言,早有異步編程的解決方案(其實(shí)是多任務(wù)的解決方案)。其中有一種叫做"協(xié)程"(coroutine),意思是多個線程互相協(xié)作,完成異步任務(wù)。

協(xié)程有點(diǎn)像函數(shù),又有點(diǎn)像線程。它的運(yùn)行流程大致如下。

  • 第一步,協(xié)程A開始執(zhí)行。
  • 第二步,協(xié)程A執(zhí)行到一半,進(jìn)入暫停,執(zhí)行權(quán)轉(zhuǎn)移到協(xié)程B。
  • 第三步,(一段時間后)協(xié)程B交還執(zhí)行權(quán)。
  • 第四步,協(xié)程A恢復(fù)執(zhí)行。

上面流程的協(xié)程A,就是異步任務(wù),因為它分成兩段(或多段)執(zhí)行。

舉例來說,讀取文件的協(xié)程寫法如下。

function *asyncJob() {
  // ...其他代碼
  var f = yield readFile(fileA);
  // ...其他代碼
}

上面代碼的函數(shù)asyncJob是一個協(xié)程,它的奧妙就在其中的yield命令。它表示執(zhí)行到此處,執(zhí)行權(quán)將交給其他協(xié)程。也就是說,yield命令是異步兩個階段的分界線。

協(xié)程遇到yield命令就暫停,等到執(zhí)行權(quán)返回,再從暫停的地方繼續(xù)往后執(zhí)行。它的最大優(yōu)點(diǎn),就是代碼的寫法非常像同步操作,如果去除yield命令,簡直一模一樣。

Generator函數(shù)的概念

Generator函數(shù)是協(xié)程在ES6的實(shí)現(xiàn),最大特點(diǎn)就是可以交出函數(shù)的執(zhí)行權(quán)(即暫停執(zhí)行)。

整個Generator函數(shù)就是一個封裝的異步任務(wù),或者說是異步任務(wù)的容器。異步操作需要暫停的地方,都用yield語句注明。Generator函數(shù)的執(zhí)行方法如下。

function* gen(x){
  var y = yield x + 2;
  return y;
}

var g = gen(1);
g.next() // { value: 3, done: false }
g.next() // { value: undefined, done: true }

上面代碼中,調(diào)用Generator函數(shù),會返回一個內(nèi)部指針(即遍歷器)g 。這是Generator函數(shù)不同于普通函數(shù)的另一個地方,即執(zhí)行它不會返回結(jié)果,返回的是指針對象。調(diào)用指針g的next方法,會移動內(nèi)部指針(即執(zhí)行異步任務(wù)的第一段),指向第一個遇到的yield語句,上例是執(zhí)行到x + 2為止。

換言之,next方法的作用是分階段執(zhí)行Generator函數(shù)。每次調(diào)用next方法,會返回一個對象,表示當(dāng)前階段的信息(value屬性和done屬性)。value屬性是yield語句后面表達(dá)式的值,表示當(dāng)前階段的值;done屬性是一個布爾值,表示Generator函數(shù)是否執(zhí)行完畢,即是否還有下一個階段。

Generator函數(shù)的數(shù)據(jù)交換和錯誤處理

Generator函數(shù)可以暫停執(zhí)行和恢復(fù)執(zhí)行,這是它能封裝異步任務(wù)的根本原因。除此之外,它還有兩個特性,使它可以作為異步編程的完整解決方案:函數(shù)體內(nèi)外的數(shù)據(jù)交換和錯誤處理機(jī)制。

next方法返回值的value屬性,是Generator函數(shù)向外輸出數(shù)據(jù);next方法還可以接受參數(shù),這是向Generator函數(shù)體內(nèi)輸入數(shù)據(jù)。

function* gen(x){
  var y = yield x + 2;
  return y;
}

var g = gen(1);
g.next() // { value: 3, done: false }
g.next(2) // { value: 2, done: true }

上面代碼中,第一個next方法的value屬性,返回表達(dá)式x + 2的值(3)。第二個next方法帶有參數(shù)2,這個參數(shù)可以傳入 Generator 函數(shù),作為上個階段異步任務(wù)的返回結(jié)果,被函數(shù)體內(nèi)的變量y接收。因此,這一步的 value 屬性,返回的就是2(變量y的值)。

Generator 函數(shù)內(nèi)部還可以部署錯誤處理代碼,捕獲函數(shù)體外拋出的錯誤。

function* gen(x){
  try {
    var y = yield x + 2;
  } catch (e){
    console.log(e);
  }
  return y;
}

var g = gen(1);
g.next();
g.throw('出錯了');
// 出錯了

上面代碼的最后一行,Generator函數(shù)體外,使用指針對象的throw方法拋出的錯誤,可以被函數(shù)體內(nèi)的try ...catch代碼塊捕獲。這意味著,出錯的代碼與處理錯誤的代碼,實(shí)現(xiàn)了時間和空間上的分離,這對于異步編程無疑是很重要的。

異步任務(wù)的封裝

下面看看如何使用 Generator 函數(shù),執(zhí)行一個真實(shí)的異步任務(wù)。

var fetch = require('node-fetch');

function* gen(){
  var url = 'https://api.github.com/users/github';
  var result = yield fetch(url);
  console.log(result.bio);
}

上面代碼中,Generator函數(shù)封裝了一個異步操作,該操作先讀取一個遠(yuǎn)程接口,然后從JSON格式的數(shù)據(jù)解析信息。就像前面說過的,這段代碼非常像同步操作,除了加上了yield命令。

執(zhí)行這段代碼的方法如下。

var g = gen();
var result = g.next();

result.value.then(function(data){
  return data.json();
}).then(function(data){
  g.next(data);
});

上面代碼中,首先執(zhí)行Generator函數(shù),獲取遍歷器對象,然后使用next 方法(第二行),執(zhí)行異步任務(wù)的第一階段。由于Fetch模塊返回的是一個Promise對象,因此要用then方法調(diào)用下一個next 方法。

可以看到,雖然 Generator 函數(shù)將異步操作表示得很簡潔,但是流程管理卻不方便(即何時執(zhí)行第一階段、何時執(zhí)行第二階段)。

Thunk函數(shù)

參數(shù)的求值策略

Thunk函數(shù)早在上個世紀(jì)60年代就誕生了。

那時,編程語言剛剛起步,計算機(jī)學(xué)家還在研究,編譯器怎么寫比較好。一個爭論的焦點(diǎn)是"求值策略",即函數(shù)的參數(shù)到底應(yīng)該何時求值。

var x = 1;

function f(m){
  return m * 2;
}

f(x + 5)

上面代碼先定義函數(shù)f,然后向它傳入表達(dá)式x + 5。請問,這個表達(dá)式應(yīng)該何時求值?

一種意見是"傳值調(diào)用"(call by value),即在進(jìn)入函數(shù)體之前,就計算x + 5的值(等于6),再將這個值傳入函數(shù)f 。C語言就采用這種策略。

f(x + 5)
// 傳值調(diào)用時,等同于
f(6)

另一種意見是"傳名調(diào)用"(call by name),即直接將表達(dá)式x + 5傳入函數(shù)體,只在用到它的時候求值。Haskell語言采用這種策略。

f(x + 5)
// 傳名調(diào)用時,等同于
(x + 5) * 2

傳值調(diào)用和傳名調(diào)用,哪一種比較好?回答是各有利弊。傳值調(diào)用比較簡單,但是對參數(shù)求值的時候,實(shí)際上還沒用到這個參數(shù),有可能造成性能損失。

function f(a, b){
  return b;
}

f(3 * x * x - 2 * x - 1, x);

上面代碼中,函數(shù)f的第一個參數(shù)是一個復(fù)雜的表達(dá)式,但是函數(shù)體內(nèi)根本沒用到。對這個參數(shù)求值,實(shí)際上是不必要的。因此,有一些計算機(jī)學(xué)家傾向于"傳名調(diào)用",即只在執(zhí)行時求值。

Thunk函數(shù)的含義

編譯器的"傳名調(diào)用"實(shí)現(xiàn),往往是將參數(shù)放到一個臨時函數(shù)之中,再將這個臨時函數(shù)傳入函數(shù)體。這個臨時函數(shù)就叫做Thunk函數(shù)。

function f(m){
  return m * 2;
}

f(x + 5);

// 等同于

var thunk = function () {
  return x + 5;
};

function f(thunk){
  return thunk() * 2;
}

上面代碼中,函數(shù)f的參數(shù)x + 5被一個函數(shù)替換了。凡是用到原參數(shù)的地方,對Thunk函數(shù)求值即可。

這就是Thunk函數(shù)的定義,它是"傳名調(diào)用"的一種實(shí)現(xiàn)策略,用來替換某個表達(dá)式。

JavaScript語言的Thunk函數(shù)

JavaScript語言是傳值調(diào)用,它的Thunk函數(shù)含義有所不同。在JavaScript語言中,Thunk函數(shù)替換的不是表達(dá)式,而是多參數(shù)函數(shù),將其替換成單參數(shù)的版本,且只接受回調(diào)函數(shù)作為參數(shù)。

// 正常版本的readFile(多參數(shù)版本)
fs.readFile(fileName, callback);

// Thunk版本的readFile(單參數(shù)版本)
var readFileThunk = Thunk(fileName);
readFileThunk(callback);

var Thunk = function (fileName){
  return function (callback){
    return fs.readFile(fileName, callback);
  };
};

上面代碼中,fs模塊的readFile方法是一個多參數(shù)函數(shù),兩個參數(shù)分別為文件名和回調(diào)函數(shù)。經(jīng)過轉(zhuǎn)換器處理,它變成了一個單參數(shù)函數(shù),只接受回調(diào)函數(shù)作為參數(shù)。這個單參數(shù)版本,就叫做Thunk函數(shù)。

任何函數(shù),只要參數(shù)有回調(diào)函數(shù),就能寫成Thunk函數(shù)的形式。下面是一個簡單的Thunk函數(shù)轉(zhuǎn)換器。

// ES5版本
var Thunk = function(fn){
  return function (){
    var args = Array.prototype.slice.call(arguments);
    return function (callback){
      args.push(callback);
      return fn.apply(this, args);
    }
  };
};

// ES6版本
var Thunk = function(fn) {
  return function (...args) {
    return function (callback) {
      return fn.call(this, ...args, callback);
    }
  };
};

使用上面的轉(zhuǎn)換器,生成fs.readFile的Thunk函數(shù)。

var readFileThunk = Thunk(fs.readFile);
readFileThunk(fileA)(callback);

下面是另一個完整的例子。

function f(a, cb) {
  cb(a);
}
let ft = Thunk(f);

let log = console.log.bind(console);
ft(1)(log) // 1

Thunkify模塊

生產(chǎn)環(huán)境的轉(zhuǎn)換器,建議使用Thunkify模塊。

首先是安裝。

$ npm install thunkify

使用方式如下。

var thunkify = require('thunkify');
var fs = require('fs');

var read = thunkify(fs.readFile);
read('package.json')(function(err, str){
  // ...
});

Thunkify的源碼與上一節(jié)那個簡單的轉(zhuǎn)換器非常像。

function thunkify(fn){
  return function(){
    var args = new Array(arguments.length);
    var ctx = this;

    for(var i = 0; i < args.length; ++i) {
      args[i] = arguments[i];
    }

    return function(done){
      var called;

      args.push(function(){
        if (called) return;
        called = true;
        done.apply(null, arguments);
      });

      try {
        fn.apply(ctx, args);
      } catch (err) {
        done(err);
      }
    }
  }
};

它的源碼主要多了一個檢查機(jī)制,變量called確?;卣{(diào)函數(shù)只運(yùn)行一次。這樣的設(shè)計與下文的Generator函數(shù)相關(guān)。請看下面的例子。

function f(a, b, callback){
  var sum = a + b;
  callback(sum);
  callback(sum);
}

var ft = thunkify(f);
var print = console.log.bind(console);
ft(1, 2)(print);
// 3

上面代碼中,由于thunkify只允許回調(diào)函數(shù)執(zhí)行一次,所以只輸出一行結(jié)果。

Generator 函數(shù)的流程管理

你可能會問, Thunk函數(shù)有什么用?回答是以前確實(shí)沒什么用,但是ES6有了Generator函數(shù),Thunk函數(shù)現(xiàn)在可以用于Generator函數(shù)的自動流程管理。

Generator函數(shù)可以自動執(zhí)行。

function* gen() {
  // ...
}

var g = gen();
var res = g.next();

while(!res.done){
  console.log(res.value);
  res = g.next();
}

上面代碼中,Generator函數(shù)gen會自動執(zhí)行完所有步驟。

但是,這不適合異步操作。如果必須保證前一步執(zhí)行完,才能執(zhí)行后一步,上面的自動執(zhí)行就不可行。這時,Thunk函數(shù)就能派上用處。以讀取文件為例。下面的Generator函數(shù)封裝了兩個異步操作。

var fs = require('fs');
var thunkify = require('thunkify');
var readFile = thunkify(fs.readFile);

var gen = function* (){
  var r1 = yield readFile('/etc/fstab');
  console.log(r1.toString());
  var r2 = yield readFile('/etc/shells');
  console.log(r2.toString());
};

上面代碼中,yield命令用于將程序的執(zhí)行權(quán)移出Generator函數(shù),那么就需要一種方法,將執(zhí)行權(quán)再交還給Generator函數(shù)。

這種方法就是Thunk函數(shù),因為它可以在回調(diào)函數(shù)里,將執(zhí)行權(quán)交還給Generator函數(shù)。為了便于理解,我們先看如何手動執(zhí)行上面這個Generator函數(shù)。

var g = gen();

var r1 = g.next();
r1.value(function(err, data){
  if (err) throw err;
  var r2 = g.next(data);
  r2.value(function(err, data){
    if (err) throw err;
    g.next(data);
  });
});

上面代碼中,變量g是Generator函數(shù)的內(nèi)部指針,表示目前執(zhí)行到哪一步。next方法負(fù)責(zé)將指針移動到下一步,并返回該步的信息(value屬性和done屬性)。

仔細(xì)查看上面的代碼,可以發(fā)現(xiàn)Generator函數(shù)的執(zhí)行過程,其實(shí)是將同一個回調(diào)函數(shù),反復(fù)傳入next方法的value屬性。這使得我們可以用遞歸來自動完成這個過程。

Thunk函數(shù)的自動流程管理

Thunk函數(shù)真正的威力,在于可以自動執(zhí)行Generator函數(shù)。下面就是一個基于Thunk函數(shù)的Generator執(zhí)行器。

function run(fn) {
  var gen = fn();

  function next(err, data) {
    var result = gen.next(data);
    if (result.done) return;
    result.value(next);
  }

  next();
}

function* g() {
  // ...
}

run(g);

上面代碼的run函數(shù),就是一個Generator函數(shù)的自動執(zhí)行器。內(nèi)部的next函數(shù)就是Thunk的回調(diào)函數(shù)。next函數(shù)先將指針移到Generator函數(shù)的下一步(gen.next方法),然后判斷Generator函數(shù)是否結(jié)束(result.done屬性),如果沒結(jié)束,就將next函數(shù)再傳入Thunk函數(shù)(result.value屬性),否則就直接退出。

有了這個執(zhí)行器,執(zhí)行Generator函數(shù)方便多了。不管內(nèi)部有多少個異步操作,直接把Generator函數(shù)傳入run函數(shù)即可。當(dāng)然,前提是每一個異步操作,都要是Thunk函數(shù),也就是說,跟在yield命令后面的必須是Thunk函數(shù)。

var g = function* (){
  var f1 = yield readFile('fileA');
  var f2 = yield readFile('fileB');
  // ...
  var fn = yield readFile('fileN');
};

run(g);

上面代碼中,函數(shù)g封裝了n個異步的讀取文件操作,只要執(zhí)行run函數(shù),這些操作就會自動完成。這樣一來,異步操作不僅可以寫得像同步操作,而且一行代碼就可以執(zhí)行。

Thunk函數(shù)并不是Generator函數(shù)自動執(zhí)行的唯一方案。因為自動執(zhí)行的關(guān)鍵是,必須有一種機(jī)制,自動控制Generator函數(shù)的流程,接收和交還程序的執(zhí)行權(quán)?;卣{(diào)函數(shù)可以做到這一點(diǎn),Promise 對象也可以做到這一點(diǎn)。

co模塊

基本用法

co模塊是著名程序員TJ Holowaychuk于2013年6月發(fā)布的一個小工具,用于Generator函數(shù)的自動執(zhí)行。

比如,有一個Generator函數(shù),用于依次讀取兩個文件。

var gen = function* (){
  var f1 = yield readFile('/etc/fstab');
  var f2 = yield readFile('/etc/shells');
  console.log(f1.toString());
  console.log(f2.toString());
};

co模塊可以讓你不用編寫Generator函數(shù)的執(zhí)行器。

var co = require('co');
co(gen);

上面代碼中,Generator函數(shù)只要傳入co函數(shù),就會自動執(zhí)行。

co函數(shù)返回一個Promise對象,因此可以用then方法添加回調(diào)函數(shù)。

co(gen).then(function (){
  console.log('Generator 函數(shù)執(zhí)行完成');
});

上面代碼中,等到Generator函數(shù)執(zhí)行結(jié)束,就會輸出一行提示。

co模塊的原理

為什么co可以自動執(zhí)行Generator函數(shù)?

前面說過,Generator就是一個異步操作的容器。它的自動執(zhí)行需要一種機(jī)制,當(dāng)異步操作有了結(jié)果,能夠自動交回執(zhí)行權(quán)。

兩種方法可以做到這一點(diǎn)。

(1)回調(diào)函數(shù)。將異步操作包裝成Thunk函數(shù),在回調(diào)函數(shù)里面交回執(zhí)行權(quán)。

(2)Promise 對象。將異步操作包裝成Promise對象,用then方法交回執(zhí)行權(quán)。

co模塊其實(shí)就是將兩種自動執(zhí)行器(Thunk函數(shù)和Promise對象),包裝成一個模塊。使用co的前提條件是,Generator函數(shù)的yield命令后面,只能是Thunk函數(shù)或Promise對象。

上一節(jié)已經(jīng)介紹了基于Thunk函數(shù)的自動執(zhí)行器。下面來看,基于Promise對象的自動執(zhí)行器。這是理解co模塊必須的。

基于Promise對象的自動執(zhí)行

還是沿用上面的例子。首先,把fs模塊的readFile方法包裝成一個Promise對象。

var fs = require('fs');

var readFile = function (fileName){
  return new Promise(function (resolve, reject){
    fs.readFile(fileName, function(error, data){
      if (error) return reject(error);
      resolve(data);
    });
  });
};

var gen = function* (){
  var f1 = yield readFile('/etc/fstab');
  var f2 = yield readFile('/etc/shells');
  console.log(f1.toString());
  console.log(f2.toString());
};

然后,手動執(zhí)行上面的Generator函數(shù)。

var g = gen();

g.next().value.then(function(data){
  g.next(data).value.then(function(data){
    g.next(data);
  });
});

手動執(zhí)行其實(shí)就是用then方法,層層添加回調(diào)函數(shù)。理解了這一點(diǎn),就可以寫出一個自動執(zhí)行器。

function run(gen){
  var g = gen();

  function next(data){
    var result = g.next(data);
    if (result.done) return result.value;
    result.value.then(function(data){
      next(data);
    });
  }

  next();
}

run(gen);

上面代碼中,只要Generator函數(shù)還沒執(zhí)行到最后一步,next函數(shù)就調(diào)用自身,以此實(shí)現(xiàn)自動執(zhí)行。

co模塊的源碼

co就是上面那個自動執(zhí)行器的擴(kuò)展,它的源碼只有幾十行,非常簡單。

首先,co函數(shù)接受Generator函數(shù)作為參數(shù),返回一個 Promise 對象。

function co(gen) {
  var ctx = this;

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

在返回的Promise對象里面,co先檢查參數(shù)gen是否為Generator函數(shù)。如果是,就執(zhí)行該函數(shù),得到一個內(nèi)部指針對象;如果不是就返回,并將Promise對象的狀態(tài)改為resolved。

function co(gen) {
  var ctx = this;

  return new Promise(function(resolve, reject) {
    if (typeof gen === 'function') gen = gen.call(ctx);
    if (!gen || typeof gen.next !== 'function') return resolve(gen);
  });
}

接著,co將Generator函數(shù)的內(nèi)部指針對象的next方法,包裝成onFulfilled函數(shù)。這主要是為了能夠捕捉拋出的錯誤。

function co(gen) {
  var ctx = this;

  return new Promise(function(resolve, reject) {
    if (typeof gen === 'function') gen = gen.call(ctx);
    if (!gen || typeof gen.next !== 'function') return resolve(gen);

    onFulfilled();
    function onFulfilled(res) {
      var ret;
      try {
        ret = gen.next(res);
      } catch (e) {
        return reject(e);
      }
      next(ret);
    }
  });
}

最后,就是關(guān)鍵的next函數(shù),它會反復(fù)調(diào)用自身。

function next(ret) {
  if (ret.done) return resolve(ret.value);
  var value = toPromise.call(ctx, ret.value);
  if (value && isPromise(value)) return value.then(onFulfilled, onRejected);
  return onRejected(new TypeError('You may only yield a function, promise, generator, array, or object, '
    + 'but the following object was passed: "' + String(ret.value) + '"'));
}

上面代碼中,next 函數(shù)的內(nèi)部代碼,一共只有四行命令。

第一行,檢查當(dāng)前是否為 Generator 函數(shù)的最后一步,如果是就返回。

第二行,確保每一步的返回值,是 Promise 對象。

第三行,使用 then 方法,為返回值加上回調(diào)函數(shù),然后通過 onFulfilled 函數(shù)再次調(diào)用 next 函數(shù)。

第四行,在參數(shù)不符合要求的情況下(參數(shù)非 Thunk 函數(shù)和 Promise 對象),將 Promise 對象的狀態(tài)改為 rejected,從而終止執(zhí)行。

處理并發(fā)的異步操作

co支持并發(fā)的異步操作,即允許某些操作同時進(jìn)行,等到它們?nèi)客瓿?,才進(jìn)行下一步。

這時,要把并發(fā)的操作都放在數(shù)組或?qū)ο罄锩妫趛ield語句后面。

// 數(shù)組的寫法
co(function* () {
  var res = yield [
    Promise.resolve(1),
    Promise.resolve(2)
  ];
  console.log(res);
}).catch(onerror);

// 對象的寫法
co(function* () {
  var res = yield {
    1: Promise.resolve(1),
    2: Promise.resolve(2),
  };
  console.log(res);
}).catch(onerror);

下面是另一個例子。

co(function* () {
  var values = [n1, n2, n3];
  yield values.map(somethingAsync);
});

function* somethingAsync(x) {
  // do something async
  return y
}

上面的代碼允許并發(fā)三個somethingAsync異步操作,等到它們?nèi)客瓿桑艜M(jìn)行下一步。

async函數(shù)

含義

ES7提供了async函數(shù),使得異步操作變得更加方便。async函數(shù)是什么?一句話,async函數(shù)就是Generator函數(shù)的語法糖。

前文有一個Generator函數(shù),依次讀取兩個文件。

var fs = require('fs');

var readFile = function (fileName) {
  return new Promise(function (resolve, reject) {
    fs.readFile(fileName, function(error, data) {
      if (error) reject(error);
      resolve(data);
    });
  });
};

var gen = function* (){
  var f1 = yield readFile('/etc/fstab');
  var f2 = yield readFile('/etc/shells');
  console.log(f1.toString());
  console.log(f2.toString());
};

寫成async函數(shù),就是下面這樣。

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

一比較就會發(fā)現(xiàn),async函數(shù)就是將Generator函數(shù)的星號(*)替換成async,將yield替換成await,僅此而已。

async函數(shù)對 Generator 函數(shù)的改進(jìn),體現(xiàn)在以下四點(diǎn)。

(1)內(nèi)置執(zhí)行器。Generator函數(shù)的執(zhí)行必須靠執(zhí)行器,所以才有了co模塊,而async函數(shù)自帶執(zhí)行器。也就是說,async函數(shù)的執(zhí)行,與普通函數(shù)一模一樣,只要一行。

var result = asyncReadFile();

上面的代碼調(diào)用了asyncReadFile函數(shù),然后它就會自動執(zhí)行,輸出最后結(jié)果。這完全不像Generator函數(shù),需要調(diào)用next方法,或者用co模塊,才能得到真正執(zhí)行,得到最后結(jié)果。

(2)更好的語義。asyncawait,比起星號和yield,語義更清楚了。async表示函數(shù)里有異步操作,await表示緊跟在后面的表達(dá)式需要等待結(jié)果。

(3)更廣的適用性。 co模塊約定,yield命令后面只能是Thunk函數(shù)或Promise對象,而async函數(shù)的await命令后面,可以是Promise對象和原始類型的值(數(shù)值、字符串和布爾值,但這時等同于同步操作)。

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

進(jìn)一步說,async函數(shù)完全可以看作多個異步操作,包裝成的一個Promise對象,而await命令就是內(nèi)部then命令的語法糖。

語法

async函數(shù)的語法規(guī)則總體上比較簡單,難點(diǎn)是錯誤處理機(jī)制。

(1)async函數(shù)返回一個Promise對象。

async函數(shù)內(nèi)部return語句返回的值,會成為then方法回調(diào)函數(shù)的參數(shù)。

async function f() {
  return 'hello world';
}

f().then(v => console.log(v))
// "hello world"

上面代碼中,函數(shù)f內(nèi)部return命令返回的值,會被then方法回調(diào)函數(shù)接收到。

async函數(shù)內(nèi)部拋出錯誤,會導(dǎo)致返回的Promise對象變?yōu)?code>reject狀態(tài)。拋出的錯誤對象會被catch方法回調(diào)函數(shù)接收到。

async function f() {
  throw new Error('出錯了');
}

f().then(
  v => console.log(v),
  e => console.log(e)
)
// Error: 出錯了

(2)async函數(shù)返回的Promise對象,必須等到內(nèi)部所有await命令的Promise對象執(zhí)行完,才會發(fā)生狀態(tài)改變。也就是說,只有async函數(shù)內(nèi)部的異步操作執(zhí)行完,才會執(zhí)行then方法指定的回調(diào)函數(shù)。

下面是一個例子。

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"

(3)正常情況下,await命令后面是一個Promise對象。如果不是,會被轉(zhuǎn)成一個立即resolve的Promise對象。

async function f() {
  return await 123;
}

f().then(v => console.log(v))
// 123

上面代碼中,await命令的參數(shù)是數(shù)值123,它被轉(zhuǎn)成Promise對象,并立即resolve。

await命令后面的Promise對象如果變?yōu)?code>reject狀態(tài),則reject的參數(shù)會被catch方法的回調(diào)函數(shù)接收到。

async function f() {
  await Promise.reject('出錯了');
}

f()
.then(v => console.log(v))
.catch(e => console.log(e))
// 出錯了

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

只要一個await語句后面的Promise變?yōu)?code>reject,那么整個async函數(shù)都會中斷執(zhí)行。

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

上面代碼中,第二個await語句是不會執(zhí)行的,因為第一個await語句狀態(tài)變成了reject。

為了避免這個問題,可以將第一個await放在try...catch結(jié)構(gòu)里面,這樣第二個await就會執(zhí)行。

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方面,處理前面可能出現(xiàn)的錯誤。

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命令,可以統(tǒng)一放在try...catch結(jié)構(gòu)中。

async function main() {
  try {
    var val1 = await firstStep();
    var val2 = await secondStep(val1);
    var val3 = await thirdStep(val1, val2);

    console.log('Final: ', val3);
  }
  catch (err) {
    console.error(err);
  }
}

(4)如果await后面的異步操作出錯,那么等同于async函數(shù)返回的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函數(shù)f執(zhí)行后,await后面的Promise對象會拋出一個錯誤對象,導(dǎo)致catch方法的回調(diào)函數(shù)被調(diào)用,它的參數(shù)就是拋出的錯誤對象。具體的執(zhí)行機(jī)制,可以參考后文的“async函數(shù)的實(shí)現(xiàn)”。

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

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

async函數(shù)的實(shí)現(xiàn)

async 函數(shù)的實(shí)現(xiàn),就是將 Generator 函數(shù)和自動執(zhí)行器,包裝在一個函數(shù)里。

async function fn(args){
  // ...
}

// 等同于

function fn(args){
  return spawn(function*() {
    // ...
  });
}

所有的async函數(shù)都可以寫成上面的第二種形式,其中的 spawn 函數(shù)就是自動執(zhí)行器。

下面給出spawn函數(shù)的實(shí)現(xiàn),基本就是前文自動執(zhí)行器的翻版。

function spawn(genF) {
  return new Promise(function(resolve, reject) {
    var gen = genF();
    function step(nextF) {
      try {
        var next = nextF();
      } catch(e) {
        return reject(e);
      }
      if(next.done) {
        return resolve(next.value);
      }
      Promise.resolve(next.value).then(function(v) {
        step(function() { return gen.next(v); });
      }, function(e) {
        step(function() { return gen.throw(e); });
      });
    }
    step(function() { return gen.next(undefined); });
  });
}

async函數(shù)是非常新的語法功能,新到都不屬于 ES6,而是屬于 ES7。目前,它仍處于提案階段,但是轉(zhuǎn)碼器Babelregenerator都已經(jīng)支持,轉(zhuǎn)碼后就能使用。

async 函數(shù)的用法

async函數(shù)返回一個Promise對象,可以使用then方法添加回調(diào)函數(shù)。當(dāng)函數(shù)執(zhí)行的時候,一旦遇到await就會先返回,等到觸發(fā)的異步操作完成,再接著執(zhí)行函數(shù)體內(nèi)后面的語句。

下面是一個例子。

async function getStockPriceByName(name) {
  var symbol = await getStockSymbol(name);
  var stockPrice = await getStockPrice(symbol);
  return stockPrice;
}

getStockPriceByName('goog').then(function (result) {
  console.log(result);
});

上面代碼是一個獲取股票報價的函數(shù),函數(shù)前面的async關(guān)鍵字,表明該函數(shù)內(nèi)部有異步操作。調(diào)用該函數(shù)時,會立即返回一個Promise對象。

下面的例子,指定多少毫秒后輸出一個值。

function timeout(ms) {
  return new Promise((resolve) => {
    setTimeout(resolve, ms);
  });
}

async function asyncPrint(value, ms) {
  await timeout(ms);
  console.log(value)
}

asyncPrint('hello world', 50);

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

Async函數(shù)有多種使用形式。

// 函數(shù)聲明
async function foo() {}

// 函數(shù)表達(dá)式
const foo = async function () {};

// 對象的方法
let obj = { async foo() {} };

// 箭頭函數(shù)
const foo = async () => {};

注意點(diǎn)

第一點(diǎn),await命令后面的Promise對象,運(yùn)行結(jié)果可能是rejected,所以最好把await命令放在try...catch代碼塊中。

async function myFunction() {
  try {
    await somethingThatReturnsAPromise();
  } catch (err) {
    console.log(err);
  }
}

// 另一種寫法

async function myFunction() {
  await somethingThatReturnsAPromise()
  .catch(function (err) {
    console.log(err);
  };
}

第二點(diǎn),多個await命令后面的異步操作,如果不存在繼發(fā)關(guān)系,最好讓它們同時觸發(fā)。

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

上面代碼中,getFoogetBar是兩個獨(dú)立的異步操作(即互不依賴),被寫成繼發(fā)關(guān)系。這樣比較耗時,因為只有getFoo完成以后,才會執(zhí)行getBar,完全可以讓它們同時觸發(fā)。

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

// 寫法二
let fooPromise = getFoo();
let barPromise = getBar();
let foo = await fooPromise;
let bar = await barPromise;

上面兩種寫法,getFoogetBar都是同時觸發(fā),這樣就會縮短程序的執(zhí)行時間。

第三點(diǎn),await命令只能用在async函數(shù)之中,如果用在普通函數(shù),就會報錯。

async function dbFuc(db) {
  let docs = [{}, {}, {}];

  // 報錯
  docs.forEach(function (doc) {
    await db.post(doc);
  });
}

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

async function dbFuc(db) {
  let docs = [{}, {}, {}];

  // 可能得到錯誤結(jié)果
  docs.forEach(async function (doc) {
    await db.post(doc);
  });
}

上面代碼可能不會正常工作,原因是這時三個db.post操作將是并發(fā)執(zhí)行,也就是同時執(zhí)行,而不是繼發(fā)執(zhí)行。正確的寫法是采用for循環(huán)。

async function dbFuc(db) {
  let docs = [{}, {}, {}];

  for (let doc of docs) {
    await db.post(doc);
  }
}

如果確實(shí)希望多個請求并發(fā)執(zhí)行,可以使用Promise.all方法。

async function dbFuc(db) {
  let docs = [{}, {}, {}];
  let promises = docs.map((doc) => db.post(doc));

  let results = await Promise.all(promises);
  console.log(results);
}

// 或者使用下面的寫法

async function dbFuc(db) {
  let docs = [{}, {}, {}];
  let promises = docs.map((doc) => db.post(doc));

  let results = [];
  for (let promise of promises) {
    results.push(await promise);
  }
  console.log(results);
}

ES6將await增加為保留字。使用這個詞作為標(biāo)識符,在ES5是合法的,在ES6將拋出SyntaxError。

與Promise、Generator的比較

我們通過一個例子,來看Async函數(shù)與Promise、Generator函數(shù)的區(qū)別。

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

首先是Promise的寫法。

function chainAnimationsPromise(elem, animations) {

  // 變量ret用來保存上一個動畫的返回值
  var ret = null;

  // 新建一個空的Promise
  var p = Promise.resolve();

  // 使用then方法,添加所有動畫
  for(var anim of animations) {
    p = p.then(function(val) {
      ret = val;
      return anim(elem);
    });
  }

  // 返回一個部署了錯誤捕捉機(jī)制的Promise
  return p.catch(function(e) {
    /* 忽略錯誤,繼續(xù)執(zhí)行 */
  }).then(function() {
    return ret;
  });

}

雖然Promise的寫法比回調(diào)函數(shù)的寫法大大改進(jìn),但是一眼看上去,代碼完全都是Promise的API(then、catch等等),操作本身的語義反而不容易看出來。

接著是Generator函數(shù)的寫法。

function chainAnimationsGenerator(elem, animations) {

  return spawn(function*() {
    var ret = null;
    try {
      for(var anim of animations) {
        ret = yield anim(elem);
      }
    } catch(e) {
      /* 忽略錯誤,繼續(xù)執(zhí)行 */
    }
    return ret;
  });

}

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

最后是Async函數(shù)的寫法。

async function chainAnimationsAsync(elem, animations) {
  var ret = null;
  try {
    for(var anim of animations) {
      ret = await anim(elem);
    }
  } catch(e) {
    /* 忽略錯誤,繼續(xù)執(zhí)行 */
  }
  return ret;
}

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

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號