Vue實例方法之事件的實現

開始

這段時間一直在看vue的源碼，源碼很是多和雜，因此本身結合資料和理解理出了一個主線，而後根據主線去剝離其餘的一些知識點，而後將各個知識點逐一學習。這裏主要是分析的事件系統的實現。

正文

1、瞭解使用方式

在分析以前先了解下幾個api的使用方式：

vm.$on(event, callback)

• 參數：

  • {string | Array<string>} event (數組只在 2.2.0+ 中支持)
  • {Function} callback
• 用法：$on事件須要兩個參數，一個是監聽的當前實例上的事件名，一個是事件觸發的回調函數，回調函數接受的是在事件出發的時候額外傳遞的參數。
• 例子：

vm.$on('test', function (msg) {
  console.log(msg)
})
vm.$emit('test', 'hi')
// => "hi"

vm.$once(event, callback)

$once事件總體上來講和$on事件的使用方式差很少，可是event只支持字符串也就是說只支持單個事件。而且該事件再觸發一次後就移除了監聽器。

• 例子

vm.$once('testonce', function (msg) {
  console.log(msg)
})

vm.$off([event, callback])

• 參數：

  • {string | Array<string>} event（僅在 2.2.2+ 支持數組）
  • {Function} [callback]

• 用法:移除自定義事件監聽器

  • 若是沒有提供參數，則移除全部的事件監聽器
  • 若是隻提供了事件，則移除該事件全部的監聽器；
  • 若是同時提供了事件與回調，則只移除這個回調的監聽器。
• 例子：

vm.$off()
vm.$off('test')
vm.$off('test1', function (msg) {
  console.log(msg)
})
vm.$off(['test1','test2'], function (msg) {
  console.log(msg)
})

vm.$emit(event, [..args])

• 參數：

  • {string} event 要觸發的事件名
  • [...args]可選
• 用法：

觸發當前實例上的事件。附加參數都會傳給監聽器回調。

• 例子

vm.$emit('test', '觸發自定義事件')

2、源碼分析

事件的初始化工做

咱們在使用自定義事件的api的時候，確定有個地方是須要來存咱們的事件和回調的地方。在vue中大部分的初始化工做都是在core/instance/init.js的initMixin方法中。因此咱們可以在initMixin看到initEvents方法。

// initEvents
export function initEvents (vm: Component) {
  vm._events = Object.create(null)
  vm._hasHookEvent = false
  // init parent attached events
  const listeners = vm.$options._parentListeners
  if (listeners) {
    updateComponentListeners(vm, listeners)
  }
}

上面的代碼能夠看到，在初始化Vue事件的時候,在vm實例上面掛載了一個_events的空對象。後面咱們本身調用的自定義事件都存在裏面。

由於vue自己在組件嵌套的時候就有子組件使用父組件的事件的時候。因此就能夠經過updateComponentListeners方法把父組件事件監聽器（好比click）傳遞給子組件。（這裏不作過多討論）

自定義事件的掛載方式

自定義事件的掛載是在eventsMixin方法中實現的。這裏面將四個方法掛在Vue的原型上面。

Vue.prototype.$on
Vue.prototype.$once
Vue.prototype.$off
Vue.prototype.$emit

Vue.prototype.$on的實現

Vue.prototype.$on = function (event: string | Array<string>, fn: Function): Component {
const vm: Component = this
    if (Array.isArray(event)) {
      for (let i = 0, l = event.length; i < l; i++) {
        this.$on(event[i], fn)
      }
    } else {
      (vm._events[event] || (vm._events[event] = [])).push(fn)
      // optimize hook:event cost by using a boolean flag marked at registration
      // instead of a hash lookup
      if (hookRE.test(event)) {
        vm._hasHookEvent = true
      }
    }
    return vm
}

第一個參數就是自定義事件，由於多是數組，因此判斷若是是數組，那麼就循環調用this.$on方法。
若是不是數組，那麼就直接向最開始定義的_events對象集合裏面添加自定義事件。

因此這個時候_events對象生成的格式大概就是下面：

vm._events={
    'test':[fn,fn...],
    'test1':[fn,fn...]
}

Vue.prototype.$once 的實現

Vue.prototype.$once = function (event: string, fn: Function): Component {
    const vm: Component = this
    function on () {
      vm.$off(event, on)
      fn.apply(vm, arguments)
    }
    on.fn = fn
    vm.$on(event, on)
    return vm
}

這裏定義了一個on函數。接着把fn賦值給on.fn。最後在調用的是vm.$on。這裏傳入的就是事件名和前面定義的on函數。on函數在執行的時候會先移除_events中對應的事件，而後調用fn

因此分析下獲得的是：

vm._events={
    'oncetest':[ 
          function on(){
              vm.$off(event,on)
              fn.apply(vm,arguments)
          } ,
          ...
     ]
}

Vue.prototype.$off的實現

Vue.prototype.$off = function (event?: string | Array<string>, fn?: Function): Component {
    const vm: Component = this
    // all
    // 若是沒有傳任何參數的時候，直接清楚全部掛在_events對象上的全部事件。
    if (!arguments.length) {
      vm._events = Object.create(null)
      return vm
    }
    // array of events
    // 若是第一個參數是數組的話，那麼就循環調用this.$off方法
    if (Array.isArray(event)) {
      for (let i = 0, l = event.length; i < l; i++) {
        this.$off(event[i], fn)
      }
      return vm
    }
    // specific event
    // 獲取對應事件全部的回調多是個數組
    const cbs = vm._events[event]
    // 沒有相關的事件的時候直接返回vm實例
    if (!cbs) {
      return vm
    }
    // 若是隻傳入了事件名，那麼清除該事件名下全部的事件。 也就是說 vm._events = {'test': null, ...}
    if (!fn) {
      vm._events[event] = null
      return vm
    }
    // 若是傳入的第二個參數爲真，那麼就去cbs裏面遍歷，在cbs中找到和fn相等的函數，而後經過splice刪除該函數。
    if (fn) {
      // specific handler
      let cb
      let i = cbs.length
      while (i--) {
        cb = cbs[i]
        if (cb === fn || cb.fn === fn) {
          cbs.splice(i, 1)
          break
        }
      }
    }
    return vm
}

上面主要就是實現的下面三種狀況：

• 若是沒有提供參數，則移除全部的事件監聽器；
• 若是隻提供了事件，則移除該事件全部的監聽器；
• 若是同時提供了事件與回調，則只移除這個回調的監聽器。

Vue.prototype.$emit 的實現

Vue.prototype.$emit = function (event: string): Component {
    const vm: Component = this
    if (process.env.NODE_ENV !== 'production') {
      const lowerCaseEvent = event.toLowerCase()
      if (lowerCaseEvent !== event && vm._events[lowerCaseEvent]) {
        tip(
          `Event "${lowerCaseEvent}" is emitted in component ` +
          `${formatComponentName(vm)} but the handler is registered for "${event}". ` +
          `Note that HTML attributes are case-insensitive and you cannot use ` +
          `v-on to listen to camelCase events when using in-DOM templates. ` +
          `You should probably use "${hyphenate(event)}" instead of "${event}".`
        )
      }
    }
    // 匹配到事件列表，該列表是一個json。
    let cbs = vm._events[event]
    if (cbs) {
      //將該json轉化成爲真正的數組
      cbs = cbs.length > 1 ? toArray(cbs) : cbs
      const args = toArray(arguments, 1)
      // 循環遍歷調用全部的自定義事件。
      for (let i = 0, l = cbs.length; i < l; i++) {
        try {
          cbs[i].apply(vm, args)
        } catch (e) {
          handleError(e, vm, `event handler for "${event}"`)
        }
      }
    }
    return vm
}

上面主要意思是：匹配到json中相關key值的value,這個value先轉換成真正的數組，再循環遍歷數組，傳入給的參數執行數組中的每一個函數

最後

vue中的自定義事件主要目的是爲了組件之間的通訊。由於_events對象是掛在Vue實例上的。所以每一個組件是均可以訪問到vm._events的值的，也可以向其中push值的。

整個自定義事件系統呢就是在vm實例上掛載一個_events的對象，能夠理解爲一個json，其中json的key值就是自定義事件的名稱，一個key值可能對應着多個自定義事件，所以json中每一個key對應的value都是一個數組，每次執行事件監聽都會向數組中push相關的函數，最終經過$emit函數傳入的參數，匹配到json中相應的key,val值，從而使用給定的參數執行數組中的函數。

最後的_events對象：

vm._events={
    'test1':[fn,fn,fn],
    'test2':[fn],
    'oncetest':[ 
          function on(){
              vm.$off(event,on)
              fn.apply(vm,arguments)
          },
          ... 
     ],
     ...
}