Symbol

概述

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 的引數是一個物件，就會呼叫該物件的toString方法，將其轉為字串，然後才生成一個 Symbol 值。

const obj = {
  toString() {
    return 'abc';
  }
};
const sym = Symbol(obj);
sym // Symbol(abc)

注意，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()、JSON.stringify()返回。但是，它也不是私有屬性，有一個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)
//  ["enum", "nonEnum", Symbol(my_key)]

由於以 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]不會被無意間覆蓋，但還是可以被改寫。

var a = require('./mod.js');
global[Symbol.for('foo')] = 123;

如果鍵名使用Symbol方法生成，那麼外部將無法引用這個值，當然也就無法改寫。

// mod.js
const FOO_KEY = Symbol('foo');

// 後面程式碼相同 ……

上面程式碼將導致其他指令碼都無法引用FOO_KEY。但這樣也有一個問題，就是如果多次執行這個指令碼，每次得到的FOO_KEY都是不一樣的。雖然Node會將指令碼的執行結果快取，一般情況下，不會多次執行同一個指令碼，但是使用者可以手動清除快取，所以也不是完全可靠。

內建的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屬性，指向當前物件的建構函式。創造實例時，預設會呼叫這個方法，即使用這個屬性返回的函式當作建構函式，來創造新的實例物件。

class MyArray extends Array {
  // 覆蓋父類 Array 的建構函式
  static get [Symbol.species]() { return Array; }
}

上面程式碼中，子類MyArray繼承了父類Array。建立MyArray的實例物件時，本來會呼叫它自己的建構函式（本例中被省略了），但是由於定義了Symbol.species屬性，所以會使用這個屬性返回的的函式，建立MyArray的實例。

這個例子也說明，定義Symbol.species屬性要採用get讀取器。預設的Symbol.species屬性等同於下面的寫法。

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

下面是一個例子。

class MyArray extends Array {
  static get [Symbol.species]() { return Array; }
}
var a = new MyArray(1,2,3);
var mapped = a.map(x => x * x);

mapped instanceof MyArray // false
mapped instanceof Array // true

上面程式碼中，由於建構函式被替換成了Array。所以，mapped物件不是MyArray的實例，而是Array的實例。

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) {
    var 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屬性，指向該物件的預設遍歷器方法。

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,
//   includes: true,
//   keys: true
// }

Object.keys(Array.prototype[Symbol.unscopables])
// ['copyWithin', 'entries', 'fill', 'find', 'findIndex', 'includes', 'keys']

上面程式碼說明，陣列有7個屬性，會被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
}

上面程式碼通過指定Symbol.unscopables屬性，使得with語法塊不會在當前作用域尋找foo屬性，即foo將指向外層作用域的變數。