ES6 引入了一种新的原始数据类型 Symbol,表示独一无二的值。它是 JavaScript 语言的第七种数据类型,
前六种是: undefined、 null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。
Symbol 值通过 Symbol函数生成。这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的 Symbol 类型。凡是属性名属于 Symbol 类型,就都是独一无二的,可以保证不会与其他属性名产生冲突。
注意, Symbol函数前不能使用 new命令,否则会报错。这是因为生成的 Symbol 是一个原始类型的值,不是对象。也就是说,由于 Symbol 值不是对象,所以不能添加属性。基本上,它是一种类似于字符串的数据类型。
Symbol函数可以接受一个字符串作为参数,表示对 Symbol 实例的描述,主要是为了在控制台显示,或者转为字符串时,比较容易区分。如果 Symbol 的参数是一个对象,就会调用该对象的 toString方法,将其转为字符串,然后才生成一个 Symbol 值。
let s1 = Symbol('foo');
s1
// Symbol(foo) 'asd' + s1 // 报错
String(s1)
// "Symbol(foo)" s1.toString()
// "Symbol(foo)"
注意, Symbol函数的参数只是表示对当前 Symbol 值的描述,因此相同参数的 Symbol函数的返回值是不相等的。
Symbol 值不能与其他类型的值进行运算,会报错。
但是,Symbol 值可以显式转为字符串。
1、作为属性名的 Symbol
由于每一个 Symbol 值都是不相等的,这意味着 Symbol 值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心改写或覆盖。
let mySymbol = Symbol(); |
注意,Symbol 值作为对象属性名时,不能用点运算符。
2、属性名的遍历
Symbol 作为属性名,该属性不会出现在 for…in、 for…of循环中,也不会被 Object.keys()、 Object.getOwnPropertyNames()、 JSON.stringify()返回。但是,它也不是私有属性,有一个Object.getOwnPropertySymbols方法,可以获取指定对象的所有 Symbol 属性名。
Object.getOwnPropertySymbols方法返回一个数组,成员是当前对象的所有用作属性名的 Symbol 值。
const obj = {}; |
新的 API,Reflect.ownKeys方法可以返回所有类型的键名,包括常规键名和 Symbol 键名。
3、Symbol.for(),Symbol.keyFor()
有时,我们希望重新使用同一个 Symbol 值, Symbol.for方法可以做到这一点。它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的 Symbol 值。如果有,就返回这个 Symbol 值,否则就新建并返回一个以该字符串为名称的 Symbol 值。
let s1 = Symbol.for('foo'); |
Symbol.keyFor方法返回一个已登记的 Symbol 类型值的 key。
let s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"
let s2 = Symbol("foo");
Symbol.keyFor(s2) // undefined
4、内置的 Symbol 值
除了定义自己使用的 Symbol 值以外,ES6 还提供了 11 个内置的 Symbol 值,指向语言内部使用的方法。
- 1、Symbol.hasInstance
对象的 Symbol.hasInstance属性,指向一个内部方法。当其他对象使用 instanceof运算符,判断是否为该对象的实例时,会调用这个方法。比如, foo instanceof Foo在语言内部,实际调用的是 Foo[Symbol.hasInstance]”(foo)”。 - 2、Symbol.isConcatSpreadable
对象的 Symbol.isConcatSpreadable属性等于一个布尔值,表示该对象用于 Array.prototype.concat()时,是否可以展开。
let arr1 = ['c', 'd']; |
- 3、Symbol.species
对象的 Symbol.species属性,指向一个构造函数。创建衍生对象时,会使用该属性。 - 4、Symbol.match
对象的 Symbol.match属性,指向一个函数。当执行 str.match(myObject)时,如果该属性存在,会调用它,返回该方法的返回值。String.prototype.match(regexp)
// 等同于
regexp[Symbol.match](this) - 5、Symbol.replace
对象的 Symbol.replace属性,指向一个方法,当该对象被 String.prototype.replace方法调用时,会返回该方法的返回值。 - 6、Symbol.search
对象的 Symbol.search属性,指向一个方法,当该对象被 String.prototype.search方法调用时,会返回该方法的返回值。 - 7、Symbol.split
对象的 Symbol.split属性,指向一个方法,当该对象被 String.prototype.split方法调用时,会返回该方法的返回值。 - 8、Symbol.iterator
对象的 Symbol.iterator属性,指向该对象的默认遍历器方法。 - 9、Symbol.toPrimitive
对象的 Symbol.toPrimitive属性,指向一个方法。该对象被转为原始类型的值时,会调用这个方法,返回该对象对应的原始类型值。
Symbol.toPrimitive被调用时,会接受一个字符串参数,表示当前运算的模式,一共有三种模式。- Number:该场合需要转成数值
- String:该场合需要转成字符串
- Default:该场合可以转成数值,也可以转成字符串
let obj = {
[Symbol.toPrimitive](hint) {
switch (hint) {
case 'number':
return 123;
case 'string':
return 'str';
case 'default':
return 'default';
default:
throw new Error();
}
}
};
2 * obj // 246
3 + obj // '3default'
obj == 'default' // true
String(obj) // 'str'
- 10、Symbol.toStringTag
对象的 Symbol.toStringTag属性,指向一个方法。在该对象上面调用 Object.prototype.toString方法时,如果这个属性存在,它的返回值会出现在 toString方法返回的字符串之中,表示对象的类型。也就是说,这个属性可以用来定制 [object Object]或 [object Array]中 object后面的那个字符串。ES6 新增内置对象的 Symbol.toStringTag属性值如下。// 例一
({[Symbol.toStringTag]: 'Foo'}.toString())
// "[object Foo]"
// 例二
class Collection {
get [Symbol.toStringTag]() {
return 'xxx';
}
}
let x = new Collection();
Object.prototype.toString.call(x) // "[object xxx]"
- JSON[Symbol.toStringTag]:’JSON’
- Math[Symbol.toStringTag]:’Math’
- Module 对象 M[Symbol.toStringTag]:’Module’
- ArrayBuffer.prototype[Symbol.toStringTag]:’ArrayBuffer’
- DataView.prototype[Symbol.toStringTag]:’DataView’
- Map.prototype[Symbol.toStringTag]:’Map’
- Promise.prototype[Symbol.toStringTag]:’Promise’
- Set.prototype[Symbol.toStringTag]:’Set’
- %TypedArray%.prototype[Symbol.toStringTag]:’Uint8Array’等
- WeakMap.prototype[Symbol.toStringTag]:’WeakMap’
- WeakSet.prototype[Symbol.toStringTag]:’WeakSet’
- %MapIteratorPrototype%[Symbol.toStringTag]:’Map Iterator’
- %SetIteratorPrototype%[Symbol.toStringTag]:’Set Iterator’
- %StringIteratorPrototype%[Symbol.toStringTag]:’String Iterator’
- Symbol.prototype[Symbol.toStringTag]:’Symbol’
- Generator.prototype[Symbol.toStringTag]:’Generator’
- GeneratorFunction.prototype[Symbol.toStringTag]:’GeneratorFunction’
11、Symbol.unscopables
对象的 Symbol.unscopables属性,指向一个对象。该对象指定了使用 with关键字时,哪些属性会被 with环境排除。上面代码说明,数组有 7 个属性,会被 with命令排除。Array.prototype[Symbol.unscopables]
// {
// copyWithin: true,
// entries: true,
// fill: true,
// find: true,
// findIndex: true,
// includes: true,
// keys: true
// }
Object.keys(Array.prototype[Symbol.unscopables])
// ['copyWithin', 'entries', 'fill', 'find', 'findIndex', 'includes', 'keys']上面代码通过指定 Symbol.unscopables属性,使得 with语法块不会在当前作用域寻找 foo属性,即 foo将指向外层作用域的变量。// 没有 unscopables 时
class MyClass {
foo() { return 1; }
}
var foo = function () { return 2; };
with (MyClass.prototype) {
foo(); // 1
}
// 有 unscopables 时
class MyClass {
foo() { return 1; }
get [Symbol.unscopables]() {
return { foo: true };
}
}
var foo = function () { return 2; };
with (MyClass.prototype) {
foo(); // 2
}