diff --git a/docs/set-map.md b/docs/set-map.md index ebba6de..7486a33 100644 --- a/docs/set-map.md +++ b/docs/set-map.md @@ -25,12 +25,12 @@ Set 函数可以接受一个数组（或类似数组的对象）作为参数， ```javascript // 例一 -var set = new Set([1, 2, 3, 4, 4]); +const set = new Set([1, 2, 3, 4, 4]); [...set] // [1, 2, 3, 4] // 例二 -var items = new Set([1, 2, 3, 4, 5, 5, 5, 5]); +const items = new Set([1, 2, 3, 4, 5, 5, 5, 5]); items.size // 5 // 例三 @@ -38,7 +38,7 @@ function divs () { return [...document.querySelectorAll('div')]; } -var set = new Set(divs()); +const set = new Set(divs()); set.size // 56 // 类似于 @@ -116,7 +116,7 @@ s.has(2) // false ```javascript // 对象的写法 -var properties = { +const properties = { 'width': 1, 'height': 1 }; @@ -126,7 +126,7 @@ if (properties[someName]) { } // Set的写法 -var properties = new Set(); +const properties = new Set(); properties.add('width'); properties.add('height'); @@ -136,11 +136,11 @@ if (properties.has(someName)) { } ``` -`Array.from`方法可以将Set结构转为数组。 +`Array.from`方法可以将 Set 结构转为数组。 ```javascript -var items = new Set([1, 2, 3, 4, 5]); -var array = Array.from(items); +const items = new Set([1, 2, 3, 4, 5]); +const array = Array.from(items); ``` 这就提供了去除数组重复成员的另一种方法。 @@ -296,59 +296,60 @@ set = new Set(Array.from(set, val => val * 2)); ## WeakSet -WeakSet结构与Set类似，也是不重复的值的集合。但是，它与Set有两个区别。 +WeakSet 结构与 Set 类似，也是不重复的值的集合。但是，它与 Set 有两个区别。 -首先，WeakSet的成员只能是对象，而不能是其他类型的值。 - -其次，WeakSet中的对象都是弱引用，即垃圾回收机制不考虑WeakSet对该对象的引用，也就是说，如果其他对象都不再引用该对象，那么垃圾回收机制会自动回收该对象所占用的内存，不考虑该对象还存在于WeakSet之中。这个特点意味着，无法引用WeakSet的成员，因此WeakSet是不可遍历的。 +首先，WeakSet 的成员只能是对象，而不能是其他类型的值。 ```javascript -var ws = new WeakSet(); +const ws = new WeakSet(); ws.add(1) // TypeError: Invalid value used in weak set ws.add(Symbol()) // TypeError: invalid value used in weak set ``` -上面代码试图向WeakSet添加一个数值和`Symbol`值，结果报错，因为WeakSet只能放置对象。 +上面代码试图向 WeakSet 添加一个数值和`Symbol`值，结果报错，因为 WeakSet 只能放置对象。 -WeakSet是一个构造函数，可以使用`new`命令，创建WeakSet数据结构。 +其次，WeakSet 中的对象都是弱引用，即垃圾回收机制不考虑 WeakSet 对该对象的引用，也就是说，如果其他对象都不再引用该对象，那么垃圾回收机制会自动回收该对象所占用的内存，不考虑该对象还存在于 WeakSet 之中。这个特点意味着，无法引用 WeakSet 的成员，因此 WeakSet 是不可遍历的。 + +WeakSet 是一个构造函数，可以使用`new`命令，创建 WeakSet 数据结构。 ```javascript -var ws = new WeakSet(); +const ws = new WeakSet(); ``` -作为构造函数，WeakSet可以接受一个数组或类似数组的对象作为参数。（实际上，任何具有iterable接口的对象，都可以作为WeakSet的参数。）该数组的所有成员，都会自动成为WeakSet实例对象的成员。 +作为构造函数，WeakSet 可以接受一个数组或类似数组的对象作为参数。（实际上，任何具有 Iterable 接口的对象，都可以作为 WeakSet 的参数。）该数组的所有成员，都会自动成为 WeakSet 实例对象的成员。 ```javascript -var a = [[1,2], [3,4]]; -var ws = new WeakSet(a); +const a = [[1, 2], [3, 4]]; +const ws = new WeakSet(a); +// WeakSet {[1, 2], [3, 4]} ``` -上面代码中，`a`是一个数组，它有两个成员，也都是数组。将`a`作为WeakSet构造函数的参数，`a`的成员会自动成为WeakSet的成员。 +上面代码中，`a`是一个数组，它有两个成员，也都是数组。将`a`作为 WeakSet 构造函数的参数，`a`的成员会自动成为 WeakSet 的成员。 -注意，是`a`数组的成员成为WeakSet的成员，而不是`a`数组本身。这意味着，数组的成员只能是对象。 +注意，是`a`数组的成员成为 WeakSet 的成员，而不是`a`数组本身。这意味着，数组的成员只能是对象。 ```javascript -var b = [3, 4]; -var ws = new WeakSet(b); +const b = [3, 4]; +const ws = new WeakSet(b); // Uncaught TypeError: Invalid value used in weak set(…) ``` -上面代码中，数组`b`的成员不是对象，加入WeaKSet就会报错。 +上面代码中，数组`b`的成员不是对象，加入 WeaKSet 就会报错。 -WeakSet结构有以下三个方法。 +WeakSet 结构有以下三个方法。 -- **WeakSet.prototype.add(value)**：向WeakSet实例添加一个新成员。 -- **WeakSet.prototype.delete(value)**：清除WeakSet实例的指定成员。 -- **WeakSet.prototype.has(value)**：返回一个布尔值，表示某个值是否在WeakSet实例之中。 +- **WeakSet.prototype.add(value)**：向 WeakSet 实例添加一个新成员。 +- **WeakSet.prototype.delete(value)**：清除 WeakSet 实例的指定成员。 +- **WeakSet.prototype.has(value)**：返回一个布尔值，表示某个值是否在 WeakSet 实例之中。 下面是一个例子。 ```javascript -var ws = new WeakSet(); -var obj = {}; -var foo = {}; +const ws = new WeakSet(); +const obj = {}; +const foo = {}; ws.add(window); ws.add(obj); @@ -394,25 +395,25 @@ class Foo { ## Map -### Map结构的目的和基本用法 +### 含义和基本用法 -JavaScript的对象（Object），本质上是键值对的集合（Hash结构），但是传统上只能用字符串当作键。这给它的使用带来了很大的限制。 +JavaScript 的对象（Object），本质上是键值对的集合（Hash 结构），但是传统上只能用字符串当作键。这给它的使用带来了很大的限制。 ```javascript -var data = {}; -var element = document.getElementById('myDiv'); +const data = {}; +const element = document.getElementById('myDiv'); data[element] = 'metadata'; data['[object HTMLDivElement]'] // "metadata" ``` -上面代码原意是将一个DOM节点作为对象`data`的键，但是由于对象只接受字符串作为键名，所以`element`被自动转为字符串`[object HTMLDivElement]`。 +上面代码原意是将一个 DOM 节点作为对象`data`的键，但是由于对象只接受字符串作为键名，所以`element`被自动转为字符串`[object HTMLDivElement]`。 -为了解决这个问题，ES6提供了Map数据结构。它类似于对象，也是键值对的集合，但是“键”的范围不限于字符串，各种类型的值（包括对象）都可以当作键。也就是说，Object结构提供了“字符串—值”的对应，Map结构提供了“值—值”的对应，是一种更完善的Hash结构实现。如果你需要“键值对”的数据结构，Map比Object更合适。 +为了解决这个问题，ES6 提供了 Map 数据结构。它类似于对象，也是键值对的集合，但是“键”的范围不限于字符串，各种类型的值（包括对象）都可以当作键。也就是说，Object 结构提供了“字符串—值”的对应，Map结构提供了“值—值”的对应，是一种更完善的 Hash 结构实现。如果你需要“键值对”的数据结构，Map 比 Object 更合适。 ```javascript -var m = new Map(); -var o = {p: 'Hello World'}; +const m = new Map(); +const o = {p: 'Hello World'}; m.set(o, 'content') m.get(o) // "content" @@ -422,12 +423,12 @@ m.delete(o) // true m.has(o) // false ``` -上面代码使用`set`方法，将对象`o`当作`m`的一个键，然后又使用`get`方法读取这个键，接着使用`delete`方法删除了这个键。 +上面代码使用 Map 结构的`set`方法，将对象`o`当作`m`的一个键，然后又使用`get`方法读取这个键，接着使用`delete`方法删除了这个键。 -作为构造函数，Map也可以接受一个数组作为参数。该数组的成员是一个个表示键值对的数组。 +上面的例子展示了如何向 Map 添加成员。作为构造函数，Map 也可以接受一个数组作为参数。该数组的成员是一个个表示键值对的数组。 ```javascript -var map = new Map([ +const map = new Map([ ['name', '张三'], ['title', 'Author'] ]); @@ -439,35 +440,44 @@ map.has('title') // true map.get('title') // "Author" ``` -上面代码在新建Map实例时，就指定了两个键`name`和`title`。 +上面代码在新建 Map 实例时，就指定了两个键`name`和`title`。 -Map构造函数接受数组作为参数，实际上执行的是下面的算法。 +`Map`构造函数接受数组作为参数，实际上执行的是下面的算法。 ```javascript -var items = [ +const items = [ ['name', '张三'], ['title', 'Author'] ]; -var map = new Map(); -items.forEach(([key, value]) => map.set(key, value)); + +const map = new Map(); + +items.forEach( + ([key, value]) => map.set(key, value) +); ``` -下面的例子中，字符串`true`和布尔值`true`是两个不同的键。 +事实上，不仅仅是数组，任何具有 Iterator 接口的数据结构（详见《Iterator》一章）都可以当作`Map`构造函数的参数。这就是说，`Set`和`Map`都可以用来生成新的 Map。 ```javascript -var m = new Map([ - [true, 'foo'], - ['true', 'bar'] +const set = new Set([ + ['foo', 1], + ['bar', 2] ]); +const m1 = new Map(set); +m1.get('foo') // 1 -m.get(true) // 'foo' -m.get('true') // 'bar' +const m2 = new Map([['baz', 3]]); +const m3 = new Map(m2); +m3.get('baz') // 3 ``` +上面代码中，我们分别使用 Set 对象和 Map 对象，当作`Map`构造函数的参数，结果都生成了新的 Map 对象。 + 如果对同一个键多次赋值，后面的值将覆盖前面的值。 ```javascript -let map = new Map(); +const map = new Map(); map .set(1, 'aaa') @@ -485,10 +495,10 @@ new Map().get('asfddfsasadf') // undefined ``` -注意，只有对同一个对象的引用，Map结构才将其视为同一个键。这一点要非常小心。 +注意，只有对同一个对象的引用，Map 结构才将其视为同一个键。这一点要非常小心。 ```javascript -var map = new Map(); +const map = new Map(); map.set(['a'], 555); map.get(['a']) // undefined @@ -496,13 +506,13 @@ map.get(['a']) // undefined 上面代码的`set`和`get`方法，表面是针对同一个键，但实际上这是两个值，内存地址是不一样的，因此`get`方法无法读取该键，返回`undefined`。 -同理，同样的值的两个实例，在Map结构中被视为两个键。 +同理，同样的值的两个实例，在 Map 结构中被视为两个键。 ```javascript -var map = new Map(); +const map = new Map(); -var k1 = ['a']; -var k2 = ['a']; +const k1 = ['a']; +const k2 = ['a']; map .set(k1, 111) @@ -512,20 +522,28 @@ map.get(k1) // 111 map.get(k2) // 222 ``` -上面代码中，变量`k1`和`k2`的值是一样的，但是它们在Map结构中被视为两个键。 +上面代码中，变量`k1`和`k2`的值是一样的，但是它们在 Map 结构中被视为两个键。 -由上可知，Map的键实际上是跟内存地址绑定的，只要内存地址不一样，就视为两个键。这就解决了同名属性碰撞（clash）的问题，我们扩展别人的库的时候，如果使用对象作为键名，就不用担心自己的属性与原作者的属性同名。 +由上可知，Map 的键实际上是跟内存地址绑定的，只要内存地址不一样，就视为两个键。这就解决了同名属性碰撞（clash）的问题，我们扩展别人的库的时候，如果使用对象作为键名，就不用担心自己的属性与原作者的属性同名。 -如果Map的键是一个简单类型的值（数字、字符串、布尔值），则只要两个值严格相等，Map将其视为一个键，包括`0`和`-0`。另外，虽然`NaN`不严格相等于自身，但Map将其视为同一个键。 +如果 Map 的键是一个简单类型的值（数字、字符串、布尔值），则只要两个值严格相等，Map 将其视为一个键，包括`0`和`-0`，布尔值`true`和字符串`true`则是两个不同的键。另外，`undefined`和`null`也是两个不同的键。虽然`NaN`不严格相等于自身，但 Map 将其视为同一个键。 ```javascript let map = new Map(); -map.set(NaN, 123); -map.get(NaN) // 123 - map.set(-0, 123); map.get(+0) // 123 + +map.set(true, 1); +map.set('true', 2); +map.get(true) // 1 + +map.set(undefined, 3); +map.set(null, 4); +map.get(undefined) // 3 + +map.set(NaN, 123); +map.get(NaN) // 123 ``` ### 实例的属性和操作方法 @@ -534,10 +552,10 @@ Map结构的实例有以下属性和操作方法。 **（1）size属性** -`size`属性返回Map结构的成员总数。 +`size`属性返回 Map 结构的成员总数。 ```javascript -let map = new Map(); +const map = new Map(); map.set('foo', true); map.set('bar', false); @@ -546,17 +564,17 @@ map.size // 2 **（2）set(key, value)** -`set`方法设置`key`所对应的键值，然后返回整个Map结构。如果`key`已经有值，则键值会被更新，否则就新生成该键。 +`set`方法设置键名`key`对应的键值为`value`，然后返回整个 Map 结构。如果`key`已经有值，则键值会被更新，否则就新生成该键。 ```javascript -var m = new Map(); +const m = new Map(); -m.set("edition", 6) // 键是字符串 -m.set(262, "standard") // 键是数值 -m.set(undefined, "nah") // 键是undefined +m.set('edition', 6) // 键是字符串 +m.set(262, 'standard') // 键是数值 +m.set(undefined, 'nah') // 键是 undefined ``` -`set`方法返回的是Map本身，因此可以采用链式写法。 +`set`方法返回的是当前的`Map`对象，因此可以采用链式写法。 ```javascript let map = new Map() @@ -570,43 +588,44 @@ let map = new Map() `get`方法读取`key`对应的键值，如果找不到`key`，返回`undefined`。 ```javascript -var m = new Map(); +const m = new Map(); -var hello = function() {console.log("hello");} -m.set(hello, "Hello ES6!") // 键是函数 +const hello = function() {console.log('hello');}; +m.set(hello, 'Hello ES6!') // 键是函数 m.get(hello) // Hello ES6! ``` **（4）has(key)** -`has`方法返回一个布尔值，表示某个键是否在Map数据结构中。 +`has`方法返回一个布尔值，表示某个键是否在当前 Map 对象之中。 ```javascript -var m = new Map(); +const m = new Map(); -m.set("edition", 6); -m.set(262, "standard"); -m.set(undefined, "nah"); +m.set('edition', 6); +m.set(262, 'standard'); +m.set(undefined, 'nah'); -m.has("edition") // true -m.has("years") // false +m.has('edition') // true +m.has('years') // false m.has(262) // true m.has(undefined) // true ``` **（5）delete(key)** -`delete`方法删除某个键，返回true。如果删除失败，返回false。 +`delete`方法删除某个键，返回`true`。如果删除失败，返回`false`。 ```javascript -var m = new Map(); -m.set(undefined, "nah"); +const m = new Map(); +m.set(undefined, 'nah'); m.has(undefined) // true m.delete(undefined) m.has(undefined) // false ``` + **（6）clear()** `clear`方法清除所有成员，没有返回值。 @@ -623,19 +642,17 @@ map.size // 0 ### 遍历方法 -Map原生提供三个遍历器生成函数和一个遍历方法。 +Map 结构原生提供三个遍历器生成函数和一个遍历方法。 - `keys()`：返回键名的遍历器。 - `values()`：返回键值的遍历器。 - `entries()`：返回所有成员的遍历器。 -- `forEach()`：遍历Map的所有成员。 +- `forEach()`：遍历 Map 的所有成员。 -需要特别注意的是，Map的遍历顺序就是插入顺序。 - -下面是使用实例。 +需要特别注意的是，Map 的遍历顺序就是插入顺序。 ```javascript -let map = new Map([ +const map = new Map([ ['F', 'no'], ['T', 'yes'], ]); @@ -662,24 +679,28 @@ for (let item of map.entries()) { for (let [key, value] of map.entries()) { console.log(key, value); } +// "F" "no" +// "T" "yes" // 等同于使用map.entries() for (let [key, value] of map) { console.log(key, value); } +// "F" "no" +// "T" "yes" ``` -上面代码最后的那个例子，表示Map结构的默认遍历器接口（`Symbol.iterator`属性），就是`entries`方法。 +上面代码最后的那个例子，表示 Map 结构的默认遍历器接口（`Symbol.iterator`属性），就是`entries`方法。 ```javascript map[Symbol.iterator] === map.entries // true ``` -Map结构转为数组结构，比较快速的方法是结合使用扩展运算符（`...`）。 +Map 结构转为数组结构，比较快速的方法是使用扩展运算符（`...`）。 ```javascript -let map = new Map([ +const map = new Map([ [1, 'one'], [2, 'two'], [3, 'three'], @@ -698,26 +719,26 @@ let map = new Map([ // [[1,'one'], [2, 'two'], [3, 'three']] ``` -结合数组的`map`方法、`filter`方法，可以实现Map的遍历和过滤（Map本身没有`map`和`filter`方法）。 +结合数组的`map`方法、`filter`方法，可以实现 Map 的遍历和过滤（Map 本身没有`map`和`filter`方法）。 ```javascript -let map0 = new Map() +const map0 = new Map() .set(1, 'a') .set(2, 'b') .set(3, 'c'); -let map1 = new Map( +const map1 = new Map( [...map0].filter(([k, v]) => k < 3) ); -// 产生Map结构 {1 => 'a', 2 => 'b'} +// 产生 Map 结构 {1 => 'a', 2 => 'b'} -let map2 = new Map( +const map2 = new Map( [...map0].map(([k, v]) => [k * 2, '_' + v]) ); -// 产生Map结构 {2 => '_a', 4 => '_b', 6 => '_c'} +// 产生 Map 结构 {2 => '_a', 4 => '_b', 6 => '_c'} ``` -此外，Map还有一个`forEach`方法，与数组的`forEach`方法类似，也可以实现遍历。 +此外，Map 还有一个`forEach`方法，与数组的`forEach`方法类似，也可以实现遍历。 ```javascript map.forEach(function(value, key, map) { @@ -728,7 +749,7 @@ map.forEach(function(value, key, map) { `forEach`方法还可以接受第二个参数，用来绑定`this`。 ```javascript -var reporter = { +const reporter = { report: function(key, value) { console.log("Key: %s, Value: %s", key, value); } @@ -743,28 +764,36 @@ map.forEach(function(value, key, map) { ### 与其他数据结构的互相转换 -**（1）Map转为数组** +**（1）Map 转为数组** -前面已经提过，Map转为数组最方便的方法，就是使用扩展运算符（...）。 +前面已经提过，Map 转为数组最方便的方法，就是使用扩展运算符（`...`）。 ```javascript -let myMap = new Map().set(true, 7).set({foo: 3}, ['abc']); +const myMap = new Map() + .set(true, 7) + .set({foo: 3}, ['abc']); [...myMap] // [ [ true, 7 ], [ { foo: 3 }, [ 'abc' ] ] ] ``` -**（2）数组转为Map** +**（2）数组 转为 Map** -将数组转入Map构造函数，就可以转为Map。 +将数组转入 Map 构造函数，就可以转为 Map。 ```javascript -new Map([[true, 7], [{foo: 3}, ['abc']]]) -// Map {true => 7, Object {foo: 3} => ['abc']} +new Map([ + [true, 7], + [{foo: 3}, ['abc']] +]) +// Map { +// true => 7, +// Object {foo: 3} => ['abc'] +// } ``` -**（3）Map转为对象** +**（3）Map 转为对象** -如果所有Map的键都是字符串，它可以转为对象。 +如果所有 Map 的键都是字符串，它可以转为对象。 ```javascript function strMapToObj(strMap) { @@ -775,12 +804,14 @@ function strMapToObj(strMap) { return obj; } -let myMap = new Map().set('yes', true).set('no', false); +const myMap = new Map() + .set('yes', true) + .set('no', false); strMapToObj(myMap) // { yes: true, no: false } ``` -**（4）对象转为Map** +**（4）对象转为 Map** ```javascript function objToStrMap(obj) { @@ -792,12 +823,12 @@ function objToStrMap(obj) { } objToStrMap({yes: true, no: false}) -// [ [ 'yes', true ], [ 'no', false ] ] +// Map {"yes" => true, "no" => false} ``` -**（5）Map转为JSON** +**（5）Map 转为 JSON** -Map转为JSON要区分两种情况。一种情况是，Map的键名都是字符串，这时可以选择转为对象JSON。 +Map 转为 JSON 要区分两种情况。一种情况是，Map 的键名都是字符串，这时可以选择转为对象 JSON。 ```javascript function strMapToJson(strMap) { @@ -809,7 +840,7 @@ strMapToJson(myMap) // '{"yes":true,"no":false}' ``` -另一种情况是，Map的键名有非字符串，这时可以选择转为数组JSON。 +另一种情况是，Map 的键名有非字符串，这时可以选择转为数组 JSON。 ```javascript function mapToArrayJson(map) { @@ -821,20 +852,20 @@ mapToArrayJson(myMap) // '[[true,7],[{"foo":3},["abc"]]]' ``` -**（6）JSON转为Map** +**（6）JSON 转为 Map** -JSON转为Map，正常情况下，所有键名都是字符串。 +JSON 转为 Map，正常情况下，所有键名都是字符串。 ```javascript function jsonToStrMap(jsonStr) { return objToStrMap(JSON.parse(jsonStr)); } -jsonToStrMap('{"yes":true,"no":false}') +jsonToStrMap('{"yes": true, "no": false}') // Map {'yes' => true, 'no' => false} ``` -但是，有一种特殊情况，整个JSON就是一个数组，且每个数组成员本身，又是一个有两个成员的数组。这时，它可以一一对应地转为Map。这往往是数组转为JSON的逆操作。 +但是，有一种特殊情况，整个 JSON 就是一个数组，且每个数组成员本身，又是一个有两个成员的数组。这时，它可以一一对应地转为Map。这往往是数组转为 JSON 的逆操作。 ```javascript function jsonToMap(jsonStr) { @@ -847,27 +878,74 @@ jsonToMap('[[true,7],[{"foo":3},["abc"]]]') ## WeakMap -`WeakMap`结构与`Map`结构基本类似，唯一的区别是它只接受对象作为键名（`null`除外），不接受其他类型的值作为键名，而且键名所指向的对象，不计入垃圾回收机制。 +### 含义和用法 + +`WeakMap`结构与`Map`结构类似，也是用于生成键值对。 ```javascript -var map = new WeakMap() +// WeakMap 可以使用 set 方法添加成员 +const wm1 = new WeakMap(); +const key = {foo: 1}; +wm1.set(key, 2); +wm1.get(key) // 2 + +// WeakMap 也可以接受一个数组， +// 作为构造函数的参数 +const k1 = [1, 2, 3]; +const k2 = [4, 5, 6]; +const wm2 = new WeakMap([[k1, 'foo'], [k2, 'bar']]); +wm2.get(k2) // "bar" +``` + +`WeakMap`与`Map`的区别有两点。 + +首先，`WeakMap`只接受对象作为键名（`null`除外），不接受其他类型的值作为键名。 + +```javascript +const map = new WeakMap(); map.set(1, 2) // TypeError: 1 is not an object! map.set(Symbol(), 2) // TypeError: Invalid value used as weak map key ``` -上面代码中，如果将`1`和`Symbol`作为WeakMap的键名，都会报错。 +上面代码中，如果将数值`1`和`Symbol`值作为 WeakMap 的键名，都会报错。 -`WeakMap`的设计目的在于，键名是对象的弱引用（垃圾回收机制不将该引用考虑在内），所以其所对应的对象可能会被自动回收。当对象被回收后，`WeakMap`自动移除对应的键值对。典型应用是，一个对应DOM元素的`WeakMap`结构，当某个DOM元素被清除，其所对应的`WeakMap`记录就会自动被移除。基本上，`WeakMap`的专用场合就是，它的键所对应的对象，可能会在将来消失。`WeakMap`结构有助于防止内存泄漏。 +其次，`WeakMap`的键名所指向的对象，不计入垃圾回收机制。 -下面是`WeakMap`结构的一个例子，可以看到用法上与`Map`几乎一样。 +`WeakMap`的设计目的在于，有时我们想在某个对象上面存放一些数据，但是这会形成对于这个对象的引用。请看下面的例子。 ```javascript -var wm = new WeakMap(); -var element = document.querySelector(".element"); +const e1 = document.getElementById('foo'); +const e2 = document.getElementById('bar'); +const arr = [ + [e1, 'foo 元素'], + [e2, 'bar 元素'], +]; +``` -wm.set(element, "Original"); +上面代码中，`e1`和`e2`是两个对象，我们通过`arr`数组对这两个对象添加一些文字说明。这就形成了`arr`对`e1`和`e2`的引用。 + +一旦不再需要这两个对象，我们就必须手动删除这个引用，否则垃圾回收机制就不会释放`e1`和`e2`占用的内存。 + +```javascript +// 不需要 e1 和 e2 的时候 +// 必须手动删除引用 +arr [0] = null; +arr [1] = null; +``` + +上面这样的写法显然很不方便。一旦忘了写，就会造成内存泄露。 + +WeakMap 就是为了解决这个问题而诞生的，它的键名所引用的对象都是弱引用，即垃圾回收机制不将该引用考虑在内。因此，只要所引用的对象的其他引用都被清除，垃圾回收机制就会释放该对象所占用的内存。也就是说，一旦不再需要，WeakMap 里面的键名对象和所对应的键值对会自动消失，不用手动删除引用。 + +基本上，如果你要往对象上添加数据，又不想干扰垃圾回收机制，就可以使用 WeakMap。一个典型应用场景是，在网页的 DOM 元素上添加数据，就可以使用`WeakMap`结构。当该 DOM 元素被清除，其所对应的`WeakMap`记录就会自动被移除。 + +```javascript +const wm = new WeakMap(); +const element = document.querySelector('.element'); + +wm.set(element, 'Original'); wm.get(element) // "Original" element.parentNode.removeChild(element); @@ -877,19 +955,37 @@ wm.get(element) // undefined 上面代码中，变量`wm`是一个`WeakMap`实例，我们将一个`DOM`节点`element`作为键名，然后销毁这个节点，`element`对应的键就自动消失了，再引用这个键名就返回`undefined`。 -WeakMap与Map在API上的区别主要是两个，一是没有遍历操作（即没有`key()`、`values()`和`entries()`方法），也没有`size`属性；二是无法清空，即不支持`clear`方法。这与`WeakMap`的键不被计入引用、被垃圾回收机制忽略有关。因此，`WeakMap`只有四个方法可用：`get()`、`set()`、`has()`、`delete()`。 +总之，`WeakMap`的专用场合就是，它的键所对应的对象，可能会在将来消失。`WeakMap`结构有助于防止内存泄漏。 + +注意，WeakMap 弱引用的只是键名，而不是键值。键值依然是正常引用。 ```javascript -var wm = new WeakMap(); +const wm = new WeakMap(); +let key = {}; +let obj = {foo: 1}; -wm.size -// undefined - -wm.forEach -// undefined +wm.set(key, obj); +obj = null; +wm.get(key) +// Object {foo: 1} ``` -前文说过，WeakMap应用的典型场合就是DOM节点作为键名。下面是一个例子。 +上面代码中，键值`obj`是正常引用。所以，即使在 WeakMap 外部消除了`obj`的引用，WeakMap 内部的引用依然存在。 + +WeakMap 与 Map 在 API 上的区别主要是两个，一是没有遍历操作（即没有`key()`、`values()`和`entries()`方法），也没有`size`属性。因为没有办法列出所有键名，这个键名是否存在完全不可预测，跟垃圾回收机制是否运行相关。二是无法清空，即不支持`clear`方法。因此，`WeakMap`只有四个方法可用：`get()`、`set()`、`has()`、`delete()`。 + +```javascript +const wm = new WeakMap(); + +// size、forEach、clear 方法都不存在 +wm.size // undefined +wm.forEach // undefined +wm.clear // undefined +``` + +### WeakMap 的用途 + +前文说过，WeakMap 应用的典型场合就是 DOM 节点作为键名。下面是一个例子。 ```javascript let myElement = document.getElementById('logo'); @@ -905,11 +1001,25 @@ myElement.addEventListener('click', function() { 上面代码中，`myElement`是一个 DOM 节点，每当发生`click`事件，就更新一下状态。我们将这个状态作为键值放在 WeakMap 里，对应的键名就是`myElement`。一旦这个 DOM 节点删除，该状态就会自动消失，不存在内存泄漏风险。 +进一步说，注册监听事件的`listener`对象，就很合适用 WeakMap 实现。 + +```javascript +const listener = new WeakMap(); + +listener.set(element1, handler1); +listener.set(element2, handler2); + +element1.addEventListener('click', listener.get(element1), false); +element2.addEventListener('click', listener.get(element2), false); +``` + +上面代码中，监听函数放在 WeakMap 里面。一旦 DOM 对象消失，跟它绑定的监听函数也会自动消失。 + WeakMap 的另一个用处是部署私有属性。 ```javascript -let _counter = new WeakMap(); -let _action = new WeakMap(); +const _counter = new WeakMap(); +const _action = new WeakMap(); class Countdown { constructor(counter, action) { @@ -927,11 +1037,11 @@ class Countdown { } } -let c = new Countdown(2, () => console.log('DONE')); +const c = new Countdown(2, () => console.log('DONE')); c.dec() c.dec() // DONE ``` -上面代码中，Countdown类的两个内部属性`_counter`和`_action`，是实例的弱引用，所以如果删除实例，它们也就随之消失，不会造成内存泄漏。 +上面代码中，`Countdown`类的两个内部属性`_counter`和`_action`，是实例的弱引用，所以如果删除实例，它们也就随之消失，不会造成内存泄漏。