天天看點

了解和使用ES6中的Symbol

ES6中引入了一種新的基礎資料類型:

Symbol

,不過很多開發者可能都不怎麼了解它,或者覺得在實際的開發工作中并沒有什麼場景應用到它,那麼今天我們來講講這個資料類型,并看看我們怎麼來利用它來改進一下我們的代碼。

這是一種新的基礎資料類型(primitive type)

Symbol

是由ES6規範引入的一項新特性,它的功能類似于一種辨別唯一性的ID。通常情況下,我們可以通過調用

Symbol()

函數來建立一個Symbol執行個體:

let s1 = Symbol()
           

或者,你也可以在調用

Symbol()

函數時傳入一個可選的字元串參數,相當于給你建立的Symbol執行個體一個描述資訊:

let s2 = Symbol('another symbol')
           

如果用當下比較流行的TypeScript的方式來描述這個

Symbol()

函數的話,可以表示成:

/**
 * @param  {any} description 描述資訊。可以是任何可以被轉型成字元串的值,如:字元串、數字、對象、數組等
 */
function Symbol(description?: any): symbol
           

由于

Symbol

是一種基礎資料類型,是以當我們使用

typeof

去檢查它的類型的時候,它會傳回一個屬于自己的類型

symbol

,而不是什麼

string

object

之類的:

typeof s1  // 'symbol'
           

另外,我們需要重點記住的一點是:每個Symbol執行個體都是唯一的。是以,當你比較兩個Symbol執行個體的時候,将總會傳回

false

let s1 = Symbol()
let s2 = Symbol('another symbol')
let s3 = Symbol('another symbol')

s1 === s2 // false
s2 === s3 // false
           

應用場景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('admin')  // true

login.PASSWORD  // oh!no!
login[PASSWORD] // oh!no!
login["PASSWORD"] // oh!no!
           

由于Symbol常量

PASSWORD

被定義在a.js所在的子產品中,外面的子產品擷取不到這個Symbol,也不可能再建立一個一模一樣的Symbol出來(因為Symbol是唯一的),是以這個

PASSWORD

的Symbol隻能被限制在a.js内部使用,是以使用它來定義的類屬性是沒有辦法被子產品外通路到的,達到了一個私有化的效果。

注冊和擷取全局Symbol

通常情況下,我們在一個浏覽器視窗中(window),使用

Symbol()

函數來定義和Symbol執行個體就足夠了。但是,如果你的應用涉及到多個window(最典型的就是頁面中使用了

<iframe>

),并需要這些window中使用的某些Symbol是同一個,那就不能使用

Symbol()

函數了,因為用它在不同window中建立的Symbol執行個體總是唯一的,而我們需要的是在所有這些window環境下保持一個共享的Symbol。這種情況下,我們就需要使用另一個API來建立或擷取Symbol,那就是

Symbol.for()

,它可以注冊或擷取一個window間全局的Symbol執行個體:

let gs1 = Symbol.for('global_symbol_1')  //注冊一個全局Symbol
let gs2 = Symbol.for('global_symbol_1')  //擷取全局Symbol

gs1 === gs2  // true
           

這樣一個Symbol不光在單個window中是唯一的,在多個相關window間也是唯一的了。

好了,通過以上這些例子,你現在是不是開始對ES6的這個Symbol功能有點了解了呢?Symbol在JS内部也有很多應用,比如疊代器(Iterator)等,大家可以以此為出發點,發掘出更多相關知識點,深入的了解Symbol的用法和使用場景。