async 函数

前面的话

ES2017标准引入了async函数，使得异步操作变得更加方便。这篇文章将介绍async函数

好书：ES6入门标准

初识

什么是async函数？简单来说，它就是Generator函数的语法糖。

使用Generator函数，依次读取两个文件：

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

改写成async函数的形式：

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

在形式上：async函数就是将Generator函数的星号（*）替换为async，将yield替换为await，仅此而已。

async函数对Generator函数的改进体现在一下4点：

• 内置执行器

  Generator函数的执行必须靠执行器，所以才有了co模块，而async函数自带执行器。也就是说，async函数的执行与普通函数一模一样只要一行

  var result = asyncReadFile();
  

上面的代码调用asyncReadFile函数，然后就会自动执行，输出最终结果。不需要像Generator函数需要next方法或者使用co模块才能真正执行并得到最终结果。

• 更好的语义

  async和await比起星号和yield，语义更清楚了。async表示函数里有异步操作，await表示紧跟在后面的表达式需要等待结果。

• 更广的适用性

  co模块约定，yield命令后面只能Thunk函数或者Promise对象，而async函数的await命令后面，可以是Promise对象和原始类型的值（数值、字符串和布尔值）, 但是这时等同于同步操作。

• 返回值是Promise

  async函数的返回值是Promise对象，这比Generator函数的返回值是Iterator对象方便许多。可以使用then方法指定下一步的操作。

进一步说，async函数完全可以看作由多个异步操作包装成的一个Promise对象，而await命令就是内部then命令的语法糖

基本用法

async函数返回一个Promise对象，可以使用then方法添加回调函数。当函数执行时，一旦遇到await就先返回，等到异步从操作完成，再接着执行函数体内后面的语句。

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

这段代码是一个获取股票报价的函数，函数前面的async关键字表明该函数内部有异步操作。调用该函数会立即返回一个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', 2000);

上面的代码指定2s以后输出hello world

由于async函数返回的是Promise对象，可以作为await命令的参数。所以，上面的例子也可以写成下面的形式

async function timeout(ms) {
    await new Promise( (resolve) => {
        setTimeout(resolve, ms);
    });   
}
async function asyncPrint(value, ms) {
    await timeout(ms);
    console.log(value);
}
asyncPrint('hello world', 2000);

[async函数的多种使用形式]

    // 函数声明
    async function foo() {}
    // 函数表达式
    const foo = async function () {};
    // 对象的方法
    let obj = {
        async foo() {},
        async boo() {}
    }
    obj.foo().then();
    // Class的方法
    class Storage {
        constructor() {
            this.cachePromise = caches.open('avatars');
        }
        async getAvater(name) {
            const cache = await this.cachePromis;
            return cache.match(`/avatars/${name}.jpg`);
        }
    }
    const storage = new Storage();
    storage.getAvater('jake').then();
   // 箭头函数
   const foo = async () => {};

语法

[返回Promise对象]

async函数返回一个Promise对象。

async函数内部return语句返回的值，会成为该函数调用then方法中回调函数的参数。

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

上面的代码中，函数f内部return命令返回值会被then方法回调函数接受。

async函数内部抛出错误会导致返回的Promise对象变为reject状态。抛出的错误对象会被catch方法的回调函数接受

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

foo()返回的Promise对象为reject状态，所以执行第二个参数

[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 2018 Language Specification"

上面的代码中，函数getTitle内部有3个操作：抓取网页，取出文本，匹配页面标题。只有这三个操作全部完成，才会执行then方法里面的console.log

[await命令]

正常情况下，await命令后面是一个Promise对象。如果不是，会被转成一个立即resolve的Promise对象

async function fn() {
    return await 123;
}
fn().then(v => console.log(v));
// 123

await命令的参数是数值123，它被转成Promise对象并立即resolve。

await命令后面的Promise对象如果变成reject状态，则reject的参数会被catch方法的回调函数接收到。

async function boo() {
    await Promise.reject('出错了');
}
boo().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方法的回调函数被调用，它的参数是抛出来的错误对象。

防止出错的方法也是将其放在try…catch代码中

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

如果有多个await命令，则可以统一放在try…catch结构中

async function main() {
    try {
        var val1= await firstStep();
        var val2 = await secondStep(val1);
        var val3 = await thirdStep(val1, val2); 
        console.log('Final:', val3);
    } catch (error) {
        console.log(error)
    }
}

下面的例子使用try…catch结构，实现多次重复尝试

const superagent = require('superagent');
const NUM_RETRIES = 3;
async function test() {
    let i;
    for(i = 0; i < NUM_RETRIES; ++i) {
        try{
            await superagent.get('http:// google.com/this-throw-an-error');
            break;
        }catch (err){

        }
        console.log(i); 
    }
}
test();

上面的代码，如果await操作成功，则会使用break语句退出循环；如果失败，则会被catch语句捕捉，然后进入下一轮循环

[注意事项]

• await命令后面的Promise对象的运行结果可能是rejected，所以最好把await命令放在try…catch代码块中。

async function fn () {
    try {
        await something()
    } catch (error) {
        
    }
}
// 另一种写法
async function fn() {
    await something()
    .catch(e => console.log(e))
}

• 如果，多个await命令后面的异步操作如果不存在继发关系，最好让它们同时触发

  let foo = await getFoo();
  let boo = await getBoo();
  

上面的代码中，getFoo和getBoo是两个独立的异步操作被写成继发关系，这样比较耗时，因为只有getFoo完成之后才会执行getBoo，完全可以让它们同时触发

    // 写法一
    let [foo, boo] = await Promise.all([getFoo, getBoo]);

    // 写法二
    let fooPromise = getFoo();
    let booPromise = getBoo();
    let foo = await fooPromise;
    let boo = await booPromise;

这两种写法都是同时触发，这样会缩短程序的执行时间

• await命令只能用在async函数之中，如果用在普通函数中就会报错。

async function dbFun(db) {
        let docs = [{}, {}, {}];
        // 报错
        docs.forEach(function (doc) {
            await db.post(doc);
        });
    }

上面的函数会报错，因为await用在了普通函数中。

async函数的实现原理

async函数的实现原理是将Generator函数和自动执行器包装在一个函数里。

        async function fn (args) {
            // ...
        }
        // 等同于

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

所有的async函数都可以写成上面第二种形式，其中的spawn函数就是自定执行器

下面是spawn函数的实现:

    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.fone) {
                    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函数与Promise、Generator函数的比较。

假定某个DOM元素上面，部署了一系列的动画，前一个动画结束，才能开始后一个。如果当中有一个动画出错，就不在继续执行，而返回上一个成功执行的动画的返回值。

[promise]

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);
        });
    }
    // 返回一个部署了错误捕捉机制的Promise对象
    return p.catch(function (e) {
        // 忽略错误，继续执行
    }).then(function () {
        return ret;
    });
}

虽然Promise的写法相比回调函数的写法大大改进，但是一眼看上去，代码完全是Promise的API(then 、 catch等),操作本身的语义反而不容易看出来

[Generator]
Generator的写法

function chainAnimationsGenerator(elem, animations) {
    return spawn (function *() {
        var ret  = null;
        try {
            for(var anim of animations) {
                ret = yield anim(elem);
            }
        }catch(e) {

        }
        return ret;

    });
}

上面的代码使用Generator函数遍历了每一个动画，语义比Promise写法更清晰，用户定义的操作全部都出现在spawn函数的内部。

写法的问题在于，必须有一个任务运行器自动执行Generator函数，spawn函数就是自动执行器，它返回一个Promise对象，而且必须保证yield语句后面的表达式返回的是一个Promise对象

[async]
async函数的写法：

async function chainAnimationsAsync(elem, animations) {
    var ret  = null;
    try {
        for(var anim of animations) {
            ret = await anim(elem);
        }
    } catch (error) {
        
    }
    return ret;
}

async函数的实现最简洁，最符合语义，几乎没有与语义不相关的代码。它将Generator写法中的自动执行器改在语言层提供，不暴露给 用户，因此代码量最少。

实例

实际开发中经常遇到一组异步操作，需要按照顺序完成。比如，依次远程读取一组URL。然后按照读取的顺序输出结果：

Promise 的写法：

function logInOrder(urls) {
    // 远程读取所有的URL
    const textPromises = urls.map(url => {
        return fetch(url).then(response => response.text());
    });
    // 按次序输出
    textPromises.reduce((chain, textPromise)=> {
        return chain.then(()=>textPromise)
        .then(text => console.log(text));
    }, Promise.resolve());
}

上面的代码使用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，这样做效率太低，非常浪费时间。我们需要的是同时发出远程请求。

async function logInOrder(urls) {
    // 并发读取远程URL
    const textPromises = urls.map(async url =>{
        const response = await fetch(url);
        return response.text();
    });
    // 按次序输出
    for(const textPromise of textPromises) {
        console.log(await textPromise)
    }
}

上面的代码中，虽然map方法的参数是async函数，但是它是并发执行的，因为只有async函数内部是继发执行，外部不受影响后面的for…of循环内部使用await，因此实现了按顺序输出。