目录
- 一、定义
-
- [1.1 参数](#1.1 参数)
- [1.2 不能直接运算](#1.2 不能直接运算)
- [1.3 转为布尔值](#1.3 转为布尔值)
- [1.4 转为字符串](#1.4 转为字符串)
- 二、作为属性名的Symbol
-
- [2.1 不能使用点运算符](#2.1 不能使用点运算符)
- [2.2 对象属性,放在方括号之中](#2.2 对象属性,放在方括号之中)
- [2.3 定义常量](#2.3 定义常量)
- 三、属性名的遍历
-
- [3.1 Object.getOwnPropertySymbols](#3.1 Object.getOwnPropertySymbols)
- [3.2 对比案例](#3.2 对比案例)
- [3.3 Reflect.ownKeys](#3.3 Reflect.ownKeys)
- 四、Symbol.for(),Symbol.keyFor()
-
- [4.1 Symbol.for()](#4.1 Symbol.for())
- [4.2 Symbol.for()与Symbol()区别](#4.2 Symbol.for()与Symbol()区别)
- [4.3 Symbol.keyFor()](#4.3 Symbol.keyFor())
- [五、模块的 Singleton 模式](#五、模块的 Singleton 模式)
-
- [5.1 处理方法一](#5.1 处理方法一)
- [5.2 处理方法二](#5.2 处理方法二)
- 六、内置的Symbol值
-
- [6.1 Symbol.hasInstance](#6.1 Symbol.hasInstance)
- [6.2 Symbol.isConcatSpreadable](#6.2 Symbol.isConcatSpreadable)
-
- [6.2.1 数组](#6.2.1 数组)
- [6.2.2 类数组](#6.2.2 类数组)
- [6.2.3 类](#6.2.3 类)
- [6.3 Symbol.species](#6.3 Symbol.species)
- [6.4 Symbol.match](#6.4 Symbol.match)
- [6.5 Symbol.replace](#6.5 Symbol.replace)
- [6.6 Symbol.search](#6.6 Symbol.search)
- [6.7 Symbol.split](#6.7 Symbol.split)
- [6.8 Symbol.iterator](#6.8 Symbol.iterator)
- [6.9 Symbol.toPrimitive](#6.9 Symbol.toPrimitive)
- [6.10 Symbol.toStringTag](#6.10 Symbol.toStringTag)
- [6.11 Symbol.unscopables](#6.11 Symbol.unscopables)
ES5
的对象属性名都是字符串,这容易造成属性名的冲突 。比如,你使用了一个他人提供的对象,但又想为这个对象添加新的方法(mixin
模式),新方法的名字就有可能与现有方法产生冲突。如果有一种机制,保证每个属性的名字都是独一无二的就好了,这样就从根本上防止属性名的冲突。这就是ES6
引入Symbol
的原因。
ES6
引入了一种新的原始数据类型Symbol
,表示独一无二的值。它是JavaScript
语言的第七
种数据类型,前六种是:Undefined
、Null
、布尔值(Boolean
)、字符串(String
)、数值(Number
)、对象(Object
)。
这就是说,对象的属性名现在可以有两种类型 ,一种是原来就有的字符串,另一种就是新增的Symbol
类型。凡是属性名属于Symbol
类型,就都是独一无二的,可以保证不会与其他属性名产生冲突。
一、定义
Symbol
值通过Symbol
函数生成。Symbol
函数前不能使用new
命令,否则会报错。这是因为生成的Symbol
是一个原始类型的值,不是对象。也就是说,由于Symbol
值不是对象,所以不能添加属性。基本上,它是一种类似于字符串的数据类型。
javascript
let s = Symbol("hh");
typeof s
// "symbol"
1.1 参数
Symbol
函数可以接受一个字符串作为参数,表示对Symbol
实例的描述,主要是为了在控制台显示,或者转为字符串时,比较容易区分。
javascript
var s1 = Symbol('foo');
var s2 = Symbol('bar');
s1 // Symbol(foo)
s2 // Symbol(bar)
s1.toString() // "Symbol(foo)"
s2.toString() // "Symbol(bar)"
Symbol
函数的参数只是表示对当前Symbol
值的描述,因此相同参数的Symbol
函数的返回值是不相等的。
javascript
// 没有参数的情况
var s1 = Symbol();
var s2 = Symbol();
s1 === s2 // false
// 有参数的情况
var s1 = Symbol("foo");
var s2 = Symbol("foo");
s1 === s2 // false
1.2 不能直接运算
Symbol
值不能与其他类型的值进行运算,会报错。
javascript
var sym = Symbol('My symbol');
"your symbol is " + sym
// TypeError: can't convert symbol to string
`your symbol is ${sym}`
// TypeError: can't convert symbol to string
1.3 转为布尔值
Symbol值也可以转为布尔值,但是不能转为数值。
javascript
var sym = Symbol();
Boolean(sym) // true
!sym // false
if (sym) {
// ...
}
Number(sym) // TypeError
sym + 2 // TypeError
1.4 转为字符串
Symbol
值可以显式转为字符串。
javascript
var sym = Symbol('My symbol');
String(sym) // 'Symbol(My symbol)'
sym.toString() // 'Symbol(My symbol)'
二、作为属性名的Symbol
由于每一个Symbol
值都是不相等的,这意味着Symbol
值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心改写或覆盖。
下面代码通过方括号
结构和Object.defineProperty
,将对象的属性名指定为一个Symbol
值。
javascript
var mySymbol = Symbol();
// 第一种写法
var a = {};
a[mySymbol] = 'Hello!';
// 第二种写法
var a = {
[mySymbol]: 'Hello!'
};
// 第三种写法
var a = {};
Object.defineProperty(a, mySymbol, { value: 'Hello!' });
// 以上写法都得到同样结果
a[mySymbol] // "Hello!"
2.1 不能使用点运算符
Symbol
值作为对象属性名时,不能用点运算符
。因为点运算符后面总是字符串,所以不会读取Symbol
作为标识名所指代的那个值。
javascript
var mySymbol = Symbol();
var a = {};
a.mySymbol = 'Hello!';
a[mySymbol] // undefined
a['mySymbol'] // "Hello!"
2.2 对象属性,放在方括号之中
在对象的内部,使用Symbol
值定义属性时,Symbol
值必须放在方括号之中。
javascript
let s = Symbol();
let obj = {
[s]: function (arg) { ... }
};
obj[s](123);
2.3 定义常量
Symbol
类型还可以用于定义一组常量,保证这组常量的值都是不相等的。
javascript
const COLOR_RED = Symbol();
const COLOR_GREEN = Symbol();
function getComplement(color) {
switch (color) {
case COLOR_RED:
return COLOR_GREEN;
case COLOR_GREEN:
return COLOR_RED;
default:
throw new Error('Undefined color');
}
}
常量使用Symbol
值最大的好处,就是其他任何值都不可能有相同的值了,因此可以保证上面的switch
语句会按设计的方式工作。
还有一点需要注意,Symbol
值作为属性名时,该属性还是公开属性,不是私有属性。
三、属性名的遍历
Symbol
作为属性名,该属性不会出现在for...in、for...of
循环中,也不会被Object.keys()、Object.getOwnPropertyNames()
返回。但是,它也不是私有属性,有一个Object.getOwnPropertySymbols
方法,可以获取指定对象的所有Symbol
属性名。
3.1 Object.getOwnPropertySymbols
Object.getOwnPropertySymbols
方法返回一个数组,成员是当前对象的所有用作属性名的Symbol
值。
javascript
var obj = {};
var a = Symbol('a');
var b = Symbol('b');
obj[a] = 'Hello';
obj[b] = 'World';
var objectSymbols = Object.getOwnPropertySymbols(obj);
objectSymbols
// [Symbol(a), Symbol(b)]
3.2 对比案例
Object.getOwnPropertySymbols
方法与for...in
循环、Object.getOwnPropertyNames
方法进行对比的例子。
javascript
var obj = {};
var foo = Symbol("foo");
Object.defineProperty(obj, foo, {
value: "foobar",
});
for (var i in obj) {
console.log(i); // 无输出
}
Object.getOwnPropertyNames(obj)
// []
Object.getOwnPropertySymbols(obj)
// [Symbol(foo)]
3.3 Reflect.ownKeys
Reflect.ownKeys
方法可以返回所有类型的键名,包括常规键名和Symbol
键名。
javascript
let obj = {
[Symbol('my_key')]: 1,
enum: 2,
nonEnum: 3
};
Reflect.ownKeys(obj)
// [Symbol(my_key), 'enum', 'nonEnum']
四、Symbol.for(),Symbol.keyFor()
4.1 Symbol.for()
有时,我们希望重新使用同一个Symbol
值,Symbol.for
方法可以做到这一点。它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的Symbol
值。如果有,就返回这个Symbol
值,否则就新建并返回一个以该字符串为名称的Symbol
值。
javascript
var s1 = Symbol.for('foo');
var s2 = Symbol.for('foo');
s1 === s2 // true
4.2 Symbol.for()与Symbol()区别
Symbol.for()
与Symbol()
这两种写法,都会生成新的Symbol
。它们的区别是,前者会被登记在全局环境中供搜索,后者不会。Symbol.for()
不会每次调用就返回一个新的Symbol
类型的值,而是会先检查给定的key
是否已经存在,如果不存在才会新建一个值。
比如,如果你调用Symbol.for("cat")
30次,每次都会返回同一个Symbol值
,但是调用Symbol("cat")
30次,会返回30
个不同的Symbol
值。
javascript
Symbol.for("bar") === Symbol.for("bar")
// true
Symbol("bar") === Symbol("bar")
// false
由于Symbol()
写法没有登记机制,所以每次调用都会返回一个不同的值.
4.3 Symbol.keyFor()
Symbol.keyFor
方法返回一个已登记的Symbol
类型值的key
。下面代码中,变量s2
属于未登记的Symbol
值,所以返回undefined
。
javascript
var s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"
var s2 = Symbol("foo");
Symbol.keyFor(s2) // undefined
Symbol.for
为Symbol
值登记的名字,是全局环境的,可以在不同的iframe
或service worker
中取到同一个值。
javascript
iframe = document.createElement('iframe');
iframe.src = String(window.location);
document.body.appendChild(iframe);
iframe.contentWindow.Symbol.for('foo') === Symbol.for('foo')
// true
上面代码中,iframe
窗口生成的Symbol
值,可以在主页面得到。
五、模块的 Singleton 模式
Singleton模式
指的是调用一个类,任何时候返回的都是同一个实例。
对于Node
来说,模块文件可以看成是一个类。怎么保证每次执行这个模块文件,返回的都是同一个实例呢?
很容易想到,可以把实例放到顶层对象global
。
javascript
// mod.js
function A() {
this.foo = 'hello';
}
if (!global._foo) {
global._foo = new A();
}
module.exports = global._foo;
javascript
var a = require('./mod.js');
console.log(a.foo);
上面代码中,变量a
任何时候加载的都是A
的同一个实例。
但是,这里有一个问题,全局变量global._foo
是可写的,任何文件都可以修改。为了防止这种情况出现,我们就可以使用Symbol
。
5.1 处理方法一
javascript
// mod.js
const FOO_KEY = Symbol.for('foo');
function A() {
this.foo = 'hello';
}
if (!global[FOO_KEY]) {
global[FOO_KEY] = new A();
}
module.exports = global[FOO_KEY];
上面代码中,可以保证global[FOO_KEY]
不会被无意间覆盖,但还是可以被改写。
javascript
global[Symbol.for('foo')] = { foo: 'world' };
const a = require('./mod.js');
5.2 处理方法二
如果键名使用Symbol
方法生成,那么外部将无法引用这个值,当然也就无法改写。
javascript
// mod.js
const FOO_KEY = Symbol('foo');
function A() {
this.foo = 'hello';
}
if (!global[FOO_KEY]) {
global[FOO_KEY] = new A();
}
module.exports = global[FOO_KEY];
上面代码将导致其他脚本都无法引用FOO_KEY 。但这样也有一个问题,就是如果多次执行这个脚本,每次得到的FOO_KEY
都是不一样的。虽然 Node
会将脚本的执行结果缓存,一般情况下,不会多次执行同一个脚本,但是用户可以手动清除缓存,所以也不是绝对可靠。
六、内置的Symbol值
除了定义自己使用的Symbol
值以外,ES6
还提供了11
个内置的Symbol
值,指向语言内部使用的方法。
6.1 Symbol.hasInstance
对象的Symbol.hasInstance
属性,指向一个内部方法。当其他对象使用instanceof
运算符,判断是否为该对象的实例时,会调用这个方法。
javascript
class MyClass {
[Symbol.hasInstance](foo) {
return foo instanceof Array;
}
}
[1, 2, 3] instanceof new MyClass() // true
6.2 Symbol.isConcatSpreadable
对象的Symbol.isConcatSpreadable
属性等于一个布尔值,表示该对象使用Array.prototype.concat()
时,是否可以展开。
6.2.1 数组
数组的默认行为是可以展开。Symbol.isConcatSpreadable
默认等于undefined
。该属性等于true
时,也有展开的效果。
javascript
let arr1 = ['c', 'd'];
['a', 'b'].concat(arr1, 'e') // ['a', 'b', 'c', 'd', 'e']
arr1[Symbol.isConcatSpreadable] // undefined
let arr2 = ['c', 'd'];
arr2[Symbol.isConcatSpreadable] = false;
['a', 'b'].concat(arr2, 'e') // ['a', 'b', ['c','d'], 'e']
6.2.2 类数组
类数组的对象正好相反,默认不展开。它的Symbol.isConcatSpreadable
属性true
,才可以展开。
javascript
let obj = {length: 2, 0: 'c', 1: 'd'};
['a', 'b'].concat(obj, 'e') // ['a', 'b', obj, 'e']
obj[Symbol.isConcatSpreadable] = true;
['a', 'b'].concat(obj, 'e') // ['a', 'b', 'c', 'd', 'e']
6.2.3 类
Symbol.isConcatSpreadable
属性也可以定义在类里面。
javascript
class A1 extends Array {
constructor(args) {
super(args);
this[Symbol.isConcatSpreadable] = true;
}
}
class A2 extends Array {
constructor(args) {
super(args);
this[Symbol.isConcatSpreadable] = false;
}
}
let a1 = new A1();
a1[0] = 3;
a1[1] = 4;
let a2 = new A2();
a2[0] = 5;
a2[1] = 6;
[1, 2].concat(a1).concat(a2)
// [1, 2, 3, 4, [5, 6]]
6.3 Symbol.species
对象的Symbol.species
属性,指向一个方法。该对象作为构造函数创造实例时,会调用这个方法。即如果this.constructor[Symbol.species]
存在,就会使用这个属性作为构造函数,来创造新的实例对象。
Symbol.species
属性默认的读取器如下。
javascript
static get [Symbol.species]() {
return this;
}
6.4 Symbol.match
对象的Symbol.match
属性,指向一个函数。当执行str.match(myObject)
时,如果该属性存在,会调用它,返回该方法的返回值。
javascript
String.prototype.match(regexp)
// 等同于
regexp[Symbol.match](this)
class MyMatcher {
[Symbol.match](string) {
return 'hello world'.indexOf(string);
}
}
'e'.match(new MyMatcher()) // 1
6.5 Symbol.replace
对象的Symbol.replace
属性,指向一个方法,当该对象被String.prototype.replace
方法调用时,会返回该方法的返回值。
javascript
String.prototype.replace(searchValue, replaceValue)
// 等同于
searchValue[Symbol.replace](this, replaceValue)
6.6 Symbol.search
对象的Symbol.search
属性,指向一个方法,当该对象被String.prototype.search
方法调用时,会返回该方法的返回值。
javascript
String.prototype.search(regexp)
// 等同于
regexp[Symbol.search](this)
class MySearch {
constructor(value) {
this.value = value;
}
[Symbol.search](string) {
return string.indexOf(this.value);
}
}
'foobar'.search(new MySearch('foo')) // 0
6.7 Symbol.split
对象的Symbol.split
属性,指向一个方法,当该对象被String.prototype.split
方法调用时,会返回该方法的返回值。
javascript
String.prototype.split(separator, limit)
// 等同于
separator[Symbol.split](this, limit)
console.log(String.prototype.split.call("gg,dd",","));
class MySearch {
constructor(value) {
this.value = value;
}
[Symbol.split](string) {
return "oo"
}
}
console.log('foobar'.split(new MySearch('foo'))) // 00
6.8 Symbol.iterator
对象的Symbol.iterator
属性,指向该对象的默认遍历器方法。
javascript
var myIterable = {};
myIterable[Symbol.iterator] = function* () {
yield 1;
yield 2;
yield 3;
};
[...myIterable] // [1, 2, 3]
对象进行for...of
循环时,会调用Symbol.iterator
方法,返回该对象的默认遍历器.
javascript
class Collection {
*[Symbol.iterator]() {
let i = 0;
while(this[i] !== undefined) {
yield this[i];
++i;
}
}
}
let myCollection = new Collection();
myCollection[0] = 1;
myCollection[1] = 2;
for(let value of myCollection) {
console.log(value);
}
// 1
// 2
6.9 Symbol.toPrimitive
对象的Symbol.toPrimitive
属性,指向一个方法。该对象被转为原始类型的值时,会调用这个方法,返回该对象对应的原始类型值。
Symbol.toPrimitive
被调用时,会接受一个字符串参数,表示当前运算的模式,一共有三种模式。
- Number:该场合需要转成数值
- String:该场合需要转成字符串
- Default:该场合可以转成数值,也可以转成字符串
javascript
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'
6.10 Symbol.toStringTag
对象的Symbol.toStringTag
属性,指向一个方法。在该对象上面调用Object.prototype.toString
方法时,如果这个属性存在,它的返回值会出现在toString
方法返回的字符串之中,表示对象的类型。也就是说,这个属性可以用来定制[object Object]
或[object Array]
中object
后面的那个字符串。
javascript
({[Symbol.toStringTag]: 'Foo'}.toString())
// "[object Foo]"
class Collection {
get [Symbol.toStringTag]() {
return 'xxx';
}
}
var x = new Collection();
Object.prototype.toString.call(x) // "[object xxx]"
ES6
新增内置对象的Symbol.toStringTag
属性值如下。
javascript
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'
6.11 Symbol.unscopables
对象的Symbol.unscopables
属性,指向一个对象。该对象指定了使用with
关键字时,哪些属性会被with
环境排除。
javascript
Array.prototype[Symbol.unscopables]
// {
// copyWithin: true,
// entries: true,
// fill: true,
// find: true,
// findIndex: true,
// keys: true
// }
Object.keys(Array.prototype[Symbol.unscopables])
// ['copyWithin', 'entries', 'fill', 'find', 'findIndex', 'keys']
上面代码说明,数组有6个属性,会被with
命令排除。
javascript
// 没有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
}