從零到有模擬實現一個Set類

時間 2019-11-05

標籤到有模擬實現一個 set 简体版

原文原文鏈接

前言

es6新增了Set數據結構，它容許你存儲任何類型的惟一值，不管是原始值仍是對象引用。這篇文章但願經過模擬實現一個Set來增長對它的理解。

用在前面

實際工做和學習過程當中，你可能也常常用Set來對數組作去重處理

let unique = (array) => {
  return [ ...new Set(array) ]
}

console.log(unique([ 1, 2, 3, 4, 1, 2, 5 ])) // [1, 2, 3, 4, 5]

基本語法

如下內容基本出自MDN,這裏寫出來，純粹是爲了便於後面的模擬操做。若是你已經很熟悉了，能夠直接略過。

new Set([ iterable ])

能夠傳遞一個可迭代對象，它的全部元素將被添加到新的 Set中。若是不指定此參數或其值爲null，則新的 Set爲空。vue

let s = new Set([ 1, 2, 3 ]) // Set(3) {1, 2, 3}
let s2 = new Set() // Set(0) {}
let s3 = new Set(null /* or undefined */) // Set(0) {}

實例屬性和方法

屬性java

constructor Set的構造函數node

size Set 長度git

操做方法es6

Set.prototype.add(value)

在Set對象尾部添加一個元素。返回該Set對象。github

Set.prototype.has(value)

返回一個布爾值，表示該值在Set中存在與否。vuex

Set.prototype.delete(value)

移除Set中與這個值相等的元素，返回Set.prototype.has(value)在這個操做前會返回的值（即若是該元素存在，返回true，不然返回false）數組

Set.prototype.clear()

移除Set對象內的全部元素。沒有返回值數據結構

栗子

let s = new Set()

s.add(1) // Set(1) {1}
  .add(2) // Set(2) {1, 2}
  .add(NaN) // Set(2) {1, 2, NaN}
  .add(NaN) // Set(2) {1, 2, NaN}

// 注意這裏由於添加完元素以後返回的是該Set對象，因此能夠鏈式調用
// NaN === NaN 結果是false，可是Set中只會存一個NaN

s.has(1) // true
s.has(NaN) // true

s.size // 3

s.delete(1)
s.has(1) // false
s.size // 2

s.clear()

s // Set(0) {}

遍歷方法

Set.prototype.keys()

返回一個新的迭代器對象，該對象包含Set對象中的按插入順序排列的全部元素的值。

Set.prototype.values()

返回一個新的迭代器對象，該對象包含Set對象中的按插入順序排列的全部元素的值。

Set.prototype.entries()

返回一個新的迭代器對象，該對象包含Set對象中的按插入順序排列的全部元素的值的[value, value]數組。爲了使這個方法和Map對象保持類似，每一個值的鍵和值相等。

Set.prototype.forEach(callbackFn[, thisArg])

按照插入順序，爲Set對象中的每個值調用一次callBackFn。若是提供了thisArg參數，回調中的this會是這個參數。

栗子

let s = new Set([ 's', 'e', 't' ])

s // SetIterator {"s", "e", "t"}
s.keys() // SetIterator {"s", "e", "t"}
s.values() // SetIterator {"s", "e", "t"}
s.entries() // SetIterator {"s", "e", "t"}

// log
[ ...s ] // ["s", "e", "t"]
[ ...s.keys() ] //  ["s", "e", "t"]
[ ...s.values() ] //  ["s", "e", "t"]
[ ...s.entries() ] //  [["s", "s"], ["e", "e"], ["t", "t"]]

s.forEach(function (value, key, set) {
  console.log(value, key, set, this)
})

// s s Set(3) {"s", "e", "t"} Window
// e e Set(3) {"s", "e", "t"} Window
// t t Set(3) {"s", "e", "t"} Window

s.forEach(function () {
  console.log(this)
}, { name: 'qianlongo' })

// {name: "qianlongo"}
// {name: "qianlongo"}
// {name: "qianlongo"}

for (let value of s) {
  console.log(value)
}
// s
// e
// t

for (let value of s.entries()) {
  console.log(value)
}
// ["s", "s"]
// ["e", "e"]
// ["t", "t"]

總體結構

以上回顧了一下Set的基本使用，咱們能夠開始嘗試模擬實現一把啦。你也能夠直接點擊查看源碼。

目錄結構

├──set-polyfill
│ ├──iterator.js // 導出一個構造函數Iterator,模擬建立可迭代對象
│ ├──set.js // Set類
│ ├──utils.js // 輔助函數
│ ├──test.js // 測試

Set總體框架

class Set {

  constructor (iterable) {}

  get size () {}

  has () {}

  add () {}

  delete () {}  

  clear () {}

  forEach () {}

  keys () {}

  values () {}  

  entries () {}

  [ Symbol.iterator ] () {}
}

輔助方法

開始實現Set細節前，咱們先看一下會用到的一些輔助方法

assert, 這個方法是學習vuex源碼時候看到的，感受蠻實用的，主要用來對某些條件進行判斷，拋出錯誤。

const assert = (condition, msg) => {
  if (!condition) throw new Error(msg)
}

isDef, 過濾掉null和undefined

const isDef = (value) => {
  return value != void 0
}

isIterable, 簡單判斷value是不是迭代器對象.

const isIterable = (value) => {
  return isDef(value) && typeof value[ Symbol.iterator ] === 'function'
}

forOf, 模擬for of行爲, 對迭代器對象進行遍歷操做。

const forOf = (iterable, callback, ctx) => {
  let result

  iterable = iterable[ Symbol.iterator ]()
  result = iterable.next()

  while (!result.done) {
    callback.call(ctx, result.value)
    result = iterable.next()
  }
}

源碼實現

class Set {
  constructor (iterable) {
    // 使用數組來存儲Set的每一項元素
    this.value = []
    // 判斷是否使用new調用
    assert(this instanceof Set, 'Constructor Set requires "new"')
    // 過濾掉null和undefined
    if (isDef(iterable)) {
      // 是可迭代對象才進行下一步forOf元素添加
      assert(isIterable(iterable), `${iterable} is not iterable`)
      // 循環可迭代對象，初始化
      forOf(iterable, (value) => {
        this.add(value)
      })
    }
  }
  // 獲取s.size時候會調用 size函數，返回value數組的長度
  // https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Functions/get
  get size () {
    return this.value.length
  }
  // 使用數組的includes方法判斷是否包含value
  // https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Array/includes
  // [ NaN ].includes(NaN)會返回true，正好Set也只能存一個NaN
  has (value) {
    return this.value.includes(value)
  }
  // 經過has方法判斷value是否存在，不存在則添加進數組，最後返回Set自己，支持鏈式調用
  add (value) {
    if (!this.has(value)) {
      this.value.push(value)
    }

    return this
  }
  // 在刪除以前先判斷value是否存在用之當作返回值,存在則經過splice方法移除
  delete (value) {
    let result = this.has(value)

    if (result) {
      this.value.splice(this.value.indexOf(value), 1)
    }

    return result
  }
  // 從新賦值一個空數組，即實現clear方法
  clear () {
    this.value = []
  }
  // 經過forOf遍歷 values返回的迭代對象，實現forEach
  forEach (callback, thisArg) {
    forOf(this.values(), (value) => {
      callback.call(thisArg, value, value, this)
    })
  }
  // 返回一個迭代對象，該對象中的值是Set中的value
  keys () {
    return new Iterator(this.value)
  }
  // 同keys
  values () {
    return this.keys()
  }
  // 返回一個迭代對象，不一樣keys和values的是其值是[value, value]
  entries () {
    return new Iterator(this.value, (value) => [ value, value ])
  }
  // 返回一個新的迭代器對象，該對象包含Set對象中的按插入順序排列的全部元素的值。
  [ Symbol.iterator ] () {
    return this.values()
  }
}

測試一把

執行 node test.js

size屬性和操做方法

const Set = require('./set')
const s = new Set()

s.add(1)
  .add(2)
  .add(NaN)
  .add(NaN)

console.log(s)  // Set { value: [ 1, 2, NaN ] }
console.log(s.has(1)) // true
console.log(s.has(NaN)) // true
console.log(s.size) // 3

s.delete(1)

console.log(s.has(1)) // false
console.log(s.size) // 2

s.clear()

console.log(s) // Set { value: [] }

上面的例子把Set的size屬性和操做方法過了一遍，打印出來的Set實例和原生的長得不太同樣，就先無論了。

遍歷方法

let s2 = new Set([ 's', 'e', 't' ])

console.log(s2) // Set { value: [ 's', 'e', 't' ] }
console.log(s2.keys()) // Iterator {}
console.log(s2.values()) //  Iterator {}
console.log(s2.entries()) //  Iterator {}

console.log([ ...s2 ]) // [ 's', 'e', 't' ]
console.log([ ...s2.keys() ]) // [ 's', 'e', 't' ]
console.log([ ...s2.values() ]) // [ 's', 'e', 't' ]
console.log([ ...s2.entries() ]) // [ [ 's', 's' ], [ 'e', 'e' ], [ 't', 't' ] ]

s2.forEach(function (value, key, set) {
  console.log(value, key, set, this)
})

// s s Set { value: [ 's', 'e', 't' ] } global
// e e Set { value: [ 's', 'e', 't' ] } global
// t t Set { value: [ 's', 'e', 't' ] } global

s2.forEach(function () {
  console.log(this)
}, { name: 'qianlongo' })

// { name: 'qianlongo' }
// { name: 'qianlongo' }
// { name: 'qianlongo' }

// {name: "qianlongo"}
// {name: "qianlongo"}
// {name: "qianlongo"}

for (let value of s) {
  console.log(value)
}
// s
// e
// t

for (let value of s.entries()) {
  console.log(value)
}
// ["s", "s"]
// ["e", "e"]
// ["t", "t"]

遍歷方法看起來也能夠達到和前面例子同樣的效果,源碼實現部分基本就到這裏啦，可是還沒完...

爲何[ ...s2 ]能夠獲得數組[ 's', 'e', 't' ]呢？
s2 爲何能夠被for of循環呢？

iterator(迭代器)

從 MDN找來這段話，在JavaScript中迭代器是一個對象，它提供了一個next() 方法，用來返回序列中的下一項。這個方法返回包含兩個屬性：done(表示遍歷是否結束)和 value（當前的值）。

迭代器對象一旦被建立，就能夠反覆調用next()。

function makeIterator(array){
  var nextIndex = 0

  return {
    next: function () {
      return nextIndex < array.length ?
        { done: false, value: array[ nextIndex++ ] } :
        { done: true, value: undefined }
    }
  };
}

var it = makeIterator(['yo', 'ya'])

console.log(it.next()) // { done: false, value: "yo" }
console.log(it.next()) // { done: false, value: "ya" }
console.log(it.next()) // { done: true, value: undefined }

這個時候能夠講一下咱們的iterator.js中的代碼了

class Iterator {
  constructor (arrayLike, iteratee = (value) => value) {
    this.value = Array.from(arrayLike)
    this.nextIndex = 0
    this.len = this.value.length
    this.iteratee = iteratee
  }

  next () {
    let done = this.nextIndex >= this.len
    let value = done ? undefined : this.iteratee(this.value[ this.nextIndex++ ])

    return { done, value }
  }

  [ Symbol.iterator ] () {
    return this
  }
}

Iterator的實例有一個next方法，每次調用都會返回一個done屬性和value屬性，其語意和前面的解釋是同樣的。

let it = new Iterator(['yo', 'ya'])

console.log(it.next()) // { done: false, value: "yo" }
console.log(it.next()) // { done: false, value: "ya" }
console.log(it.next()) // { done: true, value: undefined }

看到這裏你可能已經知道了，Iterator要實現的功能之一就是提供一個迭代器。那這個又和上面的問題1和2有啥關係呢？咱們再來看看for of

for of

一個數據結構只要部署了Symbol.iterator屬性，就被視爲具備iterator接口，就能夠用for...of循環遍歷它的成員。也就是說，for...of循環內部調用的是數據結構的Symbol.iterator方法 for...of 循環

默認只有（Array，Map，Set，String，TypedArray，arguments）可被for of迭代。咱們自定義的Set類不在這其中，前面的例子中卻在for of循環中打印出了想要的值。緣由就是咱們給Iterator類部署了Symbol.iterator方法，執行該方法便返回Iterator實例自己，它是一個能夠被迭代的對象。

[ Symbol.iterator ] () {
  return this
}

到這裏上面的問題2就能夠解釋通了。

再看看問題1 爲何[ ...s2 ]能夠獲得數組[ 's', 'e', 't' ]呢？,緣由也是咱們給Set、keys、values、entries部署了Symbol.iterator，使之具備「iterator」接口,而擴展運算符...的特色之一就是任何具備Iterator接口的對象，均可以用擴展運算符轉爲真正的數組。