第23章 Set 和 Map 数据结构

1 Set

1.1 基本用法

Set本身是一个构造函数，用来生成 Set 数据结构。它类似于数组，但是成员的值都是唯一的。

Set函数可以接受一个数组（或者具有 iterable 接口的其他数据结构）作为参数，用来初始化。

// 参数为真数组，实现去重
const set = new Set([1, 2, 3, 4, 4]);
[...set]// [1, 2, 3, 4]

function dedupe(array) {
  return Array.from(new Set(array));
}
dedupe([1, 1, 2, 3]) // [1, 2, 3]：Array.from方法可以将 Set 结构转为数组

//参数为字符串，实现去重
[...new Set('ababbc')].join('')// "abc"

//参数为伪数组
const set = new Set(document.querySelectorAll('div'));
set.size // 56

let set = new Set();
let a = NaN;
let b = NaN;
set.add(a);
set.add(b);
set // Set {NaN}：Set 内部判断两个值是否不同，它类似于精确相等运算符（===）。主要的区别是向 Set 加入值时认为NaN等于自身

let set = new Set();
set.add({});
set.size // 1
set.add({});
set.size // 2：两个对象总是不相等的

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：实例用for-of遍历
}

1.2 Set 实例的属性和方法

• constructor：构造函数，默认就是Set函数
• size：返回Set实例的成员总数
• add(value)：添加某个值，返回 Set 结构本身
• has(value)：返回一个布尔值，表示该值是否为Set的成员
• delete(value)：删除某个值，返回一个布尔值，表示删除是否成功
• clear()：清除所有成员，没有返回值

s.add(1).add(2).add(2);
s.size // 2：注意2被加入了两次

s.has(2) // true
s.has(3) // false

s.delete(2);
s.has(2) // false

应用：判断是否包括一个键 

// 对象的写法
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
}

1.3 遍历操作

1.3.1遍历方法

• keys()：返回键名的遍历器
• values()：返回键值的遍历器
• entries()：返回键值对的遍历器
• forEach()：使用回调函数遍历每个成员，没有返回值。参数就是一个处理函数，函数参数依次为键值、键名、集合本身。第二个参数，表示绑定处理函数内部的this对象。

let set = new Set(['red', 'green', 'blue']);

for (let item of set.keys()) {//由于 Set 结构没有键名，只有键值,所以keys方法和values方法的行为完全一致
  console.log(item);
}
// red
// green
// blue

for (let item of set.values()) {//可以省略values方法，直接用for...of循环遍历 Set
  console.log(item);
}
// red
// green
// blue

for (let item of set.entries()) {
  console.log(item);
}
// ["red", "red"]
// ["green", "green"]
// ["blue", "blue"]

let set = new Set([1, 4, 9]);
set.forEach((value, key) => console.log(key + ' : ' + value))
// 1 : 1
// 4 : 4
// 9 : 9

1.3.2 遍历的应用

• 扩展运算符和 Set 结构相结合，就可以去除数组的重复成员。（数组去重）

let arr = [3, 5, 2, 2, 5, 5];
let unique = [...new Set(arr)];// [3, 5, 2]

• 数组的map和filter方法也可以间接用于 Set （转为真数组后使用map和filter）

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}

• 实现并集（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 结构
let set = new Set([1, 2, 3]);
set = new Set([...set].map(val => val * 2));
// set的值是2, 4, 6

// 方法二：Array.from方法
let set = new Set([1, 2, 3]);
set = new Set(Array.from(set, val => val * 2));
// set的值是2, 4, 6

2  WeakSet

2.1 含义

WeakSet 结构与 Set 类似，也是不重复的值的集合，WeakSet 的成员只能是对象。

如果其他对象都不再引用该对象，那么垃圾回收机制会自动回收该对象所占用的内存，不考虑该对象还存在于 WeakSet 之中。因此，WeakSet 适合临时存放一组对象，以及存放跟对象绑定的信息。只要这些对象在外部消失，它在 WeakSet 里面的引用就会自动消失。

WeakSet 的成员是不适合引用的，因为它会随时消失。另外，由于 WeakSet 内部有多少个成员，取决于垃圾回收机制有没有运行，运行前后很可能成员个数是不一样的，而垃圾回收机制何时运行是不可预测的，因此 ES6 规定 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

2.2 基本用法

 WeakSet 是一个构造函数，可以使用new命令，创建 WeakSet 数据结构。

作为构造函数，WeakSet 可以接受一个数组或类似数组的对象作为参数。（实际上，任何具有 Iterable 接口的对象，都可以作为 WeakSet 的参数。）该数组的所有成员，都会自动成为 WeakSet 实例对象的成员。

const ws = new WeakSet();

const a = [[1, 2], [3, 4]];
const ws = new WeakSet(a);// WeakSet {[1, 2], [3, 4]}：a的成员会自动成为 WeakSet 的成员

const b = [3, 4];
const ws = new WeakSet(b);// Uncaught TypeError: Invalid value used in weak set(…)：数组的成员只能是对象。

2.3 方法 

• 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.delete(window);
ws.has(window);    // false

WeakSet 不能遍历，是因为成员都是弱引用，随时可能消失，遍历机制无法保证成员的存在，很可能刚刚遍历结束，成员就取不到了。WeakSet 的一个用处，是储存 DOM 节点，而不用担心这些节点从文档移除时，会引发内存泄漏。

3 Map

3.0 Map和Object

• Map中的键值是有序的（FIFO 原则），遍历顺序就是插入顺序，但是还很快；而添加到对象中的键则不是。
• Map的键值对个数可以从 size 属性获取，而 Object 的键值对个数只能手动计算。
• Map的键的类型是任意的，而 Object 只能是字符串。

3.1 基本用法

Map本身是一个构造函数，用来生成Map 数据结构。它类似于对象，也是键值对的集合，但是“键”的范围不限于字符串，各种类型的值（包括对象）都可以当作键。

Map 也可以接受一个数组（或者具有 iterable 接口的其他数据结构）作为参数。该数组的成员是一个个表示键值对的数组。这就是说，Set和Map都可以用来生成新的 Map。

//参数的本质是二维数组
const map = new Map([
  ['name', '张三'],
  ['title', 'Author']
]);
map.size // 2
map.has('name') // true
map.get('name') // "张三"
//实际上执行的是下面的算法
const items = [
  ['name', '张三'],
  ['title', 'Author']
];
const map = new Map();
items.forEach(
  ([key, value]) => map.set(key, value)
);

//参数是set
const set = new Set([
  ['foo', 1],
  ['bar', 2]
]);
const m1 = new Map(set);
m1.get('foo') // 1
//参数是map
const m2 = new Map([['baz', 3]]);
const m3 = new Map(m2);
m3.get('baz') // 3

//如果对同一个键多次赋值，后面的值将覆盖前面的值
const map = new Map();
map
.set(1, 'aaa')
.set(1, 'bbb');
map.get(1) // "bbb"
//如果读取一个未知的键，则返回undefined
new Map().get('asfddfsasadf')
// undefined

• 如果 Map 的键是一个简单类型的值（数字、字符串、布尔值），则只要两个值严格相等，Map 将其视为一个键。虽然NaN不严格相等于自身，但 Map 将其视为同一个键。
• 如果 Map 的键是一个引用类型的值，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

//键的类型为对象
const m = new Map();
const o = {p: 'Hello World'};
m.set(o, 'content')
m.get(o) // "content"
//键的类型为数组
const map = new Map();
map.set(['a'], 555);
map.get(['a']) // undefined:实际上这是两个不同的数组实例，内存地址是不一样的，因此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

3.2 实例的属性和方法

• size属性，返回 Map 结构的成员总数
• set(key, value)，返回整个 Map 结构（即当前的Map对象），可以采用链式写法
• get(key)，如果找不到key，返回undefined
• has(key)，返回一个布尔值，表示某个键是否在当前 Map 对象之中
• delete(key)，删除某个键，返回true。如果删除失败，返回false
• clear()，清除所有成员，没有返回值

const map = new Map();
map.set('foo', true);
map.set('bar', false);
map.size // 2

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

const m = new Map();
const hello = function() {console.log('hello');};
m.set(hello, 'Hello ES6!') // 键是函数
m.get(hello)  // Hello ES6!

const m = new Map();
m.set('edition', 6);
m.has('edition')     // true
m.has('years')       // false

const m = new Map();
m.set(undefined, 'nah');
m.has(undefined)     // true
m.delete(undefined)
m.has(undefined)       // false

let map = new Map();
map.set('foo', true);
map.set('bar', false);
map.size // 2
map.clear()
map.size // 0

3.3 遍历方法

3.3.1方法

• keys()：返回键名的遍历器。
• values()：返回键值的遍历器。
• entries()：返回所有成员的遍历器。
• forEach()：遍历 Map 的所有成员。参数就是一个处理函数，函数参数依次value,key,map。接受第二个参数，用来绑定this

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 [key, value] of map.entries()) {//entries()可以省略
  console.log(key, value);
}
// "F" "no"
// "T" "yes"

const reporter = {
  report: function(key, value) {
    console.log("Key: %s, Value: %s", key, value);
  }
};

map.forEach(function(value, key, map) {
  this.report(key, value);//this，就指向reporter
}, reporter);

3.3.2 应用 

• Map 结构转为数组结构，比较快速的方法是使用扩展运算符（...）
• 结合数组的map方法、filter方法，可以实现 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']]

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'}

3.4 与其他数据结构的互相转换

（1）Map 转为数组

使用扩展运算符（...）

const myMap = new Map()
  .set(true, 7)
  .set({foo: 3}, ['abc']);
[...myMap]
// [ [ true, 7 ], [ { foo: 3 }, [ 'abc' ] ] ]

（2）数组 转为 Map

将数组传入 Map 构造函数

new Map([
  [true, 7],
  [{foo: 3}, ['abc']]
])
// Map {
//   true => 7,
//   Object {foo: 3} => ['abc']
// }

（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 }

（4）对象转为 Map

let obj = {"a":1, "b":2};
let map = new Map(Object.entries(obj));

（5）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}'

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 转为 Map

正常情况下，所有键名都是字符串。

整个 JSON 就是一个数组，且每个数组成员本身，又是一个有两个成员的数组。

function jsonToStrMap(jsonStr) {
  return objToStrMap(JSON.parse(jsonStr));
}

jsonToStrMap('{"yes": true, "no": false}')
// Map {'yes' => true, 'no' => false}

function jsonToMap(jsonStr) {
  return new Map(JSON.parse(jsonStr));
}

jsonToMap('[[true,7],[{"foo":3},["abc"]]]')
// Map {true => 7, Object {foo: 3} => ['abc']}

4 WeakMap

4.1 含义

   WeakMap结构与Map结构类似，也是用于生成键值对的集合。WeakMap只接受对象作为键名（null除外）。

WeakMap的键名所指向的对象，不计入垃圾回收机制。它的键名所引用的对象都是弱引用，一旦不再需要，WeakMap 里面的键名对象和所对应的键值对会自动消失，不用手动删除引用，有助于防止内存泄漏。WeakMap 弱引用的只是键名，而不是键值。键值依然是正常引用。

// WeakMap 也可以接受一个数组，作为构造函数的参数
const k1 = [1, 2, 3];
const k2 = [4, 5, 6];
const wm2 = new WeakMap([[k1, 'foo'], [k2, 'bar']]);
wm2.get(k2) // "bar"

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

const wm = new WeakMap();
let key = {};
let obj = {foo: 1};
wm.set(key, obj);
obj = null;
wm.get(key)// Object {foo: 1}:即使在 WeakMap 外部消除了obj的引用，WeakMap 内部的引用依然存在。

4.2　WeakMap 的方法

WeakMap 与 Map 在 API 上的区别主要是两个：

一是没有遍历操作（即没有keys()、values()和entries()方法），也没有size属性。因为没有办法列出所有键名，某个键名是否存在完全不可预测，跟垃圾回收机制是否运行相关。

二是无法清空，即不支持clear方法。因此，WeakMap只有四个方法可用：get()、set()、has()、delete()。

// WeakMap 可以使用 set 方法添加成员
const wm1 = new WeakMap();
const key = {foo: 1};
wm1.set(key, 2);
wm1.get(key) // 2

4.3　WeakMap 的用途

WeakMap 应用的典型场合就是 DOM 节点作为键名。当该 DOM 元素被清除，该ＤＯＭ对象占用的内存就会被垃圾回收机制释放。WeakMap 保存的这个键值对，也会自动消失，不存在内存泄漏风险。

const e1 = document.getElementById('foo');
const e2 = document.getElementById('bar');
const arr = [//我们通过arr数组对e1和e2添加一些文字说明。这就形成了arr对e1和e2的引用
  [e1, 'foo 元素'],
  [e2, 'bar 元素'],
];
arr [0] = null;// 不需要 e1 和 e2 的时候，必须手动删除引用，否则垃圾回收机制就不会释放e1和e2占用的内存。
arr [1] = null;

const wm = new WeakMap();
const element = document.getElementById('example');
wm.set(element, 'some information');//对element的引用就是弱引用，不会被计入垃圾回收机制
wm.get(element) // "some information"

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

WeakMap 的另一个用处是部署私有属性。

5 WeakRef

6 FinalizationRegistry