文章目录
Set
基本用法
ES6提供了新的数据结构Set。它类似于数组,但是成员的值都是唯一的,没有重复的值。
Set本身是一个构造函数,用来生成Set数据结构。
const s = new Set();
[2,3,5,4,2,5,2].forEach(x => s.add(x));
for(let i of s){
console.log(i);
}
// 2 3 4 5
上面代码通过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, 4]);
items.size // 5
// 例三
const items = new Set(document.queryselectorAll('div'));
items.size // 56
// 类似于
const set = new Set();
document.queryselectorAll('div').forEach(div => set.add(div))
items.size // 56
上面代码中,例一和例二都是Set函数接受数组作为参数,例三是接受数组的对象作为参数。
上面代码也展示了一种去除数组重复成员的方法。
// 去除数组的重复成员
[...new Set(array)]
上面的方法也可以用于,去除字符串里面的重复字符。
[...new Set('abbccde')].join('');
// 'abcde'
向Set加入值的时候,不会发生类型转换,所以5和’5’是两个不同的值。Set内部判断两个值是否不同,使用的算法叫做’Same-value-zero equality’,它类似于精确运算符(===),主要的区别是向Set加入值时认为NaN等于自身,而精确相等运算符认为NaN不等于自身。
let set = new Set();
let a = NaN;
let b = NaN;
set.add(a);
set.add(b);
console.log(set) // Set {NaN}
上面代码向Set实例添加了两个NaN,但是只能加入一个。这表明,在Set内部,两个NaN是相等的。
另外,两个对象总是不相等的。
let set = new Set();
set.add({});
set.size // 1
set.add({});
set.size //2
上面代码表示,由于两个空对象不相等,所以他们被视为两个值。
Set实例的属性和方法
Set结构实例有以下属性:
- Set.prototype.constructor:构造函数,默认就是Set函数
- Set.prototype.size:返回Set实例的成员总数
Set实例的方法分为两大类:操作方法(用于操作数据)和遍历方法(用于遍历成员)。下面是4个操作方法
- Set.prototype.add(value):添加某个值,返回Set结构本身
- Set.prototype.delete(value):删除某个值,返回一个布尔值,表示删除是否成功
- Set.prototype.has(value):返回一个布尔值,表示该值是否为Set的成员
- Set.prototype.clear():清除所有成员,没有返回值
上面这些属性和方法的实例
let set = new Set();
set.add(1).add('1').add(2).add(2); // 注意2被加入了两次
set.size // 3
set.has(1); // true
set.has('1'); // true
set.has(2); // true
set.has(3); // false
set.delete('1');
set.has('1'); // false
下面是一个对比,看看在判断是否包括在一个键上面,Object结构和Set结构的写法不同。
const properties = {
'width': 1,
'height': 1
};
if(properties[someName]){
// do something
}
// Set的写法
const properties = new Set();
properties.add('width');
properties.add('height');
if(properties.has(someName)){
// do something
}
Array.from方法可以将Set结构转为数组
const items = new Set([1, 2, 3, 4, 5]);
const array = Array.from(items);
这就提供了去除数组重复成员的另一种方法
function dedupe(array) {
return Array.from(new Set(array));
}
dedupe([1, 1, 2, 3]) // [1, 2, 3]
遍历操作
Set结构的实例有四个遍历方法,可以用于遍历成员
- Set.prototype.keys():返回键名的遍历器
- Set.prototype.values():返回键值的遍历器
- Set.prototype.entries(): 返回键值对的遍历器
- Set.prototype.forEach():使用回调函数遍历每个成员
需要特别指出的是,Set的遍历顺序就是插入顺序。这个特性有时非常有用,比如使用Set保存一个回调函数列表,调用时就能保证按照添加顺序调用。
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"]
上面代码中,entries方法返回的遍历器,同时包括键名和键值,所以每次输出一个数组,他的两个成员完全相等。
Set结构的实例默认可遍历,他的默认遍历器生成函数就是它的values方法。
Set.prototype[Symbol.iterator] === Set.prototype.values
// true
这意味着,可以忽略values方法,直接用for…of循环遍历Set。
let set = new Set(['red', 'green', 'blue']);
for(let item of set){
console.log(item);
}
// red
// green
// blue
forEach()
Set结构和实例与数组一样,也拥有forEach方法,用于对每个成员执行某种操作,没有返回值。
let set = new Set(['red', 'green', 'blue']);
set.forEach( (value, key) => console.log(key + ':' + value) )
// red : red
// green : green
// blue : blue
上面代码说明,forEach方法的参数就是一个处理函数。该函数的参数与数组的forEach一致,一次为键值、键名、集合本身。这里需要注意,Set结构的键名就是键值(两者是同一个值),因此第一个参数和第二个参数的值永远都是一样的。
forEach方法还可以有第二个参数,表示绑定处理函数内部的this对象。
遍历的应用
扩展运算符(…)内部使用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了。
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 a = new Set([4, 2, 3]);
// 并集
let union = new Set([...a, ...b]);
// Set {1, 2, 3, 4}
// 交集
let intersect = new Set([...a].filter(x => b.has(x)));
// Set {2, 3}
// 差集
let Difference = new Set([...a].filter(x => !b.has(x)));
// Set {1}
如果想在遍历操作中,同步改变原来的Set结构,目前没有直接的方法,但是有两种变通方法。一种是利用原Set结构映射出一个新的结构,然后赋值给原来的Set结构;另外一种是Array.from方法。
// 方法一
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
WeakSet
含义
WeakSet结构与Set类似,也是不重复的值的集合。但是,它与Set有两个区别。
首先,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中的对象都是弱引用,即垃圾回收机制不考虑WeakSet对该对象的引用,也就是说,如果其他对象都不再引用该对象,那么垃圾回收机制会自动回收该对象所占用的内存,不考虑该对象还存在于WeakSet之中。
这是因为垃圾回收机制依赖引用计数,如果一个值的引用次数不为0,垃圾回收机制就不会释放这块内存。结束使用该值之后,有时会忘记取消引用,导致内存无法释放,进而可能会引发内存泄漏。WeakSet里面的引用,都不计入垃圾回收机制,所以就不存在这个问题。因此,WeakSet适合临时存放一组对象,以及存放跟对象绑定的信息。只要这些对象在外部消失,它在WeakSet里面的引用就会自动消失。
由于上面这个特点,WeakSet的成员是不适合引用的,因为它会随时小时。另外,由于WeakSet内部有多少个成员,取决于垃圾回收机制有没有运行,运行前后很可能成员个数是一样的,而垃圾回收机制运行是不可预测的,因此ES6规定WeakSet不可遍历。
这些特点同样适用于本章后面要介绍的WeakMap结构。
语法
WeakSet是一个构造函数,可以使用new命令,创建WeakSet数据结构。
const ws = new WeakSet();
作为构造函数,WeakSet可以接受一个数组或类似数组的对象作为参数。(实际上,任何具有Iterable接口的对象,都可以作为WeakSet的参数)该数组的所有成员,都会自动成为WeakSet实例对象的成员。
const a = [[1,2],[3,4]];
const ws = new WeakSet(a);
// WeakSet {[1,2],[3,4]}
上面代码中,a是一个数组,它有两个成员,也都是数组。将a作为WeakSet构造函数的参数,a的成员会自动成为WeakSet的成员。
注意,是a数组的成员成为WeakSet的成员,而不是a数组本身。这意味着,数组的成员只能是对象。
const b = [3,4];
const ws = new WeakSet(b);
// Uncaught TypeError: Invalid value used in weak set(…)
上面代码中,数组b的成员不是对象,加入WeakSet就会报错。
WeakSet结构有以下三个方法:
- WeakSet.prototype.add(value):向WeakSet实例添加一个新成员。
- WeakSet.prototype.delete(value):清除WeakSet实例的指定成员。
- 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);
ws.has(window); //false
WeakSet没有size属性,没有办法遍历它的成员。
ws.size //undefined
ws.forEach // undefined
ws.forEach(function(item){
console.log(item)
})
// TypeError: undefined is not a function
上面代码视图获取size和forEach属性,结构都不能成功。
WeakSet不能遍历,因为成员都是弱引用,随时可能消失,遍历机制无法保证成员的存在,很可能刚刚遍历结束,,成员就取不到了。
WeakSet的一个用处,是储存DOM节点,而不用担心这些节点从文档移除时,会引发内存泄漏。
WeakSet的例子
const foos = new WeakSet();
class Foo{
constructor() {
foos.add(this)
}
method() {
if(!foos.has(this)){
throw new TypeError('Foo.prototype.method 只能在Foo的实例上调用!');
}
}
}
上面代码保证了Foo的实例方法,只能在Foo的实例上调用。这里使用WeakSet的好处是 ,foos对实例的引用,不会被计入内存回收机制,所以删除实例的时候,不用考虑foos,也不会出现内存泄漏。
Map
含义和基本用法
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当做一个键,然后又使用get方法取这个键,接着使用delete方法删除这个键。
上面的例子展示了如何想Map添加成员。作为构造函数,Map也可以接受一个数组作为参数。该数组的成员是一个个表示键值对的数组。
const map = new Map([
['name', 'Lias'],
['title', 'Author']
]);
map.size //2
map.has('name') // true
map.get('name') // Lisa
map.has('title') // true
map.get('title') // Author
上面代码在新建Map实例时,就指定了两个键name和title。
Map构造函数接受数组作为参数,实际上执行的是下面的算法。
const items = [
['name', 'Lias'],
['title', 'Author']
];
const map = new Map();
items.forEach(
([key, value]) => map.set(key, value)
)
事实上,不仅仅是数组,任何具有Iterator接口、且每个成员都是一个双元素的数组的数据结构都可以当作Map构造函数的参数。这就是说,Set和Map都可以用来生成新的Map。
const set = new Set([
['foo', 1],
['boo', 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对象。
如果对同一个键多次赋值,后面的值将覆盖前面的值。
const map = new Map();
map.set(1, 'aaa').set(1, 'bbb');
map.get(1) // bbb
上面代码对键1连续赋值两次,后一次的值覆盖前一次的值。
如果读取一个未知的键,则返回undefined。
new Map().get('asdf'); // 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的键实际上是跟内存地址绑定的,只要内存地址不一样,就视为两个键。这就解决了同名属性碰撞的问题,我们扩展别人的库的时候,如果使用对象作为键名,就不用担心自己的属性与原作者的属性同名。
如果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') //2
map.set(undefined, 3)
map.set(null, 4)
map.get(undefined) // 3
map.set(NaN, 5)
map.get(NaN) //5
实例的属性和操作方法
Map结构的实例有以下属性和操作方法
size属性
size属性返回Map结构的成员总数
const map = new Map();
map.set('foo', true)
map.set('bar', false)
map.size // 2
Map.prototype.set(key, value)
set方法设置键名可以对应的键值value,然后返回整个Map结构。如果可以已经有值,则键值会被更新,否则就新生成该键。
const m = new Map();
m.set('end', 6); // 键是字符串
m.set(12, 'start') // 键是数字
m.set(undefined, "null") // 键是undefined
set方法返回的是当前的Map对象,因此可以采用链式写法。
let map = new Map().set('end', 6)
.set(12, 'start')
.set(undefined, "null")
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
Map.prototype.has(key)
has方法返回一个布尔值,表示某个减是否在当前Map对象之中
const m = new Map();
m.set('end', 6);
m.set(12, 'start')
m.set(undefined, "null")
m.has('end') // true
m.has(12) // true
m.has('false') // false
m.has(undefined) // true
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
Map.prototype.clear()
clear方法清除所有成员,没有返回值。
let map = new Map();
map.set('foo', true);
map.set('bar', false);
map.size // 2
map.clear()
map.size // 0
遍历方法
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 value of map.keys){
console.log(value);
}
// F
// T
for(let value of map.values){
console.log(value);
}
// no
// 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 map = new Map([
[1, 'a'],
[2, 'b'],
[3, 'c']
])
const map1 = new Map(
[...map].filter((k,v) => k < 3)
)
// Map结构 { 1=> 'a', a => 'b'}
const map2 = new Map(
[...map].map((k,v) => [k*2, '_' + v])
)
// Map结构{ 2 => '_a', 4 => '_b', 6 => '_c' }
此外,Map还有一个forEach方法,与数组的forEach方法类似,也可以实现遍历。
map.forEach(function(value, key, map) {
console.log("Key: %s, Value: %s", key, value);
});
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。
与其他数据结构的相互转换
Map转为数组
Map转为数组最方便的方法,就是使用扩展运算符(…)
const myMap = new Map()
.set(true, 7)
.set({foo: 3}, ['abc']);
[...myMap]
// [ [ true, 7 ], [ { foo: 3 }, [ 'abc' ] ] ]
数组转为Map
将数组传入Map构造函数,就可以转为Map。
new Map([
[true, 7],
[{foo: 3}, ['abc']]
])
// Map {
// true => 7,
// Object {foo: 3} => ['abc']
// }
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 }
如果有非字符串的键名,那么这个键名会被转为字符串,再作为对象的键名。
对象转为Map
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}
Map转为JSON
Map 转为 JSON 要区分两种情况。一种情况是,Map 的键名都是字符串,这时可以选择转为对象 JSON。
function strMapToJson(strMap) {
return JSON.stringify(strMapToObj(strMap));
}
let myMap = new Map().set('yes', true).set('no', false);
strMapToJson(myMap)
// '{"yes":true,"no":false}'
另一种情况是,Map 的键名有非字符串,这时可以选择转为数组 JSON。
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"]]]'
JSON转为Map
JSON 转为 Map,正常情况下,所有键名都是字符串。
function jsonToStrMap(jsonStr) {
return objToStrMap(JSON.parse(jsonStr));
}
jsonToStrMap('{"yes": true, "no": false}')
// Map {'yes' => true, 'no' => false}
但是,有一种特殊情况,整个 JSON 就是一个数组,且每个数组成员本身,又是一个有两个成员的数组。这时,它可以一一对应地转为 Map。这往往是 Map 转为数组 JSON 的逆操作。
function jsonToMap(jsonStr) {
return new Map(JSON.parse(jsonStr));
}
jsonToMap('[[true,7],[{"foo":3},["abc"]]]')
// Map {true => 7, Object {foo: 3} => ['abc']}
WeakMap
含义
WeakMap结构与Map结构类似,也是用于生成键值对的集合。
const wm1 = new WeakMap()
const key = { foo: 1 };
wm1.set(key, 3)
wm1.get(key) // 3
// 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除外),不接受其他类型的值作为键名。
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
map.set(null, 2)
// TypeError: Invalid value used as weak map key
上面代码中,如果将数值1和Symbol值作为WeakMap的键名,都会报错。
- 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 节点对象的引用计数是1,而不是2。这时,一旦消除对该节点的引用,它占用的内存就会被垃圾回收机制释放。Weakmap 保存的这个键值对,也会自动消失。
总之,WeakMap的专用场合就是:它的键所对应的对象,可能会在将来消失。WeakMap结构有助于防止内存泄漏。
注意,WeakMap 弱引用的只是键名,而不是键值。键值依然是正常引用。
const wm = new WeakMap();
let key = {};
let obj = {foo: 1};
wm.set(key, obj);
obj = null;
wm.get(key)
// Object {foo: 1}
上面代码中,键值obj是正常引用。所以,即使在 WeakMap 外部消除了obj的引用,WeakMap 内部的引用依然存在。
WeakMap的语法
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
WeakMap的实例
WeakMap 的例子很难演示,因为无法观察它里面的引用会自动消失。此时,其他引用都解除了,已经没有引用指向 WeakMap 的键名了,导致无法证实那个键名是不是存在。
如果引用所指向的值占用特别多的内存,就可以通过 Node 的process.memoryUsage方法看出来。根据这个思路,网友vtxf补充了下面的例子。
首先,打开 Node 命令行。
$ node --expose-gc
上面代码中,–expose-gc参数表示允许手动执行垃圾回收机制。
然后执行下面代码
// 手动执行一次垃圾回收,保证获取的内存使用状态准确
> global.gc();
undefined
// 查看内存占用的初始状态,heapUsed 为 4M 左右
> process.memoryUsage();
{ rss: 21106688,
heapTotal: 7376896,
heapUsed: 4153936,
external: 9059 }
> let wm = new WeakMap();
undefined
// 新建一个变量 key,指向一个 5*1024*1024 的数组
> let key = new Array(5 * 1024 * 1024);
undefined
// 设置 WeakMap 实例的键名,也指向 key 数组
// 这时,key 数组实际被引用了两次,
// 变量 key 引用一次,WeakMap 的键名引用了第二次
// 但是,WeakMap 是弱引用,对于引擎来说,引用计数还是1
> wm.set(key, 1);
WeakMap {}
> global.gc();
undefined
// 这时内存占用 heapUsed 增加到 45M 了
> process.memoryUsage();
{ rss: 67538944,
heapTotal: 7376896,
heapUsed: 45782816,
external: 8945 }
// 清除变量 key 对数组的引用,
// 但没有手动清除 WeakMap 实例的键名对数组的引用
> key = null;
null
// 再次执行垃圾回收
> global.gc();
undefined
// 内存占用 heapUsed 变回 4M 左右,
// 可以看到 WeakMap 的键名引用没有阻止 gc 对内存的回收
> process.memoryUsage();
{ rss: 20639744,
heapTotal: 8425472,
heapUsed: 3979792,
external: 8956 }
上面代码中,只要外部的引用消失,WeakMap 内部的引用,就会自动被垃圾回收清除。由此可见,有了 WeakMap 的帮助,解决内存泄漏就会简单很多。
WeakMap的用途
WeakMap 应用的典型场合就是 DOM 节点作为键名
let myElement = document.getElementById('logo');
let myWeakmap = new WeakMap();
myWeakmap.set(myElement, {timesClicked: 0});
myElement.addEventListener('click', function() {
let logoData = myWeakmap.get(myElement);
logoData.timesClicked++;
}, false);
上面代码中,myElement是一个 DOM 节点,每当发生click事件,就更新一下状态。我们将这个状态作为键值放在 WeakMap 里,对应的键名就是myElement。一旦这个 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,是实例的弱引用,所以如果删除实例,它们也就随之消失,不会造成内存泄漏。