Symbol

Posted 2020-10-06 rogerwu

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

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

let b = Symbol();
typeof b;   // "symbol"

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

let c = new Symbol();
console.log(c);   // Symbol is not a constructor

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

var s1 = Symbol(‘foo‘);
var s2 = Symbol(‘bar‘);
console.log(s1);   // Symbol(foo)
console.log(s2);   // Symbol(bar)

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

 

注意点：

（1）、Symbol 值作为对象属性名时，不能用 点运算符

var mySymbol = Symbol();
var a = {};

a.mySymbol = ‘Hello!‘;
a[mySymbol] // undefined
a[‘mySymbol‘] // "Hello!"

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

 

（2）、在对象的内部，使用 Symbol 值定义属性时，Symbol 值必须放在方括号之中

let s = Symbol();

let obj = {
  [s]: function (arg) { console.log(arg) }
};

obj[s](123);   // 123

 

1、Symbol.for()

Symbol.for 方法接受一个字符串作为参数，然后搜索有没有以该参数作为名称的 Symbol 值。如果有，就返回这个Symbol 值，否则，就新建并返回一个以该字符串为名称的 Symbol 值

let a3=Symbol.for(‘a3‘);
let a4=Symbol.for(‘a3‘);

console.log(a3===a4);   // true

a3 和 a4 都是 Symbol 值，是使用同样参数的 Symbol.for 方法生成的，搜索时发现同样的值，所以，实际上返回的是同一个Symbol值

 

2、Object.getOwnPropertySymbols()

Object.getOwnPropertySymbols 方法，可以获取指定对象的所有 Symbol 属性名，返回值是一个数组

var obj2 = {};
var a = Symbol(‘a‘);
var b = Symbol(‘b‘);

obj2[a] = ‘Hello‘;
obj2[b] = ‘World‘;

var objectSymbols = Object.getOwnPropertySymbols(obj2);

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