-
概述
ES5的对象属性名都是字符串,这容易造成属性名的冲突。
ES6引入了一种新的原始数据类型Symbol,表示独一无二的值。
它是JavaScript语言的第七种数据类型,前六种是:Undefined、Null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。
Symbol值通过Symbol函数生成。这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的Symbol类型。
凡是属性名属于Symbol类型,就都是独一无二的,可以保证不会与其他属性名产生冲突。
let s = Symbol();
console.log(typeof s) // symbol
上面代码中,变量s就是一个独一无二的值。typeof运算符的结果,表明变量s是Symbol数据类型,而不是字符串之类的其他类型。
Symbol函数可以接受一个字符串作为参数,表示对Symbol实例的描述。这主要是为了在控制台显示或者转为字符串时,比较容易区分。
var s1 = Symbol('foo');
var s2 = Symbol('bar');
console.log(s1,s2) // Symbol(foo) Symbol(bar) 如果不加参数,输出都是Symbol,不能区分
每个Symbol类型都是独一无二的值,体现在下面这段代码中:
var a= Symbol("aaa");
var b= Symbol("aaa");
a===b // false a和b是不相等的
Symbol值不能与其他类型的值进行运算,会报错。但是,Symbol值可以显式转为字符串。
var sym = Symbol('a symbol');
//两种方法都可以转为字符串
String(sym) // 'Symbol(a symbol)'
sym.toString() // 'Symbol(a symbol)'
-
作为属性名的Symbol
由于每一个Symbol值都是不相等的,这意味着Symbol值可以作为标识符用于对象的属性名,这就能保证不会出现同名的属性。
推荐两种写法:
var name= Symbol();
// 第一种写法
var student= {};
student[name] = 'jack!'; // Symbol值name作为student的属性
// 第二种写法
var student= {
[name]: 'jack!' //注意要使用方括号包裹,不放在方括号中,该属性的键名就是字符串
};
注意,Symbol值作为对象属性名时,不能用点运算符,要使用方括号。
因为点运算符后面总是字符串,所以不会读取name作为标识名所指代的那个值,导致student的属性name名实际上是一个字符串,而不是一个Symbol值。如以下代码就不是Symbol值作为属性。
student.name= 'jack';
取值对象的Symbol类型的属性也要用方括号。普通属性是直接用点运算符。
-
Symbol类型定义常量
Symbol类型还可以用于定义一组常量,保证这组常量的值都是不相等的。
levels = {
DEBUG: Symbol('debug'),
INFO: Symbol('info'),
WARN: Symbol('warn')
};
console.log(levels.DEBUG) // Symbol(debug)
console.log(levels.INFO) // Symbol(info)
console.log(levels.WARN) // Symbol(warn)
常量使用Symbol值最大的好处,就是其他任何值都不可能有相同的值了。
-
属性名的遍历
Symbol 作为属性名,该属性不会出现在for...in、for...of循环中,也不会被Object.keys()、JSON.stringify()等返回。
ES6中有一个Object.getOwnPropertySymbols方法,可以获取指定对象的所有 Symbol 属性名,返回的是一个数组。
var obj = {};
var name = Symbol('name');
var age = Symbol('age');
obj[name] = 'huang';
obj[age] = '23';
var objectSymbols = Object.getOwnPropertySymbols(obj); // 是个数组,可以用for循环遍历
console.log(objectSymbols) // [ Symbol(name), Symbol(age) ]
console.log(obj[name]) // huang 取出Symbol类型的属性要用方括号
// 遍历数组里的属性
for(var i in objectSymbols){
console.log(objectSymbols[i])
}
另一个新的API,Reflect.ownKeys方法可以返回对象的属性所有类型的键名,包括常规键名和 Symbol 键名。
语法 Reflect.ownKeys(对象名)
var name = Symbol('name');
var age = Symbol('age');
var obj = {
[name] : 'huang', // Symbol类型属性
[age] : '23', // Symbol类型属性
num : 1 // 普通属性
};
console.log( Reflect.ownKeys(obj) ) // [ 'num', Symbol(name), Symbol(age) ] 返回值是数组
Symbol.for(),Symbol.keyFor()
Symbol.for方法可以重新使用同一个Symbol值。
它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的Symbol值。如果有,就返回这个Symbol值,否则就新建并返回一个以该字符串为名称的Symbol值。
var n1 = Symbol.for('foo');
var n2 = Symbol.for('foo');
console.log( n1 === n2 ) // true n1 n2 实际上是同一个值
注意:Symbol.for方法和Symbol是不一样的,Symbol每次都是创建一个新的,Symbol.for只有不存在时才创建新的。
Symbol.for()
与Symbol()
这两种写法,都会生成新的 Symbol。它们的区别是,前者会被登记在全局环境中供搜索,后者不会。Symbol.for()
不会每次调用就返回一个新的 Symbol 类型的值,而是会先检查给定的key
是否已经存在,如果不存在才会新建一个值。比如,如果你调用Symbol.for("cat")
30 次,每次都会返回同一个 Symbol 值,但是调用Symbol("cat")
30 次,会返回 30 个不同的 Symbol 值。
Symbol.for("foo") === Symbol.for("foo") // true
Symbol("foo") === Symbol("foo") // false
Symbol.for为Symbol值登记的名字,是全局环境的。Symbol.keyFor方法返回一个已登记的 Symbol 类型值的key。
var s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo" 使用Symbol.for有登记名字
var s2 = Symbol("foo");
Symbol.keyFor(s2) // undefined 使用Symbol未登记名字
单例中使用Symbol
单例(Singleton)指的是调用一个类,任何时候返回的都是同一个实例。
const FOO_KEY = Symbol.for('foo'); // 使FOO_KEY变成Symbol类型
function A() {
this.foo = 'hello';
}
if (!global[FOO_KEY]) { // 如果不存这个实例创建新的,存在就跳过
global[FOO_KEY] = new A(); // 创建一个新的实例,把实例放到顶层对象global
}
module.exports = global[FOO_KEY]; // 暴露这个实例,可以被其他文件引用
上面代码中,可以保证global[FOO_KEY]不会被无意间覆盖,因为Symbol.for方法只有在不存在的情况下才创建新的。
要改写global[FOO_KEY]的值的方法如下:
global[Symbol.for('foo')] = 123;