10、Set和Map数据结构

一、Set
01、基本用法
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

let a = new Set([1, 2, 3, 8, 9, 5, 1, 2])
let b = [ 3, 4, 5, 6, 3, 4]
console.log(a)
console.log([...a])
console.log(a.size)
console.log(b)
console.log([...b])
/* 去重 */
console.log([...new Set(b)])
/* 
* 向 Set 加入值的时候，不会发生类型转换，所以5和"5"是两个不同的值。
* Set 内部判断两个值是否不同，使用的算法叫做“Same-value equality”，
* 它类似于精确相等运算符（===），主要的区别是NaN等于自身，
* 而精确相等运算符认为NaN不等于自身。
*这表明，在 Set 内部，两个NaN是相等。
*/
let set = new Set()
let c = NaN
let d = NaN
set.add(c)
set.add(d)
console.log([...set])
/* 两个对象总是不相等的 */
let set2 = new Set()
set2.add({})
console.log(set2.size)
console.log([...set2])
set2.add({})
console.log(set2.size)
console.log([...set2])

image.png

02、Set 实例的属性和方法

--Set.prototype.constructor：构造函数，默认就是Set函数。
--Set.prototype.size：返回Set实例的成员总数。

Set 实例的方法分为两大类：操作方法（用于操作数据）和遍历方法（用于遍历成员）。下面先介绍四个操作方法。

add(value)：添加某个值，返回Set结构本身。
delete(value)：删除某个值，返回一个布尔值，表示删除是否成功。
has(value)：返回一个布尔值，表示该值是否为Set的成员。
clear()：清除所有成员，没有返回值

let set = new Set()
set.add(2).add(3).add(2).add(4)
// 注意2被加入了两次
console.log(set.size)
function isHas(arg) {
    let a = set.has(arg)
    console.log(a)
}
isHas(1)
isHas(2)
isHas(3)
set.delete(2)
isHas(2)
console.log([...set])
set.clear()
console.log([...set])

image.png

下面是一个对比，看看在判断是否包括一个键上面，Object结构和Set结构的写法不同。

// 对象的写法
const a = {
    'width': 1,
    'height': 2
}

if (a['width']) {
    console.log('a')
}

// Set的写法
const b = new Set()
b.add('width')
b.add('height')

if (b.has('width')) {
    console.log('b')
}

image.png

03、Array.from方法可以将 Set 结构转为数组。

const set = new Set([1, 2, 3, 4, 5, 5])
console.log(set)
console.log(typeof set)
const arr = Array.from(set)
console.log(arr)
console.log(typeof arr)

image.png

04、提供了去除数组重复成员的另一种方法。

function dedupe(array) {
  return Array.from(new Set(array));
}
dedupe([1, 1, 2, 3]) // [1, 2, 3]

05、遍历操作
--Set 结构的实例有四个遍历方法，可以用于遍历成员

keys()：返回键名的遍历器
values()：返回键值的遍历器
entries()：返回键值对的遍历器
forEach()：使用回调函数遍历每个成员
需要特别指出的是，Set的遍历顺序就是插入顺序。这个特性有时非常有用，比如使用Set保存一个回调函数列表，调用时就能保证按照添加顺序调用

let set = new Set(['one', 'two', 'three'])
console.log(set.keys())
for (let item of set.keys()) {
    console.log(item)
}
console.log('\n')
/* Iterator -->迭代器*/
console.log(set.values())
for (let item of set.values()) {
    console.log(item)
}
/* entries --> 条目*/
console.log(set.entries())
for (let item of set.entries()) {
    console.log(item)
}

image.png

上面代码中，entries方法返回的遍历器，同时包括键名和键值，所以每次输出一个数组，它的两个成员完全相等。
Set 结构的实例默认可遍历，它的默认遍历器生成函数就是它的values方法。
Set 结构的实例默认可遍历，它的默认遍历器生成函数就是它的keys方法。

console.log(Set.prototype[Symbol.iterator] === Set.prototype.values)
console.log(Set.prototype[Symbol.iterator] === Set.prototype.keys)
console.log(Set.prototype[Symbol.iterator] === Set.prototype.entries)

image.png

这意味着，可以省略values方法，直接用for...of循环遍历 Set

for (let item of set) {
    console.log(item)
}

image.png

（2）forEach()
Set 结构的实例与数组一样，也拥有forEach方法，用于对每个成员执行某种操作，没有返回值。
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）遍历的应用
扩展运算符（...）内部使用for...of循环，所以也可以用于 Set 结构。
let set = new Set(['one', 'two', 'three'])
let arr = [...set]
let ls = [1, 2, 3, 4, 5, 3, 1]
/* 数组去重的话，先把它转化为Set对象 */
let set2 = new Set(ls)
let arr2 = Array.from(set)
let arr3 = Array.from(set2)
console.log(set)
console.log(arr)
console.log(arr2)
console.log(arr3)

image.png

扩展运算符和 Set 结构相结合，就可以去除数组的重复成员。
let arr = [3, 5, 2, 2, 5, 5];
let unique = [...new Set(arr)];
// [3, 5, 2]

// 数组的map和filter方法也可以用于 Set 了。
let a = [1, 2, 3]
let set = new Set(a.map(x => x*2))
console.log(set)
console.log([...set])
console.log(Array.from(set))

let set2 = new Set([1, 2, 3, 4, 5])
set2 = new Set([...set2].filter(x => (x % 2) == 0))
console.log(set2)
console.log([...set2])

image.png

// 因此使用 Set 可以很容易地实现并集（Union）、交集（Intersect）和差集（Difference）。
let a = new Set([1, 2, 3])
let b = new Set([4, 2, 3])

console.log([...a, ...b])
/* 并集 */
let union = new Set([...a, ...b])
console.log([...union])
/* 交集 */
let intersect  = new Set([...a].filter(x => b.has(x)))
console.log([...intersect])

/* 差集 */
let difference  = new Set([...a].filter(x => !b.has(x)))
console.log([...difference])

image.png

如果想在遍历操作中，同步改变原来的 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 的成员只能是对象，而不能是其他类型的值。
其次，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数组的成员成为 WeakSet 的成员，而不是a数组本身。这意味着，数组的成员只能是对象。
const b = [3, 4];
const ws = new WeakSet(b);
// Uncaught TypeError: Invalid value used in weak set(…)

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('WeakSet has ' + item)})
// TypeError: undefined is not a function
上面代码试图获取size和forEach属性，结果都不能成功。

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

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()
console.log(m)
const o = {p: 'hello夜幕小草'}
console.log(o)
m.set(o, 'hello xiaohelang')
let ll = m.get(o)
console.log(m)
console.log(ll)
console.log(m.has(o))
console.log(m.delete(o))
console.log(m.has(o))
console.log(m)
上面代码使用 Map 结构的set方法，将对象o当作m的一个键，然后又使用get方法读取这个键，接着使用delete方法删除了这个键。

image.png

上面的例子展示了如何向 Map 添加成员。作为构造函数，Map 也可以接受一个数组作为参数。该数组的成员是一个个表示键值对的数组。
const map = new Map([
    ['name', '夜幕小草'],
    ['age', 28]
    ])
console.log(map)
console.log(map.size)
console.log(map.has('name'))
console.log(map.has('夜幕小草'))
console.log(map.has('age'))
console.log(map.has(18))
console.log(map.get('name'))
console.log(map.get('夜幕下草'))
console.log(map.get('age'))
console.log(map.get(18))

image.png

上面代码在新建 Map 实例时，就指定了两个键name和age。
Map构造函数接受数组作为参数，实际上执行的是下面的算法。
const items = [
    ['name', '夜幕小草'],
    ['age', 18]
]
const map = new Map()

items.forEach(
    ([key, value]) => map.set(key, value)
    )
console.log(map)

image.png

事实上，不仅仅是数组，任何具有 Iterator 接口、且每个成员都是一个双元素的数组的数据结构（详见《Iterator》一章）都可以当作Map构造函数的参数。这就是说，Set和Map都可以用来生成新的 Map。
const set = new Set([
    ['name', '夜幕小草'],
    ['age', 18]
    ])
const m1 = new Map(set)
console.log(m1)
console.log(m1.get('name'))

const m2 = new Map([['job', 'web']])
console.log(m2)
const m3 = new Map(m2)
console.log(m3)
console.log(m3.get('job'))
// 如果对同一个键多次赋值，后面的值将覆盖前面的值。
m3.set('job', '前端')
console.log(m3)
/*
上面代码中，我们分别使用 Set 对象和 Map 对象，
当作Map构造函数的参数，结果都生成了新的 Map 对象。
*/

// 如果读取一个未知的键，则返回undefined。
console.log(m3.get('he')) //undefined
/* 注意，只有对同一个对象的引用，Map 结构才将其视为同一个键。这一点要非常小心。*/
const m4 = new Map()
m4.set(['a'], 666)
console.log(m4.get(['a'])) //undefined
/* 上面代码的set和get方法，表面是针对同一个键，但实际上这是两个值，内存地址是不一样的，
因此get方法无法读取该键，返回undefined。*/
/* 犹如一下代码 */
console.log('注意以下代码')
const m5 = new Map()
const h1 = 'he'
const h2 = 'he'
m5
.set(h1, 123)
.set(h2, 456)
console.log(m5.get('he'))
console.log(m5.get(h1))
console.log(m5.get(h2))
console.log('注意以下代码跟上段代码区别')
const m6 = new Map()
const h3 = ['he2']
const h4 = ['he2']
m6
.set(h3, 123)
.set(h4, 456)
console.log(m6.get(['he2']))
console.log(m6.get(h3))
console.log(m6.get(h4))
/* 上面代码中，变量h3和h4的值是一样的，但是它们在 Map 结构中被视为两个键。
由上可知，Map 的键实际上是跟内存地址绑定的，只要内存地址不一样，就视为两个键。
这就解决了同名属性碰撞（clash）的问题，我们扩展别人的库的时候，
如果使用对象作为键名，就不用担心自己的属性与原作者的属性同名*/

image.png

如果 Map 的键是一个简单类型的值（数字、字符串、布尔值），则只要两个值严格相等，Map 将其视为一个键，比如0和-0就是一个键，布尔值true和字符串true则是两个不同的键。另外，undefined和null也是两个不同的键。虽然NaN不严格相等于自身，但 Map 将其视为同一个键。

let m = new Map()
m.set(-0, 456)
console.log(m.get(+0))

m.set(true, 1)
m.set('true', 2)
console.log(m.get(true))
console.log(m.get('true'))

m.set(undefined, 3)
m.set(null, 4)
console.log(m.get(undefined))
console.log(m.get(null))

m.set(NaN, 234)
console.log(m.get(NaN))

image.png

实例的属性和操作方法
Map 结构的实例有以下属性和操作方法。

/*
*（1）size属性
* size属性返回 Map 结构的成员总数
*/
const m = new Map()
m.set('name', '夜幕小草')
m.set('age', 18)
console.log(m.size)

/*
*（2）set(key, value)
* set方法设置键名key对应的键值为value，
* 然后返回整个 Map 结构。如果key已经有值，则键值会被更新，否则就新生成该键。
*/
m.set(220, '夜幕小草')
console.log(m.get(220))
m.set(undefined, '夜幕小草2')
console.log(m.get(undefined))
/*
*set方法返回的是当前的Map对象，因此可以采用链式写法。
*/
let map = new Map().set(1, 'a').set(2, 'b').set(3, 'c')
console.log(map)
（3）get(key)
get方法读取key对应的键值，如果找不到key，返回undefined。
（4）has(key)
has方法返回一个布尔值，表示某个键是否在当前 Map 对象之中。
（5）delete(key)
delete方法删除某个键，返回true。如果删除失败，返回false
（6）clear()
clear方法清除所有成员，没有返回值。

image.png

遍历方法

Map 结构原生提供三个遍历器生成函数和一个遍历方法。
--keys()：返回键名的遍历器。
--values()：返回键值的遍历器。
--entries()：返回所有成员的遍历器。
--forEach()：遍历 Map 的所有成员。
需要特别注意的是，Map 的遍历顺序就是插入顺序。

const m = new Map([
    ['F', 'no'],
    ['T', 'yes']
    ])
console.log('------keys()-------')
for (let key of m.keys()) {
    console.log(key)
}

console.log('------keys()-------')
for (let value of m.values()) {
    console.log(value)
}

console.log('------entries()-------')
for (let item of m.entries()) {
    console.log(item[0], item[1])
}
/* 等同 */
console.log('------entries()-------')
for (let [key, value] of m.entries()) {
    console.log(key, value)
}

/* 等同 */
console.log('------entries()-------')
for (let [key, value] of m) {
    console.log(key, value)
}

const m2 = new Map([
    [1, 'one'],
    [2, 'two'],
    [3, 'three'],
    ])
/* Map 结构转为数组结构，比较快速的方法是使用扩展运算符（...）。*/
console.log('------[...m2.keys()]---------')
console.log([...m2.keys()])

console.log('------[...m2.values()]---------')
console.log([...m2.values()])

console.log('------[...m2.entries()]---------')
console.log([...m2.entries()])

console.log('------[...m2]---------')
console.log([...m2])

/* 结合数组的map方法、filter方法，可以实现 Map 的遍历和过滤（Map 本身没有map和filter方法）。*/
console.log('-----------filter()--------')
const m3 = new Map(
    [...m2].filter(([k, v]) => k < 3)
    )
console.log([...m3])

console.log('-----------map()--------')
const m4 = new Map(
    [...m2].map(([k, v]) => [k*2, '_' + v])
    )
console.log([...m4])

/* 此外，Map 还有一个forEach方法，与数组的forEach方法类似，也可以实现遍历。*/
m2.forEach((v, k, m) => {
    console.log('Key: %s, Value: %s', k, v)
})
/*forEach方法还可以接受第二个参数，用来绑定this。*/
const reporter = {
  report: function(key, value) {
    console.log("Key: %s, Value: %s", key, value);
  }
};

m2.forEach(function(value, key, map) {
  this.report(key, value);
}, reporter);
/*上面代码中，forEach方法的回调函数的this，就指向reporter。*/

image.png

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

（1）Map 转为数组
前面已经提过，Map 转为数组最方便的方法，就是使用扩展运算符（...）。
const m1 = new Map().set(true, 7).set({'name': '夜幕小草'}, ['abc'])
console.log([...m1])

image.png

（2）数组 转为 Map
将数组传入 Map 构造函数，就可以转为 Map。
const m2 = new Map([
  [true, 7],
  [{foo: 3}, ['abc']]
])
console.log(m2)

image.png

（3）Map 转为对象
如果所有 Map 的键都是字符串，它可以转为对象。
console.log('--------mapToJson-----')
function mapToJson(map) {
    let obj = Object.create(null)
    for (let [k, v] of map) {
        obj[k] = v
    }
    return obj
}

const myMap = new Map([
    ['yes', true],
    ['no', false]
    ])

let hl = mapToJson(myMap)
console.log(hl)

image.png

（4）对象转为 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})

（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}'
另一种情况是，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"]]]'

（6）JSON 转为 Map
JSON 转为 Map，正常情况下，所有键名都是字符串
function jsonToStrMap(jsonStr) {
  return objToStrMap(JSON.parse(jsonStr));
}
jsonToStrMap('{"yes": true, "no": false}')
// Map {'yes' => true, 'no' => false}
但是，有一种特殊情况，整个 JSON 就是一个数组，且每个数组成员本身，又是一个有两个成员的数组。这时，它可以一一对应地转为Map。这往往是数组转为 JSON 的逆操作。
function jsonToMap(jsonStr) {
  return new Map(JSON.parse(jsonStr));
}

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