面試官：JavaScript 原始數據類型 Symbol 有什麼用？

之前提到 JavaScript 原始數據類型時，咱們知道有Number，String，Null，Boolean，Undefined這幾種。ES6 引入了新的基本數據類型Symbol和BigInt。今天咱們就來了解下Symbol類型。Symbol類型是爲了解決屬性名衝突的問題，順帶還具有模擬私有屬性的功能。

簡介

建立symbol變量最簡單的方法是用Symbol()函數。sysmbol變量有兩點比較特別：

1. 它能夠做爲對象屬性名。只有字符串和 symbol 類型才能用做對象屬性名。
2. 沒有兩個symbol 的值是相等的。

const symbol1 = Symbol();
const symbol2 = Symbol();

symbol1 === symbol2; // false

const obj = {};
obj[symbol1] = 'Hello';
obj[symbol2] = 'World';

obj[symbol1]; // 'Hello'
obj[symbol2]; // 'World'
複製代碼

儘管調用Symbol() 讓它看起來像是對象，實際上symbol是 JavaScript 原始數據類型。把Symbol看成構造函數來用 new會報錯。

const symbol1 = Symbol();

typeof symbol1; // 'symbol'
symbol1 instanceof Object; // false

// Throws "TypeError: Symbol is not a constructor"
new Symbol();
複製代碼

描述信息

Symbol()函數只有一個參數，字符串description。這個字符串參數的惟一做用是輔助調試，也就是它的toString()值。可是請注意，兩個具備相同description的symbol也是不相等的。

const symbol1 = Symbol('my symbol');
const symbol2 = Symbol('my symbol');

symbol1 === symbol2; // false
console.log(symbol1); // 'Symbol(my symbol)'
複製代碼

有一個全局的symbol註冊中心，用Symbol.for()建立的symbol會添加到這個註冊中心，並用它的 description做爲索引鍵。也就是說，若是你用Symbol.for()建立帶有相同 description的兩個 symbol，它們就是相等的。

const symbol1 = Symbol.for('test');
const symbol2 = Symbol.for('test');

symbol1 === symbol2; // true
console.log(symbol1); // 'Symbol(test)'
複製代碼

一般來講，除非你有很是好的理由，不然不該該使用全局註冊中心，由於這會形成命名衝突。

命名衝突

JavaScript 內置了一個 symbol ，那就是 ES6 中的Symbol.iterator  。擁有Symbol.iterator函數的對象被稱爲可迭代對象，就是說你能夠在對象上使用for/of 循環。

const fibonacci = {
  [Symbol.iterator]: function*() {
    let a = 1;
    let b = 1;
    let temp;

    yield b;

    while (true) {
      temp = a;
      a = a + b;
      b = temp;
      yield b;
    }
  }
};

// Prints every Fibonacci number less than 100
for (const x of fibonacci) {
  if (x >= 100) {
    break;
  }
  console.log(x);
}
複製代碼

爲何這裏要用Symbol.iterator 而不是字符串？假設不用Symbol.iterator ，可迭代對象須要有一個字符串屬性名'iterator'，就像下面這個可迭代對象的類：

class MyClass {
  constructor(obj) {
    Object.assign(this, obj);
  }

  iterator() {
    const keys = Object.keys(this);
    let i = 0;
    return (function*() {
      if (i >= keys.length) {
        return;
      }
      yield keys[i++];
    })();
  }
}
複製代碼

MyClass 的實例是可迭代對象，能夠遍歷對象上面的屬性。可是上面的類有個潛在的缺陷，假設有個惡意用戶給 MyClass 構造函數傳了一個帶有iterator屬性的對象：

const obj = new MyClass({ iterator: 'not a function' });
複製代碼

這樣你在obj上使用for/of的話，JavaScript 會拋出TypeError: obj is not iterable異常。能夠看出，傳入對象的 iterator函數覆蓋了類的 iterator屬性。這有點相似原型污染的安全問題，無腦複製用戶數據會對一些特殊屬性，好比__proto__和constructor帶來問題。

這裏的核心在於，symbol讓對象的內部數據和用戶數據井水不犯河水。因爲sysmbol沒法在 JSON 裏表示，所以不用擔憂給 Express API 傳入帶有不合適的Symbol.iterator屬性的數據。另外，對於那種混合了內置函數和用戶數據的對象，好比 Mongoose model，你能夠用symbol來確保用戶數據不會跟內置屬性衝突。

私有屬性

因爲任何兩個symbol都是不相等的，在 JavaScript 裏能夠很方便地用來模擬私有屬性。symbol不會出如今 Object.keys()的結果中，所以除非你明確地export 一個symbol，或者用 Object.getOwnPropertySymbols() 函數獲取，不然其餘代碼沒法訪問這個屬性。

function getObj() {
  const symbol = Symbol('test');
  const obj = {};
  obj[symbol] = 'test';
  return obj;
}

const obj = getObj();

Object.keys(obj); // []

// 除非有這個 symbol 的引用，不然沒法訪問該屬性
obj[Symbol('test')]; // undefined

// 用 getOwnPropertySymbols() 依然能夠拿到 symbol 的引用
const [symbol] = Object.getOwnPropertySymbols(obj);
obj[symbol]; // 'test'
複製代碼

還有一個緣由是symbol不會出如今JSON.stringify()的結果裏，確切地說是JSON.stringify()會忽略symbol屬性名和屬性值：

const symbol = Symbol('test');
const obj = { [symbol]: 'test', test: symbol };

JSON.stringify(obj); // "{}"
複製代碼

總結

用 Symbol 表示對象內部狀態，能夠很好地隔離用戶數據和程序狀態。有了它，咱們就再也不須要某些命名約定了，好比內部屬性用'$'開頭。下次碰到須要定義私有屬性的時候，試試Symbol類型吧！

看到這個很有氣質的 logo，不來關注下嗎？