背景

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] // undefineda['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 值，可以在主頁面得到。

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持武林網。