Symbol · 前端筆記

[TOC] ## 概述 ES5 的對象屬性名都是字符串，這容易造成屬性名的沖突。比如，你使用了一個他人提供的對象，但又想為這個對象添加新的方法（mixin 模式），新方法的名字就有可能與現有方法產生沖突。 `Symbol()`函數會返回`symbol?`類型的值，該類型具有靜態屬性和靜態方法。它的靜態屬性會暴露幾個內建的成員對象；它的靜態方法會暴露全局的symbol注冊，且類似于內建對象類，但作為構造函數來說它并不完整，因為它不支持語法："new Symbol()"。每個從`Symbol()`返回的symbol值都是唯一的。一個symbol值能作為對象屬性的標識符；這是該數據類型僅有的目的。 symbol 是一種基本數據類型（primitive data type）。 ## 語法 > Symbol([description]) 參數 description 可選可選的，字符串。symbol的description可以用于調試，但無法訪問到symbol本身。 Symbol函數的參數只是表示對當前 Symbol 值的描述，因此相同參數的Symbol函數的返回值是不相等的。 ## 作為屬性名的 Symbol 由于每一個 Symbol 值都是不相等的，這意味著 Symbol 值可以作為標識符，用于對象的屬性名，就能保證不會出現同名的屬性。這對于一個對象由多個模塊構成的情況非常有用，能防止某一個鍵被不小心改寫或覆蓋。注意，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!" ~~~ ## 遍歷 Symbol 作為屬性名，該屬性不會出現在`for...in`、`for...of`循環中，也不會被`Object.keys()`、`Object.getOwnPropertyNames()`、`JSON.stringify()`返回。但是，它也不是私有屬性，有一個`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)] ~~~ 另一個新的 API，Reflect.ownKeys方法可以返回所有類型的鍵名，包括常規鍵名和 Symbol 鍵名。 ~~~ let obj = { [Symbol('my_key')]: 1, enum: 2, nonEnum: 3 }; Reflect.ownKeys(obj) // ["enum", "nonEnum", Symbol(my_key)] ~~~ ## 方法 ### Symbol.for(key) 使用給定的key搜索現有的symbol，如果找到則返回該symbol。否則將使用給定的key在全局symbol注冊表中創建一個新的symbol。 ~~~ let s1 = Symbol.for('foo'); let s2 = Symbol.for('foo'); s1 === s2 // true ~~~ `Symbol.for()`與`Symbol()`這兩種寫法，都會生成新的 Symbol。它們的區別是，前者會被登記在全局環境中供搜索，后者不會。`Symbol.for()`不會每次調用就返回一個新的 Symbol 類型的值，而是會先檢查給定的key是否已經存在，如果不存在才會新建一個值。比如，如果你調用`Symbol.for("cat")`30 次，每次都會返回同一個 Symbol 值，但是調用`Symbol("cat")`30 次，會返回 30 個不同的 Symbol 值。 ### Symbol.for() 從全局symbol注冊表中，為給定的symbol檢索一個共享的?symbol key。 ~~~ let s1 = Symbol.for("foo"); Symbol.keyFor(s1) // "foo" let s2 = Symbol("foo"); Symbol.keyFor(s2) // undefined ~~~ ## 內置的 Symbol 值除了定義自己使用的 Symbol 值以外，ES6 還提供了 11 個內置的 Symbol 值，指向語言內部使用的方法。 ### Symbol.hasInstance 對象的Symbol.hasInstance屬性，指向一個內部方法。當其他對象使用instanceof運算符，判斷是否為該對象的實例時，會調用這個方法。比如，foo instanceof Foo在語言內部，實際調用的是Foo[Symbol.hasInstance](foo)。 ### Symbol.isConcatSpreadable 對象的Symbol.isConcatSpreadable屬性等于一個布爾值，表示該對象用于Array.prototype.concat()時，是否可以展開。 ### Symbol.species 對象的Symbol.species屬性，指向一個構造函數。創建造衍生對象時，會使用該屬性。 ### Symbol.match 對象的Symbol.match屬性，指向一個函數。當執行str.match(myObject)時，如果該屬性存在，會調用它，返回該方法的返回值。 ### Symbol.replace 對象的Symbol.replace屬性，指向一個方法，當該對象被String.prototype.replace方法調用時，會返回該方法的返回值。 ### Symbol.search 對象的Symbol.search屬性，指向一個方法，當該對象被String.prototype.search方法調用時，會返回該方法的返回值。 ### Symbol.split 對象的Symbol.split屬性，指向一個方法，當該對象被String.prototype.split方法調用時，會返回該方法的返回值。 ### Symbol.iterator 對象的Symbol.iterator屬性，指向該對象的默認遍歷器方法。 ### Symbol.toPrimitive 對象的Symbol.toPrimitive屬性，指向一個方法。該對象被轉為原始類型的值時，會調用這個方法，返回該對象對應的原始類型值。 ### Symbol.toStringTag 對象的Symbol.toStringTag屬性，指向一個方法。在該對象上面調用Object.prototype.toString方法時，如果這個屬性存在，它的返回值會出現在toString方法返回的字符串之中，表示對象的類型。也就是說，這個屬性可以用來定制[object Object]或[object Array]中object后面的那個字符串。 ### Symbol.unscopables 對象的Symbol.unscopables屬性，指向一個對象。該對象指定了使用with關鍵字時，哪些屬性會被with環境排除。