Symbol 是 ES6 帶來的第七種原始型別,本文用實例說明它解決了什麼問題,以及相關的登記機制。
開發時最惱人的其中一件事,就是屬性名稱撞車——尤其是當你寫的程式要往別人的物件上掛東西時。Symbol 每次呼叫都會產生一個獨一無二的值,天生適合拿來當不會衝突的鍵。
let s1 = Symbol('a');
let s2 = Symbol('a');
console.log(s1); // Symbol(a)
console.log(typeof s1); // symbol
console.log(s1 == s2); // false,字串相同但值不同
var s1 = Symbol();
var s2 = Symbol();
var s3 = Symbol();
var obj = { [s1]: 'hi' };
obj[s2] = 'ES6';
Object.defineProperty(obj, s3, { value: 'ES2015' });
console.log(obj); // 三個 Symbol 鍵各自成立
console.log(obj.s1); // undefined
console.log(obj[s1]); // hi
console.log(obj['s1']); // undefined
要注意的是,Symbol 作為屬性名時不能用點運算子取值,必須用方括號搭配同一個 Symbol 變數。
另一個容易踩到的點:這類屬性不會出現在 for...in、for...of 迴圈裡,也不會被 Object.keys() 或 Object.getOwnPropertyNames() 回傳。若要取出它們,得改用 Object.getOwnPropertySymbols(),該方法會回傳一個陣列,成員是目前物件上所有被當作屬性名的 Symbol 值。
Symbol.for() 接受一個字串,先去全域登記表裡找有沒有同名稱的 Symbol,找到就直接回傳,找不到才新建。也就是說它保證「同名即同值」,代價是這個 Symbol 進了全域登記表,不會被垃圾回收。
Symbol.keyFor() 則反過來,傳入一個 Symbol 值,回傳它在登記表裡對應的字串鍵。
兩者必須搭配使用:Symbol() 產生的值從未登記,因此 Symbol.keyFor() 對它無能為力,只會得到 undefined。
let s1 = Symbol('a');
let s2 = Symbol('a');
let s3 = Symbol.for('b');
let s4 = Symbol.for('b');
console.log(s1 == s2); // false
console.log(s3 == s4); // true
console.log(Symbol.keyFor(s1)); // undefined
console.log(Symbol.keyFor(s3)); // "b"
實務上的判斷很簡單:需要跨模組共享、需要能被反查名稱時用 Symbol.for();只是單純想避免命名衝突,用 Symbol() 就好。