腳本之家服務(wù)器常用軟件

快捷導(dǎo)航

Vue 組件事件觸發(fā)和監(jiān)聽實(shí)現(xiàn)源碼解析

更新時(shí)間：2022年12月22日 11:17:37 作者：田八

這篇文章主要為大家介紹了Vue 組件事件觸發(fā)和監(jiān)聽實(shí)現(xiàn)源碼解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

正文

通常我們在使用Vue的時(shí)候，會(huì)使用$emit和$on來觸發(fā)和監(jiān)聽事件，但是有沒有思考是如何實(shí)現(xiàn)的呢？

今天帶來的是一個(gè)微型的事件觸發(fā)的庫，借它們的源碼來簡單初步了解Vue的事件觸發(fā)和監(jiān)聽的實(shí)現(xiàn)。

mitt

tiny-emitter

mitt使用TypeScript編寫，tiny-emitter使用原生ES5編寫，兩者對比tiny-emitter功能稍微豐富一寫，所以直接看tiny-emitter就好了。

Vue 的事件觸發(fā)和監(jiān)聽

Vue 組件事件

我沒有標(biāo)題黨，先來看一下Vue的組件事件怎么使用的：

// 父組件
<template>
  <div>
    <child @my-event="handleMyEvent"></child>
  </div>
</template>
<script>
import Child from './Child.vue'
export default {
  components: {
    Child
  },
  methods: {
    handleMyEvent (event) {
      console.log(event)
    }
  }
}
</script>
// 子組件
<template>
  <div>
    <button @click="handleClick">click</button>
  </div>
</template>
<script>
export default {
  methods: {
    handleClick () {
      this.$emit('my-event', { a: 1 })
    }
  }
}
</script>

這個(gè)代碼大家都熟，簡化之后其實(shí)可以理解成這樣的：

// 父組件
import Child from './Child.js'
const child = new Child()
child.$on('my-event', (event) => {
  console.log(event)
});
// 子組件
export default class Child extends Emitter {
  constructor () {
      super();
  }
  handleClick () {
    this.$emit('my-event', { a: 1 })
  }
}

這里可以看到子組件是繼承自Emitter，Emitter是一個(gè)事件觸發(fā)和監(jiān)聽的類，這個(gè)類的實(shí)現(xiàn)就是我們今天要學(xué)習(xí)的。

先來學(xué)習(xí)tiny-emitter的實(shí)現(xiàn)，最后把Emitter這個(gè)類完成。

源碼分析

tiny-emitter的源碼很簡單，加上注釋和換行也就68行，先一睹為快：

function E () {
  // Keep this empty so it's easier to inherit from
  // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)
}
E.prototype = {
  on: function (name, callback, ctx) {
    var e = this.e || (this.e = {});
    (e[name] || (e[name] = [])).push({
      fn: callback,
      ctx: ctx
    });
    return this;
  },
  once: function (name, callback, ctx) {
    var self = this;
    function listener () {
      self.off(name, listener);
      callback.apply(ctx, arguments);
    };
    listener._ = callback
    return this.on(name, listener, ctx);
  },
  emit: function (name) {
    var data = [].slice.call(arguments, 1);
    var evtArr = ((this.e || (this.e = {}))[name] || []).slice();
    var i = 0;
    var len = evtArr.length;
    for (i; i < len; i++) {
      evtArr[i].fn.apply(evtArr[i].ctx, data);
    }
    return this;
  },
  off: function (name, callback) {
    var e = this.e || (this.e = {});
    var evts = e[name];
    var liveEvents = [];
    if (evts && callback) {
      for (var i = 0, len = evts.length; i < len; i++) {
        if (evts[i].fn !== callback && evts[i].fn._ !== callback)
          liveEvents.push(evts[i]);
      }
    }
    // Remove event from queue to prevent memory leak
    // Suggested by https://github.com/lazd
    // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910
    (liveEvents.length)
      ? e[name] = liveEvents
      : delete e[name];
    return this;
  }
};
module.exports = E;
module.exports.TinyEmitter = E;

一共只有4個(gè)方法，on、once、emit、off，下面一個(gè)一個(gè)開始分析。

on

on方法是用來監(jiān)聽事件的，代碼如下：

function on(name, callback, ctx) {
    var e = this.e || (this.e = {});
    (e[name] || (e[name] = [])).push({
        fn: callback,
        ctx: ctx
    });
    return this;
}

它接收三個(gè)參數(shù)：

name：事件名稱
callback：事件觸發(fā)時(shí)的回調(diào)函數(shù)
ctx：回調(diào)函數(shù)的上下文

它會(huì)判斷this.e是否存在，如果不存在就創(chuàng)建一個(gè)空對象;

this.e是用來存儲(chǔ)事件的，this指向就不多講了吧。

然后把name作為key，callback和ctx作為value，存到this.e中，用于后面的事件觸發(fā)；

最后返回this，這樣就可以鏈?zhǔn)秸{(diào)用了。

once

once方法同樣是用來監(jiān)聽事件的，但是它只會(huì)觸發(fā)一次，代碼如下：

function once(name, callback, ctx) {
    var self = this;
    function listener() {
        self.off(name, listener);
        callback.apply(ctx, arguments);
    };
    listener._ = callback
    return this.on(name, listener, ctx);
}

它同on方法一樣，接收三個(gè)參數(shù)，最后也是調(diào)用的on方法，但是它會(huì)在on方法的基礎(chǔ)上做一些處理。

它內(nèi)部會(huì)定義一個(gè)listener函數(shù)，然后將這個(gè)函數(shù)作為on方法的回調(diào)函數(shù)，最后調(diào)用on方法。

listener函數(shù)會(huì)調(diào)用off方法，把自己從事件隊(duì)列中移除，然后再調(diào)用callback函數(shù)。

emit

emit方法是用來觸發(fā)事件的，代碼如下：

function emit(name) {
    var data = [].slice.call(arguments, 1);
    var evtArr = ((this.e || (this.e = {}))[name] || []).slice();
    var i = 0;
    var len = evtArr.length;
    for (i; i < len; i++) {
        evtArr[i].fn.apply(evtArr[i].ctx, data);
    }
    return this;
}

它接收一個(gè)參數(shù)，就是事件名稱，然后把除了第一個(gè)參數(shù)以外的參數(shù)，轉(zhuǎn)成數(shù)組，存到data中。

然后從this.e中取出name對應(yīng)的事件隊(duì)列，如果沒有就創(chuàng)建一個(gè)空數(shù)組，然后把這個(gè)數(shù)組復(fù)制一份，存到evtArr中。

這里老是對this.e做判斷好麻煩，其實(shí)可以在構(gòu)造函數(shù)中初始化this.e，這樣就不用每次都判斷了。

然后遍歷evtArr，依次調(diào)用每個(gè)事件的回調(diào)函數(shù)，把data作為參數(shù)傳進(jìn)去，最后返回this。

off

off方法是用來移除事件的，代碼如下：

function off(name, callback) {
    var e = this.e || (this.e = {});
    var evts = e[name];
    var liveEvents = [];
    if (evts && callback) {
      for (var i = 0, len = evts.length; i < len; i++) {
        if (evts[i].fn !== callback && evts[i].fn._ !== callback)
          liveEvents.push(evts[i]);
      }
    }
    (liveEvents.length)
      ? e[name] = liveEvents
      : delete e[name];
    return this;
  }

它接收兩個(gè)參數(shù)，name和callback，name是事件名稱，callback是回調(diào)函數(shù)。

它會(huì)從this.e中取出name對應(yīng)的事件隊(duì)列，然后通過遍歷，把不等于callback的事件，存到liveEvents中。

最后判斷liveEvents是否為空，如果不為空，就把liveEvents賦值給e[name]，否則就刪除e[name]。

動(dòng)手實(shí)現(xiàn)

上面已經(jīng)分析完tiny-emitter的源碼了，我們現(xiàn)在就來實(shí)現(xiàn)最開始提到的Emitter類。

當(dāng)然這里還是簡化版，只有on和emit方法。

class Emitter {
    constructor() {
        this.events = {};
    }
    $on(name, callback) {
        if (!this.events[name]) {
            this.events[name] = [];
        }
        this.events[name].push(callback);
    }
    $emit(name, ...args) {
        if (this.events[name]) {
            this.events[name].forEach(callback => callback(...args));
        }
    }
}

這里使用ES6的class語法來實(shí)現(xiàn)這個(gè)功能；

constructor方法用來初始化events對象，這樣對比tiny-emitter的源碼，就不用每次都判斷this.e是否存在了；

$emit通過...args來接收除了第一個(gè)參數(shù)以外的參數(shù)，就可以不用使用arguments了；

整體來說使用ES6的class語法來實(shí)現(xiàn)，代碼量更少，更加簡潔，來看了結(jié)果：