首先感谢阮一峰老师的翻译!
Symbol
- 概述
- 作为属性名的Symbol
- 实例:消除魔术字符串
- 属性名的遍历
- Symbol.for(),Symbol.keyFor()
- 实例:模块的 Singleton 模式
- 内置的Symbol值
概述
ES5的对象属性名都是字符串,这容易造成属性名的冲突。比如,你使用了一个他人提供的对象,但又想为这个对象添加新的方法(mixin模式),新方法的名字就有可能与现有方法产生冲突。如果有一种机制,保证每个属性的名字都是独一无二的就好了,这样就从根本上防止属性名的冲突。这就是ES6引入Symbol的原因。
ES6引入了一种新的原始数据类型Symbol,表示独一无二的值。它是JavaScript语言的第七种数据类型,前六种是:Undefined、Null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。
Symbol值通过Symbol
函数生成。这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的Symbol类型。凡是属性名属于Symbol类型,就都是独一无二的,可以保证不会与其他属性名产生冲突。
上面代码中,变量s
就是一个独一无二的值。typeof
运算符的结果,表明变量s
是Symbol数据类型,而不是字符串之类的其他类型。注意,Symbol
函数前不能使用new
命令,否则会报错。这是因为生成的Symbol是一个原始类型的值,不是对象。也就是说,由于Symbol值不是对象,所以不能添加属性。基本上,它是一种类似于字符串的数据类型。Symbol
函数可以接受一个字符串作为参数,表示对Symbol实例的描述,主要是为了在控制台显示,或者转为字符串时,比较容易区分。
上面代码中,s1
和s2
是两个Symbol值。如果不加参数,它们在控制台的输出都是Symbol()
,不利于区分。有了参数以后,就等于为它们加上了描述,输出的时候就能够分清,到底是哪一个值。如果 Symbol 的参数是一个对象,就会调用该对象的toString
方法,将其转为字符串,然后才生成一个 Symbol 值。
注意,Symbol
函数的参数只是表示对当前 Symbol 值的描述,因此相同参数的Symbol
函数的返回值是不相等的。
上面代码中,s1
和s2
都是Symbol
函数的返回值,而且参数相同,但是它们是不相等的。
Symbol值不能与其他类型的值进行运算,会报错。
但是,Symbol值可以显式转为字符串。
另外,Symbol值也可以转为布尔值,但是不能转为数值。
作为属性名的Symbol
由于每一个Symbol值都是不相等的,这意味着Symbol值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心改写或覆盖。
上面代码通过方括号结构和Object.defineProperty
,将对象的属性名指定为一个Symbol值。
注意,Symbol值作为对象属性名时,不能用点运算符。
上面代码中,因为点运算符后面总是字符串,所以不会读取mySymbol
作为标识名所指代的那个值,导致a
的属性名实际上是一个字符串,而不是一个Symbol值。
同理,在对象的内部,使用Symbol值定义属性时,Symbol值必须放在方括号之中。
上面代码中,如果s
不放在方括号中,该属性的键名就是字符串s
,而不是s
所代表的那个Symbol值。采用增强的对象写法,上面代码的obj
对象可以写得更简洁一些。
Symbol类型还可以用于定义一组常量,保证这组常量的值都是不相等的。
下面是另外一个例子。
常量使用Symbol值最大的好处,就是其他任何值都不可能有相同的值了,因此可以保证上面的switch
语句会按设计的方式工作。
还有一点需要注意,Symbol值作为属性名时,该属性还是公开属性,不是私有属性。
实例:消除魔术字符串
魔术字符串指的是,在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。风格良好的代码,应该尽量消除魔术字符串,该由含义清晰的变量代替。
上面代码中,字符串“Triangle”就是一个魔术字符串。它多次出现,与代码形成“强耦合”,不利于将来的修改和维护。
常用的消除魔术字符串的方法,就是把它写成一个变量。
上面代码中,我们把“Triangle”写成shapeType
对象的triangle
属性,这样就消除了强耦合。如果仔细分析,可以发现shapeType.triangle
等于哪个值并不重要,只要确保不会跟其他shapeType
属性的值冲突即可。因此,这里就很适合改用Symbol值。
上面代码中,除了将shapeType.triangle
的值设为一个Symbol,其他地方都不用修改。
属性名的遍历
Symbol 作为属性名,该属性不会出现在for...in
、for...of
循环中,也不会被Object.keys()
、Object.getOwnPropertyNames()
、JSON.stringify()
返回。但是,它也不是私有属性,有一个Object.getOwnPropertySymbols
方法,可以获取指定对象的所有 Symbol 属性名。Object.getOwnPropertySymbols
方法返回一个数组,成员是当前对象的所有用作属性名的 Symbol 值。
下面是另一个例子,Object.getOwnPropertySymbols
方法与for...in
循环、Object.getOwnPropertyNames
方法进行对比的例子。
上面代码中,使用Object.getOwnPropertyNames
方法得不到Symbol
属性名,需要使用Object.getOwnPropertySymbols
方法。另一个新的API,Reflect.ownKeys
方法可以返回所有类型的键名,包括常规键名和 Symbol 键名。
由于以 Symbol 值作为名称的属性,不会被常规方法遍历得到。我们可以利用这个特性,为对象定义一些非私有的、但又希望只用于内部的方法。
上面代码中,对象x
的size
属性是一个 Symbol 值,所以Object.keys(x)
、Object.getOwnPropertyNames(x)
都无法获取它。这就造成了一种非私有的内部方法的效果。
Symbol.for(),Symbol.keyFor()
有时,我们希望重新使用同一个Symbol值,Symbol.for
方法可以做到这一点。它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的Symbol值。如果有,就返回这个Symbol值,否则就新建并返回一个以该字符串为名称的Symbol值。
上面代码中,s1
和s2
都是 Symbol 值,但是它们都是同样参数的Symbol.for
方法生成的,所以实际上是同一个值。Symbol.for()
与Symbol()
这两种写法,都会生成新的Symbol。它们的区别是,前者会被登记在全局环境中供搜索,后者不会。Symbol.for()
不会每次调用就返回一个新的 Symbol 类型的值,而是会先检查给定的key
是否已经存在,如果不存在才会新建一个值。比如,如果你调用Symbol.for("cat")
30次,每次都会返回同一个 Symbol 值,但是调用Symbol("cat")
30次,会返回30个不同的Symbol值。
上面代码中,由于Symbol()
写法没有登记机制,所以每次调用都会返回一个不同的值。Symbol.keyFor
方法返回一个已登记的 Symbol 类型值的key
。
上面代码中,变量s2
属于未登记的Symbol值,所以返回undefined
。需要注意的是,Symbol.for
为Symbol值登记的名字,是全局环境的,可以在不同的 iframe 或 service worker 中取到同一个值。
上面代码中,iframe 窗口生成的 Symbol 值,可以在主页面得到。
实例:模块的 Singleton 模式
Singleton模式指的是调用一个类,任何时候返回的都是同一个实例。
对于Node来说,模块文件可以看成是一个类。怎么保证每次执行这个模块文件,返回的都是同一个实例呢?
很容易想到,可以把实例放到顶层对象global
。
然后,加载上面的mod.js
。
上面代码中,变量a
任何时候加载的都是A
的同一个实例。但是,这里有一个问题,全局变量global._foo
是可写的,任何文件都可以修改。
上面的代码,会使得别的脚本加载mod.js
都失真。
为了防止这种情况出现,我们就可以使用Symbol。
上面代码中,可以保证global[FOO_KEY]
不会被无意间覆盖,但还是可以被改写。
如果键名使用Symbol
方法生成,那么外部将无法引用这个值,当然也就无法改写。
上面代码将导致其他脚本都无法引用FOO_KEY
。但这样也有一个问题,就是如果多次执行这个脚本,每次得到的FOO_KEY
都是不一样的。虽然Node会将脚本的执行结果缓存,一般情况下,不会多次执行同一个脚本,但是用户可以手动清除缓存,所以也不是完全可靠。
内置的Symbol值
除了定义自己使用的Symbol值以外,ES6还提供了11个内置的Symbol值,指向语言内部使用的方法。
Symbol.hasInstance
对象的Symbol.hasInstance
属性,指向一个内部方法。当其他对象使用instanceof
运算符,判断是否为该对象的实例时,会调用这个方法。比如,foo instanceof Foo
在语言内部,实际调用的是Foo[Symbol.hasInstance](foo)
。
上面代码中,MyClass
是一个类,new MyClass()
会返回一个实例。该实例的Symbol.hasInstance
方法,会在进行instanceof
运算时自动调用,判断左侧的运算子是否为Array
的实例。
下面是另一个例子。
Symbol.isConcatSpreadable
对象的Symbol.isConcatSpreadable
属性等于一个布尔值,表示该对象使用Array.prototype.concat()
时,是否可以展开。
上面代码说明,数组的默认行为是可以展开。Symbol.isConcatSpreadable
属性等于true
或undefined
,都有这个效果。类似数组的对象也可以展开,但它的Symbol.isConcatSpreadable
属性默认为false
,必须手动打开。
对于一个类来说,Symbol.isConcatSpreadable
属性必须写成实例的属性。
上面代码中,类A1
是可展开的,类A2
是不可展开的,所以使用concat
时有不一样的结果。
Symbol.species
对象的Symbol.species
属性,指向当前对象的构造函数。创造实例时,默认会调用这个方法,即使用这个属性返回的函数当作构造函数,来创造新的实例对象。
上面代码中,子类MyArray
继承了父类Array
。创建MyArray
的实例对象时,本来会调用它自己的构造函数(本例中被省略了),但是由于定义了Symbol.species
属性,所以会使用这个属性返回的的函数,创建MyArray
的实例。这个例子也说明,定义Symbol.species
属性要采用get
读取器。默认的Symbol.species
属性等同于下面的写法。
下面是一个例子。
上面代码中,由于构造函数被替换成了Array
。所以,mapped
对象不是MyArray
的实例,而是Array
的实例。
Symbol.match
对象的Symbol.match
属性,指向一个函数。当执行str.match(myObject)
时,如果该属性存在,会调用它,返回该方法的返回值。
Symbol.replace
对象的Symbol.replace
属性,指向一个方法,当该对象被String.prototype.replace
方法调用时,会返回该方法的返回值。
下面是一个例子。
Symbol.replace
方法会收到两个参数,第一个参数是replace
方法正在作用的对象,上面例子是Hello
,第二个参数是替换后的值,上面例子是World
。
Symbol.search
对象的Symbol.search
属性,指向一个方法,当该对象被String.prototype.search
方法调用时,会返回该方法的返回值。
Symbol.split
对象的Symbol.split
属性,指向一个方法,当该对象被String.prototype.split
方法调用时,会返回该方法的返回值。
下面是一个例子。
上面方法使用Symbol.split
方法,重新定义了字符串对象的split
方法的行为,
Symbol.iterator
对象的Symbol.iterator
属性,指向该对象的默认遍历器方法。
对象进行for...of
循环时,会调用Symbol.iterator
方法,返回该对象的默认遍历器,详细介绍参见《Iterator和for...of循环》一章。
Symbol.toPrimitive
对象的Symbol.toPrimitive
属性,指向一个方法。该对象被转为原始类型的值时,会调用这个方法,返回该对象对应的原始类型值。Symbol.toPrimitive
被调用时,会接受一个字符串参数,表示当前运算的模式,一共有三种模式。
- Number:该场合需要转成数值
- String:该场合需要转成字符串
- Default:该场合可以转成数值,也可以转成字符串
Symbol.toStringTag
对象的Symbol.toStringTag
属性,指向一个方法。在该对象上面调用Object.prototype.toString
方法时,如果这个属性存在,它的返回值会出现在toString
方法返回的字符串之中,表示对象的类型。也就是说,这个属性可以用来定制[object Object]
或[object Array]
中object
后面的那个字符串。
ES6新增内置对象的Symbol.toStringTag
属性值如下。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'
Symbol.unscopables
对象的Symbol.unscopables
属性,指向一个对象。该对象指定了使用with
关键字时,哪些属性会被with
环境排除。
上面代码说明,数组有6个属性,会被with命令排除。