概述
es5的对象属性名都是字符串，这容易造成属性名的冲突。比如，你使用了一个他人提供的对象，但又想为这个对象添加新的方法（mixin模式），新方法的名字就有可能与现有方法产生冲突。如果有一种机制，保证每个属性的名字都是独一无二的就好了，这样就从根本上防止属性名的冲突。这就是es6引入symbol的原因。
es6引入了一种新的原始数据类型symbol，表示独一无二的值。它是javascript语言的第七种数据类型，前六种是：undefined、null、布尔值（boolean）、字符串（string）、数值（number）、对象（object）。
symbol值通过symbol函数生成。这就是说，对象的属性名现在可以有两种类型，一种是原来就有的字符串，另一种就是新增的symbol类型。凡是属性名属于symbol类型，就都是独一无二的，可以保证不会与其他属性名产生冲突。
let s = symbol();
typeof s
// "symbol"
上面代码中，变量s就是一个独一无二的值。typeof运算符的结果，表明变量s是symbol数据类型，而不是字符串之类的其他类型。
注意，symbol函数前不能使用new命令，否则会报错。这是因为生成的symbol是一个原始类型的值，不是对象。也就是说，由于symbol值不是对象，所以不能添加属性。基本上，它是一种类似于字符串的数据类型。
symbol函数可以接受一个字符串作为参数，表示对symbol实例的描述，主要是为了在控制台显示，或者转为字符串时，比较容易区分。
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函数的返回值是不相等的。
// 没有参数的情况
var s1 = symbol();
var s2 = symbol();
s1 === s2 // false
// 有参数的情况
var s1 = symbol("foo");
var s2 = symbol("foo");
s1 === s2 // false
上面代码中，s1和s2都是symbol函数的返回值，而且参数相同，但是它们是不相等的。
symbol值不能与其他类型的值进行运算，会报错。
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值可以显式转为字符串。
var sym = symbol('my symbol');
string(sym) // 'symbol(my symbol)'
sym.tostring() // 'symbol(my symbol)'
另外，symbol值也可以转为布尔值，但是不能转为数值。
var sym = symbol();
boolean(sym) // true
!sym // false
if (sym) {
// ...
}
number(sym) // typeerror
sym + 2 // typeerror
作为属性名的symbol
由于每一个symbol值都是不相等的，这意味着symbol值可以作为标识符，用于对象的属性名，就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用，能防止某一个键被不小心改写或覆盖。
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值作为对象属性名时，不能用点运算符。
var mysymbol = symbol();
var a = {};
a.mysymbol = 'hello!';
a[mysymbol] // undefined
a['mysymbol'] // "hello!"
上面代码中，因为点运算符后面总是字符串，所以不会读取mysymbol作为标识名所指代的那个值，导致a的属性名实际上是一个字符串，而不是一个symbol值。
同理，在对象的内部，使用symbol值定义属性时，symbol值必须放在方括号之中。
let s = symbol();
let obj = {
[s]: function (arg) { ... }
};
obj[s](123);
上面代码中，如果s不放在方括号中，该属性的键名就是字符串s，而不是s所代表的那个symbol值。
采用增强的对象写法，上面代码的obj对象可以写得更简洁一些。
let obj = {
[s](arg) { ... }
};
symbol类型还可以用于定义一组常量，保证这组常量的值都是不相等的。
log.levels = {
debug: symbol('debug'),
info: symbol('info'),
warn: symbol('warn')
};
log(log.levels.debug, 'debug message');
log(log.levels.info, 'info message');
下面是另外一个例子。
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值作为属性名时，该属性还是公开属性，不是私有属性。
实例：消除魔术字符串
魔术字符串指的是，在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。风格良好的代码，应该尽量消除魔术字符串，该由含义清晰的变量代替。
function getarea(shape, options) {
var area = 0;
switch (shape) {
case 'triangle': // 魔术字符串
area = .5 * options.width * options.height;
break;
/* ... more code ... */
}
return area;
}
getarea('triangle', { width: 100, height: 100 }); // 魔术字符串
上面代码中，字符串“triangle”就是一个魔术字符串。它多次出现，与代码形成“强耦合”，不利于将来的修改和维护。
常用的消除魔术字符串的方法，就是把它写成一个变量。
var shapetype = {
triangle: 'triangle'
};
function getarea(shape, options) {
var area = 0;
switch (shape) {
case shapetype.triangle:
area = .5 * options.width * options.height;
break;
}
return area;
}
getarea(shapetype.triangle, { width: 100, height: 100 });
上面代码中，我们把“triangle”写成shapetype对象的triangle属性，这样就消除了强耦合。
如果仔细分析，可以发现shapetype.triangle等于哪个值并不重要，只要确保不会跟其他shapetype属性的值冲突即可。因此，这里就很适合改用symbol值。
const shapetype = {
triangle: symbol()
};
上面代码中，除了将shapetype.triangle的值设为一个symbol，其他地方都不用修改。
属性名的遍历
symbol作为属性名，该属性不会出现在for...in、for...of循环中，也不会被object.keys()、object.getownpropertynames()返回。但是，它也不是私有属性，有一个object.getownpropertysymbols方法，可以获取指定对象的所有symbol属性名。
object.getownpropertysymbols方法返回一个数组，成员是当前对象的所有用作属性名的symbol值。
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)]
下面是另一个例子，object.getownpropertysymbols方法与for...in循环、object.getownpropertynames方法进行对比的例子。
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方法。
另一个新的api，reflect.ownkeys方法可以返回所有类型的键名，包括常规键名和symbol键名。
let obj = {
[symbol('my_key')]: 1,
enum: 2,
nonenum: 3
};
reflect.ownkeys(obj)
// [symbol(my_key), 'enum', 'nonenum']
由于以symbol值作为名称的属性，不会被常规方法遍历得到。我们可以利用这个特性，为对象定义一些非私有的、但又希望只用于内部的方法。
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值。
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值。
symbol.for("bar") === symbol.for("bar")
// true
symbol("bar") === symbol("bar")
// false
上面代码中，由于symbol()写法没有登记机制，所以每次调用都会返回一个不同的值。
symbol.keyfor方法返回一个已登记的symbol类型值的key。
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中取到同一个值。
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。
// mod.js
function a() {
this.foo = 'hello';
}
if (!global._foo) {
global._foo = new a();
}
module.exports = global._foo;
然后，加载上面的mod.js。
var a = require('./mod.js');
console.log(a.foo);
上面代码中，变量a任何时候加载的都是a的同一个实例。
但是，这里有一个问题，全局变量global._foo是可写的，任何文件都可以修改。
var a = require('./mod.js');
global._foo = 123;
上面的代码，会使得别的脚本加载mod.js都失真。
为了防止这种情况出现，我们就可以使用symbol。
// 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]不会被其他脚本改写。
内置的symbol值
除了定义自己使用的symbol值以外，es6还提供了11个内置的symbol值，指向语言内部使用的方法。
symbol.hasinstance
对象的symbol.hasinstance属性，指向一个内部方法。当其他对象使用instanceof运算符，判断是否为该对象的实例时，会调用这个方法。比如，foo instanceof foo在语言内部，实际调用的是foo[symbol.hasinstance](foo)。
class myclass {
[symbol.hasinstance](foo) {
return foo instanceof array;
}
}
[1, 2, 3] instanceof new myclass() // true
上面代码中，myclass是一个类，new myclass()会返回一个实例。该实例的symbol.hasinstance方法，会在进行instanceof运算时自动调用，判断左侧的运算子是否为array的实例。
下面是另一个例子。
class even {
static [symbol.hasinstance](obj) {
return number(obj) % 2 === 0;
}
}
1 instanceof even // false
2 instanceof even // true
12345 instanceof even // false
symbol.isconcatspreadable
对象的symbol.isconcatspreadable属性等于一个布尔值，表示该对象使用array.prototype.concat()时，是否可以展开。
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']
上面代码说明，数组的默认行为是可以展开。symbol.isconcatspreadable属性等于true或undefined，都有这个效果。
类似数组的对象也可以展开，但它的symbol.isconcatspreadable属性默认为false，必须手动打开。
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']
对于一个类来说，symbol.isconcatspreadable属性必须写成实例的属性。
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]]
上面代码中，类a1是可展开的，类a2是不可展开的，所以使用concat时有不一样的结果。
symbol.species
对象的symbol.species属性，指向一个方法。该对象作为构造函数创造实例时，会调用这个方法。即如果this.constructor[symbol.species]存在，就会使用这个属性作为构造函数，来创造新的实例对象。
symbol.species属性默认的读取器如下。
static get [symbol.species]() {
return this;
}
symbol.match
对象的symbol.match属性，指向一个函数。当执行str.match(myobject)时，如果该属性存在，会调用它，返回该方法的返回值。
string.prototype.match(regexp)
// 等同于
regexp[symbol.match](this)
class mymatcher {
[symbol.match](string) {
return 'hello world'.indexof(string);
}
}
'e'.match(new mymatcher()) // 1
symbol.replace
对象的symbol.replace属性，指向一个方法，当该对象被string.prototype.replace方法调用时，会返回该方法的返回值。
string.prototype.replace(searchvalue, replacevalue)
// 等同于
searchvalue[symbol.replace](this, replacevalue)
symbol.search
对象的symbol.search属性，指向一个方法，当该对象被string.prototype.search方法调用时，会返回该方法的返回值。
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
symbol.split
对象的symbol.split属性，指向一个方法，当该对象被string.prototype.split方法调用时，会返回该方法的返回值。
string.prototype.split(separator, limit)
// 等同于
separator[symbol.split](this, limit)
symbol.iterator
对象的symbol.iterator属性，指向该对象的默认遍历器方法。
var myiterable = {};
myiterable[symbol.iterator] = function* () {
yield 1;
yield 2;
yield 3;
};
[...myiterable] // [1, 2, 3]
对象进行for...of循环时，会调用symbol.iterator方法，返回该对象的默认遍历器，详细介绍参见《iterator和for...of循环》一章。
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.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'
symbol.tostringtag
对象的symbol.tostringtag属性，指向一个方法。在该对象上面调用object.prototype.tostring方法时，如果这个属性存在，它的返回值会出现在tostring方法返回的字符串之中，表示对象的类型。也就是说，这个属性可以用来定制[object object]或[object array]中object后面的那个字符串。
({[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属性值如下。
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环境排除。
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命令排除。
// 没有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
}
