本文转自:阮一峰老师的ECMAScript 6 入门,有时间能够看下评论!javascript
Generator函数是ES6提供的一种异步编程解决方案,语法行为与传统函数彻底不一样。本章详细介绍Generator函数的语法和API,它的异步编程应用请看《异步操做》一章。java
Generator函数有多种理解角度。从语法上,首先能够把它理解成,Generator函数是一个状态机,封装了多个内部状态。node
执行Generator函数会返回一个遍历器对象,也就是说,Generator函数除了状态机,仍是一个遍历器对象生成函数。返回的遍历器对象,能够依次遍历Generator函数内部的每个状态。es6
形式上,Generator函数是一个普通函数,可是有两个特征。一是,function
命令与函数名之间有一个星号;二是,函数体内部使用yield
语句,定义不一样的内部状态(yield语句在英语里的意思就是“产出”)。算法
function* helloWorldGenerator() {
yield 'hello';
yield 'world';
return 'ending';
}
var hw = helloWorldGenerator();
上面代码定义了一个Generator函数helloWorldGenerator
,它内部有两个yield
语句“hello”和“world”,即该函数有三个状态:hello,world和return语句(结束执行)。编程
而后,Generator函数的调用方法与普通函数同样,也是在函数名后面加上一对圆括号。不一样的是,调用Generator函数后,该函数并不执行,返回的也不是函数运行结果,而是一个指向内部状态的指针对象,也就是上一章介绍的遍历器对象(Iterator Object)。数组
下一步,必须调用遍历器对象的next方法,使得指针移向下一个状态。也就是说,每次调用next
方法,内部指针就从函数头部或上一次停下来的地方开始执行,直到遇到下一个yield
语句(或return
语句)为止。换言之,Generator函数是分段执行的,yield
语句是暂停执行的标记,而next
方法能够恢复执行。promise
hw.next()
// { value: 'hello', done: false }
hw.next()
// { value: 'world', done: false }
hw.next()
// { value: 'ending', done: true }
hw.next()
// { value: undefined, done: true }
上面代码一共调用了四次next
方法。安全
第一次调用,Generator函数开始执行,直到遇到第一个yield
语句为止。next
方法返回一个对象,它的value
属性就是当前yield
语句的值hello,done
属性的值false,表示遍历尚未结束。markdown
第二次调用,Generator函数从上次yield
语句停下的地方,一直执行到下一个yield
语句。next
方法返回的对象的value
属性就是当前yield
语句的值world,done
属性的值false,表示遍历尚未结束。
第三次调用,Generator函数从上次yield
语句停下的地方,一直执行到return
语句(若是没有return语句,就执行到函数结束)。next
方法返回的对象的value
属性,就是紧跟在return
语句后面的表达式的值(若是没有return
语句,则value
属性的值为undefined),done
属性的值true,表示遍历已经结束。
第四次调用,此时Generator函数已经运行完毕,next
方法返回对象的value
属性为undefined,done
属性为true。之后再调用next
方法,返回的都是这个值。
总结一下,调用Generator函数,返回一个遍历器对象,表明Generator函数的内部指针。之后,每次调用遍历器对象的next
方法,就会返回一个有着value
和done
两个属性的对象。value
属性表示当前的内部状态的值,是yield
语句后面那个表达式的值;done
属性是一个布尔值,表示是否遍历结束。
因为Generator函数返回的遍历器对象,只有调用next
方法才会遍历下一个内部状态,因此其实提供了一种能够暂停执行的函数。yield
语句就是暂停标志。
遍历器对象的next
方法的运行逻辑以下。
(1)遇到yield
语句,就暂停执行后面的操做,并将紧跟在yield
后面的那个表达式的值,做为返回的对象的value
属性值。
(2)下一次调用next
方法时,再继续往下执行,直到遇到下一个yield
语句。
(3)若是没有再遇到新的yield
语句,就一直运行到函数结束,直到return
语句为止,并将return
语句后面的表达式的值,做为返回的对象的value
属性值。
(4)若是该函数没有return
语句,则返回的对象的value
属性值为undefined
。
须要注意的是,yield
语句后面的表达式,只有当调用next
方法、内部指针指向该语句时才会执行,所以等于为JavaScript提供了手动的“惰性求值”(Lazy Evaluation)的语法功能。
function* gen() {
yield 123 + 456;
}
上面代码中,yield后面的表达式123 + 456
,不会当即求值,只会在next
方法将指针移到这一句时,才会求值。
yield
语句与return
语句既有类似之处,也有区别。类似之处在于,都能返回紧跟在语句后面的那个表达式的值。区别在于每次遇到yield
,函数暂停执行,下一次再从该位置继续向后执行,而return
语句不具有位置记忆的功能。一个函数里面,只能执行一次(或者说一个)return
语句,可是能够执行屡次(或者说多个)yield
语句。正常函数只能返回一个值,由于只能执行一次return
;Generator函数能够返回一系列的值,由于能够有任意多个yield
。从另外一个角度看,也能够说Generator生成了一系列的值,这也就是它的名称的来历(在英语中,generator这个词是“生成器”的意思)。
Generator函数能够不用yield
语句,这时就变成了一个单纯的暂缓执行函数。
function* f() {
console.log('执行了!')
}
var generator = f();
setTimeout(function () {
generator.next()
}, 2000);
上面代码中,函数f
若是是普通函数,在为变量generator赋值时就会执行。可是,函数f
是一个Generator函数,就变成只有调用next
方法时,函数f
才会执行。
另外须要注意,yield语句不能用在普通函数中,不然会报错。
(function (){
yield 1;
})()
// SyntaxError: Unexpected number
上面代码在一个普通函数中使用yield
语句,结果产生一个句法错误。
下面是另一个例子。
var arr = [1, [[2, 3], 4], [5, 6]];
var flat = function* (a){
a.forEach(function(item){
if (typeof item !== 'number'){
yield* flat(item);
} else {
yield item;
}
}
};
for (var f of flat(arr)){
console.log(f);
}
上面代码也会产生句法错误,由于forEach
方法的参数是一个普通函数,可是在里面使用了yield
语句。一种修改方法是改用for
循环。
var arr = [1, [[2, 3], 4], [5, 6]];
var flat = function* (a){
var length = a.length;
for(var i =0;i<length;i++){
var item = a[i];
if (typeof item !== 'number'){
yield* flat(item);
} else {
yield item;
}
}
};
for (var f of flat(arr)){
console.log(f);
}
// 1, 2, 3, 4, 5, 6
另外,yield
语句若是用在一个表达式之中,必须放在圆括号里面。
console.log('Hello' + yield); // SyntaxError
console.log('Hello' + yield 123); // SyntaxError
console.log('Hello' + (yield)); // OK
console.log('Hello' + (yield 123)); // OK
yield
语句用做函数参数或赋值表达式的右边,能够不加括号。
foo(yield 'a', yield 'b'); // OK
let input = yield; // OK
上一章说过,任意一个对象的Symbol.iterator
方法,等于该对象的遍历器对象生成函数,调用该函数会返回该对象的一个遍历器对象。
遍历器对象自己也有Symbol.iterator
方法,执行后返回自身。
function* gen(){
// some code
}
var g = gen();
g[Symbol.iterator]() === g
// true
上面代码中,gen
是一个Generator函数,调用它会生成一个遍历器对象g
。它的Symbol.iterator
属性,也是一个遍历器对象生成函数,执行后返回它本身。
yield
句自己没有返回值,或者说老是返回undefined
。next
方法能够带一个参数,该参数就会被看成上一个yield
语句的返回值。
function* f() {
for(var i=0; true; i++) {
var reset = yield i;
if(reset) { i = -1; }
}
}
var g = f();
g.next() // { value: 0, done: false }
g.next() // { value: 1, done: false }
g.next(true) // { value: 0, done: false }
上面代码先定义了一个能够无限运行的Generator函数f
,若是next
方法没有参数,每次运行到yield
语句,变量reset
的值老是undefined
。当next
方法带一个参数true
时,当前的变量reset
就被重置为这个参数(即true
),所以i
会等于-1,下一轮循环就会从-1开始递增。
这个功能有很重要的语法意义。Generator函数从暂停状态到恢复运行,它的上下文状态(context)是不变的。经过next
方法的参数,就有办法在Generator函数开始运行以后,继续向函数体内部注入值。也就是说,能够在Generator函数运行的不一样阶段,从外部向内部注入不一样的值,从而调整函数行为。
再看一个例子。
function* foo(x) {
var y = 2 * (yield (x + 1));
var z = yield (y / 3);
return (x + y + z);
}
var a = foo(5);
a.next() // Object{value:6, done:false}
a.next() // Object{value:NaN, done:false}
a.next() // Object{value:NaN, done:false}
上面代码中,第二次运行next
方法的时候不带参数,致使y的值等于2 * undefined
(即NaN
),除以3之后仍是NaN
,所以返回对象的value
属性也等于NaN
。第三次运行Next
方法的时候不带参数,因此z
等于undefined
,返回对象的value
属性等于5 + NaN + undefined
,即NaN
。
若是向next
方法提供参数,返回结果就彻底不同了。
function* foo(x) {
var y = 2 * (yield (x + 1));
var z = yield (y / 3);
return (x + y + z);
}
var it = foo(5);
it.next()
// { value:6, done:false }
it.next(12)
// { value:8, done:false }
it.next(13)
// { value:42, done:true }
上面代码第一次调用next
方法时,返回x+1
的值6;第二次调用next
方法,将上一次yield
语句的值设为12,所以y
等于24,返回y / 3
的值8;第三次调用next
方法,将上一次yield
语句的值设为13,所以z
等于13,这时x
等于5,y
等于24,因此return
语句的值等于42。
注意,因为next
方法的参数表示上一个yield
语句的返回值,因此第一次使用next
方法时,不能带有参数。V8引擎直接忽略第一次使用next
方法时的参数,只有从第二次使用next
方法开始,参数才是有效的。
若是想要第一次调用next
方法时,就可以输入值,能够在Generator函数外面再包一层。
function wrapper(generatorFunction) {
return function (...args) {
let generatorObject = generatorFunction(...args);
generatorObject.next();
return generatorObject;
};
}
const wrapped = wrapper(function* () {
console.log(`First input: ${yield}`);
return 'DONE';
});
wrapped().next('hello!')
// First input: hello!
上面代码中,Generator函数若是不用wrapper
先包一层,是没法第一次调用next
方法,就输入参数的。
for...of
循环能够自动遍历Generator函数,且此时再也不须要调用next
方法。
function *foo() {
yield 1;
yield 2;
yield 3;
yield 4;
yield 5;
return 6;
}
for (let v of foo()) {
console.log(v);
}
// 1 2 3 4 5
上面代码使用for...of
循环,依次显示5个yield
语句的值。这里须要注意,一旦next
方法的返回对象的done
属性为true
,for...of
循环就会停止,且不包含该返回对象,因此上面代码的return
语句返回的6,不包括在for...of
循环之中。
下面是一个利用Generator函数和for...of
循环,实现斐波那契数列的例子。
function* fibonacci() {
let [prev, curr] = [0, 1];
for (;;) {
[prev, curr] = [curr, prev + curr];
yield curr;
}
}
for (let n of fibonacci()) {
if (n > 1000) break;
console.log(n);
}
从上面代码可见,使用for...of
语句时不须要使用next方法。
前面章节曾经介绍过,for...of
循环、扩展运算符(…)、解构赋值和Array.from
方法内部调用的,都是遍历器接口。这意味着,它们能够将Generator函数返回的Iterator对象,做为参数。
function* numbers () {
yield 1
yield 2
return 3
yield 4
}
[...numbers()] // [1, 2]
Array.from(numbers()) // [1, 2]
let [x, y] = numbers();
x // 1
y // 2
for (let n of numbers()) {
console.log(n)
}
// 1
// 2
利用for...of
循环,能够写出遍历任意对象的方法。原生的JavaScript对象没有遍历接口,没法使用for...of
循环,经过Generator函数为它加上这个接口,就能够用了。
function* objectEntries(obj) {
let propKeys = Reflect.ownKeys(obj);
for (let propKey of propKeys) {
yield [propKey, obj[propKey]];
}
}
let jane = { first: 'Jane', last: 'Doe' };
for (let [key,value] of objectEntries(jane)) {
console.log(`${key}: ${value}`);
}
// first: Jane
// last: Doe
Generator函数返回的遍历器对象,都有一个throw
方法,能够在函数体外抛出错误,而后在Generator函数体内捕获。
var g = function* () {
while (true) {
try {
yield;
} catch (e) {
if (e != 'a') throw e;
console.log('内部捕获', e);
}
}
};
var i = g();
i.next();
try {
i.throw('a');
i.throw('b');
} catch (e) {
console.log('外部捕获', e);
}
// 内部捕获 a
// 外部捕获 b
上面代码中,遍历器对象i
连续抛出两个错误。第一个错误被Generator函数体内的catch
语句捕获,而后Generator函数执行完成,因而第二个错误被函数体外的catch
语句捕获。
注意,不要混淆遍历器对象的throw
方法和全局的throw
命令。上面代码的错误,是用遍历器对象的throw
方法抛出的,而不是用throw
命令抛出的。后者只能被函数体外的catch
语句捕获。
var g = function* () {
while (true) {
try {
yield;
} catch (e) {
if (e != 'a') throw e;
console.log('内部捕获', e);
}
}
};
var i = g();
i.next();
try {
throw new Error('a');
throw new Error('b');
} catch (e) {
console.log('外部捕获', e);
}
// 外部捕获 [Error: a]
上面代码之因此只捕获了a
,是由于函数体外的catch语句块,捕获了抛出的a
错误之后,就不会再继续执行try语句块了。
若是Generator函数内部没有部署try…catch代码块,那么throw方法抛出的错误,将被外部try…catch代码块捕获。
var g = function* () {
while (true) {
yield;
console.log('内部捕获', e);
}
};
var i = g();
i.next();
try {
i.throw('a');
i.throw('b');
} catch (e) {
console.log('外部捕获', e);
}
// 外部捕获 a
上面代码中,遍历器函数g
内部,没有部署try…catch代码块,因此抛出的错误直接被外部catch代码块捕获。
若是Generator函数内部部署了try…catch代码块,那么遍历器的throw方法抛出的错误,不影响下一次遍历,不然遍历直接终止。
var gen = function* gen(){
yield console.log('hello');
yield console.log('world');
}
var g = gen();
g.next();
try {
g.throw();
} catch (e) {
g.next();
}
// hello
上面代码只输出hello就结束了,由于第二次调用next方法时,遍历器状态已经变成终止了。可是,若是使用throw命令抛出错误,不会影响遍历器状态。
var gen = function* gen(){
yield console.log('hello');
yield console.log('world');
}
var g = gen();
g.next();
try {
throw new Error();
} catch (e) {
g.next();
}
// hello
// world
上面代码中,throw
命令抛出的错误不会影响到遍历器的状态,因此两次执行next
方法,都取到了正确的操做。
这种函数体内捕获错误的机制,大大方便了对错误的处理。若是使用回调函数的写法,想要捕获多个错误,就不得不为每一个函数写一个错误处理语句。
foo('a', function (a) {
if (a.error) {
throw new Error(a.error);
}
foo('b', function (b) {
if (b.error) {
throw new Error(b.error);
}
foo('c', function (c) {
if (c.error) {
throw new Error(c.error);
}
console.log(a, b, c);
});
});
});
使用Generator函数能够大大简化上面的代码。
function* g(){
try {
var a = yield foo('a');
var b = yield foo('b');
var c = yield foo('c');
} catch (e) {
console.log(e);
}
console.log(a, b, c);
}
反过来,Generator函数内抛出的错误,也能够被函数体外的catch
捕获。
function *foo() {
var x = yield 3;
var y = x.toUpperCase();
yield y;
}
var it = foo();
it.next(); // { value:3, done:false }
try {
it.next(42);
} catch (err) {
console.log(err);
}
上面代码中,第二个next
方法向函数体内传入一个参数42,数值是没有toUpperCase
方法的,因此会抛出一个TypeError错误,被函数体外的catch
捕获。
一旦Generator执行过程当中抛出错误,就不会再执行下去了。若是此后还调用next方法,将返回一个value
属性等于undefined
、done
属性等于true
的对象,即JavaScript引擎认为这个Generator已经运行结束了。
function* g() {
yield 1;
console.log('throwing an exception');
throw new Error('generator broke!');
yield 2;
yield 3;
}
function log(generator) {
var v;
console.log('starting generator');
try {
v = generator.next(); // { value: undefined, done: true }
console.log('第一次运行next方法', v);
} catch (err) {
console.log('捕捉错误', v);
}
try {
v = generator.next();
console.log('第二次运行next方法', v);
} catch (err) {
console.log('捕捉错误', v);
}
try {
v = generator.next();
console.log('第三次运行next方法', v);
} catch (err) {
console.log('捕捉错误', v);
}
console.log('caller done');
}
log(g());
// starting generator
// 第一次运行next方法 { value: 1, done: false }
// throwing an exception
// 捕捉错误 { value: 1, done: false }
// 第三次运行next方法 { value: undefined, done: true }
// caller done
上面代码一共三次运行next
方法,第二次运行的时候会抛出错误,而后第三次运行的时候,Generator函数就已经结束了,再也不执行下去了。
Generator函数返回的遍历器对象,还有一个return
方法,能够返回给定的值,而且终结遍历Generator函数。
function* gen() {
yield 1;
yield 2;
yield 3;
}
var g = gen();
g.next() // { value: 1, done: false }
g.return("foo") // { value: "foo", done: true }
g.next() // { value: undefined, done: true }
上面代码中,遍历器对象g
调用return
方法后,返回值的value
属性就是return
方法的参数foo
。而且,Generator函数的遍历就终止了,返回值的done
属性为true
,之后再调用next
方法,done
属性老是返回true
。
若是return
方法调用时,不提供参数,则返回值的vaule
属性为undefined
。
function* gen() {
yield 1;
yield 2;
yield 3;
}
var g = gen();
g.next() // { value: 1, done: false }
g.return() // { value: undefined, done: true }
若是Generator函数内部有try...finally
代码块,那么return
方法会推迟到finally
代码块执行完再执行。
function* numbers () {
yield 1;
try {
yield 2;
yield 3;
} finally {
yield 4;
yield 5;
}
yield 6;
}
var g = numbers()
g.next() // { done: false, value: 1 }
g.next() // { done: false, value: 2 }
g.return(7) // { done: false, value: 4 }
g.next() // { done: false, value: 5 }
g.next() // { done: true, value: 7 }
上面代码中,调用return
方法后,就开始执行finally
代码块,而后等到finally
代码块执行完,再执行return
方法。
若是在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"
上面代码中,foo
和bar
都是Generator函数,在bar
里面调用foo
,是不会有效果的。
这个就须要用到yield*
语句,用来在一个Generator函数里面执行另外一个Generator函数。
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()) {
console.log(v);
}
yield 'y';
}
for (let v of bar()){
console.log(v);
}
// "x"
// "a"
// "b"
// "y"
再来看一个对比的例子。
function* inner() {
yield 'hello!';
}
function* outer1() {
yield 'open';
yield inner();
yield 'close';
}
var gen = outer1()
gen.next().value // "open"
gen.next().value // 返回一个遍历器对象
gen.next().value // "close"
function* outer2() {
yield 'open'
yield* inner()
yield 'close'
}
var gen = outer2()
gen.next().value // "open"
gen.next().value // "hello!"
gen.next().value // "close"
上面例子中,outer2
使用了yield*
,outer1
没使用。结果就是,outer1
返回一个遍历器对象,outer2
返回该遍历器对象的内部值。
从语法角度看,若是yield
命令后面跟的是一个遍历器对象,须要在yield
命令后面加上星号,代表它返回的是一个遍历器对象。这被称为yield*
语句。
let delegatedIterator = (function* () {
yield 'Hello!';
yield 'Bye!';
}());
let delegatingIterator = (function* () {
yield 'Greetings!';
yield* delegatedIterator;
yield 'Ok, bye.';
}());
for(let value of delegatingIterator) {
console.log(value);
}
// "Greetings!
// "Hello!"
// "Bye!"
// "Ok, bye."
上面代码中,delegatingIterator
是代理者,delegatedIterator
是被代理者。因为yield* delegatedIterator
语句获得的值,是一个遍历器,因此要用星号表示。运行结果就是使用一个遍历器,遍历了多个Generator函数,有递归的效果。
yield*语句等同于在Generator函数内部,部署一个for…of循环。
function* concat(iter1, iter2) {
yield* iter1;
yield* iter2;
}
// 等同于
function* concat(iter1, iter2) {
for (var value of iter1) {
yield value;
}
for (var value of iter2) {
yield value;
}
}
上面代码说明,yield*
不过是for...of
的一种简写形式,彻底能够用后者替代前者。
若是yield*
后面跟着一个数组,因为数组原生支持遍历器,所以就会遍历数组成员。
function* gen(){
yield* ["a", "b", "c"];
}
gen().next() // { value:"a", done:false }
上面代码中,yield
命令后面若是不加星号,返回的是整个数组,加了星号就表示返回的是数组的遍历器对象。
实际上,任何数据结构只要有Iterator接口,就能够被yield*
遍历。
let read = (function* () {
yield 'hello';
yield* 'hello';
})();
read.next().value // "hello"
read.next().value // "h"
上面代码中,yield
语句返回整个字符串,yield*
语句返回单个字符。由于字符串具备Iterator接口,因此被yield*
遍历。
若是被代理的Generator函数有return
语句,那么就能够向代理它的Generator函数返回数据。
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* iterTree(tree) {
if (Array.isArray(tree)) {
for(let i=0; i < tree.length; i++) {
yield* iterTree(tree[i]);
}
} else {
yield tree;
}
}
const tree = [ 'a', ['b', 'c'], ['d', 'e'] ];
for(let x of iterTree(tree)) {
console.log(x);
}
// a
// b
// c
// d
// e
下面是一个稍微复杂的例子,使用yield*
语句遍历彻底二叉树。
// 下面是二叉树的构造函数,
// 三个参数分别是左树、当前节点和右树
function Tree(left, label, right) {
this.left = left;
this.label = label;
this.right = right;
}
// 下面是中序(inorder)遍历函数。
// 因为返回的是一个遍历器,因此要用generator函数。
// 函数体内采用递归算法,因此左树和右树要用yield*遍历
function* inorder(t) {
if (t) {
yield* inorder(t.left);
yield t.label;
yield* inorder(t.right);
}
}
// 下面生成二叉树
function make(array) {
// 判断是否为叶节点
if (array.length == 1) return new Tree(null, array[0], null);
return new Tree(make(array[0]), array[1], make(array[2]));
}
let tree = make([[['a'], 'b', ['c']], 'd', [['e'], 'f', ['g']]]);
// 遍历二叉树
var result = [];
for (let node of inorder(tree)) {
result.push(node);
}
result
// ['a', 'b', 'c', 'd', 'e', 'f', 'g']
若是一个对象的属性是Generator函数,能够简写成下面的形式。
let obj = {
* myGeneratorMethod() {
···
}
};
上面代码中,myGeneratorMethod
属性前面有一个星号,表示这个属性是一个Generator函数。
它的完整形式以下,与上面的写法是等价的。
let obj = {
myGeneratorMethod: function* () {
// ···
}
};
这一节讨论一种特殊状况:构造函数是Generator函数。
function* F(){
yield this.x = 2;
yield this.y = 3;
}
上面代码中,函数F是一个构造函数,又是一个Generator函数。这时,使用new命令就没法生成F的实例了,由于F返回的是一个内部指针。
'next' in (new F())
// true
上面代码中,因为new F()
返回的是一个Iterator对象,具备next方法,因此上面的表达式为true。
那么,这个时候怎么生成对象实例呢?
咱们知道,若是构造函数调用时,没有使用new命令,那么内部的this对象,绑定当前构造函数所在的对象(好比window对象)。所以,能够生成一个空对象,使用bind方法绑定F内部的this。这样,构造函数调用之后,这个空对象就是F的实例对象了。
var obj = {};
var f = F.bind(obj)();
f.next();
f.next();
f.next();
console.log(obj);
// { x: 2, y: 3 }
上面代码中,首先是F内部的this对象绑定obj对象,而后调用它,返回一个Iterator对象。这个对象执行三次next方法(由于F内部有两个yield语句),完成F内部全部代码的运行。这时,全部内部属性都绑定在obj对象上了,所以obj对象也就成了F的实例。
ES7在数组推导的基础上,提出了Generator函数推导(Generator comprehension)。
let generator = function* () {
for (let i = 0; i < 6; i++) {
yield i;
}
}
let squared = ( for (n of generator()) n * n );
// 等同于
// let squared = Array.from(generator()).map(n => n * n);
console.log(...squared);
// 0 1 4 9 16 25
“推导”这种语法结构,不只能够用于数组,ES7将其推广到了Generator函数。for…of循环会自动调用遍历器的next方法,将返回值的value属性做为数组的一个成员。
Generator函数推导是对数组结构的一种模拟,它的最大优势是惰性求值,即直到真正用到时才会求值,这样能够保证效率。请看下面的例子。
let bigArray = new Array(100000);
for (let i = 0; i < 100000; i++) {
bigArray[i] = i;
}
let first = bigArray.map(n => n * n)[0];
console.log(first);
上面例子遍历一个大数组,可是在真正遍历以前,这个数组已经生成了,占用了系统资源。若是改用Generator函数推导,就能避免这一点。下面代码只在用到时,才会生成一个大数组。
let bigGenerator = function* () {
for (let i = 0; i < 100000; i++) {
yield i;
}
}
let squared = ( for (n of bigGenerator()) n * n );
console.log(squared.next());
Generator是实现状态机的最佳结构。好比,下面的clock函数就是一个状态机。
var ticking = true;
var clock = function() {
if (ticking)
console.log('Tick!');
else
console.log('Tock!');
ticking = !ticking;
}
上面代码的clock函数一共有两种状态(Tick和Tock),每运行一次,就改变一次状态。这个函数若是用Generator实现,就是下面这样。
var clock = function*(_) {
while (true) {
yield _;
console.log('Tick!');
yield _;
console.log('Tock!');
}
};
上面的Generator实现与ES5实现对比,能够看到少了用来保存状态的外部变量ticking,这样就更简洁,更安全(状态不会被非法篡改)、更符合函数式编程的思想,在写法上也更优雅。Generator之因此能够不用外部变量保存状态,是由于它自己就包含了一个状态信息,即目前是否处于暂停态。
协程(coroutine)是一种程序运行的方式,能够理解成“协做的线程”或“协做的函数”。协程既能够用单线程实现,也能够用多线程实现。前者是一种特殊的子例程,后者是一种特殊的线程。
(1)协程与子例程的差别
传统的“子例程”(subroutine)采用堆栈式“后进先出”的执行方式,只有当调用的子函数彻底执行完毕,才会结束执行父函数。协程与其不一样,多个线程(单线程状况下,即多个函数)能够并行执行,可是只有一个线程(或函数)处于正在运行的状态,其余线程(或函数)都处于暂停态(suspended),线程(或函数)之间能够交换执行权。也就是说,一个线程(或函数)执行到一半,能够暂停执行,将执行权交给另外一个线程(或函数),等到稍后收回执行权的时候,再恢复执行。这种能够并行执行、交换执行权的线程(或函数),就称为协程。
从实现上看,在内存中,子例程只使用一个栈(stack),而协程是同时存在多个栈,但只有一个栈是在运行状态,也就是说,协程是以多占用内存为代价,实现多任务的并行。
(2)协程与普通线程的差别
不难看出,协程适合用于多任务运行的环境。在这个意义上,它与普通的线程很类似,都有本身的执行上下文、能够分享全局变量。它们的不一样之处在于,同一时间能够有多个线程处于运行状态,可是运行的协程只能有一个,其余协程都处于暂停状态。此外,普通的线程是抢先式的,到底哪一个线程优先获得资源,必须由运行环境决定,可是协程是合做式的,执行权由协程本身分配。
因为ECMAScript是单线程语言,只能保持一个调用栈。引入协程之后,每一个任务能够保持本身的调用栈。这样作的最大好处,就是抛出错误的时候,能够找到原始的调用栈。不至于像异步操做的回调函数那样,一旦出错,原始的调用栈早就结束。
Generator函数是ECMAScript 6对协程的实现,但属于不彻底实现。Generator函数被称为“半协程”(semi-coroutine),意思是只有Generator函数的调用者,才能将程序的执行权还给Generator函数。若是是彻底执行的协程,任何函数均可以让暂停的协程继续执行。
若是将Generator函数看成协程,彻底能够将多个须要互相协做的任务写成Generator函数,它们之间使用yield语句交换控制权。
Generator能够暂停函数执行,返回任意表达式的值。这种特色使得Generator有多种应用场景。
Generator函数的暂停执行的效果,意味着能够把异步操做写在yield语句里面,等到调用next方法时再日后执行。这实际上等同于不须要写回调函数了,由于异步操做的后续操做能够放在yield语句下面,反正要等到调用next方法时再执行。因此,Generator函数的一个重要实际意义就是用来处理异步操做,改写回调函数。
function* loadUI() {
showLoadingScreen();
yield loadUIDataAsynchronously();
hideLoadingScreen();
}
var loader = loadUI();
// 加载UI
loader.next()
// 卸载UI
loader.next()
上面代码表示,第一次调用loadUI函数时,该函数不会执行,仅返回一个遍历器。下一次对该遍历器调用next方法,则会显示Loading界面,而且异步加载数据。等到数据加载完成,再一次使用next方法,则会隐藏Loading界面。能够看到,这种写法的好处是全部Loading界面的逻辑,都被封装在一个函数,循序渐进很是清晰。
Ajax是典型的异步操做,经过Generator函数部署Ajax操做,能够用同步的方式表达。
function* main() {
var result = yield request("http://some.url");
var resp = JSON.parse(result);
console.log(resp.value);
}
function request(url) {
makeAjaxCall(url, function(response){
it.next(response);
});
}
var it = main();
it.next();
上面代码的main函数,就是经过Ajax操做获取数据。能够看到,除了多了一个yield,它几乎与同步操做的写法彻底同样。注意,makeAjaxCall函数中的next方法,必须加上response参数,由于yield语句构成的表达式,自己是没有值的,老是等于undefined。
下面是另外一个例子,经过Generator函数逐行读取文本文件。
function* numbers() {
let file = new FileReader("numbers.txt");
try {
while(!file.eof) {
yield parseInt(file.readLine(), 10);
}
} finally {
file.close();
}
}
上面代码打开文本文件,使用yield语句能够手动逐行读取文件。
若是有一个多步操做很是耗时,采用回调函数,可能会写成下面这样。
step1(function (value1) {
step2(value1, function(value2) {
step3(value2, function(value3) {
step4(value3, function(value4) {
// Do something with value4
});
});
});
});
采用Promise改写上面的代码。
Q.fcall(step1)
.then(step2)
.then(step3)
.then(step4)
.then(function (value4) {
// Do something with value4
}, function (error) {
// Handle any error from step1 through step4
})
.done();
上面代码已经把回调函数,改为了直线执行的形式,可是加入了大量Promise的语法。Generator函数能够进一步改善代码运行流程。
function* longRunningTask() {
try {
var value1 = yield step1();
var value2 = yield step2(value1);
var value3 = yield step3(value2);
var value4 = yield step4(value3);
// Do something with value4
} catch (e) {
// Handle any error from step1 through step4
}
}
而后,使用一个函数,按次序自动执行全部步骤。
scheduler(longRunningTask());
function scheduler(task) {
setTimeout(function() {
var taskObj = task.next(task.value);
// 若是Generator函数未结束,就继续调用
if (!taskObj.done) {
task.value = taskObj.value
scheduler(task);
}
}, 0);
}
注意,yield语句是同步运行,不是异步运行(不然就失去了取代回调函数的设计目的了)。实际操做中,通常让yield语句返回Promise对象。
var Q = require('q');
function delay(milliseconds) {
var deferred = Q.defer();
setTimeout(deferred.resolve, milliseconds);
return deferred.promise;
}
function* f(){
yield delay(100);
};
上面代码使用Promise的函数库Q,yield语句返回的就是一个Promise对象。
多个任务按顺序一个接一个执行时,yield语句能够按顺序排列。多个任务须要并列执行时(好比只有A任务和B任务都执行完,才能执行C任务),能够采用数组的写法。
function* parallelDownloads() {
let [text1,text2] = yield [
taskA(),
taskB()
];
console.log(text1, text2);
}
上面代码中,yield语句的参数是一个数组,成员就是两个任务taskA和taskB,只有等这两个任务都完成了,才会接着执行下面的语句。
利用Generator函数,能够在任意对象上部署iterator接口。
function* iterEntries(obj) {
let keys = Object.keys(obj);
for (let i=0; i < keys.length; i++) {
let key = keys[i];
yield [key, obj[key]];
}
}
let myObj = { foo: 3, bar: 7 };
for (let [key, value] of iterEntries(myObj)) {
console.log(key, value);
}
// foo 3
// bar 7
上述代码中,myObj是一个普通对象,经过iterEntries函数,就有了iterator接口。也就是说,能够在任意对象上部署next方法。
下面是一个对数组部署Iterator接口的例子,尽管数组原生具备这个接口。
function* makeSimpleGenerator(array){
var nextIndex = 0;
while(nextIndex < array.length){
yield array[nextIndex++];
}
}
var gen = makeSimpleGenerator(['yo', 'ya']);
gen.next().value // 'yo'
gen.next().value // 'ya'
gen.next().done // true
Generator能够看做是数据结构,更确切地说,能够看做是一个数组结构,由于Generator函数能够返回一系列的值,这意味着它能够对任意表达式,提供相似数组的接口。
function *doStuff() {
yield fs.readFile.bind(null, 'hello.txt');
yield fs.readFile.bind(null, 'world.txt');
yield fs.readFile.bind(null, 'and-such.txt');
}
上面代码就是依次返回三个函数,可是因为使用了Generator函数,致使能够像处理数组那样,处理这三个返回的函数。
for (task of doStuff()) {
// task是一个函数,能够像回调函数那样使用它
}
实际上,若是用ES5表达,彻底能够用数组模拟Generator的这种用法。
function doStuff() {
return [
fs.readFile.bind(null, 'hello.txt'),
fs.readFile.bind(null, 'world.txt'),
fs.readFile.bind(null, 'and-such.txt')
];
}
上面的函数,能够用如出一辙的for…of循环处理!两相一比较,就不难看出Generator使得数据或者操做,具有了相似数组的接口。