ECMAScript 专题
专题目录
您的位置:ECMAScript > ECMAScript 专题 > ECMAScript 6 Set和Map数据结构
ECMAScript 6 Set和Map数据结构
作者:--    发布时间:2019-11-20 21:07:05
  1. set
  2. weakset
  3. map
  4. weakmap

set

基本用法

es6提供了新的数据结构set。它类似于数组,但是成员的值都是唯一的,没有重复的值。

set本身是一个构造函数,用来生成set数据结构。

var s = new set();

[2, 3, 5, 4, 5, 2, 2].map(x => s.add(x));

for (let i of s) {
  console.log(i);
}
// 2 3 5 4

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

set函数可以接受一个数组(或类似数组的对象)作为参数,用来初始化。

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

上面代码中,例一和例二都是set函数接受数组作为参数,例三是接受类似数组的对象作为参数。

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

// 去除数组的重复成员
[...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,但是只能加入一个。这表明,在set内部,两个nan是相等。

另外,两个对象总是不相等的。

let set = new set();

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

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

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

set实例的属性和方法

set结构的实例有以下属性。

  • set.prototype.constructor:构造函数,默认就是set函数。
  • set.prototype.size:返回set实例的成员总数。

set实例的方法分为两大类:操作方法(用于操作数据)和遍历方法(用于遍历成员)。下面先介绍四个操作方法。

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

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

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

下面是一个对比,看看在判断是否包括一个键上面,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
}

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结构的实例有四个遍历方法,可以用于遍历成员。

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

需要特别指出的是,set的遍历顺序就是插入顺序。这个特性有时非常有用,比如使用set保存一个回调函数列表,调用时就能保证按照添加顺序调用。

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

key方法、value方法、entries方法返回的都是遍历器对象(详见《iterator对象》一章)。由于set结构没有键名,只有键值(或者说键名和键值是同一个值),所以key方法和value方法的行为完全一致。

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

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

(2)foreach()

set结构的实例的foreach方法,用于对每个成员执行某种操作,没有返回值。

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

上面代码说明,foreach方法的参数就是一个处理函数。该函数的参数依次为键值、键名、集合本身(上例省略了该参数)。另外,foreach方法还可以有第二个参数,表示绑定的this对象。

(3)遍历的应用

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

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

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

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

而且,数组的mapfilter方法也可以用于set了。

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}

因此使用set可以很容易地实现并集(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}

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

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

上面代码提供了两种方法,直接在遍历操作中改变原来的set结构。

weakset

weakset结构与set类似,也是不重复的值的集合。但是,它与set有两个区别。

首先,weakset的成员只能是对象,而不能是其他类型的值。

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

var ws = new weakset();
ws.add(1)
// typeerror: invalid value used in weak set
ws.add(symbol())
// typeerror: invalid value used in weak set

上面代码试图向weakset添加一个数值和symbol值,结果报错,因为weakset只能放置对象。

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

var ws = new weakset();

作为构造函数,weakset可以接受一个数组或类似数组的对象作为参数。(实际上,任何具有iterable接口的对象,都可以作为weakset的参数。)该数组的所有成员,都会自动成为weakset实例对象的成员。

var a = [[1,2], [3,4]];
var ws = new weakset(a);

上面代码中,a是一个数组,它有两个成员,也都是数组。将a作为weakset构造函数的参数,a的成员会自动成为weakset的成员。

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

var b = [3, 4];
var ws = new weakset(b);
// uncaught typeerror: invalid value used in weak set(…)

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

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

weakset没有size属性,没有办法遍历它的成员。

ws.size // undefined
ws.foreach // undefined

ws.foreach(function(item){ console.log('weakset has ' + item)})
// typeerror: undefined is not a function

上面代码试图获取sizeforeach属性,结果都不能成功。

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

下面是weakset的另一个例子。

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

map结构的目的和基本用法

javascript的对象(object),本质上是键值对的集合(hash结构),但是传统上只能用字符串当作键。这给它的使用带来了很大的限制。

var data = {};
var element = document.getelementbyid('mydiv');

data[element] = 'metadata';
data['[object htmldivelement]'] // "metadata"

上面代码原意是将一个dom节点作为对象data的键,但是由于对象只接受字符串作为键名,所以element被自动转为字符串[object htmldivelement]

为了解决这个问题,es6提供了map数据结构。它类似于对象,也是键值对的集合,但是“键”的范围不限于字符串,各种类型的值(包括对象)都可以当作键。也就是说,object结构提供了“字符串—值”的对应,map结构提供了“值—值”的对应,是一种更完善的hash结构实现。如果你需要“键值对”的数据结构,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

上面代码使用set方法,将对象o当作m的一个键,然后又使用get方法读取这个键,接着使用delete方法删除了这个键。

作为构造函数,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实例时,就指定了两个键nametitle

map构造函数接受数组作为参数,实际上执行的是下面的算法。

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

下面的例子中,字符串true和布尔值true是两个不同的键。

var m = new map([
  [true, 'foo'],
  ['true', 'bar']
]);

m.get(true) // 'foo'
m.get('true') // 'bar'

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

let map = new map();

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

map.get(1) // "bbb"

上面代码对键1连续赋值两次,后一次的值覆盖前一次的值。

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

new map().get('asfddfsasadf')
// undefined

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

var map = new map();

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

上面代码的setget方法,表面是针对同一个键,但实际上这是两个值,内存地址是不一样的,因此get方法无法读取该键,返回undefined

同理,同样的值的两个实例,在map结构中被视为两个键。

var map = new map();

var k1 = ['a'];
var k2 = ['a'];

map
.set(k1, 111)
.set(k2, 222);

map.get(k1) // 111
map.get(k2) // 222

上面代码中,变量k1k2的值是一样的,但是它们在map结构中被视为两个键。

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

如果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

实例的属性和操作方法

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

(1)size属性

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

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

map.size // 2

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

(3)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!

(4)has(key)

has方法返回一个布尔值,表示某个键是否在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

(5)delete(key)

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

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

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

(6)clear()

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

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

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

遍历方法

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

  • keys():返回键名的遍历器。
  • values():返回键值的遍历器。
  • entries():返回所有成员的遍历器。
  • foreach():遍历map的所有成员。

需要特别注意的是,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);
}

上面代码最后的那个例子,表示map结构的默认遍历器接口(symbol.iterator属性),就是entries方法。

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

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本身没有mapfilter方法)。

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

此外,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);

上面代码中,foreach方法的回调函数的this,就指向reporter

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

(1)map转为数组

前面已经提过,map转为数组最方便的方法,就是使用扩展运算符(...)。

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

(2)数组转为map

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

let mymap = new map().set('yes', true).set('no', false);
strmaptoobj(mymap)
// { yes: true, no: false }

(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})
// [ [ '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']}

weakmap

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

上面代码中,如果将1symbol作为weakmap的键名,都会报错。

weakmap的设计目的在于,键名是对象的弱引用(垃圾回收机制不将该引用考虑在内),所以其所对应的对象可能会被自动回收。当对象被回收后,weakmap自动移除对应的键值对。典型应用是,一个对应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

上面代码中,变量wm是一个weakmap实例,我们将一个dom节点element作为键名,然后销毁这个节点,element对应的键就自动消失了,再引用这个键名就返回undefined

weakmap与map在api上的区别主要是两个,一是没有遍历操作(即没有key()values()entries()方法),也没有size属性;二是无法清空,即不支持clear方法。这与weakmap的键不被计入引用、被垃圾回收机制忽略有关。因此,weakmap只有四个方法可用:get()set()has()delete()

var wm = new weakmap();

wm.size
// undefined

wm.foreach
// undefined

前文说过,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节点删除,该状态就会自动消失,不存在内存泄漏风险。

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()
c.dec()
// done

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

网站声明:
本站部分内容来自网络,如您发现本站内容
侵害到您的利益,请联系本站管理员处理。
联系站长
373515719@qq.com
关于本站:
编程参考手册