ES6-生成器及其实现

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,就算下次没有值了,你也可以继续调用,只不过返回的valueundefined

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属性为truefor...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() 方法返回一个包含属性 donevalue 的对象。该方法也可以通过接受一个参数用以向生成器传值。

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() 方法用来向生成器抛出异常,并恢复生成器的执行,返回带有 donevalue 两个属性的对象。

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;
        }
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,125评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,293评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,054评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,077评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,096评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,062评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,988评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,817评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,266评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,486评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,646评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,375评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,974评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,621评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,642评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,538评论 2 352

推荐阅读更多精彩内容