應用場景1:使用Symbol來作為對象屬性名(key)
在這之前,我們通常定義或訪問對象的屬性時都是使用字符串,比如下面的代碼:
let obj = { abc: 123, "hello": "world" } obj["abc"] // 123 obj["hello"] // 'world'
而現在,Symbol
可同樣用於對象屬性的定義和訪問:
const PROP_NAME = Symbol() const PROP_AGE = Symbol() let obj = { [PROP_NAME]: "一斤代碼" } obj[PROP_AGE] = 18 obj[PROP_NAME] // '一斤代碼' obj[PROP_AGE] // 18
隨之而來的是另一個非常值得注意的問題:就是當使用了Symbol作為對象的屬性key后,在對該對象進行key的枚舉時,會有什么不同?在實際應用中,我們經常會需要使用Object.keys()
或者for...in
來枚舉對象的屬性名,那在這方面,Symbol類型的key表現的會有什么不同之處呢?來看以下示例代碼:
let obj = { [Symbol('name')]: '一斤代碼', age: 18, title: 'Engineer' } Object.keys(obj) // ['age', 'title'] for (let p in obj) { console.log(p) // 分別會輸出:'age' 和 'title' } Object.getOwnPropertyNames(obj) // ['age', 'title']
由上代碼可知,Symbol類型的key是不能通過Object.keys()
或者for...in
來枚舉的,它未被包含在對象自身的屬性名集合(property names)之中。所以,利用該特性,我們可以把一些不需要對外操作和訪問的屬性使用Symbol來定義。
也正因為這樣一個特性,當使用JSON.stringify()
將對象轉換成JSON字符串的時候,Symbol屬性也會被排除在輸出內容之外:
JSON.stringify(obj) // {"age":18,"title":"Engineer"}
我們可以利用這一特點來更好的設計我們的數據對象,讓“對內操作”和“對外選擇性輸出”變得更加優雅。
然而,這樣的話,我們就沒辦法獲取以Symbol方式定義的對象屬性了么?非也。還是會有一些專門針對Symbol的API,比如:
// 使用Object的API Object.getOwnPropertySymbols(obj) // [Symbol(name)] // 使用新增的反射API Reflect.ownKeys(obj) // [Symbol(name), 'age', 'title']
應用場景2:使用Symbol來替代常量
先來看一下下面的代碼,是不是在你的代碼里經常會出現?
const TYPE_AUDIO = 'AUDIO' const TYPE_VIDEO = 'VIDEO' const TYPE_IMAGE = 'IMAGE' function handleFileResource(resource) { switch(resource.type) { case TYPE_AUDIO: playAudio(resource) break case TYPE_VIDEO: playVideo(resource) break case TYPE_IMAGE: previewImage(resource) break default: throw new Error('Unknown type of resource') } }
如上面的代碼中那樣,我們經常定義一組常量來代表一種業務邏輯下的幾個不同類型,我們通常希望這幾個常量之間是唯一的關系,為了保證這一點,我們需要為常量賦一個唯一的值(比如這里的'AUDIO'、'VIDEO'、 'IMAGE'),常量少的時候還算好,但是常量一多,你可能還得花點腦子好好為他們取個好點的名字。
現在有了Symbol
,我們大可不必這么麻煩了:
const TYPE_AUDIO = Symbol() const TYPE_VIDEO = Symbol() const TYPE_IMAGE = Symbol()
這樣定義,直接就保證了三個常量的值是唯一的了!是不是挺方便的呢。
應用場景3:使用Symbol定義類的私有屬性/方法
我們知道在JavaScript中,是沒有如Java等面向對象語言的訪問控制關鍵字private
的,類上所有定義的屬性或方法都是可公開訪問的。因此這對我們進行API的設計時造成了一些困擾。
而有了Symbol
以及模塊化機制
,類的私有屬性和方法才變成可能。例如:
- 在文件 a.js中
const PASSWORD = Symbol() class Login { constructor(username, password) { this.username = username this[PASSWORD] = password } checkPassword(pwd) { return this[PASSWORD] === pwd } } export default Login
- 在文件 b.js 中
import Login from './a' const login = new Login('admin', '123456') login.checkPassword('123456') // true login.PASSWORD // oh!no! login[PASSWORD] // oh!no! login["PASSWORD"] // oh!no!
由於Symbol常量PASSWORD
被定義在a.js所在的模塊中,外面的模塊獲取不到這個Symbol,也不可能再創建一個一模一樣的Symbol出來(因為Symbol是唯一的),因此這個PASSWORD
的Symbol只能被限制在a.js內部使用,所以使用它來定義的類屬性是沒有辦法被模塊外訪問到的,達到了一個私有化的效果。