Set 和 Map 数据结构

Set

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

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

const s = new Set();
// console.log(s);

[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 接口的其他数据结构）作为参数，用来初始化。

// 例子1
var arr = [0, 0, 1, 1, 2, 3, 3, 3]
const set = new Set(arr);
console.log([...set]); // [0,1,2,3]

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

// 去除数组的重复成员
var array = [1, 2, 3, 4, 5, 5, 5, 5];
console.log([...new Set(array)]); // 12345

上面的方法也可以用于，去除字符串里面的重复字符。

// 去除数组的重复成员
var str = 'ababbc';
console.log([...new Set(str)].join(''));
// "abc"

Set 实例的属性和方法

Set 结构的实例有以下属性

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

Set 实例的方法分为两大类：操作方法（用于操作数据）和遍历方法（用于遍历成员）。

操作方法

下面先介绍四个操作方法。

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

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

let 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

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

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

if (properties[someName]) {
  // do something
}

// Set的写法
const properties = new Set();

properties.add('width');
properties.add('height');

if (properties.has(someName)) {
  // do something
}

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

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

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

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

dedupe([1, 1, 2, 2, 2, 3, 3, 5, 5, 5, 5]); // [1, 2, 3, 5]

遍历方法

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

Set.prototype.keys()：返回键名的遍历器
Set.prototype.values()：返回键值的遍历器
Set.prototype.entries()：返回键值对的遍历器
Set.prototype.forEach()：使用回调函数遍历每个成员

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

keys方法、values方法、entries方法返回的都是遍历器对象（详见《Iterator 对象》一章）。由于 Set 结构没有键名，只有键值（或者说键名和键值是同一个值），所以keys方法和values方法的行为完全一致。

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

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

Set 结构的实例与数组一样，也拥有forEach方法，用于对每个成员执行某种操作，没有返回值。

var arr = [1, 2, 3, 4, 5];
arr.forEach(function (item, index) {
    console.log(item + ":" + index);
});
// 1:0
// 2:1
// 3:2
// 4:3
// 5:4
var set = new Set([1, 2, 3, 5, 8, 13]);
set.forEach(function (value, key) {
    console.log(value + ":" + key);
});
// 1:1
// 2:2
// 3:3
// 5:5
// 8:8
// 13:13

Set 结构的键名就是键值（两者是同一个值），因此第一个参数与第二个参数的值永远都是一样的。

遍历的应用

扩展运算符（...）内部使用for...of循环，所以也可以用于 Set 结构。

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

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

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

而且，数组的map和filter方法也可以间接用于 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]);
console.log(union); // Set {1, 2, 3, 4}

// 交集
let intersect = new Set([...a].filter(x => b.has(x)));
console.log(intersect); // set {2, 3}

// （a 相对于 b 的）差集
let difference = new Set([...a].filter(x => !b.has(x)));
console.log(difference); // 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 结构。

Map

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

let o = {
    "james": 36
}
let a = new Map();
a.set(o, "wade");
a.get(o);

a.has(o); // trie
a.delete(o); // true
a.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"

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

const items = [
  ['name', '张三'],
  ['title', 'Author']
];

const map = new Map();

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

事实上，不仅仅是数组，任何具有 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

上面代码中，我们分别使用 Set 对象和 Map 对象，当作Map构造函数的参数，结果都生成了新的 Map 对象。

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

const map = new Map();

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

map.get(1) // "bbb"

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

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

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

const set = new Set([
    [1, 'foo'],
    [2, 'bar']
]);

const map = new Map(set);
map.get(1); // 'foo'
map.get(2); // 'bar'
map.set(3, "baz");
map.get(3); // 'baz'

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

上面代码中，变量k1和k2的值是一样的，但是它们在 Map 结构中被视为两个键。

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

Map实例的属性和方法

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

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

操作方法

Map.prototype.set(key, value); // set方法设置键名key对应的键值为value，然后返回整个 Map 结构。如果key已经有值，则键值会被更新，否则就新生成该键。
Map.prototype.get(key);  // get方法读取key对应的键值，如果找不到key，返回undefined。
Map.prototype.has(key);  // has方法返回一个布尔值，表示某个键是否在当前 Map 对象之中。
Map.prototype.delete(key); // delete方法删除某个键，返回true。如果删除失败，返回false。
Map.prototype.clear(); // clear方法清除所有成员，没有返回值。

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

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

Map结构的键可以是任意值

const m = new Map();

const foo = function () {
    console.log('hello');
};
m.set(foo, 'Hello ES6!') // 键是函数

m.get(foo); // Hello ES6!

遍历方法

与Set一样， Map结构的实例有四个遍历方法，可以用于遍历成员。

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

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

const map = new Map([
    ['F', 'no'],
    ['T', 'yes'],
]);
console.log(map.keys()); // MapIterator {"F", "T"} 

for (key of map.keys()) {
    console.log(key); // F T
}
// 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 结构的默认遍历器接口（Symbol.iterator属性），就是entries方法。（Set 结构的默认遍历器接口（Symbol.iterator属性）,就是values方法）

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

遍历的应用

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

结合数组的map方法、filter方法，可以实现 Map 的遍历和过滤（Map 本身没有map和filter方法）。

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

const map1 = new Map(
    [...map0].filter(([k, v]) => k < 3)
);
// 产生 Map 结构 {1 => 'a', 2 => 'b'}

const map2 = new Map(
    [...map0].map(([k, v]) => [k * 2, '_' + v])
);
// 产生 Map 结构 {2 => '_a', 4 => '_b', 6 => '_c'}

此外，Map 还有一个forEach方法，与数组的forEach方法类似，也可以实现遍历。

var map = new Map()
    .set(1, "abc")
    .set(2, 'bcd')
    .set(3, 'def');
map.forEach(function (value, key, map) {
    console.log("Key: %s, Value: %s", key, value);
});

// Key: 1, Value: abc
// Key: 2, Value: bcd
// Key: 3, Value: def

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

Map 转为数组

前面已经提过，Map 转为数组最方便的方法，就是使用扩展运算符（...）。

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

数组 转为 Map

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

var map = new Map([
    [true, 7],
    [{
            foo: 3
        },
        ['abc']
    ]
]);
console.log(map);
// 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;
}

const myMap = new Map()
  .set('yes', true)
  .set('no', false);
strMapToObj(myMap)
// { yes: true, no: false }

如果有非字符串的键名，那么这个键名会被转成字符串，再作为对象的键名。

对象转为 Map

对象转为 Map 可以通过Object.entries()。

let obj = {
    "a": 1,
    "b": 2
};
let map = new Map(Object.entries(obj));
console.log(map);