es6的Set 和 Map 数据结构
es6的Set 和 Map 数据结构
一、Set
1. 基本用法
ES6 提供了新的数据结构 Set。它类似于数组,但是成员的值都是唯一的,没有重复的值。
Set本身是一个构造函数,用来生成 Set 数据结构。
const s = new Set();
[2, 3, 5, 4, 5, 2, 2].forEach(x => s.add(x));
for (let i of s) {
console.log(i);
}
// 2 3 5 4
上面代码通过add()方法向 Set 结构加入成员,结果表明 Set 结构不会添加重复的值。
Set()函数可以接受一个数组(或者具有 iterable 接口的其他数据结构)作为参数,用来初始化。
// 例一
const set = new Set([1, 2, 3, 4, 4]);
[...set]
// [1, 2, 3, 4]
// 例二
const items = new Set([1, 2, 3, 4, 5, 5, 5, 5]);
items.size // 5
上面代码中,例一和例二都是Set函数接受 数组 作为 参数,除了数组,Set函数也接受 类似数组的对象 作为 参数。
上面代码也展示了一种去除数组重复成员的方法。
// 去除数组的重复成员
[...new Set(array)]
上面的方法也可以用于,去除字符串里面的重复字符。
[...new Set('ababbc')].join('')
// "abc"
向 Set 加入值的时候,不会发生类型转换,所以5和"5"是两个不同的值。Set 内部判断两个值是否不同,使用的算法叫做“Same-value-zero equality”,它类似于精确相等运算符(===),主要的区别是向 Set 加入值时认为NaN等于自身,而精确相等运算符认为NaN不等于自身。
let set = new Set([5, '5', NaN, NaN, {}, {}]);
...set // 5 '5' NaN {} {}
上面代码向 Set 实例添加了两次NaN,但是只会加入一个。这表明,在 Set 内部,两个NaN是相等的;而两个对象总是不相等的。
Array.from()方法可以将 Set 结构转为数组。
const items = new Set([1, 2, 3, 4, 5]);
const array = Array.from(items);
// [1, 2, 3, 4, 5]
这就提供了去除数组重复成员的另一种方法。
function dedupe(array) {
return Array.from(new Set(array));
}
dedupe([1, 1, 2, 3, 3, 2]) // [1, 2, 3]
2. Set 实例的属性和方法
Set 结构的实例有以下属性:
Set.prototype.constructor:构造函数,默认就是Set函数;Set.prototype.size:返回Set实例的成员总数;
Set 实例的方法分为两大类:操作方法(用于操作数据)和 遍历方法(用于遍历成员)。下面先介绍四个操作方法。
Set.prototype.add(value):添加某个值,返回Set结构本身;Set.prototype.delete(value):删除某个值,返回一个布尔值,表示删除是否成功;Set.prototype.has(value):返回一个布尔值,表示该值是否为Set的成员;Set.prototype.clear():清除所有成员,没有返回值;
上面这些属性和方法的实例如下:
s.add(1).add(2).add(2);
// 注意2被加入了两次
s.size // 2
s.has(1) // true
s.has(2) // true
s.has(3) // false
s.delete(2) // true
s.has(2) // false
3. 遍历操作
Set 结构的实例有四个遍历方法,可以用于遍历成员:
Set.prototype.keys():返回键名的遍历器;Set.prototype.values():返回键值的遍历器;Set.prototype.entries():返回键值对的遍历器;Set.prototype.forEach():使用回调函数遍历每个成员;
需要特别指出的是,Set的遍历顺序就是 插入顺序。这个特性有时非常有用,比如使用 Set 保存一个回调函数列表,调用时就能保证按照添加顺序调用。
3.1 keys(),values(),entries()
keys方法、values方法、entries方法返回的都是遍历器对象。由于 Set 结构没有键名,只有键值(或者说键名和键值是同一个值),所以keys方法和values方法的行为完全一致。
let set = new Set(['red', 'green', 'blue']);
for (let item of set.keys()) {
console.log(item);
}
// red
// green
// blue
for (let item of set.values()) {
console.log(item);
}
// red
// green
// blue
for (let item of set.entries()) {
console.log(item);
}
// ["red", "red"]
// ["green", "green"]
// ["blue", "blue"]
Set 结构的实例默认可遍历,它的默认遍历器生成函数就是它的values方法:
Set.prototype[Symbol.iterator] === Set.prototype.values
// true
这意味着,可以省略values方法,直接用for...of循环遍历 Set:
let set = new Set(['red', 'green', 'blue']);
for (let x of set) {
console.log(x);
}
// red
// green
// blue
3.2 forEach()
Set 结构的实例与数组一样,也拥有forEach方法,用于对每个成员执行某种操作,没有返回值。
let set = new Set([1, 4, 9]);
set.forEach((value, key) => console.log(key + ' : ' + value))
// 1 : 1
// 4 : 4
// 9 : 9
上面代码说明,forEach方法的参数就是一个处理函数。该函数的参数与数组的forEach一致,依次为键值、键名、集合本身(上例省略了该参数)。这里需要注意,Set 结构的键名就是键值(两者是同一个值),因此第一个参数与第二个参数的值永远都是一样的。
另外,forEach方法还可以有第二个参数,表示绑定处理函数内部的this对象。
3.3 遍历的应用
扩展运算符(...)内部使用for...of循环,所以也可以用于 Set 结构。
let set = new Set(['red', 'green', 'blue']);
let arr = [...set];
// ['red', 'green', 'blue']
扩展运算符和 Set 结构相结合,就可以去除数组的重复成员。
let arr = [3, 5, 2, 2, 5, 5];
let unique = [...new Set(arr)];
// [3, 5, 2]
而且,数组的map和filter方法也可以间接用于 Set 了。
思路:先通过扩展运算符(...)转化为数组,再通过 Set 方法转化回 set。
let set = new Set([1, 2, 3]);
set = new Set([...set].map(x => x * 2));
// 返回Set结构:{2, 4, 6}
let set = new Set([1, 2, 3, 4, 5]);
set = new Set([...set].filter(x => (x % 2) == 0));
// 返回Set结构:{2, 4}
因此使用 Set 可以很容易地实现 并集(Union)、交集(Intersect)和差集(Difference)。
let a = new Set([1, 2, 3]);
let b = new Set([4, 3, 2]);
// 并集
let union = new Set([...a, ...b]);
// Set {1, 2, 3, 4}
// 交集
let intersect = new Set([...a].filter(x => b.has(x)));
// set {2, 3}
// (a 相对于 b 的)差集
let difference = new Set([...a].filter(x => !b.has(x)));
// Set {1}
如果想在遍历操作中,同步改变原来的 Set 结构,目前没有直接的方法,但有两种变通方法。一种是利用原 Set 结构映射出一个新的结构,然后赋值给原来的 Set 结构;另一种是直接利用Array.from方法改变在转换为 Set。
下面代码是上面两种方法的演示,直接在遍历操作中改变原来的 Set 结构。
// 方法一
let set = new Set([1, 2, 3]);
set = new Set([...set].map(val => val * 2));
// set的值是2, 4, 6
// 方法二
let set = new Set([1, 2, 3]);
set = new Set(Array.from(set, val => val * 2));
// set的值是2, 4, 6
4. 集合运算
ES2025 为 Set 结构添加了以下集合运算方法:
Set.prototype.union(other):并集;Set.prototype.intersection(other):交集;Set.prototype.difference(other):差集;Set.prototype.symmetricDifference(other):对称差集;Set.prototype.isSubsetOf(other):判断是否为子集;Set.prototype.isSupersetOf(other):判断是否为超集;Set.prototype.isDisjointFrom(other):判断是否不相交;
以上方法的参数都必须是 Set 结构,或者是一个类似于 Set 的结构(拥有size属性,以及keys()和has()方法。
4.1 .union()
.union()是并集运算,返回包含两个集合中存在的所有成员的集合。
const frontEnd = new Set(["JavaScript", "HTML", "CSS"]);
const backEnd = new Set(["Python", "Java", "JavaScript"]);
const all = frontEnd.union(backEnd);
// Set {"JavaScript", "HTML", "CSS", "Python", "Java"}
4.2 .intersection()
.intersection()是交集运算,返回同时包含在两个集合中的成员的集合。
const frontEnd = new Set(["JavaScript", "HTML", "CSS"]);
const backEnd = new Set(["Python", "Java", "JavaScript"]);
const frontAndBackEnd = frontEnd.intersection(backEnd);
// Set {"JavaScript"}
4.3 .difference()
.difference()是差集运算,返回第一个集合中存在但第二个集合中不存在的所有成员的集合。
const frontEnd = new Set(["JavaScript", "HTML", "CSS"]);
const backEnd = new Set(["Python", "Java", "JavaScript"]);
const onlyFrontEnd = frontEnd.difference(backEnd);
// Set {"HTML", "CSS"}
const onlyBackEnd = backEnd.difference(frontEnd);
// Set {"Python", "Java"}
4.4 .symmetryDifference()
.symmetryDifference()是对称差集,返回两个集合的所有独一无二成员的集合,即去除了重复的成员。
const frontEnd = new Set(["JavaScript", "HTML", "CSS"]);
const backEnd = new Set(["Python", "Java", "JavaScript"]);
const onlyFrontEnd = frontEnd.symmetricDifference(backEnd);
// Set {"HTML", "CSS", "Python", "Java"}
const onlyBackEnd = backEnd.symmetricDifference(frontEnd);
// Set {"Python", "Java", "HTML", "CSS"}
注意,返回结果中的成员顺序,由 添加到集合 的顺序决定。
4.5 .isSubsetOf()
.isSubsetOf()返回一个布尔值,判断第一个集合是否为第二个集合的子集,即第一个集合的所有成员都是第二个集合的成员。
const frontEnd = new Set(["JavaScript", "HTML", "CSS"]);
const declarative = new Set(["HTML", "CSS"]);
declarative.isSubsetOf(frontEnd);
// true
frontEndLanguages.isSubsetOf(declarativeLanguages);
// false
任何集合都是自身的子集。
frontEnd.isSubsetOf(frontEnd);
// true
4.6 isSupersetOf()
isSupersetOf()返回一个布尔值,表示第一个集合是否为第二个集合的超集,即第二个集合的所有成员都是第一个集合的成员。
const frontEnd = new Set(["JavaScript", "HTML", "CSS"]);
const declarative = new Set(["HTML", "CSS"]);
declarative.isSupersetOf(frontEnd);
// false
frontEnd.isSupersetOf(declarative);
// true
任何集合都是自身的超集。
frontEnd.isSupersetOf(frontEnd);
// true
4.7 .isDisjointFrom()
.isDisjointFrom()判断两个集合是否不相交,即没有共同成员。
const frontEnd = new Set(["JavaScript", "HTML", "CSS"]);
const interpreted = new Set(["JavaScript", "Ruby", "Python"]);
const compiled = new Set(["Java", "C++", "TypeScript"]);
interpreted.isDisjointFrom(compiled);
// true
frontEnd.isDisjointFrom(interpreted);
// false
二、WeakSet
1. 含义
WeakSet 结构与 Set 类似,也是 不重复 的值的集合。但是,它与 Set 有两个区别。
首先,WeakSet 的成员只能是 对象 和 Symbol 值,而不能是其他类型的值。
const ws = new WeakSet();
ws.add(1) // 报错
ws.add(Symbol(1)) // 不报错
ws.add([1, 2]) // 不报错
ws.add({a: [1]}) // 不报错
上面代码试图向 WeakSet 添加一个数值,结果报错了,因为 WeakSet 只能放置 对象 和 Symbol 值。
其次,WeakSet 中的对象都是 弱引用,即垃圾回收机制不考虑 WeakSet 对该对象的引用,也就是说,如果其他对象都不再引用该对象,那么垃圾回收机制会自动回收该对象所占用的内存,不考虑该对象还存在于 WeakSet 之中。
WeakSet 里面的引用,都不计入垃圾回收机制,所以就不存在内存泄漏的问题。因此,WeakSet 适合临时存放一组对象,以及存放跟对象绑定的信息。只要这些对象在外部消失,它在 WeakSet 里面的引用就会自动消失。
由于上面这个特点,WeakSet 的成员是不适合引用的,因为它会随时消失。另外,由于 WeakSet 内部有多少个成员,取决于垃圾回收机制有没有运行,运行前后很可能成员个数是不一样的,而垃圾回收机制何时运行是不可预测的,因此 ES6 规定 WeakSet 不可遍历。
这些特点同样适用于本章后面要介绍的 WeakMap 结构。
2. 语法
WeakSet 是一个构造函数,可以使用new命令,创建 WeakSet 数据结构。
const ws = new WeakSet();
作为构造函数,WeakSet 可以接受一个数组或类似数组的对象作为参数。(实际上,任何具有 Iterable 接口的对象,都可以作为 WeakSet 的参数。)该数组的所有成员,都会自动成为 WeakSet 实例对象的成员。
const ws = new WeakSet([[1], [2], [3], [4], [5]]);
// WeakSet {[1], [2], [3], [4], [5]}
上面代码中,传入参数是一个数组,它有5个成员,也都是数组。将该数组作为 WeakSet 构造函数的参数,该数组的 成员 会自动成为 WeakSet 的成员。
相当于:
const ws = new WeakSet();
ws.add([1])
ws.add([2])
ws.add([3])
ws.add([4])
ws.add([5])
// WeakSet {[1], [2], [3], [4], [5]}
注意,是 参数数组的成员 成为 WeakSet 的成员,而不 是参数数组本身 。这意味着,数组的成员只能是 对象。
const ws = new WeakSet([1, 2, 3, 4, 5, 6]);
// Uncaught TypeError: Invalid value used in weak set(…)
上面代码中,参数数组的成员是数值而不是对象,加入 WeakSet 就会报错。
3. 方法
WeakSet 结构有以下三个方法:
WeakSet.prototype.add(value):向 WeakSet 实例添加一个新成员,返回 WeakSet 结构本身;WeakSet.prototype.delete(value):清除 WeakSet 实例的指定成员,清除成功返回true,如果在
WeakSet 中找不到该成员或该成员不是对象,返回false;WeakSet.prototype.has(value):返回一个布尔值,表示某个值是否在 WeakSet 实例之中;
下面是一个例子:
const ws = new WeakSet();
const obj = {};
const foo = {};
ws.add(window);
ws.add(obj);
ws.has(window); // true
ws.has(foo); // false
ws.delete(window); // true
ws.has(window); // false
WeakSet 没有size属性,没有办法遍历它的成员。
ws.size // undefined
ws.forEach // undefined
ws.forEach(function (item){console.log('WeakSet has ' + item)})
// TypeError: undefined is not a function
上面代码试图获取size和forEach属性,结果都不能成功。
WeakSet 不能遍历,是因为成员都是弱引用,随时可能消失,遍历机制无法保证成员的存在,很可能刚刚遍历结束,成员就取不到了。WeakSet 的一个用处,是储存 DOM 节点,而不用担心这些节点从文档移除时,会引发内存泄漏。
下面是 WeakSet 的另一个例子,保证了Foo的实例方法,只能在Foo的实例上调用。
const foos = new WeakSet()
class Foo {
constructor() {
foos.add(this)
}
method () {
if (!foos.has(this)) {
throw new TypeError('Foo.prototype.method 只能在Foo的实例上调用!');
}
console.log('foo')
}
}
// Foo 实例调用 method
let foo = new Foo();
foo.method(); // foo
// 绑定后调用:
foo.method.bind(null)()
// Uncaught TypeError: Foo.prototype.method 只能在Foo的实例上调用!
这里使用 WeakSet 的好处是,foos对实例的引用,不会被计入内存回收机制,所以删除实例的时候,不用考虑foos,也不会出现内存泄漏。
三、Map
1. 含义和基本用法
1.1 和对象的区别
JavaScript 的对象(Object),本质上是键值对的集合(Hash 结构),但是传统上只能用字符串当作键。这给它的使用带来了很大的限制。
const data = {};
const element = document.getElementById('myDiv');
data[element] = 'metadata';
data['[object HTMLDivElement]'] // "metadata"
上面代码原意是将一个 DOM 节点作为对象data的键,但是由于对象只接受 字符串 作为键名,所以element被自动转为字符串[object HTMLDivElement]。
为了解决这个问题,ES6 提供了 Map 数据结构。它类似于对象,也是键值对的集合,但是“键”的范围不限于字符串,各种类型的值(包括对象)都可以当作键。也就是说,Object 结构提供了“字符串—值”的对应,Map 结构提供了“值—值”的对应,是一种更完善的 Hash 结构实现。如果你需要“键值对”的数据结构,Map 比 Object 更合适。
const m = new Map();
const o = {p: 'Hello World'};
m.set(o, 'content')
m.get(o) // "content"
m.has(o) // true
m.delete(o) // true
m.has(o) // false
上面代码使用 Map 结构的set方法,将对象o当作m的一个键,然后又使用get方法读取这个键,接着使用delete方法删除了这个键。
1.2 接受数组作为参数
const map = new Map([
['name', 'hll'],
['age', '18']
]);
map.size // 2
map.has('name') // true
map.get('name') // "hll"
map.has('age') // true
map.get('age') // 18
上面代码在新建 Map 实例时,就指定了两个键name和age。
Map构造函数接受数组作为参数,实际上执行的是下面的算法。
const items = [
['name', 'hll'],
['age', '18']
];
const map = new Map();
items.forEach(
([key, value]) => map.set(key[0], key[1])
);
1.3 接受 Set 和 Map 作为参数
事实上,不仅仅是数组,任何具有 Iterator 接口、且每个成员都是一个 双元素 的数组的数据结构都可以当作Map构造函数的参数。也就是说,Set和Map都可以用来生成新的 Map。
const set = new Set([
['foo', 1],
['bar', 2]
]);
const m1 = new Map(set);
m1.get('foo') // 1
const m2 = new Map([['baz', 3]]);
const m3 = new Map(m2);
m3.get('baz') // 3
上面代码中,我们分别使用 Set 对象和 Map 对象,当作Map构造函数的参数,结果都生成了新的 Map 对象。
1.4 读取和赋值的特殊情况
- 如果对同一个键多次赋值,后面的值将覆盖前面的值。
const map = new Map();
map
.set(1, 'aaa')
.set(1, 'bbb');
map.get(1) // "bbb"
上面代码对键1连续赋值两次,后一次的值覆盖前一次的值。
- 如果读取一个未知的键,则返回
undefined。
new Map().get('asfddfsasadf')
// undefined
- 只有对同一个对象的引用,Map 结构才将其视为同一个键。
const map = new Map();
map.set(['a'], 555);
map.get(['a']) // undefined
上面代码的set和get方法,表面是针对同一个键,但实际上这是两个不同的数组实例,内存地址是不一样的,因此get方法无法读取该键,返回undefined。
同理,同样的值的两个实例,在 Map 结构中被视为两个键。
const map = new Map();
const k1 = ['a'];
const k2 = ['a'];
map
.set(k1, 111)
.set(k2, 222);
map.get(k1) // 111
map.get(k2) // 222
上面代码中,变量k1和k2的值是一样的,但是它们在 Map 结构中被视为两个键。
由上可知,Map 的键实际上是跟内存地址绑定的,只要内存地址不一样,就视为两个键。这就解决了同名属性碰撞(clash)的问题,我们扩展别人的库的时候,如果使用对象作为键名,就不用担心自己的属性与原作者的属性同名。
- 简单类型的值作为键时,Map 开启严格相等来判断。
如果 Map 的键是一个简单类型的值(数字、字符串、布尔值),则只要两个值严格相等,Map 将其视为一个键,比如0和-0就是一个键,布尔值true和字符串true则是两个不同的键。另外,undefined和null也是两个不同的键。虽然NaN不严格相等于自身,但 Map 将其视为同一个键。
let map = new Map();
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
2. 实例的属性和操作方法
Map 结构的实例有以下属性和操作方法:
2.1 size 属性
size属性返回 Map 结构的成员总数。
const map = new Map();
map.set('foo', true);
map.set('bar', false);
map.size // 2
2.2 Map.prototype.set(key, value)
set方法设置键名key对应的键值为value,然后返回整个 Map 结构。如果key已经有值,则键值会被更新,否则就新生成该键。
const m = new Map();
m.set('edition', 6) // 键是字符串
m.set(262, 'standard') // 键是数值
m.set(undefined, 'nah') // 键是 undefined
set方法返回的是当前的Map对象,因此可以采用 链式 写法。
let map = new Map()
.set(1, 'a')
.set(2, 'b')
.set(3, 'c');
2.3 Map.prototype.get(key)
get方法读取key对应的键值,如果找不到key,返回undefined。
const m = new Map();
const hello = function() {console.log('hello');};
m.set(hello, 'Hello ES6!') // 键是函数
m.get(hello) // Hello ES6!
2.4 Map.prototype.has(key)
has方法返回一个布尔值,表示某个键是否在当前 Map 对象之中。
const m = new Map();
m.set('edition', 6);
m.set(262, 'standard');
m.set(undefined, 'nah');
m.has('edition') // true
m.has('years') // false
m.has(262) // true
m.has(undefined) // true
2.5 Map.prototype.delete(key)
delete方法删除某个键,返回true;如果删除失败,返回false。
const m = new Map();
m.set(undefined, 'nah');
m.has(undefined) // true
m.delete(undefined)
m.has(undefined) // false
2.6 Map.prototype.clear()
clear方法清除所有成员,没有返回值。
let map = new Map();
map.set('foo', true);
map.set('bar', false);
map.size // 2
map.clear()
map.size // 0
3. 遍历方法
Map 结构原生提供三个遍历器生成函数和一个遍历方法:
Map.prototype.keys():返回 键名 的遍历器;Map.prototype.values():返回 键值 的遍历器;Map.prototype.entries():返回 所有成员 的遍历器;Map.prototype.forEach():遍历 Map 的所有成员;
需要特别注意的是,Map 的遍历顺序就是插入顺序。
const map = new Map([
['F', 'no'],
['T', 'yes'],
]);
for (let key of map.keys()) {
console.log(key);
}
// "F"
// "T"
for (let value of map.values()) {
console.log(value);
}
// "no"
// "yes"
for (let item of map.entries()) {
console.log(item);
}
// ["F", "no"]
// ["T", "yes"]
// 或者
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] === map.entries
// true
Map 结构转为 数组 结构,比较快速的方法是使用扩展运算符(...)。
const map = new Map([
[1, 'one'],
[2, 'two'],
[3, 'three'],
]);
[...map.keys()]
// [1, 2, 3]
[...map.values()]
// ['one', 'two', 'three']
[...map.entries()]
// [[1,'one'], [2, 'two'], [3, 'three']]
[...map]
// [[1,'one'], [2, 'two'], [3, 'three']]
结合数组的map方法、filter方法,可以实现 Map 的遍历和过滤(Map 本身没有map和filter方法)。
const map0 = new Map()
.set(1, 'a')
.set(2, 'b')
.set(3, 'c');
const map1 = new Map(
[...map0].filter(([k, v]) => k < 3)
);
// 产生 Map 结构 {1 => 'a', 2 => 'b'}
const map2 = new Map(
[...map0].map(([k, v]) => [k * 2, '_' + v])
);
// 产生 Map 结构 {2 => '_a', 4 => '_b', 6 => '_c'}
此外,Map 还有一个forEach方法,与数组的forEach方法类似,也可以实现遍历。它的第一个参数是回调函数,回调函数里面可以传入三个参数,分别是:value(当前值)、key(当前键)、map(遍历的整个map)。
map.forEach(function(value, key, map) {
console.log("Key: %s, Value: %s", key, value, map);
});
forEach方法还可以接受第二个参数,用来绑定this。
const reporter = {
report: function(key, value) {
console.log("Key: %s, Value: %s", key, value);
}
};
map.forEach(function(value, key, map) {
this.report(key, value);
}, reporter);
上面代码中,forEach方法的回调函数的this,就指向reporter。
4.与其他数据结构的互相转换
4.1 Map 转为数组
前面已经提过,Map 转为数组最方便的方法,就是使用扩展运算符(...)。
const myMap = new Map()
.set(true, 7)
.set({foo: 3}, ['abc']);
[...myMap]
// [ [ true, 7 ], [ { foo: 3 }, [ 'abc' ] ] ]
4.2 数组 转为 Map
将数组传入 Map 构造函数,就可以转为 Map。
new Map([[true, 7], [{foo: 3}, ['abc']]])
// Map {
// true => 7,
// Object {foo: 3} => ['abc']
// }
4.3 Map 转为对象
如果所有 Map 的键都是字符串,它可以无损地转为对象。
function strMapToObj(strMap) {
let obj = Object.create(null);
for (let [k,v] of strMap) {
obj[k] = v;
}
return obj;
}
const myMap = new Map()
.set('yes', true)
.set('no', false);
strMapToObj(myMap)
// { yes: true, no: false }
如果有非字符串的键名,那么这个键名会被转成字符串,再作为对象的键名。
function strMapToObj(strMap) {
let obj = Object.create(null);
for (let [k,v] of strMap) {
obj[k.toString()] = v;
}
return obj;
}
4.4 对象转为 Map
对象转为 Map 可以通过Object.entries()。
let obj = {"a":1, "b":2};
let map = new Map(Object.entries(obj));
此外,也可以自己实现一个转换函数。
function objToStrMap(obj) {
let strMap = new Map();
for (let k of Object.keys(obj)) {
strMap.set(k, obj[k]);
}
return strMap;
}
objToStrMap({yes: true, no: false})
// Map {"yes" => true, "no" => false}
4.5 Map 转为 JSON
Map 转为 JSON 要区分两种情况。
- 一种情况是,Map 的键名都是 字符串,这时可以选择转为 对象JSON(即先转化为对象,再对对象使用
JSON.stringify())。
function strMapToJson(map) {
let obj = Object.create(null);
for (let [k, v] of map) {
obj[k] = v
}
return JSON.stringify(obj);
}
let myMap = new Map().set('yes', true).set('no', false);
strMapToJson(myMap)
// '{"yes":true,"no":false}'
另一种情况是,Map 的键名有 非字符串,这时可以选择转为 数组JSON(即先转化为数组,再对数组使用JSON.stringify())。
function mapToArrayJson(map) {
return JSON.stringify([...map]);
}
let myMap = new Map().set(true, 7).set({foo: 3}, ['abc']);
mapToArrayJson(myMap)
// '[[true,7],[{"foo":3},["abc"]]]'
4.6 JSON 转为 Map
JSON 转为 Map,正常情况下,所有键名都是 字符串,我们可以先通过JSON.parse(),将 JSON 转为对象,再从对象转化为 Map。
function jsonToStrMap(jsonStr) {
let obj = JSON.parse(jsonStr);
let map = new Map();
for (let k of Object.keys(obj)) {
map.set(k, obj[k])
}
return map;
}
console.log(jsonToStrMap('{"yes": true, "no": false}'));
// Map {'yes' => true, 'no' => false}
但是,有一种特殊情况,整个 JSON 就是一个数组,且每个成员本身,又是一个有两个成员的数组,诸如[[x1, y1],[x2, y2],[x3, y3]...]这种格式。这时,它可以一一对应地转为 Map。这往往是 Map 转为数组 JSON 的逆操作。直接通过JSON.parse()转化为数组后,再转为 Map。
function jsonToMap(jsonStr) {
let arr = JSON.parse(jsonStr);
return new Map(arr);
}
console.log(jsonToMap('[[true,7],[{"foo":3},["abc"]]]'));
// Map {true => 7, Object {foo: 3} => ['abc']}
四、WeakMap
1. 含义
WeakMap结构与Map结构类似,也是用于生成 键值对 的集合。
1.1 声明
和 Map 一样,使用new来声明。
const wm = new WeakMap();
console.log(wm);
// WeakMap {}
1.2 添加成员
- 可以使用
set方法添加成员。
const wm1 = new WeakMap();
const key = {foo: 1};
wm1.set(key, 2);
wm1.get(key) // 2
- 可以传入数组作为构造函数的参数。
const k1 = [1, 2, 3];
const k2 = [4, 5, 6];
const wm2 = new WeakMap([[k1, 'foo'], [k2, 'bar']]);
wm2.get(k2) // "bar"
1.3 与 Map的区别
WeakMap 与 Map 的区别有两点:
- WeakMap 只接受对象(
null除外)和 Symbol 值作为 键名,不接受其他类型的值作为键名。
const map = new WeakMap();
map.set(1, 2) // 报错
map.set(null, 2) // 报错
map.set(Symbol(), 2) // 不报错
上面代码中,如果将数值1和null作为 WeakMap 的键名,都会报错,将 Symbol 值作为键名不会报错。
- WeakMap 的键名所指向的对象,不计入垃圾回收机制。
WeakMap 的设计目的在于,有时我们想在某个对象上面存放一些数据,但是这会形成对于这个对象的引用。请看下面的例子。
const e1 = document.getElementById('foo');
const e2 = document.getElementById('bar');
const arr = [
[e1, 'foo 元素'],
[e2, 'bar 元素'],
];
上面代码中,e1和e2是两个对象,我们通过arr数组对这两个对象添加一些文字说明。这就形成了arr对e1和e2的引用。
一旦不再需要这两个对象,我们就必须手动删除这个引用,否则垃圾回收机制就不会释放e1和e2占用的内存。
// 不需要 e1 和 e2 的时候
// 必须手动删除引用
arr [0] = null;
arr [1] = null;
上面这样的写法显然很不方便。一旦忘了写,就会造成内存泄露。
WeakMap 就是为了解决这个问题而诞生的,它的键名所引用的对象都是 弱引用,即垃圾回收机制不将该引用考虑在内。因此,只要所引用的对象的其他引用都被清除,垃圾回收机制就会释放该对象所占用的内存。也就是说,一旦不再需要,WeakMap 里面的键名对象和所对应的键值对会自动消失,不用手动删除引用。
基本上,如果你要往对象上添加数据,又不想干扰垃圾回收机制,就可以使用 WeakMap。一个典型应用场景是,在网页的 DOM 元素上添加数据,就可以使用 WeakMap 结构。当该 DOM 元素被清除,其所对应的 WeakMap 记录就会自动被移除。
const wm = new WeakMap();
const element = document.getElementById('example');
wm.set(element, 'some information');
wm.get(element) // "some information"
上面代码中,先新建一个 WeakMap 实例。然后,将一个 DOM 节点作为键名存入该实例,并将一些附加信息作为键值,一起存放在 WeakMap 里面。这时,WeakMap 里面对element的引用就是弱引用,不会被计入垃圾回收机制。
也就是说,上面的 DOM 节点对象除了 WeakMap 的弱引用外,其他位置对该对象的引用一旦消除,该对象占用的内存就会被垃圾回收机制释放。WeakMap 保存的这个键值对,也会自动消失。
总之,WeakMap 的专用场合就是,它的键所对应的对象,可能会在将来消失。WeakMap 结构有助于防止内存泄漏。
注意,WeakMap 弱引用的只是 键名,而不是 键值。当 键值 的引用在外部被消除时,在WeakMap内部还是正常存在的,没有任何影响。
const wm1 = new WeakMap();
const wm2 = new WeakMap();
let obj1 = {foo: 1};
let obj2 = {bar: 2};
wm1.set(obj1, obj2);
wm2.set(obj2, obj1);
obj1 = null;
wm1.get(obj1)
// undefined
wm2.get(obj1)
// Object {foo: 1}
上面代码中,wm2内部的键值obj1是正常引用。所以,即使在 WeakMap 外部消除了obj1的引用,WeakMap 内部的引用依然存在。
2. 语法
WeakMap 与 Map 在 API 上的区别主要是两个,一是 没有遍历操作(即没有keys()、values()和entries()方法),也没有size属性。因为没有办法列出所有键名,某个键名是否存在完全不可预测,跟垃圾回收机制是否运行相关。这一刻可以取到键名,下一刻垃圾回收机制突然运行了,这个键名就没了,为了防止出现不确定性,就统一规定不能取到键名。二是 无法清空,即不支持clear方法。因此,WeakMap只有四个方法可用:get()、set()、has()、delete()。
const wm = new WeakMap();
// size、forEach、clear 方法都不存在
wm.size // undefined
wm.forEach // undefined
wm.clear // undefined
3. WeakMap 的用途
前文说过,WeakMap 应用的典型场合就是 DOM 节点作为键名。下面是一个例子。
let myWeakmap = new WeakMap();
myWeakmap.set(document.getElementById('logo'), {timesClicked: 0});
document.getElementById('logo').addEventListener('click', function() {
let logoData = myWeakmap.get(document.getElementById('logo'));
logoData.timesClicked++;
}, false);
上面代码中,document.getElementById('logo')是一个 DOM 节点,每当发生click事件,就更新一下状态。我们将这个状态作为键值放在 WeakMap 里,对应的键名就是这个节点对象。一旦这个 DOM 节点删除,该状态就会自动消失,不存在内存泄漏风险。
WeakMap 的另一个用处是部署私有属性。
const _counter = new WeakMap();
const _action = new WeakMap();
class Countdown {
constructor(counter, action) {
_counter.set(this, counter);
_action.set(this, action);
}
dec() {
let counter = _counter.get(this);
if (counter < 1) return;
counter--;
_counter.set(this, counter);
if (counter === 0) {
_action.get(this)();
}
}
}
const c = new Countdown(2, () => console.log('DONE'));
c.dec()
c.dec()
// DONE
上面代码中,Countdown类的两个内部属性_counter和_action,是实例的弱引用,所以如果删除实例,它们也就随之消失,不会造成内存泄漏。
五、WeakRef
WeakSet 和 WeakMap 是基于弱引用的数据结构,ES2021 更进一步,提供了 WeakRef 对象,用于直接创建对象的弱引用。
let target = {};
let wr = new WeakRef(target);
上面示例中,target是原始对象,构造函数WeakRef()创建了一个基于target的新对象wr。这里,wr就是一个 WeakRef 的实例,属于对target的弱引用,垃圾回收机制不会计入这个引用,也就是说,wr的引用不会妨碍原始对象target被垃圾回收机制清除。
WeakRef 实例对象有一个deref()方法,如果原始对象存在,该方法返回原始对象;如果原始对象已经被垃圾回收机制清除,该方法返回undefined。
let target = {a: 1};
let wr = new WeakRef(target);
let obj = wr.deref(); // {a: 1}
if (obj) { // target 未被垃圾回收机制清除
// ...
}
上面示例中,deref()方法可以判断原始对象是否已被清除。
弱引用对象的一大用处,就是作为缓存,未被清除时可以从缓存取值,一旦清除缓存就自动失效。
六、FinalizationRegistry
ES2021 引入了清理器注册表功能 FinalizationRegistry,用来指定目标对象被垃圾回收机制清除以后,所要执行的回调函数。
- 首先,新建一个注册表实例:
const registry = new FinalizationRegistry(heldValue => {
// ....
});
上面代码中,FinalizationRegistry()是系统提供的构造函数,返回一个清理器注册表实例,里面登记了所要执行的回调函数。回调函数作为FinalizationRegistry()的参数传入,它本身有一个参数heldValue。
- 然后,注册表实例的
register()方法,用来注册所要观察的目标对象。
registry.register(theObject, "some value");
上面示例中,theObject就是所要观察的目标对象,一旦该对象被垃圾回收机制清除,注册表就会在清除完成后,调用早前注册的回调函数,并将some value作为参数(前面的heldValue)传入回调函数。
回调函数的参数heldValue可以是任意类型的值,字符串、数值、布尔值、对象,甚至可以是undefined。
最后,如果以后还想取消已经注册的回调函数,则要向register()传入第三个参数,作为 标记值。这个标记值必须是 对象,一般都用原始对象。接着,再使用注册表实例对象的unregister()方法取消注册。
registry.register(theObject, "some value", theObject);
// ...其他操作...
registry.unregister(theObject);
由于回调函数被调用以后,就不再存在于注册表之中了,所以执行unregister()应该是在回调函数还没被调用之前。
总结
详情请查看:阮一峰老师的 ECMAScript 6 入门 —— Set 和 Map 数据结构
更多推荐
所有评论(0)