Generator函数

迭代器 vs 生成器

迭代器

• 有next方法，执行返回结果对象
• 结果对象：value，done

function createIterator(item){
  var i = 0;
  return {
    next: function(){
      var done = i >= items.length;
      var value = !done ? items(i++) : undefined;
      return {
        done: done,
        value: value
      }
    }
  };
}

var iterator = createIterator([1,2,3]);

iterator.next();
iterator.next();
iterator.next();
iterator.next();

可迭代协议

• [Symbol.iterator]属性
• 内置可迭代对象：String Array Map Set等

迭代器协议

• next方法：done,value

Generator函数(生成器)

• ES6异步编程解决方案
• 声明：通过function *声明
• 返回值：符合可迭代协议和迭代器协议的生成器对象
• 在执行时能暂停，又能从暂停处继续执行

生成器对象

• next(param)
• return(param)
• throw(param)

yield

• 只能出现在Generator函数
• 用来暂停和恢复生成器函数
  ** next执行 **
• 遇yield暂停，将紧跟yield表达式的值作为返回的对象的value
• 没有yield,一直执行到return,将return的值作为返回的对象的value
• 没有return,将undefined作为返回的对象的value
  ** next参数 **
• next方法可以带一个参数，该参数会被当作一个yield表达式的返回值

function* createIterator(){
  let first = yield 1;
  let second = yield first + 2;
  yield second + 3;
}

let iterator = createIterator();

iterator.next(); // {value:1,done:false}
iterator.next(4); // {value:6,done:false}
iterator.next(5); // {value:8,done:false}
iterator.next(); // {value:undefined,done:true}

yield* 生成器函数/可迭代对象

• 委托给其他可迭代对象
• 作用：复用生成器

function* generator1(){
  yield 1;
  yield 2;
}

function* generator2(){
  yield 100;
  yield* generator1();
  yield 200;
}

let g2 = generator2();
g2.next(); // {value:100,done:false}
g2.next(); // {value:1,done:false}
g2.next(); // {value:2,done:false}
g2.next(); // {value:200,done:false}
g2.next(); // {value:undefined,done:true}

return(param)

• 给定param值终结遍历器，param可缺省

function* createIterator(){
  yield 1;
  yield 2;
  yield 3;
}

let iterator = createIterator();

iterator.next(); // {value:1,done:false}
iterator.return(); // {value:undefined,done:true}
iterator.next(); // {value:undefined,done:true}

throw(param)

• 让生成器对象内部抛出错误

function* createIterator(){
  let first = yield 1;
  let second;
  try{
    second = yield first + 2;
  }catch(e){
    second = 6;
  }
  yield second +3;
}
let iterator = createIterator();

iterator.next(); // {value:1,done:false}
iterator.next(10); // {value:12,done:false}
iterator.throw(new Error('error')); // {value:9,done:false}
iterator.next(); // {value:undefined,done:true}

Generator函数的实现原理

协程

• 一个线程存在多个协程，但同时只能执行一个
• Generator函数是协程在ES6的实现
• Yield挂起X协程（交给其他协程），next唤醒X协程

Generator函数应用

//需求：按顺序读取文件
function readFilesByCallback(){
  const fs = require('fs');
  const files = [
    "Users/kitty/testgenerator/1.json",
    "Users/kitty/testgenerator/2.json",
    "Users/kitty/testgenerator/3.json",
  ];
  fs.readFile(files[0],function(err, data){
    console.log(data.toString());
    fs.readFile(files[1],function(err, data){
      console.log(data.toString());
      fs.readFile(files[2],function(err, data){
        console.log(data.toString());
      });
    });
  });
}

//调用
readFilesByCallback();

//上面的代码回调太多，用generator优化代码
function* readFilesByGenerator(){
  const fs = require("fs");
  const files = [
    "Users/kitty/testgenerator/1.json",
    "Users/kitty/testgenerator/2.json",
    "Users/kitty/testgenerator/3.json",
  ];
  let fileStr = "";
  function readFile(filename){
    fs.readFile(filename,function(err, data){
      console.log(data.toString());
      f.next(data,toString())
    });
  }
  yield readFile(files[0]);
  yield readFile(files[1]);
  yield readFile(files[2]);
}

//调用
const f = readFilesByGenerator();
f.next();

//缺点：耦合性太高，readFile里面的方法与外面调用的f.next()是同一个，代码不优雅
//修改方法：用Thunk函数

Thunk函数

• 求值策略 传值调用，传名调用sum(x+1,x+2)
  - 传值调用：算好了x+1和x+2在调用sum
  - 传名调用：调用sum函数时在计算x+1,x+2的值
• thunk函数时传名调用的实现方式之一
• 可以实现自动执行Generator函数

const fs = require("fs");
const Thunk = function(fn){//fn:fs.readFile
  return function(...args){
    return function(callback){
      return fn.call(this,...args,callback);//fn.readFile(...args,next())
    };
  };
};
const readFileThunk = Thunk(fs.readFile);//第一层return

function run(fn){
  var gen = fn();//g()
  function next(err, data){
    var result = gen.next(data);//{value:function,done:false}
    if(result.done) return;
    result.value(next);//重点 next传入callback
  }
  next();
}

const g = function*(){
  const s1 = yield readFileThunk('Users/kitty/testgenerator/1.json');
  console.log(s1.toString());
  const s2 = yield readFileThunk('Users/kitty/testgenerator/2.json');
  console.log(s2.toString());
  const s3 = yield readFileThunk('Users/kitty/testgenerator/3.json');
  console.log(s3.toString());
}

run(g)

作业

• co模块的源码分析-koa引用了co模块