ES5的对象属性名都是字符串,这容易造成属性名的冲突。比如,你使用了一个他人提供的对象,但又想为这个对象添加新的方法(mixin模式),新方法的名字就有可能与现有方法产生冲突。如果有一种机制,保证每个属性的名字都是独一无二的就好了,这样就冲根本上防止属性名的冲突。这就是ES6引入Symbol的原因。
ES6引入了一种新的原始性数据类型Symbol,表示独一无二的值。它属于javaScript语言的原生数据类型之一,其他数据类型是:undefinded、null、布尔值(Boolean)、字符串(String)、数值(Number)、大整数(BigInt)、对象(Object)
Symbol值通过Symbol()函数生成。这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的Symbol类型。凡是属性名属于Symbol类型,就是独一无二的们可以保证不会与其他属性名产生冲突。
1 let s = Symbol(); 2 console.log(typeof s); 3 //"symbol"
上面代码中,变量s就是一个独一无二的值。typeof运算符的结果,表名变量s是Symbol数据类型,而不是字符串之类的其他类型。
注意,Symbol()函数前不能使用new命令,否则会报错。这是因为生成的Symbol是一个原始类型的值,不是对象,所以不能使用new命令来调用。另外,由于Symbol值不是对象,所以也不能添加属性。基本上,它是一种类似于字符串的数据类型。
Symbol()函数可以接收一个字符串作为参数,表示对Symbol示例的描述。这主要是为了在控制台显示,或者转为字符串时,比较容易区分。
1 let s1 = Symbol('foo'); 2 let s2 = Symbol('bar'); 3 4 s1 // Symbol(foo) 5 s2 // Symbol(bar) 6 7 s1.toString() // "Symbol(foo)" 8 s2.toString() // "Symbol(bar)"
上面代码中,s1和s2是两个Symbol值。如果不加参数,他们在控制台输出的都是Symbol(),不利于区分。有了参数以后,就等于他们加上了描述,输出的时候就能够分清,到底是哪一个值。
如果Symbol的参数是一个对象,就会调用该对象的toString()方法,将其转为字符串然后才生成一个Symbol值。
1 const obj = { 2 toString() { 3 return 'abc'; 4 } 5 }; 6 const sym = Symbol(obj); 7 sym // Symbol(abc)
注意,Symbol()函数的参数知识表示对当前Symbol值的描述,因此相同参数的Symbol函数的返回值是不相等的。
1 // 没有参数的情况 2 let s1 = Symbol(); 3 let s2 = Symbol(); 4 5 s1 === s2 // false 6 7 // 有参数的情况 8 let s1 = Symbol('foo'); 9 let s2 = Symbol('foo'); 10 11 s1 === s2 // false
上面代码中,s1和s2都是Symbol()函数的返回值,而且参数相同,但是他们是不相等的。事实上,如果调用100次Symbol(),会得到100个互不相等得值。
Symbol值不能与其他类型的值进行运算,会报错。
1 let sym = Symbol('My symbol'); 2 3 "your symbol is " + sym 4 // TypeError: can't convert symbol to string 5 `your symbol is ${sym}` 6 // TypeError: can't convert symbol to string
但是,Symbol值也可以转为布尔值,但是不能转为数值。
let sym = Symbol(); Boolean(sym) // true !sym // false if (sym) { // ... } Number(sym) // TypeError sym + 2 // TypeError
前面说过,Symbol()函数创建Symbol值时,可以用参数添加一个描述。
1 const sym = Symbol('foo');
上面代码中,sym这个值的描述就是字符串foo
但是,读取这个描述需要将Symbol显示转为字符串,即下面的写法。
1 const sym = Symbol('foo'); 2 3 String(sym) // "Symbol(foo)" 4 sym.toString() // "Symbol(foo)"
上面的用法不是很方便。ES2019提供了一个Symbol值的实例属性description,直接直接返回Symbol值的描述。
1 const sym = Symbol('foo'); 2 3 sym.description // "foo"
由于每一个symbol值都是不相等的,这意味着只要Symbol值作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块的情况非常有用,能防止某一个键被不小心改写或覆盖。
1 let mySymbol = Symbol(); 2 3 // 第一种写法 4 let a = {}; 5 a[mySymbol] = 'Hello!'; 6 7 // 第二种写法 8 let a = { 9 [mySymbol]: 'Hello!' 10 }; 11 12 // 第三种写法 13 let a = {}; 14 Object.defineProperty(a, mySymbol, { value: 'Hello!' }); 15 16 // 以上写法都得到同样结果 17 a[mySymbol] // "Hello!"
上面代码通过方括号结构和Object.defineProperty()方法,将对象的属性名指定为一个Symbol值。
注意,symbol值作为对象属性名时,不能用点运算符。
1 const mySymbol = Symbol(); 2 const a = {}; 3 4 a.mySymbol = 'Hello!'; 5 a[mySymbol] // undefined 6 a['mySymbol'] // "Hello!"
上面代码中,因为点运算符后面总是字符串,所以不会读取mySymbol作为标识名所指代的那个值,导致a的属性名实际上是一个字符串,而不是一个Symbol值。
同理,在对象的内部,使用Symbol值定义属性时,Symbol值必须放在方括号中。
1 let s = Symbol(); 2 3 let obj = { 4 [s]: function (arg) { ... } 5 }; 6 7 obj[s](123);
上面代码中,如果s不放在方括号中,该属性的键名就是字符串s,而不是s所代表的那个Symbol值。
采用增强的对象写法,上面代码的obj对象可以写的更简洁一些。
1 let obj = { 2 [s](arg) { ... } 3 };
Symbol类型还可以用于定义一组常量,保证这组常量的值都是不相同的。
1 const log = {}; 2 3 log.levels = { 4 DEBUG: Symbol('debug'), 5 INFO: Symbol('info'), 6 WARN: Symbol('warn') 7 }; 8 console.log(log.levels.DEBUG, 'debug message'); 9 console.log(log.levels.INFO, 'info message');
下面是另外一个例子
1 const COLOR_RED = Symbol(); 2 const COLOR_GREEN = Symbol(); 3 4 function getComplement(color) { 5 switch (color) { 6 case COLOR_RED: 7 return COLOR_GREEN; 8 case COLOR_GREEN: 9 return COLOR_RED; 10 default: 11 throw new Error('Undefined color'); 12 } 13 }
常量使用Symbol值最大的好处,就是其他任何值都不可能有相同的值了,因此可以保证上面的switch语句会按设计的方式工作。
还有一点需要注意,Symbol值作为属性名时,该属性还是公开属性,不是私有属性。