1. 初识生成器Generator
闲来晚上睡不着,你去数三羊,1,2,3
就真的三只羊,就没了。。。还是睡不着,于是继续产出(yield)羊:
function* SheepGenerator(){
let index = 1;
while(true){
yield index++;
}
}
let countSheep = SheepGenerator();
countSheep.next().value; // 1
countSheep.next().value; // 2
countSheep.next().value; // 3
countSheep.next().value; // 4
。。。
这样,你能数到天荒地老。。。只要调用,就有产出。这就是一个最基本的生成器函数。
形式上,Generator 函数是一个普通函数,但是有两个特征:
-
function
关键字与函数名之间有一个星号*
; - 函数体内部使用
yield
表达式,定义不同的内部状态。
Generator 函数的调用方法与普通函数一样,也是在函数名后面加上一对圆括号。不同的是,调用 Generator 函数后,该函数并不执行,返回的也不是函数运行结果,而是一个指向内部状态的指针对象,即遍历器对象(Iterator Object)。必须调用遍历器对象的next
方法,使得指针移向下一个状态。那么什么是状态呢?
2. 生成器的状态
countSheep.next() // {value: 6, done: false}
通过next
方法调用生成器函数,发现返回一个对象,其中value
表示当前产出的值,done
表示是否还有下一个值,如果没有(done: true
)(但是当不存在return语句时,就算没有下一个yield,最后一个yield也会为done:false
),继续调用返{value: undefined, done: true}
,value
值变为undefined
,就算下次没有值了,你也可以继续调用,只不过返回的value
是undefined
function* helloWorldGenerator() {
yield 'hello';
yield 'world'; // { value: 'world', done: false }
return 'ending'; // { value: 'ending', done: true }
}
let hw = helloWorldGenerator();
hw.next(); // { value: 'hello', done: false }
hw.next();// { value: 'world', done: false }
hw.next();// { value: 'ending', done: true }
hw.next();// { value: undefined, done: true }
hw.next();// { value: undefined, done: true }
3. yield表达式
yield将生成器分为一个一个节点,每次调用.next
方法时,指针就会移到yield
节点处,产出当前值,再次调用.next
时,指针就会移到下一个yield
节点处,以此类推。。。如果遇到return
语句,标志return
是最后一个yield
节点,return
后面的yield
会被忽略:
function* helloGenerator() {
yield 'hello';
return 'ending'; // yield节点截止标志
yield 'World'; // 会被忽略
}
let hg = helloGenerator();
hg.next();//{ value: 'hello', done: false }
hg.next();// { value: 'ending', done: true }
hg.next();// { value: undefined, done: true }
Generator 函数可以不用yield
表达式,这时就变成了一个单纯的暂缓执行函数:
function* f() {
console.log('执行了!')
}
var generator = f();
generator.next(); // '执行了'
函数f
如果是普通函数,在为变量generator
赋值时就会执行。但是,函数f
是一个 Generator 函数,就变成只有调用next
方法时,函数f
才会执行。
yield
表达式只能用在 Generator 函数里面,用在其他地方都会报错。
4. yield* 表达式
如果yield
表达式后面跟的是一个遍历器对象,即在yield
表达式后面加上星号,表明它返回的是一个遍历器对象。称为yield*
表达式。
yield 表达式*,就是在一个 Generator 函数里面执行另一个 Generator 函数:
function* foo() {
yield 'a';
yield 'b';
}
function* bar() {
yield 'x';
yield* foo(); // 内部执行Generator bar
yield 'y';
}
for (let v of bar()){
console.log(v);
}
// "x"
// "a"
// "b"
// "y"
任何数据结构只要有 Iterator 接口,就可以被yield*
遍历:
function* gen(){
yield* ["a", "b", "c"];
}
gen().next() // { value:"a", done:false }
5. 生成器(Generator)与迭代(遍历)器(Iterator)
原生具备 Iterator 接口的数据结构如下。
- Array
- Map
- Set
- String
- TypedArray
- 函数的 arguments 对象
- NodeList 对
一个对象如果要具备可被for...of
循环调用的 Iterator 接口,就必须在Symbol.iterator
的属性上部署遍历器生成方法(原型链上的对象具有该方法也可)。
迭代器协议:
当一个对象只有满足下述条件才会被认为是一个迭代器:
它实现了一个 next()
的方法并且拥有以下含义:
属性 | 值 |
---|---|
next |
返回一个对象的无参函数,被返回对象拥有两个属性:done (boolean)true:迭代器已经超过了可迭代次数。这种情况下,value的值可以被省略如果迭代器可以产生序列中的下一个值,则为 false。这等效于没有指定done这个属性。value - 迭代器返回的任何 JavaScript 值。done 为 true 时可省略。next 方法必须要返回一一个对象,该对象有两个必要的属性: done和value,如果返回一个非对象值(比如false和undefined) 会展示一个 TypeError ("iterator.next() returned a non-object value") 的错误 |
可迭代协议:
普通对象变成可迭代对象, 一个对象必须实现 @@iterator 方法, 即这个对象(或者它原型链 prototype chain 上的某个对象)必须有一个名字是 Symbol
.iterator
的属性:
Symbol.iterator
属性对应一个函数,执行后返回当前对象的迭代器对象。
属性 | 值 |
---|---|
[Symbol.iterator] |
返回一个对象的无参函数,被返回对象符合迭代器协议。 |
自定义迭代器:
let myIterable = {};
myIterable[Symbol.iterator] = function* () {
yield 1;
yield 2;
yield 3;
};
[...myIterable]; // [1, 2, 3]
对数组和 Set 结构进行解构赋值时,会默认调用Symbol.iterator
方法:
let set = new Set().add('a').add('b').add('c');
let [x,y] = set;
// x='a'; y='b'
let [first, ...rest] = set;
// first='a'; rest=['b','c'];
扩展运算符(...)也会调用默认的 Iterator 接口:
// 例一
var str = 'hello';
[...str] // ['h','e','l','l','o']
// 例二
let arr = ['b', 'c'];
['a', ...arr, 'd']
// ['a', 'b', 'c', 'd']
`生成器对象 既是迭代器也是可迭代对象:
let generator = function* () {
yield 1;
yield* [2,3,4];
yield 5;
};
let iterator = generator();
iterator.next() // { value: 1, done: false }
iterator.next() // { value: 2, done: false }
iterator.next() // { value: 3, done: false }
iterator.next() // { value: 4, done: false }
iterator.next() // { value: 5, done: false }
iterator.next() // { value: undefined, done: true }
[...iterator]; // [1, 2, 3, 4, 5]
一旦next
方法的返回对象的done
属性为true
,for...of
循环就会中止,且不包含该返回对象,即return语句的值不会被for..of 遍历,也不会被解构出来:
function* foo() {
yield 1;
yield 2;
yield 3;
yield 4;
yield 5;
return 6; // return不会被for..of 遍历,也不会被解构出来
}
[...foo()]; // [1, 2, 3, 4, 5]
// foo()
for (let v of foo()) {
console.log(v);
}
// 1 2 3 4 5
// 注意f
let f = foo()
for (let v of f) {
console.log(v);
}
实现斐波那契数列:
function* fibonacci(){
let [prev, curr] = [0, 1];
while(true){
yield curr;
[prev, curr] = [curr, prev + curr];
}
}
for(let n of fibonacci()) {
if(n > 100) break;
console.log(n)
}
6. Generator.prototype.next
- 语法:
gen.next(value)
next() 方法返回一个包含属性 done
和 value
的对象。该方法也可以通过接受一个参数用以向生成器传值。
function* gen() {
while(true) {
var value = yield null;
console.log(value);
}
}
let g = gen();
g.next(1);
// "{ value: null, done: false }"
g.next(2);
// 2
// "{ value: null, done: false }"
注意,由于next
方法的参数表示上一个yield
表达式的返回值,所以在第一次使用next
方法时,传递参数是无效的。
7. Generator.protytype.return
- 语法:
gen.return(value)
return() 方法返回给定的值(value)并结束生成器。如果return
方法调用时,不提供参数,则返回值的value
属性为undefined
。
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 }
如果 Generator 函数内部有try...finally
代码块,且正在执行try
代码块,那么return
方法会导致立刻进入finally
代码块,执行完以后,整个函数才会结束。
function* numbers () {
yield 1;
try {
yield 2;
yield 3;
} finally {
yield 4;
yield 5;
}
yield 6;
}
var g = numbers();
g.next() // { value: 1, done: false }
g.next() // { value: 2, done: false }
g.return(7) // { value: 4, done: false }
g.next() // { value: 5, done: false }
g.next() // { value: 7, done: true }
8. Generator.prototype.throw
- 语法:
gen.throw(exception)
throw() 方法用来向生成器抛出异常,并恢复生成器的执行,返回带有 done
及 value
两个属性的对象。
function* gen() {
while(true) {
try {
yield 42;
} catch(e) {
console.log(e);
}
}
}
let g = gen();
g.next(); // { value: 42, done: false }
g.throw(new Error("Something went wrong")); //"Something went wrong"
9.理解 next()、throw()、return()
next()
、throw()
、return()
这三个方法本质上是同一件事,都是让 Generator 函数恢复执行,并且使用不同的语句替换yield
表达式
next()
是将yield
表达式替换成一个值:
const g = function* (x, y) {
let result = yield x + y;
return result;
};
const gen = g(1, 2);
gen.next(); // Object {value: 3, done: false}
gen.next(1); // Object {value: 1, done: true}
// 相当于将 let result = yield x + y
// 替换成 let result = 1;
throw()
是将yield
表达式替换成一个throw
语句:
gen.throw(new Error('出错了')); // Uncaught Error: 出错了
// 相当于将 let result = yield x + y
// 替换成 let result = throw(new Error('出错了'));
return()
是将yield
表达式替换成一个return
语句:
gen.return(2); // Object {value: 2, done: true}
// 相当于将 let result = yield x + y
// 替换成 let result = return 2;
10. 手写generator函数
下面实现这样一个函数:
1..next
调用:
其实这就是一个迭代器,实现了迭代器协议:
let g = generator(1,2,3);
g.next(); // {value: 1, done: false}
g.next(); // {value: 2, done: false}
g.next(); // {value: 3, done: false}
g.next(); // {value: undefined, done: true}
使用单例模式及闭包(简单理解,就是函数内部嵌套的函数引用了内部变量)实现:
function generator(...rest) {
let index = -1; // 内部变量
return {
next() { // 内部函数
index++; // 形成闭包
return {value: rest[index], done: !rest[index]}
}
}
}
// 测试
let g = generator(1,2);
g.next(); // {value: 1, done: false}
g.next(); // {value: 2, done: false}
g.next(); // {value: undefined, done: true}
2.for...of
遍历:
for...of
遍历会默认调用Symbol.iterator方法
其实这就是一个可迭代对象,实现了可迭代协议:
for(let i of g) {
console.log(i);
}; // 依次输出 1 2 3
上面虽然实现了.next
操作,但是返回的是一个普通对象而不是一个可迭代对象,是不能使用for...of
遍历的,下面将这个普通对象变为可迭代对象:
function generator(...rest) {
let index = -1;
return {
next() { // 产生迭代器
index++;
return {value: rest[index], done: !rest[index]}
},
[Symbol.iterator](){
return this; // 返回当前迭代器
}
}
}
let g = generator(1,2,3);
// for..of
for(let i of g){
console.log(i); // 输出 1 2 3
}
// 解构
[...g]; // [1,2,3]
因为Generator既是迭代器(.next()
)又是可迭代对象([Symbol.iterator]
),所以我们的generator
也要实现迭代器协议和可迭代协议。
3..return
结束:
let f = generator([1,2,3]);
g.next(); // {value: 1, done: false}
g.return(22); // {value: 22, done: true}
g.next(); // {value: undefined, done: true}
注意return
是关键字,最好使用ES6属性名表达式['return'](){}
定义方法名:
function generator(...rest) {
let index = -1;
let isReturned = false; // 判断是否调用了return
return {
next() {
index++;
if (!isReturned) {
return {value: rest[index], done: !rest[index]}
}
return {value: undefined, done: true}
},
[Symbol.iterator]() {
return this;
},
['return'](value) { // ES6属性名表达式
isReturned = true;
return {value: value, done: true};
},
}
}
// 测试:
let a = generator(1,2,3)
{next: ƒ, return: ƒ, Symbol(Symbol.iterator): ƒ}
a.next()
// {value: 1, done: false}
a.return(111)
// {value: 111, done: true}
a.next()
// {value: undefined, done: true}
a.next()
// {value: undefined, done: true}
4..throw
的实现:
function generator(...rest) {
let index = -1;
let isReturned = false; // 判断是否调用了return
let isThrowed = false; // 判断是否调用了throw
return {
next() {
index++;
if (!isReturned && !isThrowed) {
return {value: rest[index], done: !rest[index]}
}
return {value: undefined, done: true}
},
[Symbol.iterator]() {
return this;
},
['return'](value) { // ES6属性名表达式
isReturned = true;
return {value: value, done: true};
},
// 同理:throw的实现
['throw'](value) { // ES6属性名表达式
isThrowed = true;
throw value;
}
}
}