利用generator组织异步流程

generator 概述

generator 是 ES6 中 协程 的实现，用 * 标识的 generator 函数 是其核心，generator 函数 中可以容纳多个流程：

function returnTwoAsync() {
    setTimeout(0, function() {
        return 2;
    });
}

function returnThreeAsync() {
    setTimeout(0, function() {
        it.next(3);
    });
}

function *gen() {
    console.log('Begin.....');
    yield 1;
    yield returnTwoAsync();
    yield returnThreeAsync();
}

const it = gen(); // 'Beign....'
it.next(); // {data:1, done:false}
it.next(); // {data:undefined, done:false}
it.next(); // {data:3, done:false}
it.next(); // {data:undefined, done:true}

调用 generator 函数，将返回一个 迭代器（iterator）对象，迭代器对象具有 next() 和 throw() 方法。每次调用 next()，就能将 generator 由暂停态变为执行态，并将返回一个执行信息对象，该对象包含了当前阶段的运行结果 value，以及标识了 generator 是否运行完毕的 done：

{value: xxx, done: false}

当 generator 运行到 yield 关键字时，generator 就会进入暂态。如果在调用 next 方法时传递了参数 next(param)，则能将 param 传回 generator 流程，这在调用异步过程时非常有用，如上面代码片中的 returnTwoAsync、returnThreeAsync 所示。

利用 generator 组织异步流程

假设一个业务流程中穿插了多个异步过程，除了进行传统的回调解决策略，也可借助于 generator 进行解决，但需要做如下改造：

• 通过 generator 函数来组织业务流程，可以通过 yield 来等待异步流程执行完毕，通过 try-catch 进行错误处理：

function* gen() {
    try {
        let data1 = yield callback1();
        catch (e) { console.error(e); }
        let data2 = yield callback2();
    }
}

// 调用generator函数，获得操纵generator执行过程的迭代器对象 const it = gen(); // 首次调用`next`方法，驱动generator开始执行 it.next()

• 改造异步方法：

• 遇到错误通过迭代器对象的 throw(error) 方法抛出错误，使得外部能够通过 try-catch 进行错误处理。

• 如果没有发生错误，则可以继续业务流程，并利用传递参数的 next() 方法告知 generator 运行结果，并继续 generator 函数的执行。

function callback(err, data) {
    if(err) {
        // 抛出错误
        it.throw(err);
    } else {
        it.next(data);
    }
}

综上，利用 generator，上一节的文件大小统计代码就可以这样撰写：

const fs = require('fs');

// 改造size方法
function size(filename) {
    fs.stat(filename, function(err, stat) {
        if(err) it.throw(err);
        else it.next(stat.size);
    });
}

function *main() {
    const sizeInfo = {
        'file1': 0,
        'file2': 0,
        'file3': 0
    };
    try {
        sizeInfo['file1'] = yield size('file1.md');
        sizeInfo['file2'] = yield size('file2.md');
        sizeInfo['file3'] = yield size('file3.md');
    } catch(e) {
        console.error(e);
    }
    console.log(sizeInfo);
}

const it = main();
// 驱动iterator运行
it.next();

可以看到，借助于 generator，我们可以用传统的阻塞式的、同步式的代码来撰写业务逻辑，也可以通过 try-catch 进行错误处理，但是，需要进行一定程度侵入式的改造，假设原有 100 个异步函数，我们就需要改造这 100 个函数，并且还担心这样的改造影响到原有的业务流程，因此，我们还需要进一步的处理，首先，我们会考虑创建一个运行器，来驱动我们的 generator 运行。