第7种数据类型：Symbol

概述

ES5的对象属性名都是字符串，这容易造成属性名的冲突。比如，你使用了一个他人提供的对象，但又想为这个对象添加新的方法（mixin模式），新方法的名字就有可能与现有方法产生冲突。如果有一种机制，能够保证每个属性的名字都是独一无二的就好了，这样就能从根本上防止属性名冲突。这就是ES6引入Symbol的原因。

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

Symbol值通过Symbol函数生成。这就是说，对象的属性名现在可以有两种类型：一种是原来的就有的字符串，另一种就是新增的Symbol类型。只要属性名属于Symbol类型，就是独一无二的，可以保证不会与其他属性名产生冲突。

jscopied
let s = Symbol();

typeof s // 'symbol'

上面的代码中，变量s就是一个独一无二的值。typeof运算符的结果表明变量s是Symbol数据类型，而不是字符串之类的其他类型。

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

Symbol函数可以接受一个字符串作为参数，表示对Symbol实例的描述，主要是为了在控制台显示或转为字符串时比较容易区分。

jscopied
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函数的返回值是不相等的。

jscopied
// 没有参数的情况
var s1 = Symbol()
var s2 = Symbol()

s1 === s2 // false

// 有参数的情况
var s1 = Symbol('s')
var s2 = Symbol('s')

s1 === s2 // false

上面的代码中，s1和s2都是Symbol函数的返回值，而且参数相同，但是它们是不相等的。

Symbol值不能与其他类型的值进行运算，否则会报错。

jscopied
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值可以显示转为字符串。

jscopied
var sym = Symbol('My symbol');

String(sym) // 'Symbol(My symbol)'
sym.toString() // 'Symbol(My symbol)'

另外，Symbol值也可以转为布尔值，但不能转为数值。

jscopied
var sym = Symbol();
Boolen(sym) // true
!sym // false

if (sym) {
  // ...
}

Number(sym) // TypeError
sym + 2 // TypeError

作为属性名的Symbol

由于每一个Symbol值都是不相等的，这意味着Symbol值可以作为标识符用于对象的属性名，保证不会出现同外的属性。这对于一个对象由多个模块构成的情况非常有用，能防止某一个键被不小心改写或覆盖。

jscopied
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值作为对象属性名时不能使用点运算符。

jscopied
var mySymbol = Symbol();
var a = {};

a.mySymbol = 'Hello';
a[mySymbol] // undefined
a['mySymbol'] // 'Hello'

上面的代码中，因为点运算符后面总是字符串，所以不会读取mySymbol作为标识名所指代的值，导致a的属性名实际上是一个字符串，而不是一个Symbol值。

同理，在对象的内部，使用Symbol值定义属性时，Symbol值必须放在方括号中。

jscopied
let s = Symbol();

let obj = {
  [s]: function (arg) {
    // ...
  }
}

obj[s](123);

上面的代码中，如果s不放在方括号中，该属性的键名就是字符串s，而不是s所代表的Symbol值。

采用增强的对象写法，上面的obj对象可以写得更简洁一些。

jscopied
let obj = {
  [s] (org) { ... }
}

Symbol类型还可用于定义一组常量，保证这组常量的值都是不相等的。

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

log(log.levels.DEBUG, 'debug message');
log(log.levels.INFO, 'info message');

下面是另外一个例子：

jscopied
const COLOR_RED = Symbol();
const COLOR_GREEN = Symbol();

function getComplement (color) {
  switch (color) {
    case COLOR_RED:
      return COLOR_GREEN;
    case COLOR_GERREN:
      return COLOR_RED;
    defalut:
      throw new Error('Undefined color');
  }
}

常量使用Symbol值最大的好处，就是其他任何值都不可能有相同的值了，因此可以保证上面的switch语句会按设计的方式工作。

还有一点需要注意，Symbol值作为属性名时，该属性还是公开属性，不是私有属性。

实例：消除魔术字符串

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

jscopied
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就是一个魔术字符串，它多次出现，与代码形成“强耦合”，不利于将来的修改和维护。

常用的消除魔术字符串的方法，就是把它写成一个变量。

jscopied
var shapeType = {
  triangle: 'Triangle'
};

function getArea (shape, options) {
  var area = 0;

  switch (shape) {
    case shapeType.triangle: // 魔术字符串
      area = .5 * options.width * options.height;
      break;
    /* ... more code ... */
  }

  return area;
}

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

上面的代码中，我们把Triangle写成shapeType对象的triangle属性，这样就消除了强耦合。如果仔细分析，可以发现shapeType.triangle等于哪个值并不重要，只要确保不会跟其他shapeType属性的值冲突即可。因此，这里很适合改用Symbol值。

jscopied
const shapeType = {
  triangle: Symbol()
}

上面的代码中，除了将shapeType.triangle的值设为一个Symbol，其他地方都不用修改。

属性名的遍历

Symbol作为属性名，该属性不会出现在for...in、for...of循环中，也不会被Object.keys()、Object.getOwnPropertyNames()返回。但它也不是私有属性，有一个Object.getOwnPropertySymbols可以获取指定对象的所有Symbol属性名。

Object.getOwnpropertySymbol方法返回一个数组，成员是当前对象的所有用作属性名的Symbol值。

jscopied
var obj = {};
var a = Symbol('a');
var b = Symbol('b');

obj[a] = 'Hello';
obj[b] = 'World';

var objectSymbols = obj.getOwnPropertySymbols(obj);

console.log(objectSymbols) // [Symbol(a), Symbol(b)]

下面是另外一个例子，将Object.getOwnPropertySymbols方法与for...in循环、Object.geOwnPropertyNames方法进行了对比：

jscopied
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属性名。

另一个新的API——Reflect.ownKeys()可以返回所有类型的键名，包括常规键名和Symbol键名。

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

Reflect.ownKeys(obj); // [Symbol(my_key), 'enum', 'nonEnum']

以Symbol值作为名称的属性不会被常规方法遍历得到。我们可以利用这个特性，为对象定义一些非私有但又希望只用于内部的方法。

jscopied
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值。

jscopied
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值。

jscopied
Symbol.for('bar') === Symbol.for('bar') // true

Symbol('bar') === Symbol('bar') // false

上面的代码中，由于Symbol()写法没有登记机制，所以每次调用都会返回一个不同的值。

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

jscopied
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中取到同一个值。

jscopied
iframe = document.createElement('iframe');
iframe.src = String(window.location);
document.body.appendChild(iframe)l

iframe.contentWindow.Symbol.for('foo') === Symbol.for('foo') // true

上面的代码中，iframe窗口生成的Symbol值可以在主页面得到。

内置的Symbol值

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

Symbol.hasInstance

对象Symbol.hasInstance属性指向一个内部方法，对象使用instanceof运算符时会调用这个方法，判断该对象是否为某个构造函数的实例。比如，foo instanceof Foo在语言内部实际调用的是Foo[Symbol.hasInstance](foo)。

jscopied
class MyClass {
  [Symbol.hasInstance](foo) {
    return foo instanceof Array;
  }
}

var o = new Myclass();
o instanceof Array // true

Symbol.isConcatSpreadable

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

jscopied
let arr1 = ['c', 'd'];
['a', 'b'].concat(arr1, 'e') // ['a', 'b', 'c', 'd', 'e']

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

上面的代码说明，数组的Symbol.isConcatSpreadable属性默认为true，表示可以展开。

类似数组的对象也可以展开，但其Symbol.isConcatSpreadable属性默认为false，必须手动打开。

jscopied
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属性必须写成一个返回布尔值的方法。

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

Symbol.species

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

Symbol.species属性默认的读取器如下：

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

Symbol.match

对象的Symbol.match属性指向一个函数，当执行str.match(myObject)时，如果该属性存在，会调用它返回该方法的返回值。

jscopied
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.replcae方法调用时，会返回该方法的返回值。

Smobl.search

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

Symbol.split

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

Symbot.iterator

对象的Symbol.iterator属性指向其默认遍历器方法，即对象在进行for...of循环时会调用这个方法，返回该对象的默认遍历器。

Symbol.toPrimitive

对象的Symbol.toPrimitive属性指向一个方法，对象被转为原始类型的值时会调用这个方法，返回该对象对应的原始类型值。

Symbol.toPrimitive被调用时会接受一个字符串参数，表示当前运算的模式。一个有3种模式：

• Number：该场合需要转成数值。
• String：该场合需要转成字符串。
• Default：该场合可以转成字符串，也可以转成数值。

jscopied
let obj = {
  [Symbol.toPrimitive] (hint) {
    switch (hint) {
      case: 'number':
        return 123;
      case: 'string':
        return 'str';
      case: 'defalut':
        return 'defalut';
      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后面的字符串。

jscopied
({[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’
• %TypeArray%.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环境排除。

jscopied
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命令排除。

jscopied
// 没有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
}

以上，摘抄自阮一峰老师的《ES6标准入门》