《十》ES6+ 中的 Symbol

ES6 引入了一种新的原始数据类型 Symbol，表示独一无二的值。

Symbol是 JavaScript 语言的第七种数据类型，前六种是：String、Number、Boolean、Null、Undefined、Object。

const s = Symbol()
typeof s // "symbol"

Symbol 出现的原因：

ES6 之前，对象属性名都是字符串，容易造成属性名的冲突。例如：有一个对象，要给其添加一个新的属性，但是在不确定内部有什么属性的情况下，很容易本来是想添加新的属性，结果却是覆盖掉了原本的某个属性。这就是 Symbol 出现的原因。

也就是说，对象的属性名现在有两种类型，一种是原来就有的字符串，另一种就是新增的 Symbol 类型。Symbol 值作为对象的属性名时，必须放在方括号之中。

const s = Symbol()
const obj = {
  [s]: 'Lee',
}
console.log(obj[s])

Symbol 作为属性名，既不会出现在 for...in 循环中，也不会被 Object.keys() 、Object.getOwnPropertyNames() 返回。可以通过 Object.getOwnPropertySymbols() 方法，可以获取指定对象的所有 Symbol 属性名。该方法返回一个数组，成员是当前对象的所有用作属性名的 Symbol 值。

Reflect.ownKeys() 方法可以返回所有类型的键名，包括常规键名和 Symbol 键名。

const obj = {};
let a = Symbol('a')
let b = Symbol('b')
obj[a] = 'Hello'
obj[b] = 'World'

const objectSymbols = Object.getOwnPropertySymbols(obj) // [Symbol(a), Symbol(b)]

创建 Symbol：

Symbol 值通过 Symbol 函数生成。Symbol 函数可以接受一个字符串作为参数，表示对 Symbol 实例的描述，主要是为了在控制台显示，或者转为字符串时比较容易区分；如果 Symbol 的参数是一个对象，就会调用该对象的 toString() 方法，将其转为字符串，然后才生成一个 Symbol 值。

Symbol 函数前不能使用 new 命令，否则会报错，这是因为生成的 Symbol 是一个原始类型的值，不是对象。

const s1 = Symbol('foo') // Symbol(foo)
const s2 = Symbol('bar') // Symbol(bar)

const obj = {
  toString() {
    return 'abc';
  }
}
const sym = Symbol(obj) // Symbol(abc)

直接通过 Symbol 函数创建出来的值都是独一无二的。

// 没有参数的情况
const s1 = Symbol()
const s2 = Symbol()
s1 === s2 // false

// 有参数的情况
const s1 = Symbol('foo')
const s2 = Symbol('foo')
s1 === s2 // false

Symbol 值不能与任何类型的值进行运算，会报错。

const sym = Symbol('My symbol')

"your symbol is " + sym // TypeError: can't convert symbol to string
`your symbol is ${sym}` // TypeError: can't convert symbol to string

Symbol 值可以显式转为字符串和布尔值，但是不能转为数值。

const sym = Symbol('My symbol')

String(sym) // 'Symbol(My symbol)'
Boolean(sym) // true
Number(sym) // TypeError

Symbol 实例的属性：

ES10 提供了一个 Symbol 实例的属性 description，直接返回 Symbol 的描述。

ES6 还提供了一些内置的 Symbol 值，直接作为 Symbol 函数的属性来使用。但一般不会使用到。

const sym = Symbol('foo')
sym.description // "foo"

Symbol 的方法：

Symbol.for()：

Symbol.for() 接受一个字符串作为参数，然后搜索有没有以该参数作为名称的 Symbol 值，如果有，就返回这个 Symbol 值，否则就新建一个以该字符串为名称的 Symbol 值，并将其注册到全局。

Symbol.for() 与 Symbol() 都会生成新的 Symbol。它们的区别是，前者会被登记在全局环境中供搜索，后者不会。

let s1 = Symbol.for('foo')
let s2 = Symbol.for('foo')

s1 === s2 // true

Symbol.keyFor()：

Symbol.keyFor() 方法返回一个已登记的 Symbol 类型值的 key。

let s1 = Symbol.for("foo")
Symbol.keyFor(s1) // "foo"

let s2 = Symbol("foo")
Symbol.keyFor(s2) // undefined