Symbol介绍
一、 概述
原因
ES5 的对象属性名都是字符串,这容易造成属性名的冲突。就如为别人提供的对象添加新的方法时,方法名就有可能与现有方法名冲突。这时引入Symbol,使每个属性名都是独一无二的,从根本上防止属性名的冲突。
概念
它是 JavaScript 语言的第七种数据类型,表示独一无二的值。前六种是:undefined、null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。
生成方式
(注意:Symbol函数前不能使用new命令,否则会报错。由于 Symbol 值不是对象,所以不能添加属性。)
let s = Symbol();
接收参数
字符串:
let s1 = Symbol('foo');
let s2 = Symbol('bar');
s1 // Symbol(foo)
s2 // Symbol(bar)
s1.toString() // "Symbol(foo)"
s2.toString() // "Symbol(bar)"
对象:
先调用该对象的toString方法,将其转为字符串,然后才生成一个 Symbol 值。
const obj = {
toString() {
return 'abc';
}
};
const sym = Symbol(obj);
sym // Symbol(abc)
(注意:Symbol函数的参数只是表示对当前 Symbol 值的描述,因此相同参数的Symbol函数的返回值是不相等的。)
值运算
let sym = Symbol('My symbol');
Symbol 值不能与其他类型的值进行运算,会报错。
"your symbol is " + sym
Symbol 值可以显式转为字符串。
String(sym) // 'Symbol(My symbol)'
sym.toString() // 'Symbol(My symbol)'
Symbol 值也可以转为布尔值,但是不能转为数值。
Boolean(sym) // true
二、作为属性名的Symbol
Symbol 值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性。
// 第一种写法
let a = {};
a[mySymbol] = 'Hello!';
// 第二种写法
let a = {
[mySymbol]: 'Hello!'
};
// 第三种写法
let a = {};
Object.defineProperty(a, mySymbol, { value: 'Hello!' });
// 以上写法都得到同样结果
a[mySymbol] // "Hello!"
(注意:Symbol 值作为对象属性名时,不能用点运算符,因为点运算符后面总是字符串。Symbol 值作为属性名时,该属性还是公开属性,不是私有属性。)
三、属性名的遍历
Symbol 作为属性名,该属性不会出现在for…in、for…of循环中,也不会被Object.keys()
、Object.getOwnPropertyNames()
、JSON.stringify()
返回。但是,它也不是私有属性,有一个Object.getOwnPropertySymbols
方法,可以获取指定对象的所有 Symbol 属性名。
Object.getOwnPropertySymbols
方法返回一个数组,成员是当前对象的所有用作属性名的 Symbol 值。
Reflect.ownKeys
方法可以返回所有类型的键名,包括常规键名和 Symbol 键名。
四、Symbol.for(),Symbol.keyFor()
有时,我们希望重新使用同一个 Symbol 值,Symbol.for
方法可以做到这一点。它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的 Symbol 值。如果有,就返回这个 Symbol 值,否则就新建并返回一个以该字符串为名称的 Symbol 值。
Symbol.for()
:返回一个已登记的 Symbol 类型值的key。会生成新的 Symbol,并且被登记在全局环境中供搜索,登记的名字,是全局环境的。不会每次调用就返回一个新的 Symbol 类型的值,而是会先检查给定的key是否已经存在,如果不存在才会新建一个值。
let s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"
let s2 = Symbol("foo");
Symbol.keyFor(s2) // undefined
Symbol()
:不会被登记在全局环境中供搜索,既每次调用会返回不同的 Symbol 值
五、内置Symbol值
Symbol.hasInstance
对象的Symbol.hasInstance
属性,指向一个内部方法。当其他对象使用instanceof
运算符,判断是否为该对象的实例时,会调用这个方法。
Symbol.isConcatSpreadable
对象的Symbol.isConcatSpreadable
属性等于一个布尔值,表示该对象用于Array.prototype.concat()
时,是否可以展开。
数组的默认行为是可以展开,Symbol.isConcatSpreadable
默认等于undefined。该属性等于true时,也有展开的效果。
Symbol.species
对象的Symbol.species
属性,指向一个构造函数。创建衍生对象时,会使用该属性。
Symbol.species
的作用在于,实例对象在运行过程中,需要再次调用自身的构造函数时,会调用该属性指定的构造函数。它主要的用途是,有些类库是在基类的基础上修改的,那么子类使用继承的方法时,作者可能希望返回基类的实例,而不是子类的实例。
Symbol.match
对象的Symbol.matc
h属性,指向一个函数。当执行str.match(myObject)
时,如果该属性存在,会调用它,返回该方法的返回值。
Symbol.replace
对象的Symbol.replace
属性,指向一个方法,当该对象被String.prototype.replace
方法调用时,会返回该方法的返回值。
Symbol.replace
方法会收到两个参数,第一个参数是replace方法正在作用的对象,第二个参数是替换后的值。
Symbol.search
对象的Symbol.search属性,指向一个方法,当该对象被String.prototype.search
方法调用时,会返回该方法的返回值。用于在字符串中定位子串
Symbol.split
对象的Symbol.split属性,指向一个方法,当该对象被String.prototype.split方法调用时,会返回该方法的返回值。用于分割字符串
Symbol.iterator
对象的Symbol.iterator属性,指向该对象的默认遍历器方法。
Symbol.toPrimitive
对象的Symbol.toPrimitive属性,指向一个方法。该对象被转为原始类型的值时,会调用这个方法,返回该对象对应的原始类型值。
Symbol.toPrimitive被调用时,会接受一个字符串参数,表示当前运算的模式,一共有三种模式。
- Number:该场合需要转成数值
- String:该场合需要转成字符串
- Default:该场合可以转成数值,也可以转成字符串
Symbol.toStringTag
对象的Symbol.toStringTag
属性,指向一个方法。在该对象上面调用Object.prototype.toString
方法时,如果这个属性存在,它的返回值会出现在toString方法返回的字符串之中,表示对象的类型。也就是说,这个属性可以用来定制[object Object]
或[object Array]
中object后面的那个字符串。
Symbol.unscopables
对象的Symbol.unscopables属性,指向一个对象。该对象指定了使用with关键字时,哪些属性会被with环境排除。