詳解ES6 Symbol 的用途
Symbol 唯一的用途就是標(biāo)識對象屬性,表明對象支持的功能。 相比于字符屬性名,Symbol 的區(qū)別在于唯一,可避免名字沖突。 這樣 Symbol 就給出了唯一標(biāo)識類型信息的一種方式,從這個角度看有點(diǎn)類似 C++ 的 Traits。
解決了什么問題
在 JavaScript 中要判斷一個對象支持的功能,常常需要做一些 Duck Test。 比如經(jīng)常需要判斷一個對象是否可以按照數(shù)組的方式去迭代,這類對象稱為 Array-like。 lodash 中是這樣判斷的:
function isArrayLike(value) { return value != null && isLength(value.length) && !isFunction(value); }
在 ES6 中提出一個 @@iterator 方法,所有支持迭代的對象(比如 Array、Map、Set)都要實(shí)現(xiàn)。 @@iterator 方法的屬性鍵為 Symbol.iterator 而非字符串。 這樣只要對象定義有 Symbol.iterator 屬性就可以用 for ... of 進(jìn)行迭代。 比如:
if (Symbol.iterator in arr) { for(let n of arr) console.log(n) }
其他用例
上述例子中 Symbol 標(biāo)識了這個對象是可迭代的(Iterables),是一個典型的 Symbol 用例。 詳情可以參考 ES6 迭代器 一文。 此外利用 Symbol 還可以做很多其他事情,例如:
常量枚舉
JavaScript 沒有枚舉類型,常量概念也通常用字符串或數(shù)字表示。例如:
const COLOR_GREEN = 1 const COLOR_RED = 2 function isSafe(trafficLight) { if (trafficLight === COLOR_RED) return false if (trafficLight === COLOR_GREEN) return true throw new Error(`invalid trafficLight: ${trafficLight}`) }
- 我們需要認(rèn)真地排列這些常量的值。如果不小心有兩個值重復(fù)會很難調(diào)試,就像 #define false true 引起的問題一樣。
- 取值可能重復(fù)。如果有另一處定義了 BUSY = 1 并不小心把 BUSY 傳入,干脆 isSafe(1),理想的枚舉概念應(yīng)該拋出異常,但上述代碼無法檢測。
Symbol 給出了解決方案:
const COLOR_GREEN = Symbol('green') const COLOR_RED = Symbol('red')
即使字符串寫錯或重復(fù)也不重要,因?yàn)槊看握{(diào)用 Symbol() 都會給出獨(dú)一無二的值。 這樣就可以確保所有 isSafe() 調(diào)用都傳入這兩個 Symbol 之一。
私有屬性
由于沒有訪問限制,JavaScript 曾經(jīng)有一個慣例:私有屬性以下劃線起始來命名。 這樣不僅無法隱藏這些名字,而且會搞壞代碼風(fēng)格。 可以利用 Symbol 來隱藏這些私有屬性:
let speak = Symbol('speak') class Person { [speak]() { console.log('harttle') } }
如下幾種訪問都獲取不到 speak 屬性:
let p = new Person() Object.keys(p) // [] Object.getOwnPropertyNames(p) // [] for(let key in p) console.log(key) // <empty>
但 Symbol 只能隱藏這些函數(shù),并不能阻止未授權(quán)訪問。 仍然可以通過 Object.getOwnPerpertySymbols(), Reflect.ownKeys(p) 來枚舉到 speak 屬性。
新的基本類型
Symbol 是新的基本類型,從此 JavaScript 有 7 種類型:
- Number
- Boolean
- String
- undefined
- null
- Symbol
- Object
轉(zhuǎn)換為字符串
Symbol 支持 symbol.toString() 方法以及 String(symbol), 但不能通過 + 轉(zhuǎn)換為字符串,也不能直接用于模板字符串輸出。 后兩種情況都會產(chǎn)生 TypeError,是為了避免把它當(dāng)做字符串屬性名來使用。
轉(zhuǎn)換為數(shù)字
不可轉(zhuǎn)換為數(shù)字。Number(symbol) 或四則運(yùn)算都會產(chǎn)生 TypeError。
轉(zhuǎn)換為布爾
Boolean(symbol) 和取非運(yùn)算都 OK。這是為了方便判斷是否包含屬性。
包裹對象
Symbol 是基本類型,但不能用 new Symbol(sym) 來包裹成對象,需要使用 Object(sym)。 除了判等不成立外,包裹對象的使用與原基本類型幾乎相同:
let sym = Symbol('author') let obj = { [sym]: 'harttle' } let wrapped = Object(sym) wrapped instanceof Symbol // true,真的是true!!! obj[sym] // 'harttle' obj[wrapped] // 'harttle'
常見的 Symbol
文章最前面的例子提到的 Symbol.iterator 是一個內(nèi)置 Symbol。除此之外常見的內(nèi)置 Symbol 還有:
Symbol.match
Symbol.match 在 String.prototype.match() 中用于獲取 RegExp 對象的匹配方法。 我們來改寫一下 Symbol.match 標(biāo)識的方法,
觀察 String.prototype.match() 的表現(xiàn), 下面的例子來自 MDN:
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/@@match class RegExp1 extends RegExp { [Symbol.match](str) { var result = RegExp.prototype[Symbol.match].call(this, str); return result ? 'VALID' : 'INVALID'; } } console.log('2012-07-02'.match(new RegExp1('([0-9]+)-([0-9]+)-([0-9]+)'))); // expected output: "VALID" Symbol.toPrimitive
在對象進(jìn)行運(yùn)算時經(jīng)常會變成 "[object Object]", 這是對象轉(zhuǎn)換為字符串(基本數(shù)據(jù)類型)的默認(rèn)行為,定義在 Object.prototype.toString。 比如這個對象:
var count = { value: 3 }; count + 2 // "[object Object]2"
這個對象也在表示一個數(shù)字,怎么讓它可以參加四則運(yùn)算呢? 給它加一個 Symbol.toPrimitive 屬性,來改變它轉(zhuǎn)換為基本類型的行為:
count[Symbol.toPrimitive] = function () { return this.value }; count + 2 // 5
更多內(nèi)置 Symbol 請參考 MDN 文檔: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol#Well-known_symbols
跨 Realm 使用
JavaScript Realm 是指當(dāng)前代碼片段運(yùn)行的上下文,包括全局變量,比如 Array, Date 這些全局函數(shù)。 在打開新標(biāo)簽頁、 加載 iframe 或加載 Worker 進(jìn)程時,都會產(chǎn)生多個 JavaScript Realm。 跨 Realm 通信時這些全局變量是不同的,例如從 iframe 中傳遞給數(shù)組 arr 給父窗口, 父窗口中收到的 arr instanceof Array 為 false,因?yàn)樗脑褪?iframe 中的那個 Array。
但是一個對象在 iframe 中可以迭代(Iterable),那么在父窗口中也應(yīng)當(dāng)能被迭代。 這就要求 Symbol 可以跨 Realm,當(dāng)然 Symbol.iterator 可以。 如果你定義的 Symbol 也需要跨 Realm,請使用 Symbol Registry API:
// 在 Symbol Registry 中注冊一個跨 Realm Symbol let sym = Symbol.for('foo') // 獲取 Symbol 的鍵值字符串 Symbol.keyFor(sym) // 'foo'
內(nèi)置的跨 Realm Symbol 其實(shí)不在 Symbol Registry 中:
Symbol.keyFor(Symbol.iterator) // undefined
總結(jié)
以上所述是小編給大家介紹的ES6 Symbol 的用途,希望對大家有所幫助,如果大家有任何疑問歡迎給我留言,小編會及時回復(fù)大家的!
相關(guān)文章
echarts動態(tài)渲染柱狀圖背景顏色及頂部數(shù)值方法詳解
在使用echarts時,有時需要給柱狀圖設(shè)置背景,下面這篇文章主要給大家介紹了關(guān)于echarts動態(tài)渲染柱狀圖背景顏色及頂部數(shù)值的相關(guān)資料,文中通過圖文以及代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-11-11詳解JS實(shí)現(xiàn)簡單的時分秒倒計(jì)時代碼
這篇文章主要介紹了JS時分秒倒計(jì)時的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-04-04JS實(shí)現(xiàn)點(diǎn)餐自動選擇框(案例分析)
這篇文章主要介紹了JS實(shí)現(xiàn)點(diǎn)餐自動選擇框功能,點(diǎn)擊上方全選和全不選選擇框?qū)崿F(xiàn)對應(yīng)功能,本文分步驟通過實(shí)例代碼講解的非常詳細(xì),需要的朋友可以參考下2019-12-12通過javascript實(shí)現(xiàn)掃雷游戲代碼實(shí)例
這篇文章主要介紹了通過javascript實(shí)現(xiàn)掃雷游戲代碼實(shí)例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-02-02javascript addBookmark 加入收藏 多瀏覽器兼容
不錯的加入收藏代碼,加入了對一些常見瀏覽器的判斷,更好的體現(xiàn)用戶體驗(yàn),兼容了ie,firefox.2009-08-08