ES6 set 和 map 数据结构
Set
基本用法
ES6 提供了新的数据结构 Set。它类似于数组,但是成员的值都是唯一的,没有重复的值。
Set 本身是一个构造函数,用来生成 Set 数据结构。
1 | var s = new Set(); |
上面代码通过 add 方法向 Set 结构加入成员,结果表明 Set 结构不会添加重复的值。
Set 函数可以接受一个数组(或类似数组的对象)作为参数,用来初始化。
1 | // 例一 |
上面代码中,例一和例二都是 Set 函数接受数组作为参数,例三是接受类似数组的对象作为参数。
上面代码中,也展示了一种去除数组重复成员的方法。
1 | // 去除数组的重复成员 |
向 Set 加入值的时候,不会发生类型转换,所以 5 和”5”是两个不同的值。Set 内部判断两个值是否不同,使用的算法叫做“Same-value equality”,它类似于精确相等运算符(===),主要的区别是 NaN 等于自身,而精确相等运算符认为 NaN 不等于自身。
1 | let set = new Set(); |
上面代码向 Set 实例添加了两个 NaN,但是只能加入一个。这表明,在 Set 内部,两个 NaN 是相等。
另外,两个对象总是不相等的。
1 | let set = new Set(); |
上面代码表示,由于两个空对象不相等,所以它们被视为两个值。
Set 实例的属性和方法
Set 结构的实例有以下属性。
1.Set.prototype.constructor:构造函数,默认就是 Set 函数。
2.Set.prototype.size:返回 Set 实例的成员总数。
Set 实例的方法分为两大类:操作方法(用于操作数据)和遍历方法(用于遍历成员)。下面先介绍四个操作方法。
1.add(value):添加某个值,返回 Set 结构本身。
2.delete(value):删除某个值,返回一个布尔值,表示删除是否成功。
3.has(value):返回一个布尔值,表示该值是否为 Set 的成员。
4.clear():清除所有成员,没有返回值。
上面这些属性和方法的实例如下。
1 | s.add(1).add(2).add(2); |
下面是一个对比,看看在判断是否包括一个键上面,Object 结构和 Set 结构的写法不同。
1 | // 对象的写法 |
Array.from 方法可以将 Set 结构转为数组。
1 | var items = new Set([1, 2, 3, 4, 5]); |
这就提供了去除数组重复成员的另一种方法。
1 | function dedupe(array) { |
遍历操作
Set 结构的实例有四个遍历方法,可以用于遍历成员。
1.keys():返回键名的遍历器
2.values():返回键值的遍历器
3.entries():返回键值对的遍历器
4.forEach():使用回调函数遍历每个成员
需要特别指出的是,Set 的遍历顺序就是插入顺序。这个特性有时非常有用,比如使用 Set 保存一个回调函数列表,调用时就能保证按照添加顺序调用。
keys(),values(),entries()
key 方法、value 方法、entries 方法返回的都是遍历器对象(详见《Iterator 对象》一章)。由于 Set 结构没有键名,只有键值(或者说键名和键值是同一个值),所以 key 方法和 value 方法的行为完全一致。
1 | let set = new Set(['red', 'green', 'blue']); |
上面代码中,entries 方法返回的遍历器,同时包括键名和键值,所以每次输出一个数组,它的两个成员完全相等。
Set 结构的实例默认可遍历,它的默认遍历器生成函数就是它的 values 方法。
1 | Set.prototype[Symbol.iterator] === Set.prototype.values |
这意味着,可以省略 values 方法,直接用 for…of 循环遍历 Set。
1 | let set = new Set(['red', 'green', 'blue']); |
forEach()
Set 结构的实例的 forEach 方法,用于对每个成员执行某种操作,没有返回值。
1 | let set = new Set([1, 2, 3]); |
上面代码说明,forEach 方法的参数就是一个处理函数。该函数的参数依次为键值、键名、集合本身(上例省略了该参数)。另外,forEach 方法还可以有第二个参数,表示绑定的 this 对象。
遍历的应用
扩展运算符(…)内部使用 for…of 循环,所以也可以用于 Set 结构。
1 | let set = new Set(['red', 'green', 'blue']); |
扩展运算符和 Set 结构相结合,就可以去除数组的重复成员。
1 | let arr = [3, 5, 2, 2, 5, 5]; |
而且,数组的 map 和 filter 方法也可以用于 Set 了。
1 | let set = new Set([1, 2, 3]); |
因此使用 Set 可以很容易地实现并集(Union)、交集(Intersect)和差集(Difference)。
1 | let a = new Set([1, 2, 3]); |
如果想在遍历操作中,同步改变原来的 Set 结构,目前没有直接的方法,但有两种变通方法。一种是利用原 Set 结构映射出一个新的结构,然后赋值给原来的 Set 结构;另一种是利用 Array.from 方法。
1 | // 方法一 |
上面代码提供了两种方法,直接在遍历操作中改变原来的 Set 结构。
WeakSet
WeakSet 结构与 Set 类似,也是不重复的值的集合。但是,它与 Set 有两个区别。
首先,WeakSet 的成员只能是对象,而不能是其他类型的值。
其次,WeakSet 中的对象都是弱引用,即垃圾回收机制不考虑 WeakSet 对该对象的引用,也就是说,如果其他对象都不再引用该对象,那么垃圾回收机制会自动回收该对象所占用的内存,不考虑该对象还存在于 WeakSet 之中。这个特点意味着,无法引用 WeakSet 的成员,因此 WeakSet 是不可遍历的。
1 | var ws = new WeakSet(); |
上面代码试图向 WeakSet 添加一个数值和 Symbol 值,结果报错,因为 WeakSet 只能放置对象。
WeakSet 是一个构造函数,可以使用 new 命令,创建 WeakSet 数据结构。
1 | var ws = new WeakSet(); |
作为构造函数,WeakSet 可以接受一个数组或类似数组的对象作为参数。(实际上,任何具有 iterable 接口的对象,都可以作为 WeakSet 的参数。)该数组的所有成员,都会自动成为 WeakSet 实例对象的成员。
1 | var a = [[1,2], [3,4]]; |
上面代码中,a 是一个数组,它有两个成员,也都是数组。将 a 作为 WeakSet 构造函数的参数,a 的成员会自动成为 WeakSet 的成员。
注意,是 a 数组的成员成为 WeakSet 的成员,而不是 a 数组本身。这意味着,数组的成员只能是对象。
1 | var b = [3, 4]; |
上面代码中,数组 b 的成员不是对象,加入 WeaKSet 就会报错。
WeakSet 结构有以下三个方法。
1.WeakSet.prototype.add(value):向 WeakSet 实例添加一个新成员。
2.WeakSet.prototype.delete(value):清除 WeakSet 实例的指定成员。
3.WeakSet.prototype.has(value):返回一个布尔值,表示某个值是否在 WeakSet 实例之中。
下面是一个例子。
1 | var ws = new WeakSet(); |
WeakSet 没有 size 属性,没有办法遍历它的成员。
1 | ws.size // undefined |
上面代码试图获取 size 和 forEach 属性,结果都不能成功。
WeakSet 不能遍历,是因为成员都是弱引用,随时可能消失,遍历机制无法保证成员的存在,很可能刚刚遍历结束,成员就取不到了。WeakSet 的一个用处,是储存 DOM 节点,而不用担心这些节点从文档移除时,会引发内存泄漏。
下面是 WeakSet 的另一个例子。
1 | const foos = new WeakSet() |
上面代码保证了 Foo 的实例方法,只能在 Foo 的实例上调用。这里使用 WeakSet 的好处是,foos 对实例的引用,不会被计入内存回收机制,所以删除实例的时候,不用考虑 foos,也不会出现内存泄漏。
Map
Map 结构的目的和基本用法
JavaScript 的对象(Object),本质上是键值对的集合(Hash 结构),但是传统上只能用字符串当作键。这给它的使用带来了很大的限制。
1 | var data = {}; |
上面代码原意是将一个 DOM 节点作为对象 data 的键,但是由于对象只接受字符串作为键名,所以 element 被自动转为字符串[object HTMLDivElement]。
为了解决这个问题,ES6 提供了 Map 数据结构。它类似于对象,也是键值对的集合,但是“键”的范围不限于字符串,各种类型的值(包括对象)都可以当作键。也就是说,Object 结构提供了“字符串—值”的对应,Map 结构提供了“值—值”的对应,是一种更完善的 Hash 结构实现。如果你需要“键值对”的数据结构,Map 比 Object 更合适。
1 | var m = new Map(); |
上面代码使用 set 方法,将对象 o 当作 m 的一个键,然后又使用 get 方法读取这个键,接着使用 delete 方法删除了这个键。
作为构造函数,Map 也可以接受一个数组作为参数。该数组的成员是一个个表示键值对的数组。
1 | var map = new Map([ |
上面代码在新建 Map 实例时,就指定了两个键 name 和 title。
Map 构造函数接受数组作为参数,实际上执行的是下面的算法。
1 | var items = [ |
下面的例子中,字符串 true 和布尔值 true 是两个不同的键。
1 | var m = new Map([ |
如果对同一个键多次赋值,后面的值将覆盖前面的值。
1 | let map = new Map(); |
上面代码对键 1 连续赋值两次,后一次的值覆盖前一次的值。
如果读取一个未知的键,则返回 undefined。
1 | new Map().get('asfddfsasadf') |
注意,只有对同一个对象的引用,Map 结构才将其视为同一个键。这一点要非常小心。
1 | var map = new Map(); |
上面代码的 set 和 get 方法,表面是针对同一个键,但实际上这是两个值,内存地址是不一样的,因此 get 方法无法读取该键,返回 undefined。
同理,同样的值的两个实例,在 Map 结构中被视为两个键。
1 | var map = new Map(); |
上面代码中,变量 k1 和 k2 的值是一样的,但是它们在 Map 结构中被视为两个键。
由上可知,Map 的键实际上是跟内存地址绑定的,只要内存地址不一样,就视为两个键。这就解决了同名属性碰撞(clash)的问题,我们扩展别人的库的时候,如果使用对象作为键名,就不用担心自己的属性与原作者的属性同名。
如果 Map 的键是一个简单类型的值(数字、字符串、布尔值),则只要两个值严格相等,Map 将其视为一个键,包括 0 和-0。另外,虽然 NaN 不严格相等于自身,但 Map 将其视为同一个键。
1 | let map = new Map(); |
实例的属性和操作方法
Map 结构的实例有以下属性和操作方法。
size 属性
size 属性返回 Map 结构的成员总数。
1 | let map = new Map(); |
set(key, value)
set 方法设置 key 所对应的键值,然后返回整个 Map 结构。如果 key 已经有值,则键值会被更新,否则就新生成该键。
1 | var m = new Map(); |
set 方法返回的是 Map 本身,因此可以采用链式写法。
1 | let map = new Map() |
get(key)
get 方法读取 key 对应的键值,如果找不到 key,返回 undefined。
1 | var m = new Map(); |
has(key)
has 方法返回一个布尔值,表示某个键是否在 Map 数据结构中。
1 | var m = new Map(); |
delete(key)
delete 方法删除某个键,返回 true。如果删除失败,返回 false。
1 | var m = new Map(); |
clear()
clear 方法清除所有成员,没有返回值。
1 | let map = new Map(); |
遍历方法
Map 原生提供三个遍历器生成函数和一个遍历方法。
1.keys():返回键名的遍历器。
2.values():返回键值的遍历器。
3.entries():返回所有成员的遍历器。
4.forEach():遍历 Map 的所有成员。
需要特别注意的是,Map 的遍历顺序就是插入顺序。
下面是使用实例。
1 | let map = new Map([ |
上面代码最后的那个例子,表示 Map 结构的默认遍历器接口(Symbol.iterator 属性),就是 entries 方法。
1 | map[Symbol.iterator] === map.entries |
Map 结构转为数组结构,比较快速的方法是结合使用扩展运算符(…)。
1 | let map = new Map([ |
结合数组的 map 方法、filter 方法,可以实现 Map 的遍历和过滤(Map 本身没有 map 和 filter 方法)。
1 | let map0 = new Map() |
此外,Map 还有一个 forEach 方法,与数组的 forEach 方法类似,也可以实现遍历。
1 | map.forEach(function(value, key, map) { |
forEach 方法还可以接受第二个参数,用来绑定 this。
1 | var reporter = { |
上面代码中,forEach 方法的回调函数的 this,就指向 reporter。
与其他数据结构的互相转换
Map 转为数组
前面已经提过,Map 转为数组最方便的方法,就是使用扩展运算符(…)。
1 | let myMap = new Map().set(true, 7).set({foo: 3}, ['abc']); |
数组转为 Map
将数组转入 Map 构造函数,就可以转为 Map。
1 | new Map([[true, 7], [{foo: 3}, ['abc']]]) |
Map 转为对象
如果所有 Map 的键都是字符串,它可以转为对象。
1 | function strMapToObj(strMap) { |
对象转为 Map
1 | function objToStrMap(obj) { |
Map 转为 JSON
Map 转为 JSON 要区分两种情况。一种情况是,Map 的键名都是字符串,这时可以选择转为对象 JSON。
1 | function strMapToJson(strMap) { |
另一种情况是,Map 的键名有非字符串,这时可以选择转为数组 JSON。
1 | function mapToArrayJson(map) { |
JSON 转为 Map
JSON 转为 Map,正常情况下,所有键名都是字符串。
1 | function jsonToStrMap(jsonStr) { |
但是,有一种特殊情况,整个 JSON 就是一个数组,且每个数组成员本身,又是一个有两个成员的数组。这时,它可以一一对应地转为 Map。这往往是数组转为 JSON 的逆操作。
1 | function jsonToMap(jsonStr) { |
WeakMap
WeakMap 结构与 Map 结构基本类似,唯一的区别是它只接受对象作为键名(null 除外),不接受其他类型的值作为键名,而且键名所指向的对象,不计入垃圾回收机制。
1 | var map = new WeakMap() |
上面代码中,如果将 1 和 Symbol 作为 WeakMap 的键名,都会报错。
WeakMap 的设计目的在于,键名是对象的弱引用(垃圾回收机制不将该引用考虑在内),所以其所对应的对象可能会被自动回收。当对象被回收后,WeakMap 自动移除对应的键值对。典型应用是,一个对应 DOM 元素的 WeakMap 结构,当某个 DOM 元素被清除,其所对应的 WeakMap 记录就会自动被移除。基本上,WeakMap 的专用场合就是,它的键所对应的对象,可能会在将来消失。WeakMap 结构有助于防止内存泄漏。
下面是 WeakMap 结构的一个例子,可以看到用法上与 Map 几乎一样。
1 | var wm = new WeakMap(); |
上面代码中,变量 wm 是一个 WeakMap 实例,我们将一个 DOM 节点 element 作为键名,然后销毁这个节点,element 对应的键就自动消失了,再引用这个键名就返回 undefined。
WeakMap 与 Map 在 API 上的区别主要是两个,一是没有遍历操作(即没有 key()、values()和 entries()方法),也没有 size 属性;二是无法清空,即不支持 clear 方法。这与 WeakMap 的键不被计入引用、被垃圾回收机制忽略有关。因此,WeakMap 只有四个方法可用:get()、set()、has()、delete()。
1 | var wm = new WeakMap(); |
前文说过,WeakMap 应用的典型场合就是 DOM 节点作为键名。下面是一个例子。
1 | let myElement = document.getElementById('logo'); |
上面代码中,myElement 是一个 DOM 节点,每当发生 click 事件,就更新一下状态。我们将这个状态作为键值放在 WeakMap 里,对应的键名就是 myElement。一旦这个 DOM 节点删除,该状态就会自动消失,不存在内存泄漏风险。
WeakMap 的另一个用处是部署私有属性。
1 | let _counter = new WeakMap(); |
上面代码中,Countdown 类的两个内部属性_counter 和_action,是实例的弱引用,所以如果删除实例,它们也就随之消失,不会造成内存泄漏。