ES6-symbol类型使用详解

是什么：ES6 引入了一种新的原始数据类型 Symbol

为什么：表示独一无二的值，最大的用法是用来定义对象的唯一属性名。

怎么做：

一 创建

Symbol 函数栈不能用 new 命令，因为 Symbol 是原始数据类型，不是对象。可以接受一个字符串作为参数，为新创建的 Symbol 提供描述，用来显示在控制台或者作为字符串的时候使用，便于区分。

let sy = Symbol("KK"); 
console.log(sy); 
// Symbol(KK) 
typeof(sy); // "symbol" 
// 相同参数 Symbol() 返回的值不相等 
let sy1 = Symbol("kk"); 
sy === sy1; // false

二 使用

1 由于每一个 Symbol 的值都是不相等的，所以 Symbol 作为对象的属性名，可以保证属性不重名。

let sy = Symbol("key1"); 

// 写法1 
let syObject = {}; 
syObject[sy] = "kk"; 
console.log(syObject); // {Symbol(key1): "kk"} 

// 写法2 
let syObject = { [sy]: "kk" }; 
console.log(syObject); // {Symbol(key1): "kk"} 

// 写法3 let syObject = {}; 
Object.defineProperty(syObject, sy, {value: "kk"}); 
console.log(syObject); // {Symbol(key1): "kk"}

Symbol 作为对象属性名时不能用.运算符，要用方括号。因为.运算符后面是字符串，所以取到的是字符串 sy 属性，而不是 Symbol 值 sy 属性。

let syObject = {}; 
syObject[sy] = "kk"; 
syObject[sy]; // "kk" 
syObject.sy; // undefined

2 定义常量

const COLOR_RED = Symbol("red"); 
const COLOR_YELLOW = Symbol("yellow"); 
const COLOR_BLUE = Symbol("blue");

三 注意点

Symbol 值作为属性名时，该属性是公有属性不是私有属性，可以在类的外部访问。但是不会出现在 for...in 、 for...of 的循环中，也不会被 Object.keys() 、 Object.getOwnPropertyNames() 返回。如果要读取到一个对象的 Symbol 属性，可以通过 Object.getOwnPropertySymbols() 和 Reflect.ownKeys() 取到。

let syObject = {}; 
syObject[sy] = "kk"; 
console.log(syObject); 
for (let i in syObject) { console.log(i); } // 无输出 Object.keys(syObject); // [] 
Object.getOwnPropertySymbols(syObject); // [Symbol(key1)] Reflect.ownKeys(syObject); // [Symbol(key1)]

四 配套语法

Symbol.for()

Symbol.for() 类似单例模式，首先会在全局搜索被登记的 Symbol 中是否有该字符串参数作为名称的 Symbol 值，如果有即返回该 Symbol 值，若没有则新建并返回一个以该字符串参数为名称的 Symbol 值，并登记在全局环境中供搜索。

let yellow = Symbol("Yellow"); 
let yellow1 = Symbol.for("Yellow"); 
yellow === yellow1; // false 
let yellow2 = Symbol.for("Yellow"); 
yellow1 === yellow2; // true

Symbol.keyFor()

Symbol.keyFor() 返回一个已登记的 Symbol 类型值的 key ，用来检测该字符串参数作为名称的 Symbol 值是否已被登记。

let yellow1 = Symbol.for("Yellow"); 
Symbol.keyFor(yellow1); // "Yellow"