Set 和 Map 數(shù)據(jù)結(jié)構(gòu)

Set

基本用法

ES6 提供了新的數(shù)據(jù)結(jié)構(gòu) Set。它類似于數(shù)組，但是成員的值都是唯一的，沒有重復(fù)的值。

Set 本身是一個(gè)構(gòu)造函數(shù)，用來生成 Set 數(shù)據(jù)結(jié)構(gòu)。

var s = new Set();

[2,3,5,4,5,2,2].map(x => s.add(x))

for (i of s) {console.log(i)}
// 2 3 5 4

上面代碼通過 add 方法向 Set 結(jié)構(gòu)加入成員，結(jié)果表明 Set 結(jié)構(gòu)不會(huì)添加重復(fù)的值。

Set 函數(shù)可以接受一個(gè)數(shù)組作為參數(shù)，用來初始化。

var items = new Set([1,2,3,4,5,5,5,5]);
items.size // 5

向 Set 加入值的時(shí)候，不會(huì)發(fā)生類型轉(zhuǎn)換，所以 5 和“5”是兩個(gè)不同的值。Set 內(nèi)部判斷兩個(gè)值是否不同，使用的算法類似于精確相等運(yùn)算符（===），這意味著，兩個(gè)對象總是不相等的。唯一的例外是 NaN 等于自身（精確相等運(yùn)算符認(rèn)為 NaN 不等于自身）。

let set = new Set();

set.add({})
set.size // 1

set.add({})
set.size // 2

上面代碼表示，由于兩個(gè)空對象不是精確相等，所以它們被視為兩個(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í)例的方法分為兩大類：操作方法（用于操作數(shù)據(jù)）和遍歷方法（用于遍歷成員）。下面先介紹四個(gè)操作方法。

• add(value)：添加某個(gè)值，返回 Set 結(jié)構(gòu)本身。
• delete(value)：刪除某個(gè)值，返回一個(gè)布爾值，表示刪除是否成功。
• has(value)：返回一個(gè)布爾值，表示該值是否為 Set 的成員。
• clear()：清除所有成員，沒有返回值。

上面這些屬性和方法的實(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è)對比，看看在判斷是否包括一個(gè)鍵上面，Object 結(jié)構(gòu)和 Set 結(jié)構(gòu)的寫法不同。

// 對象的寫法
var properties = {
  "width": 1,
  "height": 1
};

if (properties[someName]) {
  // do something
}

// Set的寫法
var properties = new Set();

properties.add("width");
properties.add("height");

if (properties.has(someName)) {
  // do something
}

Array.from 方法可以將 Set 結(jié)構(gòu)轉(zhuǎn)為數(shù)組。

var items = new Set([1, 2, 3, 4, 5]);
var 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è)遍歷方法，可以用于遍歷成員。

• keys()：返回一個(gè)鍵名的遍歷器
• values()：返回一個(gè)鍵值的遍歷器
• entries()：返回一個(gè)鍵值對的遍歷器
• forEach()：使用回調(diào)函數(shù)遍歷每個(gè)成員

key 方法、value 方法、entries 方法返回的都是遍歷器（詳見《Iterator 對象》一章）。由于 Set 結(jié)構(gòu)沒有鍵名，只有鍵值（或者說鍵名和鍵值是同一個(gè)值），所以 key 方法和 value 方法的行為完全一致。

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)遍歷器就是它的 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

由于擴(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']

這就提供了另一種便捷的去除數(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）。

let a = new Set([1, 2, 3]);
let b = new Set([4, 3, 2]);

let union = new Set([...a, ...b]);
// [1, 2, 3, 4]

let intersect = new Set([...a].filter(x => b.has(x)));
// [2, 3]

Set 結(jié)構(gòu)的實(shí)例的 forEach 方法，用于對每個(gè)成員執(zhí)行某種操作，沒有返回值。

let set = new Set([1, 2, 3]);
set.forEach((value, key) => console.log(value * 2) )
// 2
// 4
// 6

上面代碼說明，forEach 方法的參數(shù)就是一個(gè)處理函數(shù)。該函數(shù)的參數(shù)依次為鍵值、鍵名、集合本身（上例省略了該參數(shù)）。另外，forEach 方法還可以有第二個(gè)參數(shù)，表示綁定的 this 對象。

如果想在遍歷操作中，同步改變原來的 Set 結(jié)構(gòu)，目前沒有直接的方法，但有兩種變通方法。一種是利用原 Set 結(jié)構(gòu)映射出一個(gè)新的結(jié)構(gòu)，然后賦值給原來的 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

上面代碼提供了兩種方法，直接在遍歷操作中改變原來的 Set 結(jié)構(gòu)。

WeakSet

WeakSet 結(jié)構(gòu)與 Set 類似，也是不重復(fù)的值的集合。但是，它與 Set 有兩個(gè)區(qū)別。

首先，WeakSet 的成員只能是對象，而不能是其他類型的值。

其次，WeakSet 中的對象都是弱引用，即垃圾回收機(jī)制不考慮 WeakSet 對該對象的引用，也就是說，如果其他對象都不再引用該對象，那么垃圾回收機(jī)制會(huì)自動(dòng)回收該對象所占用的內(nèi)存，不考慮該對象還存在于 WeakSet 之中。這個(gè)特點(diǎn)意味著，無法引用 WeakSet 的成員，因此 WeakSet 是不可遍歷的。

var ws = new WeakSet();
ws.add(1)
// TypeError: Invalid value used in weak set

上面代碼試圖向 WeakSet 添加一個(gè)數(shù)值，結(jié)果報(bào)錯(cuò)。

WeakSet 是一個(gè)構(gòu)造函數(shù)，可以使用 new 命令，創(chuàng)建 WeakSet 數(shù)據(jù)結(jié)構(gòu)。

var ws = new WeakSet();

作為構(gòu)造函數(shù)，WeakSet 可以接受一個(gè)數(shù)組或類似數(shù)組的對象作為參數(shù)。（實(shí)際上，任何具有 iterable 接口的對象，都可以作為 WeakSet 的對象。）該數(shù)組的所有成員，都會(huì)自動(dòng)成為 WeakSet 實(shí)例對象的成員。

var a = [[1,2], [3,4]];
var ws = new WeakSet(a);

上面代碼中，a 是一個(gè)數(shù)組，它有兩個(gè)成員，也都是數(shù)組。將 a 作為 WeakSet 構(gòu)造函數(shù)的參數(shù)，a 的成員會(huì)自動(dòng)成為 WeakSet 的成員。

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è)例子。

var ws = new WeakSet();
var obj = {};
var 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('WeakSet has ' + item)})
// TypeError: undefined is not a function

上面代碼試圖獲取 size 和 forEach 屬性，結(jié)果都不能成功。

WeakSet 不能遍歷，是因?yàn)槌蓡T都是弱引用，隨時(shí)可能消失，遍歷機(jī)制無法保存成員的存在，很可能剛剛遍歷結(jié)束，成員就取不到了。WeakSet 的一個(gè)用處，是儲(chǔ)存 DOM 節(jié)點(diǎn)，而不用擔(dān)心這些節(jié)點(diǎn)從文檔移除時(shí)，會(huì)引發(fā)內(nèi)存泄漏。

Map

Map 結(jié)構(gòu)的目的和基本用法

JavaScript 的對象（Object），本質(zhì)上是鍵值對的集合（Hash 結(jié)構(gòu)），但是只能用字符串當(dāng)作鍵。這給它的使用帶來了很大的限制。

var data = {};
var element = document.getElementById("myDiv");

data[element] = metadata;
data["[Object HTMLDivElement]"] // metadata

上面代碼原意是將一個(gè) DOM 節(jié)點(diǎn)作為對象 data 的鍵，但是由于對象只接受字符串作為鍵名，所以 element 被自動(dòng)轉(zhuǎn)為字符串[Object HTMLDivElement]。

為了解決這個(gè)問題，ES6 提供了 Map 數(shù)據(jù)結(jié)構(gòu)。它類似于對象，也是鍵值對的集合，但是“鍵”的范圍不限于字符串，各種類型的值（包括對象）都可以當(dāng)作鍵。也就是說，Object 結(jié)構(gòu)提供了“字符串—值”的對應(yīng)，Map 結(jié)構(gòu)提供了“值—值”的對應(yīng)，是一種更完善的 Hash 結(jié)構(gòu)實(shí)現(xiàn)。

var m = new Map();
var o = {p: "Hello World"};

m.set(o, "content")
m.get(o) // "content"

m.has(o) // true
m.delete(o) // true
m.has(o) // false

上面代碼使用 set 方法，將對象 o 當(dāng)作 m 的一個(gè)鍵，然后又使用 get 方法讀取這個(gè)鍵，接著使用 delete 方法刪除了這個(gè)鍵。

作為構(gòu)造函數(shù)，Map 也可以接受一個(gè)數(shù)組作為參數(shù)。該數(shù)組的成員是一個(gè)個(gè)表示鍵值對的數(shù)組。

var 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。

如果對同一個(gè)鍵多次賦值，后面的值將覆蓋前面的值。

let map = new Map();
map.set(1, 'aaa');
map.set(1, 'bbb');
map.get(1) // "bbb"

上面代碼對鍵 1 連續(xù)賦值兩次，后一次的值覆蓋前一次的值。

如果讀取一個(gè)未知的鍵，則返回 undefined。

new Map().get('asfddfsasadf')
// undefined

注意，只有對同一個(gè)對象的引用，Map 結(jié)構(gòu)才將其視為同一個(gè)鍵。這一點(diǎn)要非常小心。

var map = new Map();

map.set(['a'], 555);
map.get(['a']) // undefined

上面代碼的 set 和 get 方法，表面是針對同一個(gè)鍵，但實(shí)際上這是兩個(gè)值，內(nèi)存地址是不一樣的，因此 get 方法無法讀取該鍵，返回 undefined。

同理，同樣的值的兩個(gè)實(shí)例，在 Map 結(jié)構(gòu)中被視為兩個(gè)鍵。

var map = new Map();

var k1 = ['a'];
var k2 = ['a'];

map.set(k1, 111);
map.set(k2, 222);

map.get(k1) // 111
map.get(k2) // 222

上面代碼中，變量 k1 和 k2 的值是一樣的，但是它們在 Map 結(jié)構(gòu)中被視為兩個(gè)鍵。

由上可知，Map 的鍵實(shí)際上是跟內(nèi)存地址綁定的，只要內(nèi)存地址不一樣，就視為兩個(gè)鍵。這就解決了同名屬性碰撞（clash）的問題，我們擴(kuò)展別人的庫的時(shí)候，如果使用對象作為鍵名，就不用擔(dān)心自己的屬性與原作者的屬性同名。

如果 Map 的鍵是一個(gè)簡單類型的值（數(shù)字、字符串、布爾值），則只要兩個(gè)值嚴(yán)格相等，Map 將其視為一個(gè)鍵，包括 0 和 -0。另外，雖然 NaN 不嚴(yán)格相等于自身，但 Map 將其視為同一個(gè)鍵。

let map = new Map();

map.set(NaN, 123);
map.get(NaN) // 123

map.set(-0, 123);
map.get(+0) // 123

實(shí)例的屬性和操作方法

Map 結(jié)構(gòu)的實(shí)例有以下屬性和操作方法。

• size：返回成員總數(shù)。
• set(key, value)：設(shè)置 key 所對應(yīng)的鍵值，然后返回整個(gè) Map 結(jié)構(gòu)。如果 key 已經(jīng)有值，則鍵值會(huì)被更新，否則就新生成該鍵。
• get(key)：讀取 key 對應(yīng)的鍵值，如果找不到 key，返回 undefined。
• has(key)：返回一個(gè)布爾值，表示某個(gè)鍵是否在 Map 數(shù)據(jù)結(jié)構(gòu)中。
• delete(key)：刪除某個(gè)鍵，返回 true。如果刪除失敗，返回 false。
• clear()：清除所有成員，沒有返回值。

set()方法返回的是 Map 本身，因此可以采用鏈?zhǔn)綄懛ā?/p>

let map = new Map()
  .set(1, 'a')
  .set(2, 'b')
  .set(3, 'c');

下面是 has()和 delete()的例子。

var m = new Map();

m.set("edition", 6)        // 鍵是字符串
m.set(262, "standard")     // 鍵是數(shù)值
m.set(undefined, "nah")    // 鍵是undefined

var hello = function() {console.log("hello");}
m.set(hello, "Hello ES6!") // 鍵是函數(shù)

m.has("edition")     // true
m.has("years")       // false
m.has(262)           // true
m.has(undefined)     // true
m.has(hello)         // true

m.delete(undefined)
m.has(undefined)       // false

m.get(hello)  // Hello ES6!
m.get("edition")  // 6

下面是 size 屬性和 clear 方法的例子。

let map = new Map();
map.set('foo', true);
map.set('bar', false);

map.size // 2
map.clear()
map.size // 0

遍歷方法

Map 原生提供三個(gè)遍歷器。

• keys()：返回鍵名的遍歷器。
• values()：返回鍵值的遍歷器。
• entries()：返回所有成員的遍歷器。

下面是使用實(shí)例。

let 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);
}

// 等同于使用map.entries()
for (let [key, value] of map) {
  console.log(key, value);
}

上面代碼最后的那個(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)，比較快速的方法是結(jié)合使用擴(kuò)展運(yùn)算符（...）。

let 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 的遍歷和過濾（Map 本身沒有 map 和 filter 方法）。

let map0 = new Map()
  .set(1, 'a')
  .set(2, 'b')
  .set(3, 'c');

let map1 = new Map(
  [...map0].filter(([k, v]) => k < 3)
);
// 產(chǎn)生Map結(jié)構(gòu) {1 => 'a', 2 => 'b'}

let 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 方法類似，也可以實(shí)現(xiàn)遍歷。

map.forEach(function(value, key, map)) {
  console.log("Key: %s, Value: %s", key, value);
};

forEach 方法還可以接受第二個(gè)參數(shù)，用來綁定 this。

var 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。

WeakMap

WeakMap 結(jié)構(gòu)與 Map 結(jié)構(gòu)基本類似，唯一的區(qū)別是它只接受對象作為鍵名（null 除外），不接受原始類型的值作為鍵名，而且鍵名所指向的對象，不計(jì)入垃圾回收機(jī)制。

WeakMap 的設(shè)計(jì)目的在于，鍵名是對象的弱引用（垃圾回收機(jī)制不將該引用考慮在內(nèi)），所以其所對應(yīng)的對象可能會(huì)被自動(dòng)回收。當(dāng)對象被回收后，WeakMap 自動(dòng)移除對應(yīng)的鍵值對。典型應(yīng)用是，一個(gè)對應(yīng) DOM 元素的 WeakMap 結(jié)構(gòu)，當(dāng)某個(gè) DOM 元素被清除，其所對應(yīng)的 WeakMap 記錄就會(huì)自動(dòng)被移除?；旧希琖eakMap 的專用場合就是，它的鍵所對應(yīng)的對象，可能會(huì)在將來消失。WeakMap 結(jié)構(gòu)有助于防止內(nèi)存泄漏。

下面是 WeakMap 結(jié)構(gòu)的一個(gè)例子，可以看到用法上與 Map 幾乎一樣。

var wm = new WeakMap();
var element = document.querySelector(".element");

wm.set(element, "Original");
wm.get(element) // "Original"

element.parentNode.removeChild(element);
element = null;
wm.get(element) // undefined

上面代碼中，變量 wm 是一個(gè) WeakMap 實(shí)例，我們將一個(gè) DOM 節(jié)點(diǎn) element 作為鍵名，然后銷毀這個(gè)節(jié)點(diǎn)，element 對應(yīng)的鍵就自動(dòng)消失了，再引用這個(gè)鍵名就返回 undefined。

WeakMap 與 Map 在 API 上的區(qū)別主要是兩個(gè)，一是沒有遍歷操作（即沒有 key()、values() 和 entries()方法），也沒有 size 屬性；二是無法清空，即不支持 clear 方法。這與 WeakMap 的鍵不被計(jì)入引用、被垃圾回收機(jī)制忽略有關(guān)。因此，WeakMap 只有四個(gè)方法可用：get()、set()、has()、delete()。

var wm = new WeakMap();

wm.size
// undefined

wm.forEach
// undefined

前文說過，WeakMap 應(yīng)用的典型場合就是 DOM 節(jié)點(diǎn)作為鍵名。下面是一個(gè)例子。

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++;
  myWeakmap.set(myElement, logoData);
}, false);

上面代碼中，myElement 是一個(gè) DOM 節(jié)點(diǎn)，每當(dāng)發(fā)生 click 事件，就更新一下狀態(tài)。我們將這個(gè)狀態(tài)作為鍵值放在 WeakMap 里，對應(yīng)的鍵名就是 myElement。一旦這個(gè) DOM 節(jié)點(diǎn)刪除，該狀態(tài)就會(huì)自動(dòng)消失，不存在內(nèi)存泄漏風(fēng)險(xiǎn)。

WeakMap 的另一個(gè)用處是部署私有屬性。

let _counter = new WeakMap();
let _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)();
    }
  }
}

let c = new Countdown(2, () => console.log('DONE'));

c.dec()
c.dec()
// DONE

上面代碼中，Countdown 類的兩個(gè)內(nèi)部屬性_counter和_action，是實(shí)例的弱引用，所以如果刪除實(shí)例，它們也就隨之消失，不會(huì)造成內(nèi)存泄漏。