Set
基本用法
ES6 提供了新的數(shù)據(jù)結(jié)構(gòu) Set。它類(lèi)似于數(shù)組,但是成員的值都是唯一的,沒(méi)有重復(fù)的值。
Set本身是一個(gè)構(gòu)造函數(shù),用來(lái)生成 Set 數(shù)據(jù)結(jié)構(gòu)。
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
上面代碼通過(guò)add()方法向 Set 結(jié)構(gòu)加入成員,結(jié)果表明 Set 結(jié)構(gòu)不會(huì)添加重復(fù)的值。
Set函數(shù)可以接受一個(gè)數(shù)組(或者具有 iterable 接口的其他數(shù)據(jù)結(jié)構(gòu))作為參數(shù),用來(lái)初始化。
// 例一
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
// 例三
const set = new Set(document.querySelectorAll('div'));
set.size // 56
// 類(lèi)似于
const set = new Set();
document
.querySelectorAll('div')
.forEach(div => set.add(div));
set.size // 56
上面代碼中,例一和例二都是Set函數(shù)接受數(shù)組作為參數(shù),例三是接受類(lèi)似數(shù)組的對(duì)象作為參數(shù)。
上面代碼也展示了一種去除數(shù)組重復(fù)成員的方法。
// 去除數(shù)組的重復(fù)成員
[...new Set(array)]
上面的方法也可以用于,去除字符串里面的重復(fù)字符。
[...new Set('ababbc')].join('')
// "abc"
向 Set 加入值的時(shí)候,不會(huì)發(fā)生類(lèi)型轉(zhuǎn)換,所以5和"5"是兩個(gè)不同的值。Set 內(nèi)部判斷兩個(gè)值是否不同,使用的算法叫做“Same-value-zero equality”,它類(lèi)似于精確相等運(yùn)算符(===),主要的區(qū)別是向 Set 加入值時(shí)認(rèn)為NaN等于自身,而精確相等運(yùn)算符認(rèn)為NaN不等于自身。
let set = new Set();
let a = NaN;
let b = NaN;
set.add(a);
set.add(b);
set // Set {NaN}
上面代碼向 Set 實(shí)例添加了兩次NaN,但是只會(huì)加入一個(gè)。這表明,在 Set 內(nèi)部,兩個(gè)NaN是相等的。
另外,兩個(gè)對(duì)象總是不相等的。
let set = new Set();
set.add({});
set.size // 1
set.add({});
set.size // 2
上面代碼表示,由于兩個(gè)空對(duì)象不相等,所以它們被視為兩個(gè)值。
Set 實(shí)例的屬性和方法
Set 結(jié)構(gòu)的實(shí)例有以下屬性。
-
Set.prototype.constructor:構(gòu)造函數(shù),默認(rèn)就是Set函數(shù)。 -
Set.prototype.size:返回Set實(shí)例的成員總數(shù)。
Set 實(shí)例的方法分為兩大類(lèi):操作方法(用于操作數(shù)據(jù))和遍歷方法(用于遍歷成員)。下面先介紹四個(gè)操作方法。
-
Set.prototype.add(value):添加某個(gè)值,返回 Set 結(jié)構(gòu)本身。 -
Set.prototype.delete(value):刪除某個(gè)值,返回一個(gè)布爾值,表示刪除是否成功。 -
Set.prototype.has(value):返回一個(gè)布爾值,表示該值是否為Set的成員。 -
Set.prototype.clear():清除所有成員,沒(méi)有返回值。
上面這些屬性和方法的實(shí)例如下。
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);
s.has(2) // false
下面是一個(gè)對(duì)比,看看在判斷是否包括一個(gè)鍵上面,Object結(jié)構(gòu)和Set結(jié)構(gòu)的寫(xiě)法不同。
// 對(duì)象的寫(xiě)法
const properties = {
'width': 1,
'height': 1
};
if (properties[someName]) {
// do something
}
// Set的寫(xiě)法
const properties = new Set();
properties.add('width');
properties.add('height');
if (properties.has(someName)) {
// do something
}
Array.from方法可以將 Set 結(jié)構(gòu)轉(zhuǎn)為數(shù)組。
const items = new Set([1, 2, 3, 4, 5]);
const array = Array.from(items);
這就提供了去除數(shù)組重復(fù)成員的另一種方法。
function dedupe(array) {
return Array.from(new Set(array));
}
dedupe([1, 1, 2, 3]) // [1, 2, 3]
遍歷操作
Set 結(jié)構(gòu)的實(shí)例有四個(gè)遍歷方法,可以用于遍歷成員。
-
Set.prototype.keys():返回鍵名的遍歷器 -
Set.prototype.values():返回鍵值的遍歷器 -
Set.prototype.entries():返回鍵值對(duì)的遍歷器 -
Set.prototype.forEach():使用回調(diào)函數(shù)遍歷每個(gè)成員
需要特別指出的是,Set的遍歷順序就是插入順序。這個(gè)特性有時(shí)非常有用,比如使用 Set 保存一個(gè)回調(diào)函數(shù)列表,調(diào)用時(shí)就能保證按照添加順序調(diào)用。
(1)keys(),values(),entries()
keys方法、values方法、entries方法返回的都是遍歷器對(duì)象(詳見(jiàn)《Iterator 對(duì)象》一章)。由于 Set 結(jié)構(gòu)沒(méi)有鍵名,只有鍵值(或者說(shuō)鍵名和鍵值是同一個(gè)值),所以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方法返回的遍歷器,同時(shí)包括鍵名和鍵值,所以每次輸出一個(gè)數(shù)組,它的兩個(gè)成員完全相等。
Set 結(jié)構(gòu)的實(shí)例默認(rèn)可遍歷,它的默認(rèn)遍歷器生成函數(shù)就是它的values方法。
Set.prototype[Symbol.iterator] === Set.prototype.values
// true
這意味著,可以省略values方法,直接用for...of循環(huán)遍歷 Set。
let set = new Set(['red', 'green', 'blue']);
for (let x of set) {
console.log(x);
}
// red
// green
// blue
(2)forEach()
Set 結(jié)構(gòu)的實(shí)例與數(shù)組一樣,也擁有forEach方法,用于對(duì)每個(gè)成員執(zhí)行某種操作,沒(méi)有返回值。
let set = new Set([1, 4, 9]);
set.forEach((value, key) => console.log(key + ' : ' + value))
// 1 : 1
// 4 : 4
// 9 : 9
上面代碼說(shuō)明,forEach方法的參數(shù)就是一個(gè)處理函數(shù)。該函數(shù)的參數(shù)與數(shù)組的forEach一致,依次為鍵值、鍵名、集合本身(上例省略了該參數(shù))。這里需要注意,Set 結(jié)構(gòu)的鍵名就是鍵值(兩者是同一個(gè)值),因此第一個(gè)參數(shù)與第二個(gè)參數(shù)的值永遠(yuǎn)都是一樣的。
另外,forEach方法還可以有第二個(gè)參數(shù),表示綁定處理函數(shù)內(nèi)部的this對(duì)象。
(3)遍歷的應(yīng)用
擴(kuò)展運(yùn)算符(...)內(nèi)部使用for...of循環(huán),所以也可以用于 Set 結(jié)構(gòu)。
let set = new Set(['red', 'green', 'blue']);
let arr = [...set];
// ['red', 'green', 'blue']
擴(kuò)展運(yùn)算符和 Set 結(jié)構(gòu)相結(jié)合,就可以去除數(shù)組的重復(fù)成員。
let arr = [3, 5, 2, 2, 5, 5];
let unique = [...new Set(arr)];
// [3, 5, 2]
而且,數(shù)組的map和filter方法也可以間接用于 Set 了。
let set = new Set([1, 2, 3]);
set = new Set([...set].map(x => x * 2));
// 返回Set結(jié)構(gòu):{2, 4, 6}
let set = new Set([1, 2, 3, 4, 5]);
set = new Set([...set].filter(x => (x % 2) == 0));
// 返回Set結(jié)構(gòu):{2, 4}
因此使用 Set 可以很容易地實(shí)現(xiàn)并集(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 相對(duì)于 b 的)差集
let difference = new Set([...a].filter(x => !b.has(x)));
// Set {1}
如果想在遍歷操作中,同步改變?cè)瓉?lái)的 Set 結(jié)構(gòu),目前沒(méi)有直接的方法,但有兩種變通方法。一種是利用原 Set 結(jié)構(gòu)映射出一個(gè)新的結(jié)構(gòu),然后賦值給原來(lái)的 Set 結(jié)構(gòu);另一種是利用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
上面代碼提供了兩種方法,直接在遍歷操作中改變?cè)瓉?lái)的 Set 結(jié)構(gòu)。
WeakSet
含義
WeakSet 結(jié)構(gòu)與 Set 類(lèi)似,也是不重復(fù)的值的集合。但是,它與 Set 有兩個(gè)區(qū)別。
首先,WeakSet 的成員只能是對(duì)象,而不能是其他類(lèi)型的值。
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 添加一個(gè)數(shù)值和Symbol值,結(jié)果報(bào)錯(cuò),因?yàn)?WeakSet 只能放置對(duì)象。
其次,WeakSet 中的對(duì)象都是弱引用,即垃圾回收機(jī)制不考慮 WeakSet 對(duì)該對(duì)象的引用,也就是說(shuō),如果其他對(duì)象都不再引用該對(duì)象,那么垃圾回收機(jī)制會(huì)自動(dòng)回收該對(duì)象所占用的內(nèi)存,不考慮該對(duì)象還存在于 WeakSet 之中。
這是因?yàn)槔厥諜C(jī)制根據(jù)對(duì)象的可達(dá)性(reachability)來(lái)判斷回收,如果對(duì)象還能被訪問(wèn)到,垃圾回收機(jī)制就不會(huì)釋放這塊內(nèi)存。結(jié)束使用該值之后,有時(shí)會(huì)忘記取消引用,導(dǎo)致內(nèi)存無(wú)法釋放,進(jìn)而可能會(huì)引發(fā)內(nèi)存泄漏。WeakSet 里面的引用,都不計(jì)入垃圾回收機(jī)制,所以就不存在這個(gè)問(wèn)題。因此,WeakSet 適合臨時(shí)存放一組對(duì)象,以及存放跟對(duì)象綁定的信息。只要這些對(duì)象在外部消失,它在 WeakSet 里面的引用就會(huì)自動(dòng)消失。
由于上面這個(gè)特點(diǎn),WeakSet 的成員是不適合引用的,因?yàn)樗鼤?huì)隨時(shí)消失。另外,由于 WeakSet 內(nèi)部有多少個(gè)成員,取決于垃圾回收機(jī)制有沒(méi)有運(yùn)行,運(yùn)行前后很可能成員個(gè)數(shù)是不一樣的,而垃圾回收機(jī)制何時(shí)運(yùn)行是不可預(yù)測(cè)的,因此 ES6 規(guī)定 WeakSet 不可遍歷。
這些特點(diǎn)同樣適用于本章后面要介紹的 WeakMap 結(jié)構(gòu)。
語(yǔ)法
WeakSet 是一個(gè)構(gòu)造函數(shù),可以使用new命令,創(chuàng)建 WeakSet 數(shù)據(jù)結(jié)構(gòu)。
const ws = new WeakSet();
作為構(gòu)造函數(shù),WeakSet 可以接受一個(gè)數(shù)組或類(lèi)似數(shù)組的對(duì)象作為參數(shù)。(實(shí)際上,任何具有 Iterable 接口的對(duì)象,都可以作為 WeakSet 的參數(shù)。)該數(shù)組的所有成員,都會(huì)自動(dòng)成為 WeakSet 實(shí)例對(duì)象的成員。
const a = [[1, 2], [3, 4]];
const ws = new WeakSet(a);
// WeakSet {[1, 2], [3, 4]}
上面代碼中,a是一個(gè)數(shù)組,它有兩個(gè)成員,也都是數(shù)組。將a作為 WeakSet 構(gòu)造函數(shù)的參數(shù),a的成員會(huì)自動(dòng)成為 WeakSet 的成員。
注意,是a數(shù)組的成員成為 WeakSet 的成員,而不是a數(shù)組本身。這意味著,數(shù)組的成員只能是對(duì)象。
const b = [3, 4];
const ws = new WeakSet(b);
// Uncaught TypeError: Invalid value used in weak set(…)
上面代碼中,數(shù)組b的成員不是對(duì)象,加入 WeakSet 就會(huì)報(bào)錯(cuò)。
WeakSet 結(jié)構(gòu)有以下三個(gè)方法。
- WeakSet.prototype.add(value):向 WeakSet 實(shí)例添加一個(gè)新成員。
- WeakSet.prototype.delete(value):清除 WeakSet 實(shí)例的指定成員。
- WeakSet.prototype.has(value):返回一個(gè)布爾值,表示某個(gè)值是否在 WeakSet 實(shí)例之中。
下面是一個(gè)例子。
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 沒(méi)有size屬性,沒(méi)有辦法遍歷它的成員。
ws.size // undefined
ws.forEach // undefined
ws.forEach(function(item){ console.log('WeakSet has ' + item)})
// TypeError: undefined is not a function
上面代碼試圖獲取size和forEach屬性,結(jié)果都不能成功。
WeakSet 不能遍歷,是因?yàn)槌蓡T都是弱引用,隨時(shí)可能消失,遍歷機(jī)制無(wú)法保證成員的存在,很可能剛剛遍歷結(jié)束,成員就取不到了。WeakSet 的一個(gè)用處,是儲(chǔ)存 DOM 節(jié)點(diǎn),而不用擔(dān)心這些節(jié)點(diǎn)從文檔移除時(shí),會(huì)引發(fā)內(nèi)存泄漏。
下面是 WeakSet 的另一個(gè)例子。
const foos = new WeakSet()
class Foo {
constructor() {
foos.add(this)
}
method () {
if (!foos.has(this)) {
throw new TypeError('Foo.prototype.method 只能在Foo的實(shí)例上調(diào)用!');
}
}
}
上面代碼保證了Foo的實(shí)例方法,只能在Foo的實(shí)例上調(diào)用。這里使用 WeakSet 的好處是,foos對(duì)實(shí)例的引用,不會(huì)被計(jì)入內(nèi)存回收機(jī)制,所以刪除實(shí)例的時(shí)候,不用考慮foos,也不會(huì)出現(xiàn)內(nèi)存泄漏。
Map
含義和基本用法
JavaScript 的對(duì)象(Object),本質(zhì)上是鍵值對(duì)的集合(Hash 結(jié)構(gòu)),但是傳統(tǒng)上只能用字符串當(dāng)作鍵。這給它的使用帶來(lái)了很大的限制。
const data = {};
const element = document.getElementById('myDiv');
data[element] = 'metadata';
data['[object HTMLDivElement]'] // "metadata"
上面代碼原意是將一個(gè) DOM 節(jié)點(diǎn)作為對(duì)象data的鍵,但是由于對(duì)象只接受字符串作為鍵名,所以element被自動(dòng)轉(zhuǎn)為字符串[object HTMLDivElement]。
為了解決這個(gè)問(wèn)題,ES6 提供了 Map 數(shù)據(jù)結(jié)構(gòu)。它類(lèi)似于對(duì)象,也是鍵值對(duì)的集合,但是“鍵”的范圍不限于字符串,各種類(lèi)型的值(包括對(duì)象)都可以當(dāng)作鍵。也就是說(shuō),Object 結(jié)構(gòu)提供了“字符串—值”的對(duì)應(yīng),Map 結(jié)構(gòu)提供了“值—值”的對(duì)應(yīng),是一種更完善的 Hash 結(jié)構(gòu)實(shí)現(xiàn)。如果你需要“鍵值對(duì)”的數(shù)據(jù)結(jié)構(gòu),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 結(jié)構(gòu)的set方法,將對(duì)象o當(dāng)作m的一個(gè)鍵,然后又使用get方法讀取這個(gè)鍵,接著使用delete方法刪除了這個(gè)鍵。
上面的例子展示了如何向 Map 添加成員。作為構(gòu)造函數(shù),Map 也可以接受一個(gè)數(shù)組作為參數(shù)。該數(shù)組的成員是一個(gè)個(gè)表示鍵值對(duì)的數(shù)組。
const map = new Map([
['name', '張三'],
['title', 'Author']
]);
map.size // 2
map.has('name') // true
map.get('name') // "張三"
map.has('title') // true
map.get('title') // "Author"
上面代碼在新建 Map 實(shí)例時(shí),就指定了兩個(gè)鍵name和title。
Map構(gòu)造函數(shù)接受數(shù)組作為參數(shù),實(shí)際上執(zhí)行的是下面的算法。
const items = [
['name', '張三'],
['title', 'Author']
];
const map = new Map();
items.forEach(
([key, value]) => map.set(key, value)
);
事實(shí)上,不僅僅是數(shù)組,任何具有 Iterator 接口、且每個(gè)成員都是一個(gè)雙元素的數(shù)組的數(shù)據(jù)結(jié)構(gòu)(詳見(jiàn)《Iterator》一章)都可以當(dāng)作Map構(gòu)造函數(shù)的參數(shù)。這就是說(shuō),Set和Map都可以用來(lái)生成新的 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 對(duì)象和 Map 對(duì)象,當(dāng)作Map構(gòu)造函數(shù)的參數(shù),結(jié)果都生成了新的 Map 對(duì)象。
如果對(duì)同一個(gè)鍵多次賦值,后面的值將覆蓋前面的值。
const map = new Map();
map
.set(1, 'aaa')
.set(1, 'bbb');
map.get(1) // "bbb"
上面代碼對(duì)鍵1連續(xù)賦值兩次,后一次的值覆蓋前一次的值。
如果讀取一個(gè)未知的鍵,則返回undefined。
new Map().get('asfddfsasadf')
// undefined
注意,只有對(duì)同一個(gè)對(duì)象的引用,Map 結(jié)構(gòu)才將其視為同一個(gè)鍵。這一點(diǎn)要非常小心。
const map = new Map();
map.set(['a'], 555);
map.get(['a']) // undefined
上面代碼的set和get方法,表面是針對(duì)同一個(gè)鍵,但實(shí)際上這是兩個(gè)不同的數(shù)組實(shí)例,內(nèi)存地址是不一樣的,因此get方法無(wú)法讀取該鍵,返回undefined。
同理,同樣的值的兩個(gè)實(shí)例,在 Map 結(jié)構(gòu)中被視為兩個(gè)鍵。
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的值是一樣的,但是它們?cè)?Map 結(jié)構(gòu)中被視為兩個(gè)鍵。
由上可知,Map 的鍵實(shí)際上是跟內(nèi)存地址綁定的,只要內(nèi)存地址不一樣,就視為兩個(gè)鍵。這就解決了同名屬性碰撞(clash)的問(wèn)題,我們擴(kuò)展別人的庫(kù)的時(shí)候,如果使用對(duì)象作為鍵名,就不用擔(dān)心自己的屬性與原作者的屬性同名。
如果 Map 的鍵是一個(gè)簡(jiǎn)單類(lèi)型的值(數(shù)字、字符串、布爾值),則只要兩個(gè)值嚴(yán)格相等,Map 將其視為一個(gè)鍵,比如0和-0就是一個(gè)鍵,布爾值true和字符串true則是兩個(gè)不同的鍵。另外,undefined和null也是兩個(gè)不同的鍵。雖然NaN不嚴(yán)格相等于自身,但 Map 將其視為同一個(gè)鍵。
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
實(shí)例的屬性和操作方法
Map 結(jié)構(gòu)的實(shí)例有以下屬性和操作方法。
(1)size 屬性
size屬性返回 Map 結(jié)構(gòu)的成員總數(shù)。
const map = new Map();
map.set('foo', true);
map.set('bar', false);
map.size // 2
(2)Map.prototype.set(key, value)
set方法設(shè)置鍵名key對(duì)應(yīng)的鍵值為value,然后返回整個(gè) Map 結(jié)構(gòu)。如果key已經(jīng)有值,則鍵值會(huì)被更新,否則就新生成該鍵。
const m = new Map();
m.set('edition', 6) // 鍵是字符串
m.set(262, 'standard') // 鍵是數(shù)值
m.set(undefined, 'nah') // 鍵是 undefined
set方法返回的是當(dāng)前的Map對(duì)象,因此可以采用鏈?zhǔn)綄?xiě)法。
let map = new Map()
.set(1, 'a')
.set(2, 'b')
.set(3, 'c');
(3)Map.prototype.get(key)
get方法讀取key對(duì)應(yīng)的鍵值,如果找不到key,返回undefined。
const m = new Map();
const hello = function() {console.log('hello');};
m.set(hello, 'Hello ES6!') // 鍵是函數(shù)
m.get(hello) // Hello ES6!
(4)Map.prototype.has(key)
has方法返回一個(gè)布爾值,表示某個(gè)鍵是否在當(dāng)前 Map 對(duì)象之中。
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
(5)Map.prototype.delete(key)
delete方法刪除某個(gè)鍵,返回true。如果刪除失敗,返回false。
const m = new Map();
m.set(undefined, 'nah');
m.has(undefined) // true
m.delete(undefined)
m.has(undefined) // false
(6)Map.prototype.clear()
clear方法清除所有成員,沒(méi)有返回值。
let map = new Map();
map.set('foo', true);
map.set('bar', false);
map.size // 2
map.clear()
map.size // 0
遍歷方法
Map 結(jié)構(gòu)原生提供三個(gè)遍歷器生成函數(shù)和一個(gè)遍歷方法。
-
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[0], item[1]);
}
// "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"
上面代碼最后的那個(gè)例子,表示 Map 結(jié)構(gòu)的默認(rèn)遍歷器接口(Symbol.iterator屬性),就是entries方法。
map[Symbol.iterator] === map.entries
// true
Map 結(jié)構(gòu)轉(zhuǎn)為數(shù)組結(jié)構(gòu),比較快速的方法是使用擴(kuò)展運(yùn)算符(...)。
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']]
結(jié)合數(shù)組的map方法、filter方法,可以實(shí)現(xiàn) Map 的遍歷和過(guò)濾(Map 本身沒(méi)有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)
);
// 產(chǎn)生 Map 結(jié)構(gòu) {1 => 'a', 2 => 'b'}
const map2 = new Map(
[...map0].map(([k, v]) => [k * 2, '_' + v])
);
// 產(chǎn)生 Map 結(jié)構(gòu) {2 => '_a', 4 => '_b', 6 => '_c'}
此外,Map 還有一個(gè)forEach方法,與數(shù)組的forEach方法類(lèi)似,也可以實(shí)現(xiàn)遍歷。
map.forEach(function(value, key, map) {
console.log("Key: %s, Value: %s", key, value);
});
forEach方法還可以接受第二個(gè)參數(shù),用來(lái)綁定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方法的回調(diào)函數(shù)的this,就指向reporter。
與其他數(shù)據(jù)結(jié)構(gòu)的互相轉(zhuǎn)換
(1)Map 轉(zhuǎn)為數(shù)組
前面已經(jīng)提過(guò),Map 轉(zhuǎn)為數(shù)組最方便的方法,就是使用擴(kuò)展運(yùn)算符(...)。
const myMap = new Map()
.set(true, 7)
.set({foo: 3}, ['abc']);
[...myMap]
// [ [ true, 7 ], [ { foo: 3 }, [ 'abc' ] ] ]
(2)數(shù)組 轉(zhuǎn)為 Map
將數(shù)組傳入 Map 構(gòu)造函數(shù),就可以轉(zhuǎn)為 Map。
new Map([
[true, 7],
[{foo: 3}, ['abc']]
])
// Map {
// true => 7,
// Object {foo: 3} => ['abc']
// }
(3)Map 轉(zhuǎn)為對(duì)象
如果所有 Map 的鍵都是字符串,它可以無(wú)損地轉(zhuǎn)為對(duì)象。
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 }
如果有非字符串的鍵名,那么這個(gè)鍵名會(huì)被轉(zhuǎn)成字符串,再作為對(duì)象的鍵名。
(4)對(duì)象轉(zhuǎn)為 Map
對(duì)象轉(zhuǎn)為 Map 可以通過(guò)Object.entries()。
let obj = {"a":1, "b":2};
let map = new Map(Object.entries(obj));
此外,也可以自己實(shí)現(xiàn)一個(gè)轉(zhuǎn)換函數(shù)。
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}
(5)Map 轉(zhuǎn)為 JSON
Map 轉(zhuǎn)為 JSON 要區(qū)分兩種情況。一種情況是,Map 的鍵名都是字符串,這時(shí)可以選擇轉(zhuǎn)為對(duì)象 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 的鍵名有非字符串,這時(shí)可以選擇轉(zhuǎn)為數(shù)組 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"]]]'
(6)JSON 轉(zhuǎn)為 Map
JSON 轉(zhuǎn)為 Map,正常情況下,所有鍵名都是字符串。
function jsonToStrMap(jsonStr) {
return objToStrMap(JSON.parse(jsonStr));
}
jsonToStrMap('{"yes": true, "no": false}')
// Map {'yes' => true, 'no' => false}
但是,有一種特殊情況,整個(gè) JSON 就是一個(gè)數(shù)組,且每個(gè)數(shù)組成員本身,又是一個(gè)有兩個(gè)成員的數(shù)組。這時(shí),它可以一一對(duì)應(yīng)地轉(zhuǎn)為 Map。這往往是 Map 轉(zhuǎn)為數(shù)組 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結(jié)構(gòu)與Map結(jié)構(gòu)類(lèi)似,也是用于生成鍵值對(duì)的集合。
// WeakMap 可以使用 set 方法添加成員
const wm1 = new WeakMap();
const key = {foo: 1};
wm1.set(key, 2);
wm1.get(key) // 2
// WeakMap 也可以接受一個(gè)數(shù)組,
// 作為構(gòu)造函數(shù)的參數(shù)
const k1 = [1, 2, 3];
const k2 = [4, 5, 6];
const wm2 = new WeakMap([[k1, 'foo'], [k2, 'bar']]);
wm2.get(k2) // "bar"
WeakMap與Map的區(qū)別有兩點(diǎn)。
首先,WeakMap只接受對(duì)象作為鍵名(null除外),不接受其他類(lèi)型的值作為鍵名。
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
上面代碼中,如果將數(shù)值1和Symbol值作為 WeakMap 的鍵名,都會(huì)報(bào)錯(cuò)。
其次,WeakMap的鍵名所指向的對(duì)象,不計(jì)入垃圾回收機(jī)制。
WeakMap的設(shè)計(jì)目的在于,有時(shí)我們想在某個(gè)對(duì)象上面存放一些數(shù)據(jù),但是這會(huì)形成對(duì)于這個(gè)對(duì)象的引用。請(qǐng)看下面的例子。
const e1 = document.getElementById('foo');
const e2 = document.getElementById('bar');
const arr = [
[e1, 'foo 元素'],
[e2, 'bar 元素'],
];
上面代碼中,e1和e2是兩個(gè)對(duì)象,我們通過(guò)arr數(shù)組對(duì)這兩個(gè)對(duì)象添加一些文字說(shuō)明。這就形成了arr對(duì)e1和e2的引用。
一旦不再需要這兩個(gè)對(duì)象,我們就必須手動(dòng)刪除這個(gè)引用,否則垃圾回收機(jī)制就不會(huì)釋放e1和e2占用的內(nèi)存。
// 不需要 e1 和 e2 的時(shí)候
// 必須手動(dòng)刪除引用
arr [0] = null;
arr [1] = null;
上面這樣的寫(xiě)法顯然很不方便。一旦忘了寫(xiě),就會(huì)造成內(nèi)存泄露。
WeakMap 就是為了解決這個(gè)問(wèn)題而誕生的,它的鍵名所引用的對(duì)象都是弱引用,即垃圾回收機(jī)制不將該引用考慮在內(nèi)。因此,只要所引用的對(duì)象的其他引用都被清除,垃圾回收機(jī)制就會(huì)釋放該對(duì)象所占用的內(nèi)存。也就是說(shuō),一旦不再需要,WeakMap 里面的鍵名對(duì)象和所對(duì)應(yīng)的鍵值對(duì)會(huì)自動(dòng)消失,不用手動(dòng)刪除引用。
基本上,如果你要往對(duì)象上添加數(shù)據(jù),又不想干擾垃圾回收機(jī)制,就可以使用 WeakMap。一個(gè)典型應(yīng)用場(chǎng)景是,在網(wǎng)頁(yè)的 DOM 元素上添加數(shù)據(jù),就可以使用WeakMap結(jié)構(gòu)。當(dāng)該 DOM 元素被清除,其所對(duì)應(yīng)的WeakMap記錄就會(huì)自動(dòng)被移除。
const wm = new WeakMap();
const element = document.getElementById('example');
wm.set(element, 'some information');
wm.get(element) // "some information"
上面代碼中,先新建一個(gè) WeakMap 實(shí)例。然后,將一個(gè) DOM 節(jié)點(diǎn)作為鍵名存入該實(shí)例,并將一些附加信息作為鍵值,一起存放在 WeakMap 里面。這時(shí),WeakMap 里面對(duì)element的引用就是弱引用,不會(huì)被計(jì)入垃圾回收機(jī)制。
也就是說(shuō),上面的 DOM 節(jié)點(diǎn)對(duì)象除了 WeakMap 的弱引用外,其他位置對(duì)該對(duì)象的引用一旦消除,該對(duì)象占用的內(nèi)存就會(huì)被垃圾回收機(jī)制釋放。WeakMap 保存的這個(gè)鍵值對(duì),也會(huì)自動(dòng)消失。
總之,WeakMap的專(zhuān)用場(chǎng)合就是,它的鍵所對(duì)應(yīng)的對(duì)象,可能會(huì)在將來(lái)消失。WeakMap結(jié)構(gòu)有助于防止內(nèi)存泄漏。
注意,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 內(nèi)部的引用依然存在。
WeakMap 的語(yǔ)法
WeakMap 與 Map 在 API 上的區(qū)別主要是兩個(gè),一是沒(méi)有遍歷操作(即沒(méi)有keys()、values()和entries()方法),也沒(méi)有size屬性。因?yàn)闆](méi)有辦法列出所有鍵名,某個(gè)鍵名是否存在完全不可預(yù)測(cè),跟垃圾回收機(jī)制是否運(yùn)行相關(guān)。這一刻可以取到鍵名,下一刻垃圾回收機(jī)制突然運(yùn)行了,這個(gè)鍵名就沒(méi)了,為了防止出現(xiàn)不確定性,就統(tǒng)一規(guī)定不能取到鍵名。二是無(wú)法清空,即不支持clear方法。因此,WeakMap只有四個(gè)方法可用:get()、set()、has()、delete()。
const wm = new WeakMap();
// size、forEach、clear 方法都不存在
wm.size // undefined
wm.forEach // undefined
wm.clear // undefined
WeakMap 的示例
WeakMap 的例子很難演示,因?yàn)闊o(wú)法觀察它里面的引用會(huì)自動(dòng)消失。此時(shí),其他引用都解除了,已經(jīng)沒(méi)有引用指向 WeakMap 的鍵名了,導(dǎo)致無(wú)法證實(shí)那個(gè)鍵名是不是存在。
賀師俊老師提示,如果引用所指向的值占用特別多的內(nèi)存,就可以通過(guò) Node 的process.memoryUsage方法看出來(lái)。根據(jù)這個(gè)思路,網(wǎng)友vtxf補(bǔ)充了下面的例子。
首先,打開(kāi) Node 命令行。
$ node --expose-gc
上面代碼中,--expose-gc參數(shù)表示允許手動(dòng)執(zhí)行垃圾回收機(jī)制。
然后,執(zhí)行下面的代碼。
// 手動(dòng)執(zhí)行一次垃圾回收,保證獲取的內(nèi)存使用狀態(tài)準(zhǔn)確
> global.gc();
undefined
// 查看內(nèi)存占用的初始狀態(tài),heapUsed 為 4M 左右
> process.memoryUsage();
{ rss: 21106688,
heapTotal: 7376896,
heapUsed: 4153936,
external: 9059 }
> let wm = new WeakMap();
undefined
// 新建一個(gè)變量 key,指向一個(gè) 5*1024*1024 的數(shù)組
> let key = new Array(5 * 1024 * 1024);
undefined
// 設(shè)置 WeakMap 實(shí)例的鍵名,也指向 key 數(shù)組
// 這時(shí),key 數(shù)組實(shí)際被引用了兩次,
// 變量 key 引用一次,WeakMap 的鍵名引用了第二次
// 但是,WeakMap 是弱引用,對(duì)于引擎來(lái)說(shuō),引用計(jì)數(shù)還是1
> wm.set(key, 1);
WeakMap {}
> global.gc();
undefined
// 這時(shí)內(nèi)存占用 heapUsed 增加到 45M 了
> process.memoryUsage();
{ rss: 67538944,
heapTotal: 7376896,
heapUsed: 45782816,
external: 8945 }
// 清除變量 key 對(duì)數(shù)組的引用,
// 但沒(méi)有手動(dòng)清除 WeakMap 實(shí)例的鍵名對(duì)數(shù)組的引用
> key = null;
null
// 再次執(zhí)行垃圾回收
> global.gc();
undefined
// 內(nèi)存占用 heapUsed 變回 4M 左右,
// 可以看到 WeakMap 的鍵名引用沒(méi)有阻止 gc 對(duì)內(nèi)存的回收
> process.memoryUsage();
{ rss: 20639744,
heapTotal: 8425472,
heapUsed: 3979792,
external: 8956 }
上面代碼中,只要外部的引用消失,WeakMap 內(nèi)部的引用,就會(huì)自動(dòng)被垃圾回收清除。由此可見(jiàn),有了 WeakMap 的幫助,解決內(nèi)存泄漏就會(huì)簡(jiǎn)單很多。
Chrome 瀏覽器的 Dev Tools 的 Memory 面板,有一個(gè)垃圾桶的按鈕,可以強(qiáng)制垃圾回收(garbage collect)。這個(gè)按鈕也能用來(lái)觀察 WeakMap 里面的引用是否消失。
WeakMap 的用途
前文說(shuō)過(guò),WeakMap 應(yīng)用的典型場(chǎng)合就是 DOM 節(jié)點(diǎn)作為鍵名。下面是一個(gè)例子。
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')是一個(gè) DOM 節(jié)點(diǎn),每當(dāng)發(fā)生click事件,就更新一下?tīng)顟B(tài)。我們將這個(gè)狀態(tài)作為鍵值放在 WeakMap 里,對(duì)應(yīng)的鍵名就是這個(gè)節(jié)點(diǎn)對(duì)象。一旦這個(gè) DOM 節(jié)點(diǎn)刪除,該狀態(tài)就會(huì)自動(dòng)消失,不存在內(nèi)存泄漏風(fēng)險(xiǎn)。
WeakMap 的另一個(gè)用處是部署私有屬性。
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類(lèi)的兩個(gè)內(nèi)部屬性_counter和_action,是實(shí)例的弱引用,所以如果刪除實(shí)例,它們也就隨之消失,不會(huì)造成內(nèi)存泄漏。
WeakRef
WeakSet 和 WeakMap 是基于弱引用的數(shù)據(jù)結(jié)構(gòu),ES2021 更進(jìn)一步,提供了 WeakRef 對(duì)象,用于直接創(chuàng)建對(duì)象的弱引用。
let target = {};
let wr = new WeakRef(target);
上面示例中,target是原始對(duì)象,構(gòu)造函數(shù)WeakRef()創(chuàng)建了一個(gè)基于target的新對(duì)象wr。這里,wr就是一個(gè) WeakRef 的實(shí)例,屬于對(duì)target的弱引用,垃圾回收機(jī)制不會(huì)計(jì)入這個(gè)引用,也就是說(shuō),wr的引用不會(huì)妨礙原始對(duì)象target被垃圾回收機(jī)制清除。
WeakRef 實(shí)例對(duì)象有一個(gè)deref()方法,如果原始對(duì)象存在,該方法返回原始對(duì)象;如果原始對(duì)象已經(jīng)被垃圾回收機(jī)制清除,該方法返回undefined。
let target = {};
let wr = new WeakRef(target);
let obj = wr.deref();
if (obj) { // target 未被垃圾回收機(jī)制清除
// ...
}
上面示例中,deref()方法可以判斷原始對(duì)象是否已被清除。
弱引用對(duì)象的一大用處,就是作為緩存,未被清除時(shí)可以從緩存取值,一旦清除緩存就自動(dòng)失效。
function makeWeakCached(f) {
const cache = new Map();
return key => {
const ref = cache.get(key);
if (ref) {
const cached = ref.deref();
if (cached !== undefined) return cached;
}
const fresh = f(key);
cache.set(key, new WeakRef(fresh));
return fresh;
};
}
const getImageCached = makeWeakCached(getImage);
上面示例中,makeWeakCached()用于建立一個(gè)緩存,緩存里面保存對(duì)原始文件的弱引用。
注意,標(biāo)準(zhǔn)規(guī)定,一旦使用WeakRef()創(chuàng)建了原始對(duì)象的弱引用,那么在本輪事件循環(huán)(event loop),原始對(duì)象肯定不會(huì)被清除,只會(huì)在后面的事件循環(huán)才會(huì)被清除。
FinalizationRegistry
ES2021 引入了清理器注冊(cè)表功能 FinalizationRegistry,用來(lái)指定目標(biāo)對(duì)象被垃圾回收機(jī)制清除以后,所要執(zhí)行的回調(diào)函數(shù)。
首先,新建一個(gè)注冊(cè)表實(shí)例。
const registry = new FinalizationRegistry(heldValue => {
// ....
});
上面代碼中,FinalizationRegistry()是系統(tǒng)提供的構(gòu)造函數(shù),返回一個(gè)清理器注冊(cè)表實(shí)例,里面登記了所要執(zhí)行的回調(diào)函數(shù)?;卣{(diào)函數(shù)作為FinalizationRegistry()的參數(shù)傳入,它本身有一個(gè)參數(shù)heldValue。
然后,注冊(cè)表實(shí)例的register()方法,用來(lái)注冊(cè)所要觀察的目標(biāo)對(duì)象。
registry.register(theObject, "some value");
上面示例中,theObject就是所要觀察的目標(biāo)對(duì)象,一旦該對(duì)象被垃圾回收機(jī)制清除,注冊(cè)表就會(huì)在清除完成后,調(diào)用早前注冊(cè)的回調(diào)函數(shù),并將some value作為參數(shù)(前面的heldValue)傳入回調(diào)函數(shù)。
注意,注冊(cè)表不對(duì)目標(biāo)對(duì)象theObject構(gòu)成強(qiáng)引用,屬于弱引用。因?yàn)閺?qiáng)引用的話,原始對(duì)象就不會(huì)被垃圾回收機(jī)制清除,這就失去使用注冊(cè)表的意義了。
回調(diào)函數(shù)的參數(shù)heldValue可以是任意類(lèi)型的值,字符串、數(shù)值、布爾值、對(duì)象,甚至可以是undefined。
最后,如果以后還想取消已經(jīng)注冊(cè)的回調(diào)函數(shù),則要向register()傳入第三個(gè)參數(shù),作為標(biāo)記值。這個(gè)標(biāo)記值必須是對(duì)象,一般都用原始對(duì)象。接著,再使用注冊(cè)表實(shí)例對(duì)象的unregister()方法取消注冊(cè)。
registry.register(theObject, "some value", theObject);
// ...其他操作...
registry.unregister(theObject);
上面代碼中,register()方法的第三個(gè)參數(shù)就是標(biāo)記值theObject。取消回調(diào)函數(shù)時(shí),要使用unregister()方法,并將標(biāo)記值作為該方法的參數(shù)。這里register()方法對(duì)第三個(gè)參數(shù)的引用,也屬于弱引用。如果沒(méi)有這個(gè)參數(shù),則回調(diào)函數(shù)無(wú)法取消。
由于回調(diào)函數(shù)被調(diào)用以后,就不再存在于注冊(cè)表之中了,所以執(zhí)行unregister()應(yīng)該是在回調(diào)函數(shù)還沒(méi)被調(diào)用之前。
下面使用FinalizationRegistry,對(duì)前一節(jié)的緩存函數(shù)進(jìn)行增強(qiáng)。
function makeWeakCached(f) {
const cache = new Map();
const cleanup = new FinalizationRegistry(key => {
const ref = cache.get(key);
if (ref && !ref.deref()) cache.delete(key);
});
return key => {
const ref = cache.get(key);
if (ref) {
const cached = ref.deref();
if (cached !== undefined) return cached;
}
const fresh = f(key);
cache.set(key, new WeakRef(fresh));
cleanup.register(fresh, key);
return fresh;
};
}
const getImageCached = makeWeakCached(getImage);
上面示例與前一節(jié)的例子相比,就是增加一個(gè)清理器注冊(cè)表,一旦緩存的原始對(duì)象被垃圾回收機(jī)制清除,會(huì)自動(dòng)執(zhí)行一個(gè)回調(diào)函數(shù)。該回調(diào)函數(shù)會(huì)清除緩存里面已經(jīng)失效的鍵。
下面是另一個(gè)例子。
class Thingy {
#file;
#cleanup = file => {
console.error(
`The \`release\` method was never called for the \`Thingy\` for the file "${file.name}"`
);
};
#registry = new FinalizationRegistry(this.#cleanup);
constructor(filename) {
this.#file = File.open(filename);
this.#registry.register(this, this.#file, this.#file);
}
release() {
if (this.#file) {
this.#registry.unregister(this.#file);
File.close(this.#file);
this.#file = null;
}
}
}
上面示例中,如果由于某種原因,Thingy類(lèi)的實(shí)例對(duì)象沒(méi)有調(diào)用release()方法,就被垃圾回收機(jī)制清除了,那么清理器就會(huì)調(diào)用回調(diào)函數(shù)#cleanup(),輸出一條錯(cuò)誤信息。
由于無(wú)法知道清理器何時(shí)會(huì)執(zhí)行,所以最好避免使用它。另外,如果瀏覽器窗口關(guān)閉或者進(jìn)程意外退出,清理器則不會(huì)運(yùn)行。