以前提到 JavaScript 原始數(shù)據(jù)類型時七兜,我們知道有Number
,String
钙蒙,Null
茵瀑,Boolean
,Undefined
這幾種躬厌。ES6 引入了新的基本數(shù)據(jù)類型Symbol
和BigInt
马昨。今天我們就來了解下Symbol
類型。Symbol
類型是為了解決屬性名沖突的問題扛施,順帶還具備模擬私有屬性的功能鸿捧。
簡介
創(chuàng)建symbol
變量最簡單的方法是用Symbol()
函數(shù)。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'
盡管調(diào)用Symbol()
讓它看起來像是對象昌阿,實際上symbol
是 JavaScript 原始數(shù)據(jù)類型饥脑。把Symbol
當(dāng)作構(gòu)造函數(shù)來用 new
會報錯恳邀。
const symbol1 = Symbol();
typeof symbol1; // 'symbol'
symbol1 instanceof Object; // false
// Throws "TypeError: Symbol is not a constructor"
new Symbol();
描述信息
Symbol()
函數(shù)只有一個參數(shù),字符串description
灶轰。這個字符串參數(shù)的唯一作用是輔助調(diào)試谣沸,也就是它的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()
創(chuàng)建的symbol
會添加到這個注冊中心伴澄,并用它的 description
作為索引鍵赋除。也就是說,如果你用Symbol.for()
創(chuàng)建帶有相同 description
的兩個 symbol
非凌,它們就是相等的举农。
const symbol1 = Symbol.for('test');
const symbol2 = Symbol.for('test');
symbol1 === symbol2; // true
console.log(symbol1); // 'Symbol(test)'
通常來說,除非你有非常好的理由敞嗡,否則不應(yīng)該使用全局注冊中心颁糟,因為這會造成命名沖突。
命名沖突
JavaScript 內(nèi)置了一個 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
,可迭代對象需要有一個字符串屬性名'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
的實例是可迭代對象障贸,可以遍歷對象上面的屬性。但是上面的類有個潛在的缺陷咏删,假設(shè)有個惡意用戶給 MyClass
構(gòu)造函數(shù)傳了一個帶有iterator
屬性的對象:
const obj = new MyClass({ iterator: 'not a function' });
這樣你在obj
上使用for/of
的話惹想,JavaScript 會拋出TypeError: obj is not iterable
異常《胶可以看出,傳入對象的 iterator
函數(shù)覆蓋了類的 iterator
屬性激挪。這有點類似原型污染的安全問題辰狡,無腦復(fù)制用戶數(shù)據(jù)會對一些特殊屬性,比如__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ù)不會跟內(nèi)置屬性沖突听诸。
私有屬性
由于任何兩個symbol
都是不相等的,在 JavaScript 里可以很方便地用來模擬私有屬性蚕泽。symbol
不會出現(xiàn)在 Object.keys()
的結(jié)果中晌梨,因此除非你明確地export
一個symbol
,或者用 Object.getOwnPropertySymbols()
函數(shù)獲取须妻,否則其他代碼無法訪問這個屬性仔蝌。
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
不會出現(xiàn)在JSON.stringify()
的結(jié)果里荒吏,確切地說是JSON.stringify()
會忽略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)部屬性用'$'
開頭。下次碰到需要定義私有屬性的時候动知,試試Symbol
類型吧皿伺!
看到這個頗有氣質(zhì)的 logo,不來關(guān)注下嗎盒粮?