知乎上看到的一個問題:「ES6 中的 symbol 類型在實際開發中用得多嗎?」,以前在學習 ES6 時也有此疑問,這個 Symbol 是幹嘛的?有什麼應用場景?
Symbol 在實際開發中用的不多,在看一些類庫的實現時有看到相關使用,下面分享下關於 Symbol 的幾個使用場景。
做為私有屬性使用 Symbol 做為私有屬性,最早知道這個是在 Egg 源碼中學習到的,看一段相關的代碼片段:
//https://github.com/eggjs/egg/blob/3.0.0/lib/core/base_context_logger.js#L22constCALL=Symbol('BaseContextLogger#call');classBaseContextLogger{[CALL](method,args){//...this.ctx.logger[method](...args);}}在 JavaScript 中為了實現私有屬性,之前常用的一種方式是命名規範約定,方法名以 _開始。
Symbol 出現之後看到的一個相對較多的場景是用它來模式私有屬性、方法。這對一些 for...in、Object.getOwnPropertyNames() 操作是可以隱藏掉這些屬性,但是 ES6 中的 Symbol 和強類型語言中的 private 相比並不完全是私有的,仍然能通過 Object.getOwnPropertySymbols()、Reflect.ownKeys() 操作枚舉到這些屬性進行訪問。
鈎子函數 - 自定義格式輸出
使用 MongoDB Node.js 驅動程序生成一個 id,當執行 ObjectId()或 new ObjectId() 時總會按照固定格式輸出,如下所示:
newObjectId("632c6d93d65f74baeb22a2c9")沒了解實現之前,看起來總歸是有些神秘的,如果自己寫一個類並實現自定義輸出信息該怎麼做呢?帶着好奇之心看了下源碼實現:
//https://github.com/mongodb/js-bson/blob/v4.4.0/src/objectid.ts#L343classObjectId{toHexString():string{consthexString=this.id.toString('hex');returnhexString;}[Symbol.for('nodejs.util.inspect.custom')]():string{returnthis.inspect();}inspect():string{return`newObjectId("${this.toHexString()}")`;}}Symbol.for(str) 是新建一個以該字符串為名稱的值,並註冊到全局,如果已註冊過,就直接返回。與 Symbol() 區別簡單理解是,Symbol() 調用 100 次會返回 100 個不同 Symbol 值,Symbol.for(str) 調用 100 次返回的 Symbol 值都是相同的。
Node.js util 模塊實現了 util.inspect.custom 方法用於聲明自定義檢查函數,這裡個人理解更像一個鈎子函數,在 https://github.com/nodejs/node/issues/20821 PR 中已支持將 util.inspect.custom 做為公共符號,實現了不用加載 util 模塊就可在任何地方使用它,這裡用的就是 Symbol.for()。
面試官:實現一個可遍歷對象JavaScript 中的 Array、Set、Map 數據類型都可被 for...of 所遍歷。如果面試官說:「實現一個可以被 for...of 所遍歷的對象」 這個該怎麼實現呢?
Symbol 提供了 Symbol.iterator 方法,該方法返回一個迭代器對象,目前 Array、Set、Map 這些數據結構默認具有 Symbol.iterator 屬性,而對象 Object 是沒有的,如下所示:
console.log([][Symbol.iterator]());//Object[ArrayIterator]{}console.log((newMap())[Symbol.iterator]());//[MapEntries]{}console.log((newSet())[Symbol.iterator]());//[SetIterator]{}console.log({}[Symbol.iterator]);//undefinedSymbol.iterator 是迭代協議標準中的一部分:可迭代器協議,它定義了哪些值可以被遍歷到。要成為可迭代器對象,必須實現 @@iterator 方法,可通過常量 Symbol.iterator 訪問(到這裡是不是發現,原來常使用的 Array 類型竟和 Symbol 也有聯繫啊
迭代協議標準的另一部分是:迭代器協議 ,它定義了產生一系列值的的標準方式。通過定義 next() 方法實現,這裡不做詳細闡述,參見文檔。
了解了 Symbol.iterator 和迭代協議規則實現一個可被遍歷的對象並不難。
constrange={start:0,end:3,[Symbol.iterator]:function(){returnthis},next:function(){if(this.start>this.end){return{value:undefined,done:true}}return{value:this.start++,done:false}}}for(constidofrange){console.log(id);//0,1,2,3}除了 Symbol.iterator 還有 Symbol.asyncIterator,這個在 Node.js 後端中有一些使用場景。
Symbol 的詳細介紹,推薦兩個學習資源: