es6 symbol

南果梨發表於2019-04-01
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 例項的描述，主要是為了在控制檯顯示，或者轉為字串時，比較容易區分。

let s1 = Symbol('foo');
let 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函式的返回值是不相等的。

// 沒有引數的情況
let s1 = Symbol();
let s2 = Symbol();

s1 === s2 // false

// 有引數的情況
let s1 = Symbol('foo');
let s2 = Symbol('foo');

s1 === s2 // false
複製程式碼

上面程式碼中，s1和s2都是Symbol函式的返回值，而且引數相同，但是它們是不相等的。

Symbol 值不能與其他型別的值進行運算，會報錯。

let 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

由於每一個 Symbol 值都是不相等的，這意味著 Symbol 值可以作為識別符號，用於物件的屬性名，就能保證不會出現同名的屬性。這對於一個物件由多個模組構成的情況非常有用，能防止某一個鍵被不小心改寫或覆蓋。

let mySymbol = Symbol();

// 第一種寫法
let a = {};
a[mySymbol] = 'Hello!';

// 第二種寫法
let a = {
  [mySymbol]: 'Hello!'
};

// 第三種寫法
let a = {};
Object.defineProperty(a, mySymbol, { value: 'Hello!' });

// 以上寫法都得到同樣結果
a[mySymbol] // "Hello!"
複製程式碼

上面程式碼通過方括號結構和Object.defineProperty，將物件的屬性名指定為一個 Symbol 值。

注意，Symbol 值作為物件屬性名時，不能用點運算子。

const mySymbol = Symbol();
const 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 型別還可以用於定義一組常量，保證這組常量的值都是不相等的。

const log = {};

log.levels = {
  DEBUG: Symbol('debug'),
  INFO: Symbol('info'),
  WARN: Symbol('warn')
};
console.log(log.levels.DEBUG, 'debug message');
console.log(log.levels.INFO, 'info message');
複製程式碼

3例項：消除魔術字串

魔術字串指的是，在程式碼之中多次出現、與程式碼形成強耦合的某一個具體的字串或者數值。風格良好的程式碼，應該儘量消除魔術字串，改由含義清晰的變數代替。

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

  switch (shape) {
    case 'Triangle': // 魔術字串
      area = .5 * options.width * options.height;
      break;
    /* ... more code ... */
  }

  return area;
}

getArea('Triangle', { width: 100, height: 100 }); // 魔術字串
複製程式碼

上面程式碼中，字串Triangle就是一個魔術字串。它多次出現，與程式碼形成“強耦合”，不利於將來的修改和維護。

常用的消除魔術字串的方法，就是把它寫成一個變數。

const shapeType = {
  triangle: 'Triangle'
};

function getArea(shape, options) {
  let 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()
};
複製程式碼

4屬性名的遍歷

Symbol 作為屬性名，該屬性不會出現在for...in、for...of迴圈中，也不會被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。但是，它也不是私有屬性，有一個Object.getOwnPropertySymbols方法，可以獲取指定物件的所有 Symbol 屬性名。

Object.getOwnPropertySymbols方法返回一個陣列，成員是當前物件的所有用作屬性名的 Symbol 值。

const obj = {};
let a = Symbol('a');
let b = Symbol('b');

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

const objectSymbols = Object.getOwnPropertySymbols(obj);

objectSymbols
// [Symbol(a), Symbol(b)]

複製程式碼

下面是另一個例子，Object.getOwnPropertySymbols方法與for...in迴圈、Object.getOwnPropertyNames方法進行對比的例子。

const obj = {};

let foo = Symbol("foo");

Object.defineProperty(obj, foo, {
  value: "foobar",
});

for (let 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)]
複製程式碼

5 Symbol.for()，Symbol.keyFor()

有時，我們希望重新使用同一個 Symbol 值，Symbol.for方法可以做到這一點。它接受一個字串作為引數，然後搜尋有沒有以該引數作為名稱的 Symbol 值。如果有，就返回這個 Symbol 值，否則就新建並返回一個以該字串為名稱的 Symbol 值。

let s1 = Symbol.for('foo');
let 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.keyFor方法返回一個已登記的 Symbol 型別值的key。

let s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"

let 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 值，可以在主頁面得到。

相關文章