第十一章 Set和Map数据结构

1. Set

(1) 基本用法

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

上面代码通过 add 方法向 Set 结构加入成员,结果表明 Set 结构不会添加重复的值。

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

// 例一
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

// 例三
function divs () {
  return [...document.querySelectorAll('div')];
}

const set = new Set(divs());
set.size // 56

// 类似于
divs().forEach(div => set.add(div));
set.size // 56

上面代码中,也展示了一种去除数组重复成员的方法

// 去除数组的重复成员
[...new Set(array)]

向 Set 加入值得时候,不会发生类型转换,所以 5 和 '5' 是两个不同的值,Set 内部判断两个值是否不同,使用的算法叫做 'Same-Value equality',它类型于 精确相等运算符 (===),主要区别是 NaN 等于自身,而精确相等运算符认为 NaN 不等于自身

let set = new Set();
let a = NaN;
let b = NaN;
set.add(a);
set.add(b);
set // Set {NaN}

上面代码表明,在 Set 内部,两个 NaN 是相等的

let set = new Set();

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

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

上面代码表示,由于两个空对象不相等,所以它们被视为两个值。

2. Set 实例的属性和方法

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(1).add(2).add(2);

s.size // 2

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

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

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

const items = new Set([1,2,3,4,5]);
const array = Array.from(items);

这就提供了去除数组重复成员的另一种方法

function dedupe(array){
  return Array.from(new Set(array));
}

遍历操作:

Set 结构的实例有四个遍历方法,可以用于遍历成员

  • keys(): 返回键名的遍历器
  • values(): 返回键值得遍历器
  • entries(): 返回键值对的遍历器
  • forEach(): 使用回调函数遍历每个成员

注意:Set的遍历顺序就是插入顺序
由于 Set 结构没有键名,只有键值(或者说键名和键值是同一个值),所以keys方法和values方法的行为完全一致。

(1) keys(),values(),entries()

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方法返回的遍历器,同时包括键名和键值,所以每次输出一个数组,它的两个成员完全相等

可以省略 values 方法,直接用for...of循环遍历 Set

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

for (let x of set) {
  console.log(x);
}
// red
// green
// blue

(2) forEach

let set = new Set(['red', 'qreen', 'blue']);
set.forEach( (value, key, set) => console.log(key + ':' + value) )

(3) 遍历的应用

扩展运算符 (...) 内部使用 for...of 循环,所以也可以用于 Set 结构

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

扩展运算符和 Set 结构相结合,就可以去除数组的重复成员

let arr = [3,4,5,2,2,5,5]
leu unique = [...new Set(arr)]

而且数组的map和filter方法可以间接用于 Set 了

let set = new Set([1,2,3]);
set = new Set([...set]).map(x => x * 2)

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

因此使用 Set 可以很容易的实现并集、交集和差集

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}

// 差集
let difference = new Set([...a].filter(x => !b.has(x)));
// Set {1}

如果想在遍历操作中,同步改变原来的 Set 结构:

// 方法一
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

2. WeakSet

WeakSet 结构与 Set 类似,也是不重复的值得集合,但是,它与 Set 有两个不同

首先,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

其次,WeakSet 中的对象都是弱引用,如果其他对象都不再引用该对象,那么垃圾回收机制会自动回收该对象所占用的内存,不考虑该对象还存在于
WeakSet 中

这是因为垃圾回收机制依赖引用计数,如果一个值的引用次数不为0,垃圾回收机制就不会释放这块内存。结束使用该值之后,有时会忘记取消引用,导致内存无法释放,进而可能会引发内存泄漏。WeakSet 里面的引用,都不计入垃圾回收机制,所以就不存在这个问题。因此,WeakSet 适合临时存放一组对象,以及存放跟对象绑定的信息。只要这些对象在外部消失,它在 WeakSet 里面的引用就会自动消失

(1) 语法

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是一个数组,它有两个成员,也都是数组。将a作为 WeakSet 构造函数的参数,a的成员会自动成为 WeakSet 的成员。

注意,是a数组的成员成为 WeakSet 的成员,而不是a数组本身。这意味着,数组的成员只能是对象

const b = [3, 4];
const ws = new WeakSet(b);
// Uncaught TypeError: Invalid value used in weak set(…)

上面代码中,数组 b 的成员不是对象,加入 WeakSet就会报错

(2) 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

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

3. Map

(1) 含义和基本用法

JS的对象(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();
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 添加成员,作为构造函数,Map 也可以接受一个数组作为参数。该数组的成员是一个个表示键值对的数组

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"

事实上,不仅仅是数组,任何具有 Iterator 接口、且每个成员都是一个双元素的数组的数据结构(详见《Iterator》一章)都可以当作Map构造函数的参数。这就是说,Set和Map都可以用来生成新的 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

注意,如果对同一个键多次赋值,后面的值将覆盖前面的值

const map = new Map();

map
.set(1, 'aaa')
.set(1, 'bbb');

map.get(1) // "bbb"

***如果读取一个未知的键,则返回 undefined***

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

注意,只有对同一个对象的引用,Map 结构才将其视为同一个键。这一点要非常小心

const map = new Map();

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

上面代码的set和get方法,表面是针对同一个键,但实际上这是两个值,内存地址是不一样的,因此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

由上可知,Map 的键实际上是跟内存地址绑定的,只要内存地址不一样,就视为两个键。这就解决了同名属性碰撞(clash)的问题,我们扩展别人的库的时候,如果使用对象作为键名,就不用担心自己的属性与原作者的属性同名。

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

(2) 实例的属性和操作方法

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

a. size 属性

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

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

map.size // 2

b. set(key, value)

set方法设置键名key对应的键值为value,然后返回整个 Map 结构。如果 key 已经有值,则键值会被更新,否则就新生成该键。

const m = new Map();

m.set('edition', 6)        // 键是字符串
m.set(262, 'standard')     // 键是数值
m.set(undefined, 'nah')    // 键是 undefined

set方法返回的是当前的 Map 对象,因此可以采用链式写法

c. get(key)

get 方法读取key对应的键值,如果找不到key,返回undefined。

d. has(key)

返回一个布尔值,表示某个键是否在当前 Map 对象之中

e. delete(key)

删除某个键,返回true。如果删除失败,返回 false

f. clear()

清除所有成员,没有返回值

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

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

(3) 遍历方法

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

  • keys(): 返回键名的遍历器
  • values(): 返回键值的遍历器
  • entries(): 返回所有成员的遍历器
  • 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"

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

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

a. Map 转为数组
const myMap = new Map()
  .set(true, 7)
  .set({foo: 3}, ['abc']);
[...myMap]
// [ [ true, 7 ], [ { foo: 3 }, [ 'abc' ] ] ]
b. 数组转为 Map

将数组传入 Map 构造函数,就可以转为 Map

new Map([
  [true, 7],
  [{foo: 3}, ['abc']]
])
c. 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 }
d. 对象转为 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})
// Map {"yes" => true, "no" => false}
e. 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"]]]'

f. JSON转为 Map

JSNO 转为 Map ,正常情况下,所有键名都是字符串

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

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

但是,有一种特殊情况,整个 JSON 就是一个数组,且每个数组成员本身,又是一个有两个成员的数组。这时,它可以一一对应地转为 Map。这往往是 Map 转为数组 JSON 的逆操作。

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

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

4. WeakMap

(1) 含义

WeakMap 结构与 Map 结构类似,也是用于生成键值对的集合

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

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

WeakMap 与 Map 区别有两点:

a. 首先,WeakMap 只接受对象作为键名(null除外),不接受其他类型的值作为键名
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
b. 其次,WeakMap 的键名所指向的对象,不计入垃圾回收机制

WeakMap 的设计目的在于,有时我们想在某个对象上存放一些数据,但是这会形成对这个对象的引用,请看下面的例子:

const e1 = document.getElementById('foo');
const e2 = document.getElementById('bar');
const arr = [
  [e1, 'foo 元素'],
  [e2, 'bar 元素'],
];

上面代码中,arr对e1和e2的引用,一旦不需要这两个对象,我们就必须手动删除这个引用,否则垃圾回收机制就不会释放e1和e2占用的内存。

// 不需要 e1 和 e2 的时候, 必须手动删除引用
arr[0] = null;
arr[1] = null;

上面这样的写法显然很不方便,一旦忘了写,就会造成内存泄漏。

WeakMap 就是为了解决这个问题而诞生的,它的键名所引用的对象都是弱引用,即垃圾回收机制不将该引用考虑在内。也就是说,一旦不再需要,WeakMap里面的键名对象和所对应的键值就会自动消失,不用再手动删除引用。

一个典型的应用场景是,在网页的 DOM 元素上添加数据,就可以使用WeakMap结构。而当 DOM 元素被清除,其所对应的WeakMap记录就会被自动移除。

const wm = new WeakMap();

const element = document.getElementById('example');

wm.set(element, 'some infomation')
wm.get(element);

上面这段代码中,一旦消除对 example 节点的引用,它占用的内存就会被垃圾回收机制释放,WeakMap 保存的这个键值对,也会自动消失。

总之,WeakMap 的专用场合就是,它的键所对应的对象,可能会在将来消失。WeakMap 结构有助于防止内存泄漏。

(2) WeakMap 的语法

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

a. 一是没有遍历操作(即没有key()、values()和entries()方法),也没有size属性。因为没有办法列出所有键名,某个键名是否存在完全不可预测,跟垃圾回收机制是否运行相关。这一刻可以取到键名,下一刻垃圾回收机制突然运行了,这个键名就没了,为了防止出现不确定性,就统一规定不能取到键名。
b. 无法清空,即不支持clear方法。

因此,WeakMap只有四个方法可用:get()、set()、has()、delete()。

推荐阅读更多精彩内容