如何从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

您需要指定Symbol.iterator为其SomeClass返回类实例的迭代器的属性.迭代器必须有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()

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中迭代2d矩阵自定义类的示例

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

文档:迭代协议

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

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。在这个方法内部，MatrixIterator创建了一个实例，它以为参数，this即Matrix实例作为参数，在内部 MatrixIterator，next定义了方法。我特别喜欢这种实现迭代器的方式，因为它清楚地展示了迭代器和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);
}