Symbol

基础知识

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

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

xxxxxxxxxx
let s = Symbol();

typeof s
// "symbol"

温馨提示

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

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

xxxxxxxxxx
let s1 = Symbol('itbaizhan');
let s2 = Symbol('sxt');

s1 // Symbol(itbaizhan)
s2 // Symbol(sxt)

s1和s2是两个 Symbol 值。如果不加参数，它们在控制台的输出都是Symbol()，不利于区分。有了参数以后，就等于为它们加上了描述，输出的时候就能够分清，到底是哪一个值

温馨提示

注意，Symbol函数的参数只是表示对当前 Symbol 值的描述，因此相同参数的Symbol函数的返回值是不相等的。

xxxxxxxxxx
// 没有参数的情况
let s1 = Symbol();
let s2 = Symbol();

s1 === s2 // false

// 有参数的情况
let s1 = Symbol('itbaizhan');
let s2 = Symbol('itbaizhan');

s1 === s2 // false

s1和s2都是Symbol函数的返回值，而且参数相同，但是它们是不相等的

实例属性description

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

xxxxxxxxxx
const sym = Symbol('itbaizhan');
sym.description // "itbaizhan"

作为属性名的 Symbol

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

xxxxxxxxxx
let mySymbol = Symbol("name");
var user = {
    name:"iwen"
}
var info = {
    [mySymbol]:"itbaizhan",
}

var newUser = Object.assign(user,info)
console.log(newUser[mySymbol]);

属性名的遍历

Symbol 作为属性名，遍历对象的时候，该属性不会出现在for...in、for...of循环中，也不会被Object.keys()返回

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

xxxxxxxxxx
let mySymbol = Symbol("age");
var user = {
    name:"iwen",
    [mySymbol]:20
}

for(let item in user){
    console.log(item); // name
}

const objectSymbols = Object.getOwnPropertySymbols(user);
console.log(objectSymbols); // [Symbol(age)]

Symbol.for()

有时，我们希望重新使用同一个 Symbol 值，Symbol.for()方法可以做到这一点。

xxxxxxxxxx
let s1 = Symbol.for('itbaizhan');
let s2 = Symbol.for('itbaizhan');
console.log(s1 === s2); // true

实时效果反馈

1. 下列代码输出结果是多少：

xxxxxxxxxx
let mySymbol = Symbol("name");
var user = {
    name:"iwen"
}
var info = {
    [mySymbol]:"itbaizhan",
}

var newUser = Object.assign(user,info)
console.log(newUser.mySymbol);

A itbaizhan

B iwen

C 报错

D undefined

答案

1=>D