ES6脚丫系列SetWeakSetMapWeakMap

24次阅读

共计 12704 个字符,预计需要花费 32 分钟才能阅读完成。

本文字数:4700+,阅读时间约 10 分钟。

如果有理解不到位的地方,欢迎大家纠错。

一、Set

【01】Set 是一种数据结构。类似于数组,但是成员的值都是唯一的,没有重复的值。

Set 内部判断两个值是否相同,使用的算法类似于恒等运算符(===),这意味着,两个对象总是不相等的。

(zyx456:这里说一下,如果说两个地址相同的对象,那么它们是相等的,比如 a =b={},这时,a===b//true)

唯一的例外是 NaN 等于自身(但是恒等运算符认为 NaN 不等于自身)。

由于两个空对象不是恒等,所以它们被视为两个值。

例子:

let set = new Set();
set.add({})set.size // 1
set.add({})set.size // 2

例子:

var sett = new Set();
sett.add(NaN);
console.log(sett.size);//1
sett.add(NaN);
console.log(sett.size);//1

【02】Set() 是构造函数,用来生成 Set 实例。

Set 函数可以接受一个数组(或类数组的对象)作为参数。

语法:

  • new Set:创建一个新的、空的 Set
  • new Set(iterable):从任何可遍历数据中提取元素,构造出一个新的集合。

写法 1:

var s = new Set();

s.add(1);

console.log(s);

写法 2:

var s = new Set([1,2,3,3,3,3,3]);

console.log(s); //Set(3) {1,2,3}

【03】Set 实例有 add(item) 方法。

【04】在 Set 实例中添加新值的时候,不会发生类型转换,所以 5 和 ”5″ 是两个不同的值。

【05】Set 实例不支持下标索引,不能用方括号访问 Set 成员。

arrayOfWords[15000];//        "anapanapa"
setOfWords[15000]   // Set 不支持索引 //   undefined  

【06】set[Symbol.iterator]():

返回一个迭代器对象。

一般这个方法不会被直接调用,因为实际上就是它使集合能够被遍历,也就是说,我们可以直接写 for (v of set) {…}。

也可以传递一个生成器,函数会逐个遍历它,并把生成的值收录为一个集合;

也可以用来复制一个已有的集合。

【07】Set 属性(多种)

zyx456:Set 实例会继承原型上的所有属性和方法。

01、Set.prototype.constructor:构造函数,默认就是 Set 函数。

02、Set.prototype.size:返回 Set 实例的成员数量。

【】例子:

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

【】例子:

var set = new Set([1, 2, 3, 4, 4])[...set];    // [1, 2, 3, 4]
var items = new Set([1, 2, 3, 4, 5, 5, 5, 5]);
items.size // 5
function divs() {return [...document.querySelectorAll('div')] }
var set = new Set(divs());set.size // 56

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

【08】Set 使用 Array 方法

Set 和 Array 之间的相互转换很简单,因此,我们可以轻松地使用 Array.prototype 对象里的所有方法。

let elementsOfMagic = ["air","book"];function filterSet(set, predicate){var filteredItems = [...set].filter(predicate);
  return new Set(filteredItems);
}

var aElements = filterSet(elementsOfMagic, e => e.startsWith('a'));
console.log([...aElements]);//["air"];

【09】可以利用 Set 做到数组去重。将需要去重的数组作为 Set 的参数即可。

let res = new Set([1,1,1,2,2,2]);

let newArr = […res];//[1,2]

【10】使用 Set,可以很容易地实现并集(Union)、交集(Intersect)和差集(Difference)。

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]

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

【11】Array.from 方法可以将 Set 结构转为数组。

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

这就提供了一种去除数组的重复元素的方法。

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

set 实例有四个操作方法

var s = new Set();

  • s.add(value):添加某个值,返回 Set 实例。如果 Set 实例已经有这个值,则不产生任何效果。
  • s.delete(value):删除某个值,返回一个布尔值,表示是否删除成功。如果并不存在,则不产生任何效果。
  • s.has(value):返回一个布尔值,表示该值是否为 Set 的成员。
  • s.clear():清除所有成员,没有返回值。

【】.add() 会返回 Set 实例自身,所以可以用链式语法。

var s = new Set();

s.add(1).add(2);

【】add() 只能添加当一个元素,添加多个元素时,只有一个元素添加进去。

上面这些属性和方法的实例如下。

var s =new Set();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

【02】下面是一个对比,看看判断是否包括一个属性,Object 结构和 Set 结构的写法不同。

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

Set 实例的四个遍历方法

【01】var s =new Set();

s.keys():返回一个键名的遍历器。和 values() 相同。

【】keys()、values()、entries() 返回的都是遍历器对象。

由于 Set 结构没有键名,只有键值(或者说键名和键值是同一个值),所以 key 方法和 value 方法的行为完全一致。

zyx456:这里和数组是不同的。数组的 keys() 是返回下标。

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

【02】Set 实例默认可遍历,它的默认遍历器生成函数就是它的 values() 方法。

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

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

let set = new Set(['red', 'green', 'blue']);
for (let x of set) {console.log(x);}
// red
// green
// blue

【03】Set 结构的实例的 forEach 方法,用于对每个成员执行某种操作,没有返回值。

forEach 方法的参数:

第一个参数:一个处理函数,该处理函数的参数依次为键值、键名、集合本身(可省略该参数)。

第二个参数:表示绑定的 this 对象。可省略。

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

【04】如果想在遍历操作中,同步改变原来的 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

【01】WeakSet 结构与 Set 类似,也是不重复的值的集合。

【02】它与 Set 有两个区别:

01、WeakSet 的成员只能是对象,而不能是其他类型的值。

02、WeakSet 中的对象都是弱引用,即垃圾回收机制不考虑 WeakSet 对该对象的引用。

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

这个特点意味着,无法引用 WeakSet 的成员,因此 WeakSet 是不可遍历的。

WeakSet 不能遍历,是因为成员都是弱引用,随时可能消失,遍历机制无法保证成员的存在,很可能刚刚遍历结束,成员就取不到了。

【03】WeakSet 是一个构造函数,可以使用 new 命令,创建 WeakSet 实例。

【04】WeakSet 的参数可以是一个数组或类数组的对象。

(实际上,任何具有 iterable 接口的对象,都可以作为 WeakSet 的参数。)

【05】语法:

var ws = new WeakSet();

例子:

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

例子:

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

【06】WeakSet 实例有以下三个方法。

  • WeakSet.prototype.add(value):向 WeakSet 实例添加一个新成员。
  • WeakSet.prototype.delete(value):清除 WeakSet 实例的指定成员。返回布尔值。表示是否删除成功。
  • WeakSet.prototype.has(value):返回一个布尔值,表示某个值是否在 WeakSet 实例之中。

下面是一个例子。

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

【07】WeakSet 没有 size 属性,没有办法遍历它的成员。会返回 undefined。

ws.size // undefined
ws.forEach // undefined

ws.forEach(function(item){console.log('WeakSet has' + item)})
// TypeError: undefined is not a function

【08】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

【01】JS 中的对象,是字符串到值的映射。(zyx456:属性名还可以是数值)

这样限制很大。

例子:

比如,无法将 DOM 节点作为对象的属性名。

下面是将一个 DOM 节点作为对象 data 的键,但是由于对象只接受字符串作为键名,所以 element 被自动转为字符串 [Object HTMLDivElement]。

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

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

【02】Map 类似于对象,也是键值对的集合,但是“键”的范围不限于字符串,各种类型的值(包括对象)都可以当作键。

也就是说,Object 结构提供了“字符串—值”的对应,Map 结构提供了“值—值”的对应。

如果需要“键值对”的数据结构,Map 比 Object 更合适。

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

【03】Map 可以接受一个二维数组作为参数。

数组成员是一个或多个表示键值对的一维数组。

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 构造函数接受数组作为参数,实际上执行的是下面的算法。

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

【04】如果对同一个键多次赋值,后面的值将覆盖前面的值。

let map = new Map();

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

map.get(1) // "bbb"

【05】如果读取一个未知的键,则返回 undefined。

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

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

Map 的键实际上是跟内存地址绑定的,只要内存地址不一样,就视为两个键。

数组是引用类型,2 个相同的数组字面量并不是相同地址的数组。

var map = new Map();

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

例子:

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

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

let map = new Map();

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

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

【08】Map 实例的 size 属性

返回 Map 结构的成员总数。

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

map.size // 2

Map 实例的操作方法(多种)

var m = new Map();

【01】m.set(key, value)

set 方法设置 key 所对应的键值,然后返回整个 Map 实例。

如果 key 已经有值,则键值会被更新,否则就新生成该键。

var m = new Map();

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

set 方法返回的是 Map 本身,因此可以采用链式写法。

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

【02】m.get(key)

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

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

m.get(hello)  // Hello ES6!

【03】m.has(key)

返回一个布尔值,表示某个键是否在 Map 数据结构中。

var m = new Map();

m.set("edition", 6);
m.set(262, "standard");
m.set(undefined, "nah");

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

【04】m.delete(key)

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

var m = new Map();
m.set(undefined, "nah");
m.has(undefined)     // true

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

【05】m.clear()

clear 方法清除所有成员,没有返回值。

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

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

Map 实例的遍历方法(多种)

【01】var m = new Map();

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

实例。

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

【02】Map 结构的默认遍历器接口(Symbol.iterator 属性),是 entries 方法。

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

【03】Map 结构转为数组结构,比较快速的方法是结合使用扩展运算符(…)。

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

结合数组的 map 方法、filter 方法,可以实现 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));
// 产生 Map 结构 {1 => 'a', 2 => 'b'}
let map2 = new Map([...map0].map(([k, v]) => [k * 2, '_' + v]));
// 产生 Map 结构 {2 => '_a', 4 => '_b', 6 => '_c'}

【04】Map 的 forEach 方法,与数组的 forEach 方法类似,也可以实现遍历。

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

forEach 方法还可以接受第二个参数,用来绑定 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);

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

【01】Map 和数组

01、Map 转为数组

使用扩展运算符(…)。

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

02、数组转为 Map

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

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

【02】Map 和对象

01、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}

02、对象转为 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] ]

【03】Map 和 JSON

01、Map 转为 JSON

Map 转为 JSON 要区分两种情况。

一种情况是,Map 的键名都是字符串,可以先转换为对象,然后使用 JSON.stringify(obj) 转为 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"]]]'

02、JSON 转为 Map

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

通过 JSON.parse(josn) 转为对象,然后对象转为 Map。

function jsonToStrMap(jsonStr) {return objToStrMap(JSON.parse(jsonStr)); }
jsonToStrMap('{"yes":true,"no":false}')
    // Map {'yes' => true, 'no' => false}

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

通过 JSON.parse(json) 转为对象,然后通过 new Map() 转为 Map。

function jsonToMap(jsonStr) {return new Map(JSON.parse(jsonStr)); }
jsonToMap('[[true,7],[{"foo":3},["abc"]]]');    // Map {true => 7, Object {foo: 3} => ['abc']}

四、WeakMap

【01】WeakMap 结构与 Map 结构基本类似,唯一的区别是它只接受对象作为键名(null 除外),不接受其他类型的值作为键名。否则会报错。

var 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

【02】而且键名所指向的对象,垃圾回收机制不将该引用考虑在内。

WeakMap 的设计目的在于,键名是对象的弱引用,所以其所对应的对象可能会被自动回收。

当对象被回收后,WeakMap 自动移除对应的键值对。

var wm = new WeakMap();

var o = {};

wm.set(o,333);

o=null;

这时,wm 中的 o 所对应的键值对就没有了。

典型应用是,一个对应 DOM 元素的 WeakMap 结构,当某个 DOM 元素被清除,其所对应的 WeakMap 记录就会自动被移除。

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

下面是 WeakMap 结构的一个例子,可以看到用法上与 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

【03】WeakMap 与 Map 在 API 上的区别主要是两个,

一是没有遍历操作(即没有 key()、values() 和 entries() 方法),也没有 size 属性;

二是无法清空,即不支持 clear 方法。这与 WeakMap 的键不被计入引用、被垃圾回收机制忽略有关。

【04】WeakMap 只有四个方法可用:get()、set()、has()、delete()。

var wm = new WeakMap();

wm.size;// undefined

wm.forEach;// undefined

【05】WeakMap 应用的典型场合就是 DOM 节点作为键名。

例子。

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 是一个 DOM 节点,每当发生 click 事件,就更新一下状态。

我们将这个状态作为键值放在 WeakMap 里,对应的键名就是 myElement。一旦这个 DOM 节点删除,该状态就会自动消失,不存在内存泄漏风险。

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

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

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

正文完
 0