ES6 for...of 循环



  • 定义和使用

    ES6 借鉴 C++、Java、C# 和 Python 语言,引入了 for...of 循环,作为遍历所有数据结构的统一的方法。
    一个数据结构只要部署了 Symbol.iterator 属性,就被视为具有 iterator 接口,就可以用 for...of 循环遍历它的成员。也就是说,for...of 循环内部调用的是数据结构的 Symbol.iterator 方法。
    for...of 循环可以使用的范围包括数组、SetMap 结构、某些类似数组的对象(比如 arguments 对象、DOM NodeList 对象)、后文的 Generator 对象,以及字符串。
  • 数组

    数组原生具备 iterator 接口(即默认部署了 Symbol.iterator 属性),for...of 循环本质上就是调用这个接口产生的遍历器,可以用下面的代码证明。
    const arr = ['red', 'green', 'blue'];
    for(let v of arr) {
      console.log(v); // red green blue
    }
    
    const obj = {};
    obj[Symbol.iterator] = arr[Symbol.iterator].bind(arr);
    
    for(let v of obj) {
      console.log(v); // red green blue
    }
    
    
    上面代码中,空对象 obj 部署了数组 arrSymbol.iterator 属性,结果 objfor...of 循环,产生了与 arr 完全一样的结果。
    for...of 循环可以代替数组实例的 forEach 方法。
    const arr = ['red', 'green', 'blue'];
    arr.forEach(function (element, index) {
      console.log(element); // red green blue
      console.log(index);   // 0 1 2
    });
    
    
    JavaScript 原有的 for...in 循环,只能获得对象的键名,不能直接获取键值。ES6 提供 for...of 循环,允许遍历获得键值。
    var arr = ['a', 'b', 'c', 'd'];
    
    for (let a in arr) {
      console.log(a); // 0 1 2 3
    }
    
    for (let a of arr) {
      console.log(a); // a b c d
    }
    
    
    上面代码表明,for...in 循环读取键名,for...of 循环读取键值。如果要通过 for...of 循环,获取数组的索引,可以借助数组实例的 entries 方法和 keys 方法(参见《数组的扩展》一章)。
    for...of 循环调用遍历器接口,数组的遍历器接口只返回具有数字索引的属性。这一点跟 for...in 循环也不一样。
    let arr = [3, 5, 7];
    arr.foo = 'hello';
    
    for (let i in arr) {
      console.log(i); // "0", "1", "2", "foo"
    }
    
    for (let i of arr) {
      console.log(i); //  "3", "5", "7"
    }
    
    
    上面代码中,for...of 循环不会返回数组 arrfoo 属性。
  • Set 和 Map 结构

    SetMap 结构也原生具有 Iterator 接口,可以直接使用 for...of 循环。
    var engines = new Set(["Gecko", "Trident", "Webkit", "Webkit"]);
    for (var e of engines) {
      console.log(e);
    }
    // Gecko
    // Trident
    // Webkit
    
    var es6 = new Map();
    es6.set("edition", 6);
    es6.set("committee", "TC39");
    es6.set("standard", "ECMA-262");
    for (var [name, value] of es6) {
      console.log(name + ": " + value);
    }
    // edition: 6
    // committee: TC39
    // standard: ECMA-262
    
    
    上面代码演示了如何遍历 Set 结构和 Map 结构。值得注意的地方有两个,首先,遍历的顺序是按照各个成员被添加进数据结构的顺序。其次,Set 结构遍历时,返回的是一个值,而 Map 结构遍历时,返回的是一个数组,该数组的两个成员分别为当前 Map 成员的键名和键值。
    let map = new Map().set('a', 1).set('b', 2);
    for (let pair of map) {
      console.log(pair);
    }
    // ['a', 1]
    // ['b', 2]
    
    for (let [key, value] of map) {
      console.log(key + ' : ' + value);
    }
    // a : 1
    // b : 2
    
    
  • 计算生成的数据结构

    有些数据结构是在现有数据结构的基础上,计算生成的。比如,ES6 的数组、Set、Map 都部署了以下三个方法,调用后都返回遍历器对象。
    • entries() 返回一个遍历器对象,用来遍历[键名, 键值]组成的数组。对于数组,键名就是索引值;对于 Set,键名与键值相同。Map 结构的 Iterator 接口,默认就是调用 entries> 方法。
    • keys() 返回一个遍历器对象,用来遍历所有的键名。
    • values() 返回一个遍历器对象,用来遍历所有的键值。
    这三个方法调用后生成的遍历器对象,所遍历的都是计算生成的数据结构。
    let arr = ['a', 'b', 'c'];
    for (let pair of arr.entries()) {
      console.log(pair);
    }
    // [0, 'a']
    // [1, 'b']
    // [2, 'c']
    
    
  • 类似数组的对象

    类似数组的对象包括好几类。下面是 for...of 循环用于字符串、DOM NodeList 对象、arguments 对象的例子。
    // 字符串
    let str = "hello";
    
    for (let s of str) {
      console.log(s); // h e l l o
    }
    
    // DOM NodeList对象
    let paras = document.querySelectorAll("p");
    
    for (let p of paras) {
      p.classList.add("test");
    }
    
    // arguments对象
    function printArgs() {
      for (let x of arguments) {
        console.log(x);
      }
    }
    printArgs('a', 'b');
    // 'a'
    // 'b'
    
    
    对于字符串来说,for...of 循环还有一个特点,就是会正确识别 32 位 UTF-16 字符。
    for (let x of 'a\uD83D\uDC0A') {
      console.log(x);
    }
    // 'a'
    // '\uD83D\uDC0A'
    
    
    并不是所有类似数组的对象都具有 Iterator 接口,一个简便的解决方法,就是使用 Array.from 方法将其转为数组。
    let arrayLike = { length: 2, 0: 'a', 1: 'b' };
    // 报错
    for (let x of arrayLike) {
      console.log(x);
    }
    
    // 正确
    for (let x of Array.from(arrayLike)) {
      console.log(x);
    }
    
    
  • 对象

    对于普通的对象,for...of 结构不能直接使用,会报错,必须部署了 Iterator 接口后才能使用。但是,这样情况下,for...in 循环依然可以用来遍历键名。
    let es6 = {
      edition: 6,
      committee: "TC39",
      standard: "ECMA-262"
    };
    
    for (let e in es6) {
      console.log(e);
    }
    // edition
    // committee
    // standard
    
    for (let e of es6) {
      console.log(e);
    }
    // TypeError: es6[Symbol.iterator] is not a function
    
    
    上面代码表示,对于普通的对象,for...in 循环可以遍历键名,for...of 循环会报错。
    一种解决方法是,使用 Object.keys 方法将对象的键名生成一个数组,然后遍历这个数组。
    for (var key of Object.keys(someObject)) {
      console.log(key + ': ' + someObject[key]);
    }
    
    
    另一个方法是使用 Generator 函数将对象重新包装一下。
    function* entries(obj) {
      for (let key of Object.keys(obj)) {
        yield [key, obj[key]];
      }
    }
    
    for (let [key, value] of entries(obj)) {
      console.log(key, '->', value);
    }
    // a -> 1
    // b -> 2
    // c -> 3
    
    
  • 与其他遍历语法的比较

    以数组为例,JavaScript 提供多种遍历语法。最原始的写法就是 for 循环。
    for (var index = 0; index < myArray.length; index++) {
      console.log(myArray[index]);
    }
    
    
    这种写法比较麻烦,因此数组提供内置的 forEach 方法。
    myArray.forEach(function (value) {
      console.log(value);
    });
    
    
    这种写法的问题在于,无法中途跳出 forEach 循环,break 命令或 return 命令都不能奏效。
    for...in 循环可以遍历数组的键名。
    for (var index in myArray) {
      console.log(myArray[index]);
    }
    
    
    for...in 循环有几个缺点。
    • 数组的键名是数字,但是 for...in 循环是以字符串作为键名“0”、“1”、“2”等等。
    • for...in 循环不仅遍历数字键名,还会遍历手动添加的其他键,甚至包括原型链上的键。
    • 某些情况下,for...in 循环会以任意顺序遍历键名。
    总之,for...in 循环主要是为遍历对象而设计的,不适用于遍历数组。
    for...of 循环相比上面几种做法,有一些显著的优点。
    for (let value of myArray) {
      console.log(value);
    }
    
    
    • 有着同 for...in 一样的简洁语法,但是没有 for...in 那些缺点。
    • 不同于 forEach 方法,它可以与 break、continuereturn 配合使用。
    • 提供了遍历所有数据结构的统一操作接口。
    下面是一个使用 break 语句,跳出 for...of 循环的例子。
    for (var n of fibonacci) {
      if (n > 1000)
        break;
      console.log(n);
    }