如何从 ES6 类中创建一个迭代器

Question

如何以与 JS1.7 SomeClass.prototype.__iterator__ = function() {...} 语法相同的方式从 ES6 类中创建迭代器？

[编辑 16:00]

以下作品：

class SomeClass {
    constructor() {
    }

    *[Symbol.iterator]() {
        yield '1';
        yield '2';
    }

    //*generator() {
    //}

}

an_instance = new SomeClass();
for (let v of an_instance) {
    console.log(v);
}

WebStorm 标记 *[Symbol.iterator]() 并在 asterix 之后直接显示“预期函数名称”警告，但除此之外，它可以编译并使用 Traceur 正常运行。 （注意 WebStorm 不会为 *generator() 生成任何错误。）

Answer 1

您需要为SomeClass 指定Symbol.iterator 属性，该属性为类实例返回iterator。迭代器必须有next() 方法，女巫反过来返回带有done 和value 字段的对象。简化示例：

function SomeClass() {
  this._data = [1,2,3,4];
}

SomeClass.prototype[Symbol.iterator] = function() {
  var index = 0;
  var data  = this._data;

  return {
    next: function() {
      return { value: data[++index], done: !(index in data) }
    }
  };
};

或者使用 ES6 类和箭头函数：

class SomeClass {
  constructor() {
    this._data = [1,2,3,4];
  }

  [Symbol.iterator]() {
    var index = -1;
    var data  = this._data;

    return {
      next: () => ({ value: data[++index], done: !(index in data) })
    };
  };
}

及用法：

var obj = new SomeClass();
for (var i of obj) { console.log(i) }

在您更新的问题中，您通过生成器函数实现了类迭代器。您可以这样做，但您必须了解迭代器不能成为生成器。实际上 es6 中的迭代器是具有特定 next() method 的任何对象

Answer 2

定义一个合适的迭代器方法。例如：

class C {
  constructor() { this.a = [] }
  add(x) { this.a.push(x) }
  [Symbol.iterator]() { return this.a.values() }
}

编辑：示例使用：

let c = new C
c.add(1); c.add(2)
for (let i of c) console.log(i)

Answer 3

这是一个在 ES6 中迭代二维矩阵自定义类的示例

class Matrix {
    constructor() {
        this.matrix = [[1, 2, 9],
                       [5, 3, 8],
                       [4, 6, 7]];
    }

    *[Symbol.iterator]() {
        for (let row of this.matrix) {
            for (let cell of row) {
                yield cell;
            }
        }
    }
}

这样一个类的用法是

let matrix = new Matrix();

for (let cell of matrix) {
    console.log(cell)
}

哪个会输出

1
2
9
5
3
8
4
6
7

Answer 4

文档：Iteration Protocols

实现迭代器协议和可迭代协议技术的示例类：

class MyCollection {
  constructor(elements) {
    if (!Array.isArray(elements))
      throw new Error('Parameter to constructor must be array');

    this.elements = elements;
  }

  // Implement "iterator protocol"
  *iterator() {
    for (let key in this.elements) {
      var value = this.elements[key];
      yield value;
    }
  }

  // Implement "iterable protocol"
  [Symbol.iterator]() {
    return this.iterator();
  }
}

使用任一技术访问元素：

var myCollection = new MyCollection(['foo', 'bar', 'bah', 'bat']);

// Access elements of the collection using iterable
for (let element of myCollection)
  console.log('element via "iterable": ' + element);

// Access elements of the collection using iterator
var iterator = myCollection.iterator();
while (element = iterator.next().value)
  console.log('element via "iterator": ' + element);

Answer 5

说明

制作一个对象可迭代意味着这个对象有一个以Symbol.iterator命名的方法。当这个方法被调用时，它应该返回一个名为iterator的接口。

这个迭代器必须有一个返回下一个结果的方法next。这个结果应该是一个对象，它有一个提供下一个值的value 属性和一个done 属性，当没有更多结果时应该是true，否则应该是false。

实施

我还将为一个名为Matrix 的类实现一个迭代器，它的所有元素的范围都是从0 到width * height - 1。我将为这个迭代器创建一个不同的类，名为MatrixIterator。

class Matrix {
    constructor(width, height) {
        this.width = width;
        this.height = height;
        this.content = [];

        for (let y = 0; y < height; y++) {
            for (let x = 0; x < width; x++) {
                this.content[y * width + x] = y * width + x;
            }
        }
    }

    get(x, y) {
        return this.content[y * this.width + x];
    }

    [Symbol.iterator]() {
        return new MatrixIterator(this);
    }
}


class MatrixIterator {
    constructor(matrix) {
        this.x = 0;
        this.y = 0;
        this.matrix = matrix;
    }

    next() {
        if (this.y == this.matrix.height) return {done: true};

        let value = {
            x: this.x,
            y: this.y,
            value: this.matrix.get(this.x, this.y)
        };

        this.x++;

        if (this.x == this.matrix.width) {
            this.x = 0;
            this.y++;
        }

        return {value, done: false};
    }
}

注意Matrix 通过定义Symbol.iterator 符号来实现iterator 协议。在这个方法内部，创建了一个MatrixIterator的实例，它以this为参数，即Matrix实例作为参数，在MatrixIterator内部，定义了next方法。我特别喜欢这种实现迭代器的方式，因为它清楚地显示了 iterator 和 Symbol.iterator 的实现。

另外，也可以不直接定义Symbol.iterator，而是给prototype[Symbol.iterator]添加一个函数，如下：

Matrix.prototype[Symbol.iterator] = function() {
    return new MatrixIterator(this);
};

使用示例

let matrix = new Matrix(3, 2);
for (let e of matrix) {
    console.log(e);
}

Answer 6

存储在子对象中的 ES6 迭代器类示例：

class Iterator {
    data;

    constructor(data = {}) {
        this.data = JSON.parse(JSON.stringify(data));
    }

    add(key, value) { this.data[key] = value; }

    get(key) { return this.data[key]; }

    [Symbol.iterator]() {
        const keys = Object.keys(this.data).filter(key => 
        this.data.hasOwnProperty(key));
        const values = keys.map(key => this.data[key]).values();
        return values;
    }
}

Answer 7

我认为没有人发布过异步迭代器的示例，所以请看：

class TableReadStream<T extends any[]> {
    async *[Symbol.asyncIterator]() {
        let row: T
        while((row = await this.readRow()) !== null) {
            yield row
        }
    }
}

用法：

for await(let row of readStream) {
    console.log(row)
}