Symbol

1、symbol产生的背景

ES5 的对象属性名都是字符串，这容易造成属性名的冲突。比如，你使用了一个他人提供的对象，但又想为这个对象添加新的方法（mixin 模式），新方法的名字就有可能与现有方法产生冲突。如果有一种机制，保证每个属性的名字都是独一无二的就好了，这样就从根本上防止属性名的冲突。这就是 ES6 引入Symbol的原因

---

2、symbol

ES6 引入了一种新的原始数据类型Symbol，表示独一无二的值。它是JavaScript语言的第七种数据类型，前六种是：undefined、null、布尔值（Boolean）、字符串（String）、数值（Number）、对象（Object）。

注意，Symbol函数前不能使用new命令，否则会报错。这是因为生成的 Symbol 是一个原始类型的值，不是对象。也就是说，由于 Symbol 值不是对象，所以不能添加属性。基本上，它是一种类似于字符串的数据类型。

Symbol函数可以接受一个字符串作为参数，表示对 Symbol 实例的描述，主要是为了在控制台显示，或者转为字符串时，比较容易区分。

let s1 = Symbol('foo');
let s2 = Symbol('bar');

s1 
// Symbol(foo)
s2 
// Symbol(bar)

s1.toString() 
// "Symbol(foo)"
s2.toString() 
// "Symbol(bar)"

---

3、作为属性名的Symbol

由于每一个 Symbol 值都是不相等的，这意味着Symbol值可以作为标识符，用于对象的属性名，就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用，能防止某一个键被不小心改写或覆盖。

const mySymbol = Symbol()

// 第一种写法
let a = {};
a[mySymbol] = 'Hello!'

// 第二种写法
let a = {
  [mySymbol]: 'Hello!'
}

// 第三种写法
let a = {}
Object.defineProperty(a, mySymbol, { value: 'Hello!' })

// 以上写法都得到同样结果

a[mySymbol] 
// "Hello!"

注意，Symbol 值作为对象属性名时，不能用点运算符

const mySymbol = Symbol()
const a = {}
a.mySymbol = 'Hello!'
a[mySymbol] 
// undefined
a['mySymbol'] 
// "Hello!"

上面代码中，因为点运算符后面总是字符串，所以不会读取mySymbol作为标识名所指代的那个值，导致a的属性名实际上是一个字符串，而不是一个 Symbol 值

---

4、symbol属性名遍历

Symbol 作为属性名时以下方法不会返回此属性

• for...in
• for...of
• Object.keys()
• Object.getOwnPropertyNames()
• JSON.stringify()

但是Object.getOwnPropertySymbols方法，可以获取指定对象的所有 Symbol 属性名，并返回一个数组，成员是当前对象的所有用作属性名的 Symbol 值

const obj = {};
const a = Symbol('a')
const b = Symbol('b')

obj[a] = 'Hello'
obj[b] = 'World'

const objectSymbols = Object.getOwnPropertySymbols(obj)
console.log(objectSymbols)

// [Symbol(a), Symbol(b)]

const obj = {}
let foo = Symbol("foo")
Object.defineProperty(obj, foo, {
  value: "foobar"
})

for (let i in obj) {
  console.log(i)
  // 无输出
}

Object.getOwnPropertyNames(obj)
// []

Object.getOwnPropertySymbols(obj)
// [Symbol(foo)]

---