1
0
mirror of https://github.com/ruanyf/es6tutorial.git synced 2025-05-24 18:32:22 +00:00

Symbol列为单独的章节

This commit is contained in:
ruanyf 2015-08-07 07:39:40 +08:00
parent be427eb47f
commit 4960a1808f
6 changed files with 497 additions and 406 deletions

View File

@ -298,14 +298,35 @@ let arr = ['b', 'c'];
let arr = [...iterable]; let arr = [...iterable];
``` ```
**3其他场合** **3yield* **
以下场合也会用到默认的iterator接口可以查阅相关章节。 yield*后面跟的是一个可遍历的结构,它会调用该结构的遍历器接口。
```javascript
let generator = function* () {
yield 1;
yield* [2,3,4]; //use an iterable, is looped, and added as yields
yield 5;
};
var iterator = generator();
iterator.next() // { value: 1, done: false }
iterator.next() // { value: 2, done: false }
iterator.next() // { value: 3, done: false }
iterator.next() // { value: 4, done: false }
iterator.next() // { value: 5, done: false }
iterator.next() // { value: undefined, done: true }
```
**4其他场合**
由于数组的遍历会调用遍历器接口,所以任何接受数组作为参数的场合,其实都调用了遍历器接口。下面是一些例子。
- yield*
- Array.from() - Array.from()
- Map(), Set(), WeakMap(), WeakSet() - Map(), Set(), WeakMap(), WeakSet()(比如`new Map([['a',1],['b',2]])`
- Promise.all(), Promise.race() - Promise.all()
- Promise.race()
## 原生具备Iterator接口的数据结构 ## 原生具备Iterator接口的数据结构

View File

@ -113,7 +113,7 @@ if (true) {
有些“死区”比较隐蔽,不太容易发现。 有些“死区”比较隐蔽,不太容易发现。
```javascript ```javascript
function bar(x=y, y=2) { function bar(x = y, y = 2) {
return [x, y]; return [x, y];
} }

View File

@ -393,406 +393,6 @@ Object.getPrototypeOf(rec) === Rectangle.prototype
// false // false
``` ```
## Symbol
### 概述
在ES5中对象的属性名都是字符串这容易造成属性名的冲突。比如你使用了一个他人提供的对象但又想为这个对象添加新的方法新方法的名字有可能与现有方法产生冲突。如果有一种机制保证每个属性的名字都是独一无二的就好了这样就从根本上防止属性名的冲突。这就是ES6引入Symbol的原因。
ES6引入了一种新的原始数据类型Symbol表示独一无二的ID。它通过Symbol函数生成。这就是说对象的属性名现在可以有两种类型一种是原来就有的字符串另一种就是新增的Symbol类型。凡是属性名属于Symbol类型就都是独一无二的可以保证不会与其他属性名产生冲突。
```javascript
let s = Symbol();
typeof s
// "symbol"
```
上面代码中变量s就是一个独一无二的ID。typeof运算符的结果表明变量s是Symbol数据类型而不是字符串之类的其他类型。
注意Symbol函数前不能使用new命令否则会报错。这是因为生成的Symbol是一个原始类型的值不是对象。也就是说由于Symbol值不是对象所以不能添加属性。基本上它是一种类似于字符串的数据类型。
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)"
```
上面代码中s1和s2是两个Symbol值。如果不加参数它们在控制台的输出都是`Symbol()`,不利于区分。有了参数以后,就等于为它们加上了描述,输出的时候就能够分清,到底是哪一个值。
注意Symbol函数的参数只是表示对当前Symbol类型的值的描述因此相同参数的Symbol函数的返回值是不相等的。
```javascript
// 没有参数的情况
var s1 = Symbol();
var s2 = Symbol();
s1 === s2 // false
// 有参数的情况
var s1 = Symbol("foo");
var s2 = Symbol("foo");
s1 === s2 // false
```
上面代码中s1和s2都是Symbol函数的返回值而且参数相同但是它们是不相等的。
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
```
但是Symbol类型的值可以转为字符串。
```javascript
var sym = Symbol('My symbol');
String(sym) // 'Symbol(My symbol)'
sym.toString() // 'Symbol(My symbol)'
```
### 作为属性名的Symbol
由于每一个Symbol值都是不相等的这意味着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!"
```
上面代码通过方括号结构和Object.defineProperty将对象的属性名指定为一个Symbol值。
注意Symbol值作为对象属性名时不能用点运算符。
```javascript
var mySymbol = Symbol();
var a = {};
a.mySymbol = 'Hello!';
a[mySymbol] // undefined
a['mySymbol'] // "Hello!"
```
上面代码中因为点运算符后面总是字符串所以不会读取mySymbol作为标识名所指代的那个值导致a的属性名实际上是一个字符串而不是一个Symbol值。
同理在对象的内部使用Symbol值定义属性时Symbol值必须放在方括号之中。
```javascript
let s = Symbol();
let obj = {
[s]: function (arg) { ... }
};
obj[s](123);
```
上面代码中如果s不放在方括号中该属性的键名就是字符串s而不是s所代表的那个Symbol值。
采用增强的对象写法上面代码的obj对象可以写得更简洁一些。
```javascript
let obj = {
[s](arg) { ... }
};
```
Symbol类型还可以用于定义一组常量保证这组常量的值都是不相等的。
```javascript
log.levels = {
DEBUG: Symbol('debug'),
INFO: Symbol('info'),
WARN: Symbol('warn'),
};
log(log.levels.DEBUG, 'debug message');
log(log.levels.INFO, 'info message');
```
还有一点需要注意Symbol值作为属性名时该属性还是公开属性不是私有属性。
### 属性名的遍历
Symbol作为属性名该属性不会出现在for...in、for...of循环中也不会被`Object.keys()``Object.getOwnPropertyNames()`返回。但是它也不是私有属性有一个Object.getOwnPropertySymbols方法可以获取指定对象的所有Symbol属性名。
Object.getOwnPropertySymbols方法返回一个数组成员是当前对象的所有用作属性名的Symbol值。
```javascript
var obj = {};
var a = Symbol('a');
var b = Symbol.for('b');
obj[a] = 'Hello';
obj[b] = 'World';
var objectSymbols = Object.getOwnPropertySymbols(obj);
objectSymbols
// [Symbol(a), Symbol(b)]
```
下面是另一个例子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)]
```
上面代码中使用Object.getOwnPropertyNames方法得不到Symbol属性名需要使用Object.getOwnPropertySymbols方法。
另一个新的APIReflect.ownKeys方法可以返回所有类型的键名包括常规键名和Symbol键名。
```javascript
let obj = {
[Symbol('my_key')]: 1,
enum: 2,
nonEnum: 3
};
Reflect.ownKeys(obj)
// [Symbol(my_key), 'enum', 'nonEnum']
```
由于以Symbol值作为名称的属性不会被常规方法遍历得到。我们可以利用这个特性为对象定义一些非私有的、但又希望只用于内部的方法。
```javascript
var size = Symbol('size');
class Collection {
constructor() {
this[size] = 0;
}
add(item) {
this[this[size]] = item;
this[size]++;
}
static sizeOf(instance) {
return instance[size];
}
}
var x = new Collection();
Collection.sizeOf(x) // 0
x.add('foo');
Collection.sizeOf(x) // 1
Object.keys(x) // ['0']
Object.getOwnPropertyNames(x) // ['0']
Object.getOwnPropertySymbols(x) // [Symbol(size)]
```
上面代码中对象x的size属性是一个Symbol值所以`Object.keys(x)``Object.getOwnPropertyNames(x)`都无法获取它。这就造成了一种非私有的内部方法的效果。
### Symbol.for()Symbol.keyFor()
有时我们希望重新使用同一个Symbol值`Symbol.for`方法可以做到这一点。它接受一个字符串作为参数然后搜索有没有以该参数作为名称的Symbol值。如果有就返回这个Symbol值否则就新建并返回一个以该字符串为名称的Symbol值。
```javascript
var s1 = Symbol.for('foo');
var s2 = Symbol.for('foo');
s1 === s2 // true
```
上面代码中s1和s2都是Symbol值但是它们都是同样参数的`Symbol.for`方法生成的,所以实际上是同一个值。
`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()`写法没有登记机制,所以每次调用都会返回一个不同的值。
Symbol.keyFor方法返回一个已登记的Symbol类型值的key。
```javascript
var s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"
var s2 = Symbol("foo");
Symbol.keyFor(s2) // undefined
```
上面代码中变量s2属于未登记的Symbol值所以返回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值可以在主页面得到。
### 内置的Symbol值
除了定义自己使用的Symbol值以外ES6还提供一些内置的Symbol值指向语言内部使用的方法。
**1Symbol.hasInstance**
对象的Symbol.hasInstance属性指向一个内部方法。该对象使用instanceof运算符时会调用这个方法判断该对象是否为某个构造函数的实例。比如`foo instanceof Foo`在语言内部,实际调用的是`Foo[Symbol.hasInstance](foo)`
**2Symbol.isConcatSpreadable**
对象的Symbol.isConcatSpreadable属性指向一个方法。该对象使用Array.prototype.concat()时,会调用这个方法,返回一个布尔值,表示该对象是否可以扩展成数组。
**3Symbol.isRegExp**
对象的Symbol.isRegExp属性指向一个方法。该对象被用作正则表达式时会调用这个方法返回一个布尔值表示该对象是否为一个正则对象。
**4Symbol.match**
对象的Symbol.match属性指向一个函数。当执行`str.match(myObject)`时,如果该属性存在,会调用它,返回该方法的返回值。
**5Symbol.iterator**
对象的Symbol.iterator属性指向该对象的默认遍历器方法即该对象进行for...of循环时会调用这个方法返回该对象的默认遍历器详细介绍参见《Iterator和for...of循环》一章。
```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
```
**6Symbol.toPrimitive**
对象的Symbol.toPrimitive属性指向一个方法。该对象被转为原始类型的值时会调用这个方法返回该对象对应的原始类型值。
**7Symbol.toStringTag**
对象的Symbol.toStringTag属性指向一个方法。在该对象上面调用`Object.prototype.toString`方法时如果这个属性存在它的返回值会出现在toString方法返回的字符串之中表示对象的类型。也就是说这个属性可以用来定制`[object Object]``[object Array]`中object后面的那个字符串。
```javascript
class Collection {
get [Symbol.toStringTag]() {
return 'xxx';
}
}
var x = new Collection();
Object.prototype.toString.call(x) // "[object xxx]"
```
**8Symbol.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
}
```
## Proxy ## Proxy
### 概述 ### 概述

View File

@ -19,6 +19,7 @@
- Luke Hoban, [ES6 features](https://github.com/lukehoban/es6features): ES6新语法点的罗列 - Luke Hoban, [ES6 features](https://github.com/lukehoban/es6features): ES6新语法点的罗列
- Traceur-compiler, [Language Features](https://github.com/google/traceur-compiler/wiki/LanguageFeatures): Traceur文档列出的一些ES6例子 - Traceur-compiler, [Language Features](https://github.com/google/traceur-compiler/wiki/LanguageFeatures): Traceur文档列出的一些ES6例子
- Axel Rauschmayer, [ECMAScript 6: whats next for JavaScript?](https://speakerdeck.com/rauschma/ecmascript-6-whats-next-for-javascript-august-2014): 关于ES6新增语法的综合介绍有很多例子 - Axel Rauschmayer, [ECMAScript 6: whats next for JavaScript?](https://speakerdeck.com/rauschma/ecmascript-6-whats-next-for-javascript-august-2014): 关于ES6新增语法的综合介绍有很多例子
- Axel Rauschmayer, [Getting started with ECMAScript 6](http://www.2ality.com/2015/08/getting-started-es6.html): ES6语法点的综合介绍
- Toby Ho, [ES6 in io.js](http://davidwalsh.name/es6-io) - Toby Ho, [ES6 in io.js](http://davidwalsh.name/es6-io)
- Guillermo Rauch, [ECMAScript 6](http://rauchg.com/2015/ecmascript-6/) - Guillermo Rauch, [ECMAScript 6](http://rauchg.com/2015/ecmascript-6/)
- Charles King, [The power of ECMAScript 6](http://charlesbking.com/power_of_es6/#/) - Charles King, [The power of ECMAScript 6](http://charlesbking.com/power_of_es6/#/)

468
docs/symbol.md Normal file
View File

@ -0,0 +1,468 @@
# Symbol
## 概述
ES5的对象属性名都是字符串这容易造成属性名的冲突。比如你使用了一个他人提供的对象但又想为这个对象添加新的方法新方法的名字就有可能与现有方法产生冲突。如果有一种机制保证每个属性的名字都是独一无二的就好了这样就从根本上防止属性名的冲突。这就是ES6引入Symbol的原因。
ES6引入了一种新的原始数据类型Symbol表示独一无二的值。它是JavaScript语言的第八种数据类型前七种是数值、字符串、布尔值、数组、对象、函数、undefined。
Symbol值通过Symbol函数生成。这就是说对象的属性名现在可以有两种类型一种是原来就有的字符串另一种就是新增的Symbol类型。凡是属性名属于Symbol类型就都是独一无二的可以保证不会与其他属性名产生冲突。
```javascript
let s = Symbol();
typeof s
// "symbol"
```
上面代码中变量s就是一个独一无二的值。typeof运算符的结果表明变量s是Symbol数据类型而不是字符串之类的其他类型。
注意Symbol函数前不能使用new命令否则会报错。这是因为生成的Symbol是一个原始类型的值不是对象。也就是说由于Symbol值不是对象所以不能添加属性。基本上它是一种类似于字符串的数据类型。
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)"
```
上面代码中s1和s2是两个Symbol值。如果不加参数它们在控制台的输出都是`Symbol()`,不利于区分。有了参数以后,就等于为它们加上了描述,输出的时候就能够分清,到底是哪一个值。
注意Symbol函数的参数只是表示对当前Symbol值的描述因此相同参数的Symbol函数的返回值是不相等的。
```javascript
// 没有参数的情况
var s1 = Symbol();
var s2 = Symbol();
s1 === s2 // false
// 有参数的情况
var s1 = Symbol("foo");
var s2 = Symbol("foo");
s1 === s2 // false
```
上面代码中s1和s2都是Symbol函数的返回值而且参数相同但是它们是不相等的。
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
```
但是Symbol值可以转为字符串。
```javascript
var sym = Symbol('My symbol');
String(sym) // 'Symbol(My symbol)'
sym.toString() // 'Symbol(My symbol)'
```
## 作为属性名的Symbol
由于每一个Symbol值都是不相等的这意味着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!"
```
上面代码通过方括号结构和Object.defineProperty将对象的属性名指定为一个Symbol值。
注意Symbol值作为对象属性名时不能用点运算符。
```javascript
var mySymbol = Symbol();
var a = {};
a.mySymbol = 'Hello!';
a[mySymbol] // undefined
a['mySymbol'] // "Hello!"
```
上面代码中因为点运算符后面总是字符串所以不会读取mySymbol作为标识名所指代的那个值导致a的属性名实际上是一个字符串而不是一个Symbol值。
同理在对象的内部使用Symbol值定义属性时Symbol值必须放在方括号之中。
```javascript
let s = Symbol();
let obj = {
[s]: function (arg) { ... }
};
obj[s](123);
```
上面代码中如果s不放在方括号中该属性的键名就是字符串s而不是s所代表的那个Symbol值。
采用增强的对象写法上面代码的obj对象可以写得更简洁一些。
```javascript
let obj = {
[s](arg) { ... }
};
```
Symbol类型还可以用于定义一组常量保证这组常量的值都是不相等的。
```javascript
log.levels = {
DEBUG: Symbol('debug'),
INFO: Symbol('info'),
WARN: Symbol('warn'),
};
log(log.levels.DEBUG, 'debug message');
log(log.levels.INFO, 'info message');
```
还有一点需要注意Symbol值作为属性名时该属性还是公开属性不是私有属性。
## 属性名的遍历
Symbol作为属性名该属性不会出现在for...in、for...of循环中也不会被`Object.keys()``Object.getOwnPropertyNames()`返回。但是它也不是私有属性有一个Object.getOwnPropertySymbols方法可以获取指定对象的所有Symbol属性名。
Object.getOwnPropertySymbols方法返回一个数组成员是当前对象的所有用作属性名的Symbol值。
```javascript
var obj = {};
var a = Symbol('a');
var b = Symbol.for('b');
obj[a] = 'Hello';
obj[b] = 'World';
var objectSymbols = Object.getOwnPropertySymbols(obj);
objectSymbols
// [Symbol(a), Symbol(b)]
```
下面是另一个例子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)]
```
上面代码中使用Object.getOwnPropertyNames方法得不到Symbol属性名需要使用Object.getOwnPropertySymbols方法。
另一个新的APIReflect.ownKeys方法可以返回所有类型的键名包括常规键名和Symbol键名。
```javascript
let obj = {
[Symbol('my_key')]: 1,
enum: 2,
nonEnum: 3
};
Reflect.ownKeys(obj)
// [Symbol(my_key), 'enum', 'nonEnum']
```
由于以Symbol值作为名称的属性不会被常规方法遍历得到。我们可以利用这个特性为对象定义一些非私有的、但又希望只用于内部的方法。
```javascript
var size = Symbol('size');
class Collection {
constructor() {
this[size] = 0;
}
add(item) {
this[this[size]] = item;
this[size]++;
}
static sizeOf(instance) {
return instance[size];
}
}
var x = new Collection();
Collection.sizeOf(x) // 0
x.add('foo');
Collection.sizeOf(x) // 1
Object.keys(x) // ['0']
Object.getOwnPropertyNames(x) // ['0']
Object.getOwnPropertySymbols(x) // [Symbol(size)]
```
上面代码中对象x的size属性是一个Symbol值所以`Object.keys(x)``Object.getOwnPropertyNames(x)`都无法获取它。这就造成了一种非私有的内部方法的效果。
## Symbol.for()Symbol.keyFor()
有时我们希望重新使用同一个Symbol值`Symbol.for`方法可以做到这一点。它接受一个字符串作为参数然后搜索有没有以该参数作为名称的Symbol值。如果有就返回这个Symbol值否则就新建并返回一个以该字符串为名称的Symbol值。
```javascript
var s1 = Symbol.for('foo');
var s2 = Symbol.for('foo');
s1 === s2 // true
```
上面代码中s1和s2都是Symbol值但是它们都是同样参数的`Symbol.for`方法生成的,所以实际上是同一个值。
`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()`写法没有登记机制,所以每次调用都会返回一个不同的值。
Symbol.keyFor方法返回一个已登记的Symbol类型值的key。
```javascript
var s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"
var s2 = Symbol("foo");
Symbol.keyFor(s2) // undefined
```
上面代码中变量s2属于未登记的Symbol值所以返回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值可以在主页面得到。
## 内置的Symbol值
除了定义自己使用的Symbol值以外ES6还提供一些内置的Symbol值指向语言内部使用的方法。
### Symbol.hasInstance
对象的Symbol.hasInstance属性指向一个内部方法。该对象使用instanceof运算符时会调用这个方法判断该对象是否为某个构造函数的实例。比如`foo instanceof Foo`在语言内部,实际调用的是`Foo[Symbol.hasInstance](foo)`
```javascript
class MyClass {
[Symbol.hasInstance](foo) {
return foo instanceof Array;
}
}
var o = new MyClass();
o instanceof Array // false
```
### Symbol.isConcatSpreadable
对象的Symbol.isConcatSpreadable属性指向一个方法。该对象使用Array.prototype.concat()时,会调用这个方法,返回一个布尔值,表示该对象是否可以扩展成数组。
```javascript
class A1 extends Array {
[Symbol.isConcatSpreadable]() {
return true;
}
}
class A2 extends Array {
[Symbol.isConcatSpreadable]() {
return 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]]
```
上面代码中类A1是可扩展的类A2是不可扩展的所以使用concat时有不一样的结果。
### Symbol.isRegExp
对象的Symbol.isRegExp属性指向一个方法。该对象被用作正则表达式时会调用这个方法返回一个布尔值表示该对象是否为一个正则对象。
### Symbol.match
对象的Symbol.match属性指向一个函数。当执行`str.match(myObject)`时,如果该属性存在,会调用它,返回该方法的返回值。
```javascript
class MyMatcher {
[Symbol.match](string) {
return 'hello world'.indexOf(string);
}
}
'e'.match(new MyMatcher()) // 1
```
### Symbol.replace
对象的Symbol.replace属性指向一个方法当该对象被String.prototype.replace方法调用时会返回该方法的返回值。
### Symbol.search
对象的Symbol.search属性指向一个方法当该对象被String.prototype.search方法调用时会返回该方法的返回值。
```javascript
class MySearch {
constructor(value) {
this.value = value;
}
[Symbol.search](string) {
return string.indexOf(this.value);
}
}
'foobar'.search(new MySearch('foo')) // 0
```
### Symbol.split
对象的Symbol.split属性指向一个方法当该对象被String.prototype.split方法调用时会返回该方法的返回值。
### Symbol.iterator
对象的Symbol.iterator属性指向该对象的默认遍历器方法即该对象进行for...of循环时会调用这个方法返回该对象的默认遍历器详细介绍参见《Iterator和for...of循环》一章。
```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
```
### Symbol.toPrimitive
对象的Symbol.toPrimitive属性指向一个方法。该对象被转为原始类型的值时会调用这个方法返回该对象对应的原始类型值。
### Symbol.toStringTag
对象的Symbol.toStringTag属性指向一个方法。在该对象上面调用`Object.prototype.toString`方法时如果这个属性存在它的返回值会出现在toString方法返回的字符串之中表示对象的类型。也就是说这个属性可以用来定制`[object Object]``[object Array]`中object后面的那个字符串。
```javascript
class Collection {
get [Symbol.toStringTag]() {
return 'xxx';
}
}
var x = new Collection();
Object.prototype.toString.call(x) // "[object xxx]"
```
### 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
}
```

View File

@ -15,6 +15,7 @@
1. [数组的扩展](#docs/array) 1. [数组的扩展](#docs/array)
1. [对象的扩展](#docs/object) 1. [对象的扩展](#docs/object)
1. [函数的扩展](#docs/function) 1. [函数的扩展](#docs/function)
1. [Symbol](#docs/symbol)
1. [Set和Map数据结构](#docs/set-map) 1. [Set和Map数据结构](#docs/set-map)
1. [Iterator和for...of循环](#docs/iterator) 1. [Iterator和for...of循环](#docs/iterator)
1. [Generator函数](#docs/generator) 1. [Generator函数](#docs/generator)