簡介

創(chuàng)建symbol變量最簡單的方法是用Symbol()函數(shù)。sysmbol變量有兩點(diǎn)比較特別：

1.它可以作為對象屬性名。只有字符串和 symbol 類型才能用作對象屬性名。

2.沒有兩個(gè)symbol 的值是相等的。

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

symbol1 === symbol2; // false

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

obj[symbol1]; // 'Hello'
obj[symbol2]; // 'World'

盡管調(diào)用Symbol()讓它看起來像是對象，實(shí)際上symbol是 JavaScript 原始數(shù)據(jù)類型。把Symbol當(dāng)作構(gòu)造函數(shù)來用new會(huì)報(bào)錯(cuò)。

const symbol1 = Symbol();

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

// Throws "TypeError: Symbol is not a constructor"
new Symbol();

描述信息

Symbol()函數(shù)只有一個(gè)參數(shù)，字符串description。這個(gè)字符串參數(shù)的唯一作用是輔助調(diào)試，也就是它的toString()值。但是請注意，兩個(gè)具有相同description的symbol也是不相等的。

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

symbol1 === symbol2; // false
console.log(symbol1); // 'Symbol(my symbol)'

有一個(gè)全局的symbol注冊中心，用Symbol.for()創(chuàng)建的symbol會(huì)添加到這個(gè)注冊中心，并用它的description作為索引鍵。也就是說，如果你用Symbol.for()創(chuàng)建帶有相同description的兩個(gè) symbol，它們就是相等的。

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

symbol1 === symbol2; // true
console.log(symbol1); // 'Symbol(test)'

通常來說，除非你有非常好的理由，否則不應(yīng)該使用全局注冊中心，因?yàn)檫@會(huì)造成命名沖突。

命名沖突

JavaScript 內(nèi)置了一個(gè) symbol ，那就是 ES6 中的Symbol.iterator。擁有Symbol.iterator函數(shù)的對象被稱為可迭代對象，就是說你可以在對象上使用for/of循環(huán)。

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而不是字符串？假設(shè)不用Symbol.iterator，可迭代對象需要有一個(gè)字符串屬性名'iterator'，就像下面這個(gè)可迭代對象的類：

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的實(shí)例是可迭代對象，可以遍歷對象上面的屬性。但是上面的類有個(gè)潛在的缺陷，假設(shè)有個(gè)惡意用戶給MyClass構(gòu)造函數(shù)傳了一個(gè)帶有iterator屬性的對象：

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

這樣你在obj上使用for/of的話，JavaScript 會(huì)拋出TypeError: obj is not iterable異常?？梢钥闯觯瑐魅雽ο蟮膇terator函數(shù)覆蓋了類的iterator屬性。這有點(diǎn)類似原型污染的安全問題，無腦復(fù)制用戶數(shù)據(jù)會(huì)對一些特殊屬性，比如__proto__和constructor帶來問題。

這里的核心在于，symbol讓對象的內(nèi)部數(shù)據(jù)和用戶數(shù)據(jù)井水不犯河水。由于sysmbol無法在 JSON 里表示，因此不用擔(dān)心給 Express API 傳入帶有不合適的Symbol.iterator屬性的數(shù)據(jù)。另外，對于那種混合了內(nèi)置函數(shù)和用戶數(shù)據(jù)的對象，比如Mongoose model，你可以用symbol來確保用戶數(shù)據(jù)不會(huì)跟內(nèi)置屬性沖突。

私有屬性

由于任何兩個(gè)symbol都是不相等的，在 JavaScript 里可以很方便地用來模擬私有屬性。symbol不會(huì)出現(xiàn)在Object.keys()的結(jié)果中，因此除非你明確地export一個(gè)symbol，或者用Object.getOwnPropertySymbols()函數(shù)獲取，否則其他代碼無法訪問這個(gè)屬性。

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

const obj = getObj();

Object.keys(obj); // []

// 除非有這個(gè) symbol 的引用，否則無法訪問該屬性
obj[Symbol('test')]; // undefined

// 用 getOwnPropertySymbols() 依然可以拿到 symbol 的引用
const [symbol] = Object.getOwnPropertySymbols(obj);
obj[symbol]; // 'test'

還有一個(gè)原因是symbol不會(huì)出現(xiàn)在JSON.stringify()的結(jié)果里，確切地說是JSON.stringify()會(huì)忽略symbol屬性名和屬性值：

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

JSON.stringify(obj); // "{}"

總結(jié)

用 Symbol 表示對象內(nèi)部狀態(tài)，可以很好地隔離用戶數(shù)據(jù)和程序狀態(tài)。有了它，我們就不再需要某些命名約定了，比如內(nèi)部屬性用'$'開頭。下次碰到需要定義私有屬性的時(shí)候，試試Symbol類型吧！

以上就是詳解JavaScript原始數(shù)據(jù)類型Symbol的詳細(xì)內(nèi)容，更多關(guān)于JavaScript原始數(shù)據(jù)類型Symbo的資料請關(guān)注腳本之家其它相關(guān)文章！