ES6 系列之 Generator 的自動執行

原創 冴羽 2018-10-18 21:54

單個異步任務

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

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

爲了獲得最終的執行結果，你需要這樣做：

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

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

首先執行 Generator 函數，獲取遍歷器對象。

然後使用 next 方法，執行異步任務的第一階段，即 fetch(url)。

注意，由於 fetch(url) 會返回一個 Promise 對象，所以 result 的值爲：

{ value: Promise { <pending> }, done: false }

最後我們爲這個 Promise 對象添加一個 then 方法，先將其返回的數據格式化(data.json())，再調用 g.next，將獲得的數據傳進去，由此可以執行異步任務的第二階段，代碼執行完畢。

多個異步任務

上節我們只調用了一個接口，那如果我們調用了多個接口，使用了多個 yield，我們豈不是要在 then 函數中不斷的嵌套下去……

所以我們來看看執行多個異步任務的情況：

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

function* gen() {
    var r1 = yield fetch('https://api.github.com/users/github');
    var r2 = yield fetch('https://api.github.com/users/github/followers');
    var r3 = yield fetch('https://api.github.com/users/github/repos');

    console.log([r1.bio, r2[0].login, r3[0].full_name].join('\n'));
}

爲了獲得最終的執行結果，你可能要寫成：

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

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

但我知道你肯定不想寫成這樣……

其實，利用遞歸，我們可以這樣寫：

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

    function next(data) {
        var result = g.next(data);

        if (result.done) return;

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

    }

    next();
}

run(gen);

其中的關鍵就是 yield 的時候返回一個 Promise 對象，給這個 Promise 對象添加 then 方法，當異步操作成功時執行 then 中的 onFullfilled 函數，onFullfilled 函數中又去執行 g.next，從而讓 Generator 繼續執行，然後再返回一個 Promise，再在成功時執行 g.next，然後再返回……

啓動器函數

在 run 這個啓動器函數中，我們在 then 函數中將數據格式化 data.json()，但在更廣泛的情況下，比如 yield 直接跟一個 Promise，而非一個 fetch 函數返回的 Promise，因爲沒有 json 方法，代碼就會報錯。所以爲了更具備通用性，連同這個例子和啓動器，我們修改爲：

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

function* gen() {
    var r1 = yield fetch('https://api.github.com/users/github');
    var json1 = yield r1.json();
    var r2 = yield fetch('https://api.github.com/users/github/followers');
    var json2 = yield r2.json();
    var r3 = yield fetch('https://api.github.com/users/github/repos');
    var json3 = yield r3.json();

    console.log([json1.bio, json2[0].login, json3[0].full_name].join('\n'));
}

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

    function next(data) {
        var result = g.next(data);

        if (result.done) return;

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

    }

    next();
}

run(gen);

只要 yield 後跟着一個 Promise 對象，我們就可以利用這個 run 函數將 Generator 函數自動執行。

回調函數

yield 後一定要跟着一個 Promise 對象才能保證 Generator 的自動執行嗎？如果只是一個回調函數呢？我們來看個例子：

首先我們來模擬一個普通的異步請求：

function fetchData(url, cb) {
    setTimeout(function(){
        cb({status: 200, data: url})
    }, 1000)
}

我們將這種函數改造成：

function fetchData(url) {
    return function(cb){
        setTimeout(function(){
            cb({status: 200, data: url})
        }, 1000)
    }
}

對於這樣的 Generator 函數：

function* gen() {
    var r1 = yield fetchData('https://api.github.com/users/github');
    var r2 = yield fetchData('https://api.github.com/users/github/followers');

    console.log([r1.data, r2.data].join('\n'));
}

如果要獲得最終的結果：

var g = gen();

var r1 = g.next();

r1.value(function(data) {
    var r2 = g.next(data);
    r2.value(function(data) {
        g.next(data);
    });
});

如果寫成這樣的話，我們會面臨跟第一節同樣的問題，那就是當使用多個 yield 時，代碼會循環嵌套起來……

同樣利用遞歸，所以我們可以將其改造爲：

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

    function next(data) {
        var result = g.next(data);

        if (result.done) return;

        result.value(next);
    }

    next();
}

run(gen);

run

由此可以看到 Generator 函數的自動執行需要一種機制，即當異步操作有了結果，能夠自動交回執行權。

而兩種方法可以做到這一點。

（1）回調函數。將異步操作進行包裝，暴露出回調函數，在回調函數裏面交回執行權。

（2）Promise 對象。將異步操作包裝成 Promise 對象，用 then 方法交回執行權。

在兩種方法中，我們各寫了一個 run 啓動器函數，那我們能不能將這兩種方式結合在一些，寫一個通用的 run 函數呢？我們嘗試一下：

// 第一版
function run(gen) {
    var gen = gen();

    function next(data) {
        var result = gen.next(data);
        if (result.done) return;

        if (isPromise(result.value)) {
            result.value.then(function(data) {
                next(data);
            });
        } else {
            result.value(next)
        }
    }

    next()
}

function isPromise(obj) {
    return 'function' == typeof obj.then;
}

module.exports = run;

其實實現的很簡單，判斷 result.value 是否是 Promise，是就添加 then 函數，不是就直接執行。

return Promise

我們已經寫了一個不錯的啓動器函數，支持 yield 後跟回調函數或者 Promise 對象。

現在有一個問題需要思考，就是我們如何獲得 Generator 函數的返回值呢？又如果 Generator 函數中出現了錯誤，就比如 fetch 了一個不存在的接口，這個錯誤該如何捕獲呢？

這很容易讓人想到 Promise，如果這個啓動器函數返回一個 Promise，我們就可以給這個 Promise 對象添加 then 函數，當所有的異步操作執行成功後，我們執行 onFullfilled 函數，如果有任何失敗，就執行 onRejected 函數。

我們寫一版：

// 第二版
function run(gen) {
    var gen = gen();

    return new Promise(function(resolve, reject) {

        function next(data) {
            try {
                var result = gen.next(data);
            } catch (e) {
                return reject(e);
            }

            if (result.done) {
                return resolve(result.value)
            };

            var value = toPromise(result.value);

            value.then(function(data) {
                next(data);
            }, function(e) {
                reject(e)
            });
        }

        next()
    })

}

function isPromise(obj) {
    return 'function' == typeof obj.then;
}

function toPromise(obj) {
    if (isPromise(obj)) return obj;
    if ('function' == typeof obj) return thunkToPromise(obj);
    return obj;
}

function thunkToPromise(fn) {
    return new Promise(function(resolve, reject) {
        fn(function(err, res) {
            if (err) return reject(err);
            resolve(res);
        });
    });
}

module.exports = run;

與第一版有很大的不同：

首先，我們返回了一個 Promise，當 result.done 爲 true 的時候，我們將該值 resolve(result.value)，如果執行的過程中出現錯誤，被 catch 住，我們會將原因 reject(e)。

其次，我們會使用 thunkToPromise 將回調函數包裝成一個 Promise，然後統一的添加 then 函數。在這裏值得注意的是，在 thunkToPromise 函數中，我們遵循了 error first 的原則，這意味着當我們處理回調函數的情況時：

// 模擬數據請求
function fetchData(url) {
    return function(cb) {
        setTimeout(function() {
            cb(null, { status: 200, data: url })
        }, 1000)
    }
}

在成功時，第一個參數應該返回 null，表示沒有錯誤原因。

優化

我們在第二版的基礎上將代碼寫的更加簡潔優雅一點，最終的代碼如下：

// 第三版
function run(gen) {

    return new Promise(function(resolve, reject) {
        if (typeof gen == 'function') gen = gen();

        // 如果 gen 不是一個迭代器
        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);
        }

        function onRejected(err) {
            var ret;
            try {
                ret = gen.throw(err);
            } catch (e) {
                return reject(e);
            }
            next(ret);
        }

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

function isPromise(obj) {
    return 'function' == typeof obj.then;
}

function toPromise(obj) {
    if (isPromise(obj)) return obj;
    if ('function' == typeof obj) return thunkToPromise(obj);
    return obj;
}

function thunkToPromise(fn) {
    return new Promise(function(resolve, reject) {
        fn(function(err, res) {
            if (err) return reject(err);
            resolve(res);
        });
    });
}

module.exports = run;

co

如果我們再將這個啓動器函數寫的完善一些，我們就相當於寫了一個 co，實際上，上面的代碼確實是來自於 co……

而 co 是什麼？ co 是大神 TJ Holowaychuk 於 2013 年 6 月發佈的一個小模塊，用於 Generator 函數的自動執行。

如果直接使用 co 模塊，這兩種不同的例子可以簡寫爲：

// yield 後是一個 Promise
var fetch = require('node-fetch');
var co = require('co');

function* gen() {
    var r1 = yield fetch('https://api.github.com/users/github');
    var json1 = yield r1.json();
    var r2 = yield fetch('https://api.github.com/users/github/followers');
    var json2 = yield r2.json();
    var r3 = yield fetch('https://api.github.com/users/github/repos');
    var json3 = yield r3.json();

    console.log([json1.bio, json2[0].login, json3[0].full_name].join('\n'));
}

co(gen);
// yield 後是一個回調函數
var co = require('co');

function fetchData(url) {
    return function(cb) {
        setTimeout(function() {
            cb(null, { status: 200, data: url })
        }, 1000)
    }
}

function* gen() {
    var r1 = yield fetchData('https://api.github.com/users/github');
    var r2 = yield fetchData('https://api.github.com/users/github/followers');

    console.log([r1.data, r2.data].join('\n'));
}

co(gen);

是不是特別的好用？

ES6 系列

ES6 系列目錄地址：https://github.com/mqyqingfeng/Blog

ES6 系列預計寫二十篇左右，旨在加深 ES6 部分知識點的理解，重點講解塊級作用域、標籤模板、箭頭函數、Symbol、Set、Map 以及 Promise 的模擬實現、模塊加載方案、異步處理等內容。

如果有錯誤或者不嚴謹的地方，請務必給予指正，十分感謝。如果喜歡或者有所啓發，歡迎 star，對作者也是一種鼓勵。

發表評論
所有評論
還沒有人評論，想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章

JS module的導出和導入

KevinYan 2019-02-24 21:34:55

《劍指offer》分解讓複雜問題更簡單

ConardLi 2019-02-24 22:55:07

前端全链路性能优化实战

wy53780 2020-04-23 14:01:33

抓紧面试前的宝贵时间 快速搞定前端JavaScript面试

wy53780 2020-04-23 13:56:33

編寫自適應高度的 textarea

CarterLi 2019-02-25 00:14:46

node遇上c++ --- 愛情來的太快(一) (沒有文章)

sewerganger 2019-02-24 22:55:07

進擊webpack4 （基礎篇二：配置）

槐破夢 2019-02-24 22:55:07

ggit (git gui) --- 開發記錄 (一)

sewerganger 2019-02-24 22:45:04

搞搞, 超星爾雅；

sewerganger 2019-02-24 22:44:54

近期前端發展計劃

Ashleysweetie 2019-02-24 22:32:41

「前端面試題系列7」Javascript 中的事件機制（從原生到框架）

micherwa 2019-02-24 19:55:05

跨域的四種方式

上帝遺忘之子 2019-02-24 19:14:58

JS面試題之比較兩個對象是否相等？

幸福村的碼農 2019-02-24 17:35:07

JavaScript：函數防抖與函數節流

沉靜地閃光 2019-02-24 17:35:07

超級詳細的手寫webpack4配置來啓動vue2項目（附配置作用）

Sotyoyo 2019-02-24 16:44:37