面試官：JavaScript 原始數據類型 Symbol 有什麼用？
- 2020 年 4 月 9 日
- 筆記
以前提到 JavaScript 原始數據類型時，我們知道有Number，String，Null，Boolean，Undefined這幾種。ES6 引入了新的基本數據類型Symbol和BigInt。今天我們就來了解下Symbol類型。Symbol類型是為了解決屬性名衝突的問題，順帶還具備模擬私有屬性的功能。
簡介
創建symbol變數最簡單的方法是用Symbol()函數。sysmbol變數有兩點比較特別：
- 它可以作為對象屬性名。只有字元串和
symbol類型才能用作對象屬性名。 - 沒有兩個
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類型吧！
