异步生成器和异步迭代器的使用场景

08 Aug 2019 in nodejs on ES2018 - Hits()

异步迭代器（Async Iterators）

ES2018 提出了异步迭代器（Async Iterators），Node 10 已经支持，可以使用 for of 循环迭代。

普通的迭代器写法

const nums = [1, 2, 3];

let index = 0;
const iterator = {
  next: () => {
    if (index >= nums.length) {
      return { done: true };
    }
    const value = nums[index++];
    //返回必须包含value(此次迭代值)，done(是否迭代完)
    return { value, done: false };
  }
};
//定义iterable以便for of使用
const iterable = {
  //需要使用Symbol.iterator定义迭代子
  [Symbol.iterator]: () => iterator
};
// for of调用iterable
for (const v of iterable) {
  console.log(v); // Prints "1", "2", "3"
}

异步迭代器

const nums = [1, 2, 3];

let index = 0;
const asyncIterator = {
  next: () => {
    if (index >= nums.length) {
      //不同的是返回promise
      return Promise.resolve({ done: true });
    }
    const value = nums[index++];
    //不同的是返回promise
    return Promise.resolve({ value, done: false });
  }
};

const asyncIterable = {
  //注意是Symbol.asyncIterator
  [Symbol.asyncIterator]: () => asyncIterator
};

// for of调用iterable,需要await
for await (const value of asyncIterable) {
    console.log(value);
}

异步构造器(Async Generator)

往往认为有了 async 就不需要构造器，但是实际上构造器仍然有它的作用，然后如果构造器里面又需要异步请求的话，那么异步构造器就这样产生了。

举个例子，就是数据库指针的使用。使用指针遍历所有记录，这种场景需要使用异步迭代和异步构造器。

'use strict';

const mongoose = require('mongoose');

async function* run() {
  await mongoose.connect('mongodb://localhost:27017/test', {
    useNewUrlParser: true
  });
  await mongoose.connection.dropDatabase();

  const Model = mongoose.model('Test', mongoose.Schema({ name: String }));
  for (let i = 0; i < 5; ++i) {
    await Model.create({ name: `doc ${i}` });
  }

  const total = 5;
  //使用指针
  const cursor = Model.find().cursor();

  let processed = 0;
  // 遍历指针指向的数据集
  for await (const doc of cursor) {
    // 使用构造器语法，能无阻塞的显示进度
    yield { processed: ++processed, total };
  }
}

(async () => {
  //使用构造器
  for await (const val of run()) {
    console.log(`${val.processed} / ${val.total}`);
  }
})();