遍历器Iterator

发表于

可遍历

JavaScript中表示集合的数据结构，主要有数组（Array）、对象（Object）、Map、Set 等四种数据集合。一种数据结构只要部署了Iterator 接口，我们就称这种数据结构是可遍历的（iterable）。


Iterator的遍历过程是这样的：

（1）创建一个指针对象，指向当前数据结构的起始位置。也就是说，遍历器对象本质上，就是一个指针对象。

（2）第一次调用指针对象的next方法，可以将指针指向数据结构的第一个成员。

（3）第二次调用指针对象的next方法，指针就指向数据结构的第二个成员。

（4）不断调用指针对象的next方法，直到它指向数据结构的结束位置。


每一次调用next方法，都会返回数据结构的当前成员的信息。具体来说，就是返回一个包含value和done两个属性的对象。其中，value属性是当前成员的值，done属性是一个布尔值，表示遍历是否结束。 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 模拟next方法返回值的例子

var it = makeIterator(['a', 'b']);

it.next() // { value: "a", done: false }
it.next() // { value: "b", done: false }
it.next() // { value: undefined, done: true }

function makeIterator(array) {
  var nextIndex = 0;
  return {
    next: function() {
      return nextIndex < array.length ?
        {value: array[nextIndex++], done: false} :
        {value: undefined, done: true};
    }
  };
}


默认的Iterator接口

ES6规定，默认的 Iterator 接口部署在数据结构的Symbol.iterator属性。或者说，一个数据结构只要具有Symbol.iterator属性，就可以认为是可遍历的（iterable）。Symbol.iterator属性是一个遍历器生成函数，执行这个函数，就会返回一个遍历器。 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 对象obj是可遍历的（iterable），因为具有Symbol.iterator属性

const obj = {
  [Symbol.iterator] : function () {
    return {
      next: function () {
        return {
          value: 1,
          done: true
        };
      }
    };
  }
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
Number.prototype[Symbol.iterator] = function() {
    return {
        v: 0,
        e: this,
        next() {
            return {
                value: this.v++,
                done: this.v > this.e
            }
        }
    }
}

[...100] // 返回[0, 1, 2, ..., 99]

原生具备 Iterator 接口的数据结构如下：

  • Array
  • Map
  • Set
  • String
  • TypedArray
  • 函数的 arguments 对象
  • NodeList 对象
1
2
3
4
5
6
7
let arr = ['a', 'b', 'c'];
let iter = arr[Symbol.iterator]();

iter.next() // { value: 'a', done: false }
iter.next() // { value: 'b', done: false }
iter.next() // { value: 'c', done: false }
iter.next() // { value: undefined, done: true }

注：ES6 创造了一种新的遍历命令for...of循环，Iterator接口主要供for...of消费


调用Iterator接口的场合

默认调用 Iterator 接口（即Symbol.iterator方法）的一些场合

  • for...of循环

  • 解构赋值

    1
    2
    3
    4
    5
    6
    7
    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'];

  • 扩展运算符

    1
    2
    3
    4
    5
    6
    7
    8
    // 例一
    var str = 'hello';
    [...str] //  ['h','e','l','l','o']

    // 例二
    let arr = ['b', 'c'];
    ['a', ...arr, 'd']
    // ['a', 'b', 'c', 'd']

  • yield*

  • 由于数组的遍历会调用遍历器接口，所以任何接受数组作为参数的场合，其实都调用了遍历器接口


遍历器对象的return方法

return方法的使用场合是，如果for...of循环提前退出（通常是因为出错，或者有break语句），就会调用return方法，是可选的 。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
function readLinesSync(file) {
  return {
    [Symbol.iterator]() {
      return {
        next() {
          return {value:1, done: false };
        },
        return() {
          console.log(file);
          return {value:2, done: true };
        }
      };
    },
  };
}
1
2
3
4
5
6
7
8
9
10
11
// 情况一：break语句
for (let line of readLinesSync(fileName)) {
  console.log(line);
  break;
}

// 情况二：出错
for (let line of readLinesSync(fileName)) {
  console.log(line);
  throw new Error();
}

注意：return方法必须返回一个对象