阅读 36

ES6系列-- 8. Symbol

概述

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

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

let s = Symbol();
typeof s   // "symbol"
复制代码

Symbol 是一种独特的且不可变的数据类型,经常用来标识对象属性。

要创建 Symbol,输入 Symbol(),并添加一个可选的字符串作为其描述。

const sym1 = Symbol('apple');
console.log(sym1); //Symbol(apple)
复制代码

它将创建唯一的标识符,并将其存储在 sym1 中。描述 "apple"只是用来描述标识符的一种方式,但是不能用来访问标识符本身。

如果对具有相同描述的两个标识符进行比较……

const sym2 = Symbol('banana');
const sym3 = Symbol('banana');
console.log(sym2 === sym3);
复制代码

结果是 false,因为描述只是用来描述符号,它并不是标识符本身的一部分。无论描述是什么,每次都创建新的标识符。

Symbol 值不能与其他类型的值进行运算,会报错。但是,Symbol 值可以显式转为字符串。也可以转为布尔值,但是不能转为数值。

let sym = Symbol('My symbol');

"your symbol is " + sym  // TypeError: can't convert symbol to string

String(sym) // 'Symbol(My symbol)'
sym.toString() // 'Symbol(My symbol)'

Boolean(sym) // true
!sym  // false

Number(sym) // TypeError
sym + 2 // TypeError
复制代码

作为属性名的 Symbol

由于每一个 Symbol 值都是不相等的,这意味着 Symbol 值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性

let mySymbol = Symbol();

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

// 第二种写法
let a = {
    [mySymbol]: 'Hello!'
 };
 
 a[mySymbol] // "Hello!"
复制代码

注意,Symbol 值作为对象属性名时,不能用点运算符。同理,在对象的内部,使用 Symbol 值定义属性时,Symbol 值必须放在方括号之中。

属性名的遍历

Symbol 作为属性名,该属性不会出现在for...in、for...of循环中,也不会被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。但是,它也不是私有属性,有一个Object.getOwnPropertySymbols方法,可以获取指定对象的所有 Symbol 属性名。

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

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

const objectSymbols = Object.getOwnPropertySymbols(obj);

objectSymbols
// [Symbol(a), Symbol(b)]
复制代码