ES6学习6（Symbol）

ES5的对象属性名都是字符串，这容易造成属性名的冲突。比如，你使用了一个他人提供的对象，但又想为这个对象添加新的方法（mixin模式），新方法的名字就有可能与现有方法产生冲突。

ES6引入了一种新的原始数据类型Symbol，表示独一无二的值。它是JavaScript语言的第七种数据类型。

对象的属性名现在可以有两种类型，一种是原来就有的字符串，另一种就是新增的Symbol类型。凡是属性名属于Symbol类型，就都是独一无二的，可以保证不会与其他属性名产生冲突。

// 没有参数的情况
var s1 = Symbol();
var s2 = Symbol();
s1 === s2; // false
s1.toString(); // "Symbol()"
s2.toString(); // "Symbol()"

// 有参数的情况
var s1 = Symbol("foo");
var s2 = Symbol("foo");
s1 === s2; // false
console.log(s1); // "Symbol(foo)"
console.log(s2); // "Symbol(foo)"

Symbol值不能与其他类型的值进行运算，会报错。
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!"

Symbol值作为对象属性名时，不能用点运算符，如果你不小心用了，会得到你不想要的结果：

var mySymbol = Symbol();
var a = {};
a.mySymbol = 'Hello!';
a[mySymbol] // undefined
a['mySymbol'] // "Hello!"

应用：消除魔术字符串

由于Symbol的独特性它非常适用于用来定义常量，我们很多时候不需要常量的具体值，只需要保证这组常量的值都是不相等的，就像是Java里的枚举，只不过这里枚举的row值更加独特化：

log.levels = {
  DEBUG: Symbol('debug'),
  INFO: Symbol('info'),
  WARN: Symbol('warn')
};

实际的例子：

const shapeType = {
  triangle: Symbol()
};
function getArea(shape, options) {
  var area = 0;
  switch (shape) {
    case shapeType.triangle:
      area = .5 * options.width * options.height;
      break;
  }
  return area;
}
console.log(getArea(shapeType.triangle, { width: 100, height: 100 }));

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)]

如果你想得到所有类型的键名，可以使用Reflect.ownKeys：

let obj1 = {
  [Symbol('my_key')]: 1,
  enum: 2,
  nonEnum: 3
};

console.log(Reflect.ownKeys(obj1));
// [Symbol(my_key), 'enum', 'nonEnum']

Symbol.for()，Symbol.keyFor()

有时，我们希望重新使用同一个Symbol值，Symbol.for方法可以做到这一点。它接受一个字符串作为参数，然后搜索有没有以该参数作为名称的Symbol值。如果有，就返回这个Symbol值，否则就新建并返回一个以该字符串为名称的Symbol值。

var s1 = Symbol('foo');
var s2 = Symbol('foo');
var s3 = Symbol.for('foo');
var s4 = Symbol.for('foo');

console.log(s1 === s2); // false
console.log(s1 === s3); // false
console.log(s2 === s3); // false
console.log(s3 === s4); // true

Symbol.for()与Symbol()这两种写法，都会生成新的Symbol。它们的区别是，前者会被登记在全局环境中供搜索，后者不会。Symbol.for()不会每次调用就返回一个新的Symbol类型的值，而是会先检查给定的key是否已经存在，如果不存在才会新建一个值。比如，如果你调用Symbol.for(“cat”)30次，每次都会返回同一个Symbol值，但是调用Symbol(“cat”)30次，会返回30个不同的Symbol值。

Symbol.keyFor方法返回一个已登记的Symbol类型值的key。

console.log(Symbol.keyFor(s1));//undefined
console.log(Symbol.keyFor(s3));//foo

需要注意的是，Symbol.for为Symbol值登记的名字，是全局环境的，可以在不同的iframe或service worker中取到同一个值。

实例：模块的 Singleton 模式

Singleton模式指的是调用一个类，任何时候返回的都是同一个实例。
可以把实例放在顶层对象：

// mod.js
function A() {
  this.foo = 'hello';
}
if (!global._foo) {
  global._foo = new A();
}
module.exports = global._foo;

但是此时如果有人在调用时做了这样的操作：

var a = require('./mod.js');
global._foo = 123;

我们想要的实例就不存在了。
这时我们就可以用Symbol了：

// 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，只能使用：

var a = require('./mod.js');
console.log(a.foo);

内置的Symbol值

ES6还提供了11个内置的Symbol值，指向语言内部使用的方法。

Symbol.hasInstance

对象的Symbol.hasInstance属性，指向一个内部方法。当其他对象使用instanceof运算符，判断是否为该对象的实例时，会调用这个方法。比如，foo instanceof Foo在语言内部，实际调用的是：

Foo[Symbol.hasInstance](foo)

我们可以看一个例子：

class Even {
  static [Symbol.hasInstance](obj) {
    return Number(obj) % 2 === 0;
  }
}
1 instanceof Even // false
2 instanceof Even // true
12345 instanceof Even // false

通过这样我们可以自己定制我们的instanceof方法。
这个我在node 5.8.0里试验失败了，用babel 6.16.0转码执行也失败了。。。
看了看MDN。。。FF 50版本才支持

Symbol.isConcatSpreadable

对象的Symbol.isConcatSpreadable属性等于一个布尔值，表示该对象使用Array.prototype.concat()时，是否可以展开。
Symbol.isConcatSpreadable属性等于true是可以展开的，false不可以，undefined时不好说：

let arr1 = ['c', 'd'];
console.log(arr1[Symbol.isConcatSpreadable]); // undefined
console.log(['a', 'b'].concat(arr1, 'e')); // ['a', 'b', 'c', 'd', 'e']
arr1[Symbol.isConcatSpreadable] = false;
console.log(arr1[Symbol.isConcatSpreadable]); // false
console.log(['a', 'b'].concat(arr1, 'e')); // ['a', 'b', ['c', 'd'], 'e']

let obj = {length: 2, 0: 'c', 1: 'd'};
console.log(obj[Symbol.isConcatSpreadable]); // false
console.log(['a', 'b'].concat(obj, 'e')); // ['a', 'b', obj, 'e']
obj[Symbol.isConcatSpreadable] = true;
console.log(obj[Symbol.isConcatSpreadable]); // true
console.log(['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]]

FF 48以上可以支持

Symbol.species

这个属性指向一个方法，该对象作为构造函数创造实例时，会调用这个方法。即如果this.constructor[Symbol.species]存在，就会使用这个属性作为构造函数，来创造新的实例对象。
这个属性默认值是这样的：

static get [Symbol.species]() {
  return this;
}

也就是说会返回对象本身，但是如果你修改了它：

class MyArray extends Array {
  // Overwrite species to the parent Array constructor
  static get [Symbol.species]() { return Array; }
}
var a = new MyArray(1,2,3);
var mapped = a.concat();

console.log(mapped instanceof MyArray); // false
console.log(mapped instanceof Array);   // true

这里在a上调用concat时会调用到这个构造器，于是我们就可以修改它来控制构造出的对象。

Symbol.match

这是一个和正则表达式有关的值，对象的Symbol.match属性，指向一个函数。当执行str.match(myObject)时，如果该属性存在，会调用它，返回该方法的返回值。

class MyMatcher {
  [Symbol.match](string) {
    return 'hello world'.indexOf(string);
  }
}
'e'.match(new MyMatcher()) // 1

同时，这个值还代表着一个对象是否具有正则表达式的功能：

var re = /foo/;
console.log("foo".match(re));//[ "foo" ]
re[Symbol.match] = false;
console.log("foo".match(re));

第二次匹配是无法完成的。

Symbol.replace

对象的Symbol.replace属性，指向一个方法，当该对象被String.prototype.replace方法调用时，会返回该方法的返回值。

var str = "abc";
class Obj {
  [Symbol.replace](s,replaceStr) {
        console.log("hhaah");
        return "balalala";
    }
}
console.log(str.replace(new Obj(),"b")); //"balalala"

Symbol.search

对象的Symbol.search属性，指向一个方法，当该对象被String.prototype.search方法调用时，会返回该方法的返回值。

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属性，指向该对象的默认遍历器方法。调用对象的遍历器时就会调用这个方法。

var myIterable = {};
myIterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};

[...myIterable] // [1, 2, 3]

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 'hahaha';
      default:
        throw new Error();
     }
   }
};
console.log(2 * obj) // 246
console.log(3 + obj) // '3default'
console.log(obj == 'hahaha') // true
console.log(obj == 123) // true
console.log(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]"

Symbol.unscopables

对象的Symbol.unscopables属性，指向一个对象。该对象指定了使用with关键字时，哪些属性会被with环境排除。
比如Array，有6个属性会被with关键字排除：

Array.prototype[Symbol.unscopables]
// {
//   copyWithin: true,
//   entries: true,
//   fill: true,
//   find: true,
//   findIndex: true,
//   keys: true
// }

下面这个例子，一个读的到一个读不到：

var obj = { 
  foo: 1, 
  bar: 2 
};
obj[Symbol.unscopables] = { 
  foo: false, 
  bar: true 
};
with(obj) {
  console.log(foo); // 1
  console.log(bar); // ReferenceError: bar is not defined
}

在类里：

// 有unscopables时
class MyClass {
  foo() { return 1; }
  get [Symbol.unscopables]() {
    return { foo: true };
  }
}

var foo = function () { return 2; };
with (MyClass.prototype) {
  foo(); // 2
}