Symbol類型的應用

應用場景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內部使用，因此使用它來定義的類屬性是沒有辦法被模塊外訪問到的，達到了一個私有化的效果。