ECMAScript 6学习笔记之----Symbol

什么是Symbol

 ES5 的对象属性名都是字符串，这容易造成属性名的冲突。比如，你使用了一个他人提供的对象，但又想为这个对象添加新的方法（mixin 模式），新方法的名字就有可能与现有方法产生冲突。如果有一种机制，保证每个属性的名字都是独一无二的就好了，这样就从根本上防止属性名的冲突。这就是 ES6 引入Symbol的原因。
 Symbol是ES6新引入的原始数据类型，表示独一无二的值。他是JavaScript语言的第七种数据类型，前六种是:undefined,null,布尔型(Boolean),字符串(String), 数值Number，对象(Object) 。
 Symbol值通过``Symbol函数生成。这就是说，对象的属性名现在可以有两种类型，一种是原来就有的字符串，另一种就是新增的 Symbol类型。凡是属性名属于 Symbol类型，就都是独一无二的，可以保证不会与其他属性名产生冲突。

作为属性名的Symbol

 由于每一个Symbol值都是不相同的，这意味着Symbol可以作为标识符，用于对象的属性名，就能保证不会出现同名的属性名。三种定义Symbol方法如下：

let mySymbol = Symbol('hhh');
let a = {};

a[mySymbol]  = 'Hello';
 a = {
    [mySymbol]:'Hello'
};

Object.defineProperty(a,mySymbol,{value:'hello'})
print(a[mySymbol])

-----hello

 Symbol函数前不能使用new命令，否则会报错。这是因为生成的Symbol是一个原始类型的值，不是对象。也就是说，由于Symbol值不是对象，所以不能添加属性。基本上，他是一种类似于字符串的数据类型。

const obj = {};
let a1 = Symbol('a');
let b1 = Symbol('b');
obj[a1] = 'hello';
// obj[b1] = 'world';
Object.defineProperty(obj,mySymbol,{value:'world'})
const objSymbol = Object.getOwnPropertySymbols(obj);
for(let s in objSymbol) {
    print(objSymbol[s].toString())
}

let s3 = Symbol();
let obj1 =  {
    [s3]:(args => print(args))
}
obj1[s3](123);

消除魔术字符串

 魔术字符串指的是，在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。风格良好的代码，应该尽量消除魔术字符串，改由含义清晰的变量替代。

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

print(getArea(shapeType.triangle, {width:100, height:30}));

属性名的遍历

Symbol作为属性名，可以使用Reflect.ownKeys返回所有类型的键名。

const obj = {};
let a1 = Symbol('a');
let b1 = Symbol('b');
obj[a1] = 'hello';

Object.defineProperty(obj,b1,{value:'world'})
let keys = Reflect.ownKeys(obj);
for(let k in keys) {
    print(keys[k].toString())
    print(obj[keys[k]])
}

-----Symbol(a)
-----Symbol(b)

内置的 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;
    }
}

let result = [1,2,3] instanceof new MyClass();
print(result);

-----true

另外一个例子：

class Even {
    static [Symbol.hasInstance](obj) {
        return Number(obj) % 2 === 0;
    }
}

const Even1 = {
    [Symbol.hasInstance](obj) {
        return Number(obj) % 2 === 0;
    }
}
print(1 instanceof Even);
print(4 instanceof Even);

print(1 instanceof Even1);
print(4 instanceof Even1);

-----false
-----true
-----false
-----true

Symbol.isConcatSpreadable § ⇧

对象的Symbol.isConcatSpreadable属性等于一个布尔值，表示该对象用于Array.prototype.concat()时，是否以展开。

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)
下面是一个例子。

const x = {};
x[Symbol.replace] = (...s) => console.log(s);

'Hello'.replace(x, 'World') // ["Hello", "World"]

Symbol.replace方法会收到两个参数，第一个参数是replace方法正在作用的对象，上面例子是Hello，第二个参数是替换后的值，上面例子是World。

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)

下面是一个例子。

class MySplitter {
  constructor(value) {
    this.value = value;
  }
  [Symbol.split](string) {
    let index = string.indexOf(this.value);
    if (index === -1) {
      return string;
    }
    return [
      string.substr(0, index),
      string.substr(index + this.value.length)
    ];
  }
}

'foobar'.split(new MySplitter('foo'))
// ['', 'bar']

'foobar'.split(new MySplitter('bar'))
// ['foo', '']

'foobar'.split(new MySplitter('baz'))
// 'foobar'

上面方法使用Symbol.split方法，重新定义了字符串对象的split方法的行为，

Symbol.iterator

对象的Symbol.iterator属性，指向该对象的默认遍历器方法。

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

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

对象进行for…of循环时，会调用Symbol.iterator方法，返回该对象的默认遍历器，

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';
  }
}
let x = new Collection();
Object.prototype.toString.call(x) // "[object xxx]"