Vue 组件事件触发和监听实现源码解析

目录

• 正文
• Vue 的事件触发和监听
• 源码分析
• on
• once
• emit
• off
• 动手实现
• 总结

正文

通常我们在使用Vue的时候，会使用$emit和$on来触发和监听事件，但是有没有思考是如何实现的呢？

今天带来的是一个微型的事件触发的库，借它们的源码来简单初步了解Vue的事件触发和监听的实现。

mitt

tiny-emitter

mitt使用TypeScript编写，tiny-emitter使用原生ES5编写，两者对比tiny-emitter功能稍微丰富一写，所以直接看tiny-emitter就好了。

Vue 的事件触发和监听

• Vue 组件事件

我没有标题党，先来看一下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>

这个代码大家都熟，简化之后其实可以理解成这样的：

// 父组件
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是一个事件触发和监听的类，这个类的实现就是我们今天要学习的。

先来学习tiny-emitter的实现，最后把Emitter这个类完成。

源码分析

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个方法，on、once、emit、off，下面一个一个开始分析。

on

on方法是用来监听事件的，代码如下：

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

它接收三个参数：

• name：事件名称
• callback：事件触发时的回调函数
• ctx：回调函数的上下文

它会判断this.e是否存在，如果不存在就创建一个空对象;

this.e是用来存储事件的，this指向就不多讲了吧。

然后把name作为key，callback和ctx作为value，存到this.e中，用于后面的事件触发；

最后返回this，这样就可以链式调用了。

once

once方法同样是用来监听事件的，但是它只会触发一次，代码如下：

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方法一样，接收三个参数，最后也是调用的on方法，但是它会在on方法的基础上做一些处理。

它内部会定义一个listener函数，然后将这个函数作为on方法的回调函数，最后调用on方法。

listener函数会调用off方法，把自己从事件队列中移除，然后再调用callback函数。

emit

emit方法是用来触发事件的，代码如下：

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;
}

它接收一个参数，就是事件名称，然后把除了第一个参数以外的参数，转成数组，存到data中。

然后从this.e中取出name对应的事件队列，如果没有就创建一个空数组，然后把这个数组复制一份，存到evtArr中。

这里老是对this.e做判断好麻烦，其实可以在构造函数中初始化this.e，这样就不用每次都判断了。

然后遍历evtArr，依次调用每个事件的回调函数，把data作为参数传进去，最后返回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;
  }

它接收两个参数，name和callback，name是事件名称，callback是回调函数。

它会从this.e中取出name对应的事件队列，然后通过遍历，把不等于callback的事件，存到liveEvents中。

最后判断liveEvents是否为空，如果不为空，就把liveEvents赋值给e[name]，否则就删除e[name]。

动手实现

上面已经分析完tiny-emitter的源码了，我们现在就来实现最开始提到的Emitter类。

当然这里还是简化版，只有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语法来实现这个功能；

constructor方法用来初始化events对象，这样对比tiny-emitter的源码，就不用每次都判断this.e是否存在了；

$emit通过...args来接收除了第一个参数以外的参数，就可以不用使用arguments了；

整体来说使用ES6的class语法来实现，代码量更少，更加简洁，来看了结果：

总结

通过学习tiny-emitter的源码，我们学习到一个事件总线的设计思路以及实现方式。

了解事件总线的设计思路，可以帮助我们更好地理解Vue的事件总线，这可能对我们使用或者阅读源码有帮助。

最后通过实现一个简单的事件总线，让我们加深对这个事件总线的理解，也通过将这个实现转换为ES6的class语法，让我们对ES6的class语法有更深的理解。

以上就是Vue 组件事件触发和监听实现源码解析的详细内容，更多关于Vue 组件事件触发监听的资料请关注我们其它相关文章！