Generator 函數
Generator函數跟普通函數的寫法有非常大的區別:
一是,function關鍵字與函數名之間有一個星號;
二是,函數體內部使用yield語句,定義不同的內部狀態(yield在英語里的意思就是「產出」)。
function* g() { yield 'a'; yield 'b'; yield 'c'; return 'ending'; } g(); // 返回一個對象(迭代器對象) console.log(g()) //需要打印出來才能看得出來是什麼
g函數呢,有四個階段,分別是’a’,’b’,’c’,’ending’。
Generator 函數神奇之一:g()並不執行g函數
g()
並不會執行g函數,返回的也不是函數運行結果,而是一個指向內部狀態的指針對象,也就是迭代器對象(Iterator Object)。
Generator 函數神奇之二:分段執行
先看如下代碼:
function* g() { yield 'a'; yield 'b'; yield 'c'; return 'ending'; } var gen = g(); gen.next(); // 返回Object {value: "a", done: false}
gen.next()
返回一個非常非常簡單的對象{value: "a", done: false}
,’a’就是g函數執行到第一個yield語句之後得到的值,false表示g函數還沒有執行完,只是在這暫停。如果再寫一行代碼,還是gen.next();
,這時候返回的就是{value: "b", done: false}
,說明g函數運行到了第二個yield語句,返回的是該yield語句的返回值’b’。返回之後依然是暫停。
再寫一行gen.next();
返回{value: "c", done: false}
,再寫一行gen.next();
,返回{value: "ending", done: true}
,這樣,整個g函數就運行完畢了。
注意:
1、就算再寫一行gen.next(),會返回{value: undefined, done: true}
,這樣沒意義。
2、如果沒有go函數沒有return,第三次.next()
之後就返回{value: undefined, done: true}
,這個第三次的next()
唯一意義就是證明g函數全部執行完了。
3、如果go函書return還帶有yied,白寫,是不會有反應的
4、如果g函數沒有yield和return語句,第一次調用next就返回{value: undefined, done: true}
,之後也是{value: undefined, done: true}
5、如果只有return語句,第一次調用就返回{value: xxx, done: true}
,其中xxx
是return語句的返回值。之後永遠是{value: undefined, done: true}
提問:下面代碼會有什麼結果?
function* g() { var o = 1; yield o++; yield o++; yield o++; } var gen = g(); console.log(gen.next()); // 1 var xxx = g(); console.log(gen.next()); // 2 console.log(xxx.next()); // 1 console.log(gen.next()); // 3
見上面注釋。每個迭代器之間互不干擾,作用域獨立。
注意:
yield o++;
改成yield的話,返回{value: undefined, done: false}
yield o++;
改成o++;yield,和上面返回的一樣,白搭,只有寫在yield後面才有值返回
所以現在可以看出,每次調用next方法,內部指針就從函數頭部或上一次停下來的地方開始執行,直到遇到下一個yield語句(或return語句)為止。換言之,Generator函數是分段執行的,yield語句是暫停執行的標記,而next方法可以恢復執行。
總之,每調用一次Generator函數,就返回一個迭代器對象,代表Generator函數的內部指針。以後,每次調用迭代器對象的next方法,就會返回一個有着value和done兩個屬性的對象。value屬性表示當前的內部狀態的值,是yield語句後面那個表達式的值;done屬性是一個布爾值,表示是否遍歷結束。
所以可以看出,Generator 函數的特點就是:
1、分段執行,可以暫停
2、可以控制階段和每個階段的返回值
3、可以知道是否執行到結尾
yield語句
迭代器對象的next方法的運行邏輯如下。
(1)遇到yield語句,就暫停執行後面的操作,並將緊跟在yield後面的那個表達式的值,作為返回的對象的value屬性值。
(2)下一次調用next方法時,再繼續往下執行,直到遇到下一個yield語句。
(3)如果沒有再遇到新的yield語句,就一直運行到函數結束,直到return語句為止,並將return語句後面的表達式的值,作為返回的對象的value屬性值。
(4)如果該函數沒有return語句,則返回的對象的value屬性值為undefined。
yield語句與return語句既有相似之處,也有區別。
相似之處在於,都能返回緊跟在語句後面的那個表達式的值。
區別在於每次遇到yield,函數暫停執行,下一次再從該位置繼續向後執行,而return語句不具備位置記憶的功能。一個函數裏面,只能執行一次(或者說一個)return語句,但是可以執行多次(或者說多個)yield語句。正常函數只能返回一個值,因為只能執行一次return;Generator函數可以返回一系列的值,因為可以有任意多個yield。從另一個角度看,也可以說Generator生成了一系列的值,這也就是它的名稱的來歷(在英語中,generator這個詞是「生成器」的意思)。
注意:yield語句只能用於function*
的作用域,如果function*
的內部還定義了其他的普通函數,則函數內部不允許使用yield語句。
注意:yield語句如果參與運算,必須用括號括起來。
console.log(3 + yield 4); // 語法錯誤 console.log(3 + (yield 4)); // 打印7
next方法可以有參數
一句話說,next方法參數的作用,是為上一個yield語句賦值。由於yield永遠返回undefined,這時候,如果有了next方法的參數,yield就被賦了值,比如下例,原本a變量的值是0,但是有了next的參數,a變量現在等於next的參數,也就是11。
next方法的參數每次覆蓋的一定是undefined。next在沒有參數的時候,函數體裏面寫let xx = yield oo;是沒意義的,因為xx一定是undefined。
function* g() { var o = 1; var a = yield o++; console.log('a = ' + a); var b = yield o++; } var gen = g(); console.log(gen.next()); console.log('------'); console.log(gen.next(11));
得到
console.log(gen.next());
的作用就是輸出了{value: 1, done: false}
,注意var a = yield o++;
,由於賦值運算是先計算等號右邊,然後賦值給左邊,所以目前階段,只運算了yield o++
,並沒有賦值。console.log(gen.next(11));
的作用,首先是執行gen.next(11)
,得到什麼?首先:把第一個yield o++
重置為11,然後,賦值給a,再然後,console.log('a = ' + a);
,打印a = 11
,繼續然後,yield o++
,得到2,最後打印出來。for…of循環
for…of循環可以自動遍歷Generator函數時生成的Iterator對象,且此時不再需要調用next方法。for…of循環的基本語法是:
for (let v of foo()) { console.log(v); }
其中foo()
是迭代器對象,可以把它賦值給變量,然後遍歷這個變量。
function* foo() { yield 1; yield 2; yield 3; yield 4; yield 5; return 6; } let a = foo(); for (let v of a) { console.log(v); } // 1 2 3 4 5
Generator.prototype.throw()
Generator函數返回的迭代器對象,都有一個throw方法,可以在函數體外拋出錯誤,然後在Generator函數體內捕獲。
既然我的文章是簡單理解Generator函數,所以錯誤捕獲直接跳過。
Generator.prototype.return()
Generator函數返回的迭代器對象,還有一個return方法,可以返回給定的值,並且終結遍歷Generator函數。
function* gen() { yield 1; yield 2; yield 3; } var g = gen(); console.log(g.next()); // { value: 1, done: false } console.log(g.return('foo')); // { value: "foo", done: true } console.log(g.next()); // {value: undefined, done: true}
就是說,return的參數值覆蓋本次yield語句的返回值,並且提前終結遍歷,即使後面還有yield語句也一律無視。
提問:return方法跟next方法的區別都有哪些?
答:
1、return終結遍歷,之後的yield語句都失效;next返回本次yield語句的返回值。
2、return沒有參數的時候,返回{ value: undefined, done: true }
;next沒有參數的時候返回本次yield語句的返回值。
3、return有參數的時候,覆蓋本次yield語句的返回值,也就是說,返回{ value: 參數, done: true }
;next有參數的時候,覆蓋上次yield語句的返回值,返回值可能跟參數有關(參數參與計算的話),也可能跟參數無關(參數不參與計算)。
yield*語句
如果你打算在Generater函數內部,調用另一個Generator函數,默認情況下是沒有效果的。比如:
function* foo() { yield 'a'; yield 'b'; } function* bar() { yield 'x'; foo(); yield 'y'; } for (let v of bar()){ console.log(v); } // "x" // "y"
可見,並沒有遍歷出’a’和’b’。那麼如果想在一個Generator函數里調用另一個Generator函數,怎麼辦?用yield*語句。比如:
function* bar() { yield 'x'; yield* foo(); yield 'y'; } // 上個函數等同於 function* bar() { yield 'x'; yield 'a'; yield 'b'; yield 'y'; } // 也等同於 function* bar() { yield 'x'; for (let v of foo()) { yield v; } yield 'y'; } for (let v of bar()){ console.log(v); } // "x" // "a" // "b" // "y"
yield*
語句的作用,就是遍歷一遍A函數的迭代器對象。A函數(沒有return語句時)是for…of的一種簡寫形式,完全可以用for…of替代yield*
。反之,由於B函數的return語句,不會被yield*
遍歷,所以需要用var value = yield* iterator
的形式獲取return語句的值。function *foo() { yield 2; yield 3; return "foo"; } function *bar() { yield 1; var v = yield *foo(); console.log( "v: " + v ); yield 4; } var it = bar(); it.next() // {value: 1, done: false} it.next() // {value: 2, done: false} it.next() // {value: 3, done: false} it.next(); // "v: foo" // {value: 4, done: false} it.next() // {value: undefined, done: true}
上面代碼在第四次調用next方法的時候,屏幕上會有輸出,這是因為函數foo的return語句,向函數bar提供了返回值。
如果yield*語句後面跟着一個數組
function* gen(){ yield* ["a", "b", "c"]; } gen().next() // { value:"a", done:false }
這說明,任何數據結構只要有Iterator接口,就可以被yield*遍歷。數組有這個接口。
異步操作的同步化寫法
舉個例子,比如我在測試服務器的某目錄建了4個文件,分別是’test.html’、’a.html’、’b.html’、’c.html’,後三個文件的文件內容跟文件名相同,現在我編輯’test.html’的代碼,想要先ajax-get相對網址’a.html’,然後再回調里ajax-get相對網址’b.html’,然後在回調里ajax-get相對網址’c.html’,常規的寫法是(用上jQuery):
$.get('a.html',function(dataa) { console.log(dataa); $.get('b.html',function(datab) { console.log(datab); $.get('c.html',function(datac) { console.log(datac); }); }); }); // a.html // b.html // c.html
怎樣最快最簡單地寫出採用 Generator 函數的同步形式的代碼?
第1步:將所有異步代碼的每一步都封裝成一個普通的、可以有參數的函數,比如上面的request函數。你可能問,上面例子為啥三個異步代碼卻只定義了一個request函數?因為request函數能復用的嘛。如果不能復用的話,請老老實實定義三個普通函數,函數內容就是需要執行的異步代碼。
第2步:定義一個生成器函數,把流程寫進去,完全的同步代碼的寫法。生成器函數可以有參數。
第三步:定義一個變量,賦值為迭代器對象。迭代器對象可以加參數,參數通常將作為流程所需的初始值。
第四步:變量名.next()。不要給這個next()傳參數,傳了也沒用,因為它找不到上一個yield語句。
上面的例子是最簡單舉例,沒有涉及到下一步借用上一步的執行結果的情況,如果想讓下一步借用上一步的執行結果的話,其實也簡單,比如,我想把a.html的響應內容當做參數,發給b.html,把b.html的響應內容當做參數,發給c.html,也很簡單,不多說。
new Promise(function(resolve) { $.get('a.html',function(dataa) { console.log(dataa); resolve(); }); }).then(function(resolve) { return new Promise(function(resolve) { $.get('b.html',function(datab) { console.log(datab); resolve(); }); }); }).then(function(resolve) { $.get('c.html',function(datac) { console.log(datac); }); });
Promise的寫法的優點就是理解起來很簡單,每一步中間用then一連就OK。
Promise的寫法的缺點就是各種promise實例對象跟一連串的then,代碼量大、行數多,滿眼的promise、then、resolve看得頭暈,而且每一個then都是一個獨立的作用域,傳遞參數痛苦。
再舉一例,我想在上述每一步異步中間,都間隔3秒。怎麼寫?
function request(url) { $.get(url, function(response){ it.next(response); }); } function sleep(time) { setTimeout(function() { console.log('I\'m awake.'); it.next(); }, time); } function* ajaxs(ur) { console.log(yield request(ur)); yield sleep(3000); console.log(yield request('b.html')); yield sleep(3000); console.log(yield request('c.html')); } var it = ajaxs('a.html'); it.next();