ES6 Set 和Map,WeakSet和WeakMap据结构的介绍

前言

近期有被问到对 ES6 Set 和Map,WeakSet和WeakMao数据结构的区别,有点懵,忘记了???看来知识需要常常复习才行,所以有这篇文章, PS : set 和map 个人觉得是前端比较总要的两种数据结构,还是都要了解其使用方法的。

本文章主要参考 ES6入门文档,方便下一次查找,便记录了下来,如有不对的地方可参考原文档。

Set

类似于数组,但是成员的值都是唯一的,没有重复的值(所以常用作数组去重)

let arr= [1,2,3,4,3,4]
Array.from(new Set(arr)); // [1,2,3,4]

Set内部判断两个值是否不同，使用的算法类似于精确相等运算符（===），主要的区别是在Set结构中NaN等于自身，而精确相等运算符认为NaN不等于自身。
Set本身是一个构造函数，用来生成Set数据结构。

定义

Set函数可以接受一个数组（或类似数组的对象）作为参数，用来初始化。

// 定义一个set和结构
var s = new Set()
var s1 = new Set([1,2,3,3])

let set = new Set();

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

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

另外，Set中两个对象总是不相等的(可以添加多个空对象到Set结构中)。从上面的代码中可以看到,由于两个空对象不相等,所以被视为两个值。

Set实例的属性和方法

Set结构的实例有以下属性

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

Set 结构的实例方法分为两大类: 操作方法(操作数组)和遍历方法(英语遍历成员)
操作方法:

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

遍历操作:

• keys()：返回键名的遍历器
• values()：返回键值的遍历器
• entries()：返回键值对的遍历器
• forEach()：使用回调函数遍历每个成员,没有返回值。该函数的参数依次为键值、键名、集合本身。另外，forEach方法还可以有第二个参数，表示绑定的this对象。

注意:
Set 的遍历顺序就是插入顺序,这个特性有时候非常有用
比如使用Set保存一个回调函数列表，调用时就能保证按照添加顺序调用。

Set结构的实例默认可遍历，它的默认遍历器生成函数就是它的values方法。

Set.prototype[Symbol.iterator] === Set.prototype.values
// true

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

Set结构的遍历
数组的map和filter方法也可以用于Set
扩展运算符 (...)

如果想在遍历操作中，同步改变原来的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和Set 的区别

• WeakSet的成员只能是对象，而不能是其他类型的值
• WeakSet中的对象都是弱引用，即垃圾回收机制不考虑WeakSet对该对象的引用，也就是说，如果其他对象都不再引用该对象，那么垃圾回收机制会自动回收该对象所占用的内存，不考虑该对象还存在于WeakSet之中。这个特点意味着，无法引用WeakSet的成员，因此WeakSet是不可遍历的。

常见语法

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

var ws = new WeakSet();
ws.add(1)
// TypeError: Invalid value used in weak set
// 添加报错,因为WeakSet只能放置对象

作为构造函数,WeakSet可以接受一个数组或类似数组的对象作为参数,该数组的所有成员都会自动成为WeakSet实例对象的成员。而不是数组本身,这就意味着,数组的所有成员只能是对象,才能定义成功。

var a = [[1,2], [3,4]];
var ws = new WeakSet(a);// 定义成功

var b = [3, 4];
var 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实例之中。

注意:
WeakSet 没有有size属性,并且WeakSet 的成员都是弱引用,随时可能消失,遍历机制无法保证成员的存在，很可能刚刚遍历结束，成员就取不到了。所以没有办法遍历WeakSet的成员。

WeakSet的一个用处，是储存DOM节点，而不用担心这些节点从文档移除时，会引发内存泄漏。

Map

Map结构的存在意义

由于Javascript 中的对象只接受字符串作为键名这给它的使用带来了很大的限制。

为了解决这个问题,ES6提供了Map数据结构。

Map类似于对象，也是键值对的集合，但是“键”的范围不限于字符串，各种类型的值（包括对象）都可以当作键。也就是说 Object结构提供的是 "字符串-值"的对应。Map 结构提供的是"值-值"的对应,是一种跟完美的Hash结构实现,Map比Object更适合"键值对"的数据结构。

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

m.set(o, 'content') // 将o作为m的一个键
m.get(o) // "content"

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

作为构造函数的Map,可以接受一个数组作为参数,该数组的成员是一个个表示键值对的数组。

var map = new Map([
  ['name', '张三'],
  ['title', 'es6']
]); // Map(2) {"name" => "张三", "title" => "Author"}

上面代码表示在创建Map实例I的时候,就指定了两个键name和title,Map构造函数接受数组为参数,实际上执行的是以下代码。

var items = [
  ['name', '张三'],
  ['title', 'es6']
];
var map = new Map();
items.forEach(([key, value]) => map.set(key, value));

在Map中 t布尔的true和 字符串的 true是两个不同的键。如果同一个键被多次赋值,后面的值会覆盖之前的值。读取一个不存在的键会返回undefined

注意:
只有对同一个对象的引用,Map结构才会将其视为同一个键。

var map = new Map();

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

上面代码的set和get方法，表面是针对同一个键，但实际上这是两个值，内存地址是不一样的，因此get方法无法读取该键，返回undefined。
同理,同一个值的两个实例,在Map中被社会两个键。

总结:

1. Map的键实际上是跟内存地址绑定的,只要内存地址不一样,就视为两个键。
   这就解决了同名属性碰撞（clash）的问题，我们扩展别人的库的时候，如果使用对象作为键名，就不用担心自己的属性与原作者的属性同名。
2. 如果Map的键是一个简单数据类型的值(数字,布尔,字符串),则只要两个值严格相等,Map将其视为一个键。包括 0 和 -0 。另外,虽然NaN不严格等于自身,在Map中会视为同一个键。

Map实例的属性和方法

属性

• size属性: 返回Map结构的成员总数。

• set( key, value) :设置key 所对应的的键值,然后整个Map结构(所以可以采用链式写法)。若已存在 key 则会更新 key 的键值,否则生成新的键值。

• get(key): 读取key对应的键值,如果找不到就返回undefined。

• has(key): 返回一个布尔, 表示某个键是否在Map数据结构中。

• delete(key): 删除某个键，成功返回true。如果删除失败，返回false。

• clear(): 方法清除所有成员，没有返回值。

遍历方法

Map原生提供三个遍历器生成函数和一个遍历方法。

• keys()：返回键名的遍历器。
• values()：返回键值的遍历器。
• entries()：返回所有成员的遍历器。
• forEach()：遍历Map的所有成员。

需要特别注意的是，Map的遍历顺序就是插入顺序。

Map结构的默认遍历器接口（Symbol.iterator属性），就是entries方法。

map[Symbol.iterator] === map.entries
// true

Map数据结构和其他数据结构的转换

Map转为数组

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

• 最方便的方法就是扩展运算符 (...); 使用[...myMap]
• Array.from 转换; Array.from(myMap)

数组转为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;
}

let 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})
// [ [ '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。这往往是数组转为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结构节本类似,
唯一的区别是WeakMap只接受对象作为键名(null除外),不接受其他类型的值作为键名,而且键名所指向的对象,不计入垃圾回收机制中。

WeakMap的设计目的在于，键名是对象的弱引用（垃圾回收机制不将该引用考虑在内），所以其所对应的对象可能会被自动回收。

当对象被回收后，WeakMap自动移除对应的键值对。典型应用是，一个对应DOM元素的WeakMap结构，当某个DOM元素被清除，其所对应的WeakMap记录就会自动被移除。基本上，WeakMap的专用场合就是，它的键所对应的对象，可能会在将来消失。WeakMap结构有助于防止内存泄漏

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

• 一是没有遍历操作（即没有key()、values()和entries()方法），也没有size属性；
• 二是无法清空，即不支持clear方法。这与WeakMap的键不被计入引用、被垃圾回收机制忽略有关。因此，WeakMap只有四个方法可用：get()、set()、has()、delete()。

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

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() // DONE

上面代码中，Countdown类的两个内部属性_counter和_action，是实例的弱引用，所以如果删除实例，它们也就随之消失，不会造成内存泄漏。