详解 Symbol 类型
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('name') let a = { [s]: 'Kobe' } console.log(a) // {Symbol(name): "Kobe"} } { let s = Symbol('name') let a = {} Object.defineProperty(a, s, {value: 'Kobe'}) console.log(a) // {Symbol(name): "Kobe"} } // 使用 Object.defineProperty() 方法为对象添加属性时,如果属性名是一个 Symbol值,不能把 Symbol 转为字符串 { let s = Symbol('name') let a = {} // Object.defineProperty(a, [s], {value: 'Kobe'}) // Uncaught TypeError: Cannot convert a Symbol value to a string }
(3)、如果 Symbol 的参数是一个对象,就会调用该对象的 toString() 方法,将其转为字符串,然后才生成一个 Symbol 值
{ let obj = { a: 2, b: 3, add: function() { return this.a + this.b } } let s = Symbol(obj) console.info(s) // Symbol([object Object]) } { let obj = { a: 2, b: 3, add: function() { return this.a + this.b }, // 重写对象的toString() 方法 toString: function() { return 'overide toString' } } let s = Symbol(obj) console.info(s) // Symbol(overide toString) }
(4)、Symbol 值不能与其它类型的值进行运算,否则会报错
{ let s = Symbol('hello world') console.info("the symbol is: " + s) // Uncaught TypeError: Cannot convert a Symbol value to a string console.info(`ths symbol is ${s}`) // Uncaught TypeError: Cannot convert a Symbol value to a string }
(5)、Symbol 值可以显示的转为字符串
{ let s = Symbol('hello world') console.info(s.toString()) // Symbol(hello world) console.info(typeof s.toString()) // string }
(6)、Symbol 值可以转为布尔值,但是不能转为数值
{ let s1 = Symbol() let s2 = Symbol('hello world') let s3 = Symbol('true') let s4 = Symbol('false') // 目测应该是 只要存在这个Symbol就会转为true console.info(Boolean(s1)) // true console.info(Boolean(s2)) // true console.info(Boolean(s3)) // true console.info(Boolean(s4)) // true console.info(Boolean(!s1)) // false console.info(Boolean(!s3)) // false console.info(!s4) // false if(s4) { console.log('Symbol类型变量可以直接用于if判断') } // Symbol类型变量可以直接用于if判断 let s5 = Symbol(5) // ---> Symbol 接受的是字符串作为参数,Number类型数据应该也会调用toString方法 console.info(s5) // Symbol(5) console.info(Number(s5)) // Uncaught TypeError: Cannot convert a Symbol value to a number }
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值
{ let s1 = Symbol.for('abc') let s2 = Symbol.for('abc') console.info(s1 === s2) // true let s3 = Symbol('foo') let s4 = Symbol('foo') console.info(s3 === s4) // false }
Symbol.for('xxx') 和 Symbol('xxx') 都会生成新的 Symbol,它们的区别是:
- Symbol.for('xxx') 会提供全局搜索,首先检查给定的 key ('xxx') 是否已经存在,如果不存在才会创建
- Symbol('xxx') 不存在这种登记机制,每次都会返回一个不同的值
{ let i = 1 let s1 = Symbol.for('abc') while(i <= 30) { let temp = Symbol.for('abc') if(s1 === temp) { break } else{ console.log('temp, ' + temp.toString()) } i++ } // 直接跳出循环,没有打印输出,说明每次循环用 Symbol.for() 创建的Symbol都会在全局检索,并且相同Symbol比较是可以相等的 } { let i = 1 let s2 = Symbol('abc') while(i <= 30) { let temp = Symbol('abc') if(s2 === temp) { break } else{ console.log('temp, ' + temp.toString()) } i++ } // 30 temp, Symbol(abc) // 说明每次循环用 Symbol() 创建的Symbol都是独一无二的,不等于任何值,因此循环30次就会创建30个Symbol }
Symbol.keyFor 方法返回一个 **已登记的** Symbol 类型值的key (Symbol.for() 有登记机制,而Symbol() 没有登记机制,因此,此方法不适用于后者)
{ let s1 = Symbol.for('abc') console.log(Symbol.keyFor(s1)) // abc let s2 = Symbol('bar') console.log(Symbol.keyFor(s2)) // undefined }
Symbol 作为属性名,不会被 for in 或 for of 遍历,可以通过 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)]
{ let a = Symbol('a') let b = Symbol('b') let obj = { [a]: 'hello', [b]: 'world', c: 'es6', d: 'dom' } for(let key in obj) { console.info(key + ' --> ' + obj[key]) } /* c --> es6 d --> dom */ let objSymbols = Object.getOwnPropertySymbols(obj) console.info(objSymbols) // [Symbol(a), Symbol(b)] objSymbols.forEach(item => { console.info(item.toString() + ' --> ' + obj[item]) }) /* Symbol(a) --> hello Symbol(b) --> world */ }
Reflect.ownKeys() 方法可以返回所有类型的键名,包括常规键名和 Symbol 键名
let keyArray = Reflect.ownKeys(obj) console.log(keyArray) // ["c", "d", Symbol(a), Symbol(b)]