Comprendre l'émetteur d'événements JavaScript

Cet article est l'EventEmitter implémenté par l'auteur après avoir lu le code source de eventemitter3 et du module d'événements Node.js. Les événements JavaScript sont très importants. J'espère que vous pourrez gagner quelque chose en lisant cet article

Il y a plus de 2 mois, j'ai copié le code source de eventemitter3 sur Github et les événements du module événementiel sous Node.js, et enfin enfin Avoir une certaine compréhension des événements JavaScript.

J'ai passé du temps le week-end dernier à implémenter un eventemitter8 en utilisant ES6 sur la base de ma compréhension précédente du code source, puis je l'ai publié sur npm. Ce qui m'a surpris, c'est qu'il n'a été publié qu'il y a deux jours et qu'il y en avait. pas d'introduction Lisez-moi. Il y a en fait 45 téléchargements malgré toute promotion. Je suis curieux de savoir qui les a téléchargés et s'ils peuvent les utiliser. J'ai passé beaucoup de temps à traiter la bibliothèque JavaScript à moitié copiée et à moitié originale now.js (portail npm : now.js) Avec ma vigoureuse promotion, le nombre de téléchargements en 4 mois n'était que de 177. C’est vrai que les fleurs plantées intentionnellement ne fleurissent pas, mais les saules plantés sans intention créent de l’ombre !

eventemitter8 La plupart d'entre eux ont été écrits par moi après avoir lu le code source. Il existe certaines méthodes telles que les auditeurs, les auditeurs et les noms d'événements, je ne me souviens pas de ce qu'elles font pour le moment, je vais donc vérifier à nouveau. De nombreux cas de test font référence à eventemitter3. Je tiens à exprimer ma gratitude aux développeurs d'eventemitter3 et aux développeurs du module d'événements Node.js !

Permettez-moi de parler de ma compréhension des événements JavaScript :

Comme vous pouvez le voir sur l'image ci-dessus, le cœur de JavaScript événements Y compris l'écoute d'événements (addListener), le déclenchement d'événements (emit) et la suppression d'événements (removeListener).

Event Listener (addListener)

Tout d'abord, la surveillance doit avoir une cible de surveillance, ou un objet afin d'atteindre l'objectif de distinguer la cible, la. le nom est indispensable, nous le définissons comme type.

Deuxièmement, la cible de surveillance doit avoir une sorte d'action, qui correspond à une certaine méthode en JavaScript, définie ici comme fn.

Par exemple, vous pouvez surveiller un événement dont le type est add et dont la méthode consiste à ajouter 1 à la valeur d'une certaine variable a, fn = () => Si nous voulons également écouter une méthode qui ajoute 2 à la variable b, notre première réaction peut être de créer un événement de type add2 et de méthode fn1 = () => Vous pensez peut-être que c'est un tel gaspillage, pourrais-je simplement écouter un nom et lui faire exécuter plus d'un événement de méthode. Bien sûr, c'est possible.

Alors que faire ?

C'est très simple, il suffit de mettre la méthode de surveillance dans un tableau, de parcourir le tableau et de l'exécuter séquentiellement. L'exemple ci-dessus modifie le type à ajouter et la méthode en [fn, fn1].

Si vous souhaitez le subdiviser, il peut également être divisé en on, qui peut être exécuté un nombre illimité de fois, et une fois, qui ne peut être exécuté qu'une seule fois (l'événement sera supprimé immédiatement après l'exécution). Plus de détails plus tard.

Déclencheur d'événement (émission)

La surveillance des événements à elle seule ne suffit pas, il doit y avoir un déclencheur d'événement pour terminer l'ensemble du processus. Emit consiste à déclencher un événement unique ou une série d'événements correspondant au type d'écoute spécifique. En reprenant l'exemple précédent, un seul événement doit exécuter fn, et une série d'événements doit parcourir et exécuter fn et fn1.

Suppression d'événement (removeListener)

À proprement parler, l'écoute et le déclenchement d'événements peuvent compléter l'ensemble du processus. La suppression d'événement est facultative. Mais il arrive souvent que nous devions supprimer des événements. Par exemple, l'événement unique mentionné précédemment ne peut être exécuté qu'une seule fois. Si aucune méthode de suppression n'est fournie, il est difficile de garantir quand vous l'exécuterez à nouveau. Normalement, tant que l'événement n'est plus nécessaire, nous devrions le supprimer.

Après avoir terminé la partie principale, analysons brièvement le code source d'eventemitter8.

Analyse du code source

Tout le code source :

const toString = Object.prototype.toString;
const isType = obj => toString.call(obj).slice(8, -1).toLowerCase();
const isArray = obj => Array.isArray(obj) || isType(obj) === 'array';
const isNullOrUndefined = obj => obj === null || obj === undefined;

const _addListener = function(type, fn, context, once) {
 if (typeof fn !== 'function') {
  throw new TypeError('fn must be a function');
 }

 fn.context = context;
 fn.once = !!once;

 const event = this._events[type];
 // only one, let `this._events[type]` to be a function
 if (isNullOrUndefined(event)) {
  this._events[type] = fn;
 } else if (typeof event === 'function') {
  // already has one function, `this._events[type]` must be a function before
  this._events[type] = [event, fn];
 } else if (isArray(event)) {
  // already has more than one function, just push
  this._events[type].push(fn);
 }

 return this;
};

class EventEmitter {
 constructor() {
  if (this._events === undefined) {
   this._events = Object.create(null);
  }
 }

 addListener(type, fn, context) {
  return _addListener.call(this, type, fn, context);
 }

 on(type, fn, context) {
  return this.addListener(type, fn, context);
 }

 once(type, fn, context) {
  return _addListener.call(this, type, fn, context, true);
 }

 emit(type, ...rest) {
  if (isNullOrUndefined(type)) {
   throw new Error('emit must receive at lease one argument');
  }

  const events = this._events[type];

  if (isNullOrUndefined(events)) return false;

  if (typeof events === 'function') {
   events.call(events.context || null, rest);
   if (events.once) {
    this.removeListener(type, events);
   }
  } else if (isArray(events)) {
   events.map(e => {
    e.call(e.context || null, rest);
    if (e.once) {
     this.removeListener(type, e);
    }
   });
  }

  return true;
 }

 removeListener(type, fn) {
  if (isNullOrUndefined(this._events)) return this;

  // if type is undefined or null, nothing to do, just return this
  if (isNullOrUndefined(type)) return this;

  if (typeof fn !== 'function') {
   throw new Error('fn must be a function');
  }

  const events = this._events[type];

  if (typeof events === 'function') {
   events === fn && delete this._events[type];
  } else {
   const findIndex = events.findIndex(e => e === fn);

   if (findIndex === -1) return this;

   // match the first one, shift faster than splice
   if (findIndex === 0) {
    events.shift();
   } else {
    events.splice(findIndex, 1);
   }

   // just left one listener, change Array to Function
   if (events.length === 1) {
    this._events[type] = events[0];
   }
  }

  return this;
 }

 removeAllListeners(type) {
  if (isNullOrUndefined(this._events)) return this;

  // if not provide type, remove all
  if (isNullOrUndefined(type)) this._events = Object.create(null);

  const events = this._events[type];
  if (!isNullOrUndefined(events)) {
   // check if `type` is the last one
   if (Object.keys(this._events).length === 1) {
    this._events = Object.create(null);
   } else {
    delete this._events[type];
   }
  }

  return this;
 }

 listeners(type) {
  if (isNullOrUndefined(this._events)) return [];

  const events = this._events[type];
  // use `map` because we need to return a new array
  return isNullOrUndefined(events) ? [] : (typeof events === 'function' ? [events] : events.map(o => o));
 }

 listenerCount(type) {
  if (isNullOrUndefined(this._events)) return 0;

  const events = this._events[type];

  return isNullOrUndefined(events) ? 0 : (typeof events === 'function' ? 1 : events.length);
 }

 eventNames() {
  if (isNullOrUndefined(this._events)) return [];

  return Object.keys(this._events);
 }
}

export default EventEmitter;

Le code est très petit, seulement 151 OK, parce que j'ai écrit une version simple et utilisé ES6, il y en a si peu ; les événements Node.js et eventemitter3 sont plus nombreux et compliqués que cela. Si vous êtes intéressé, vous pouvez l'étudier en profondeur par vous-même.

const toString = Object.prototype.toString;
const isType = obj => toString.call(obj).slice(8, -1).toLowerCase();
const isArray = obj => Array.isArray(obj) || isType(obj) === 'array';
const isNullOrUndefined = obj => obj === null || obj === undefined;

Ces 4 lignes sont des fonctions utilitaires permettant de déterminer le type et s'il est nul ou indéfini.

constructor() {
 if (isNullOrUndefined(this._events)) {
  this._events = Object.create(null);
 }
}

crée une classe EventEmitter, puis initialise l'attribut _events d'une classe dans le constructeur. Cet attribut n'a pas besoin d'hériter. n'importe quoi, donc Object.create(null) a été utilisé. Bien sûr, isNullOrUndefined(this._events) vérifie également si this._events est indéfini ou nul. Si tel est le cas, il doit être créé. Mais cela n'est pas nécessaire, car l'instanciation d'un EventEmitter appellera le constructeur, qui est l'état initial. This._events ne doit pas être défini et peut être supprimé.

addListener(type, fn, context) {
 return _addListener.call(this, type, fn, context);
}

on(type, fn, context) {
 return this.addListener(type, fn, context);
}

once(type, fn, context) {
 return _addListener.call(this, type, fn, context, true);
}

Les suivantes sont trois méthodes addListener, on, once, où on est l'alias de addListener et peut être exécuté plusieurs fois. fois. once ne peut être exécuté qu’une seule fois.

Les trois méthodes utilisent la méthode _addListener :

const _addListener = function(type, fn, context, once) {
 if (typeof fn !== 'function') {
  throw new TypeError('fn must be a function');
 }

 fn.context = context;
 fn.once = !!once;

 const event = this._events[type];
 // only one, let `this._events[type]` to be a function
 if (isNullOrUndefined(event)) {
  this._events[type] = fn;
 } else if (typeof event === 'function') {
  // already has one function, `this._events[type]` must be a function before
  this._events[type] = [event, fn];
 } else if (isArray(event)) {
  // already has more than one function, just push
  this._events[type].push(fn);
 }

 return this;
};

方法有四个参数，type 是监听事件的名称，fn 是监听事件对应的方法，context 俗称爸爸，改变 this 指向的，也就是执行的主体。once 是一个布尔型，用来标志是否只执行一次。
首先判断 fn 的类型，如果不是方法，抛出一个类型错误。fn.context = context;fn.once = !!once 把执行主体和是否执行一次作为方法的属性。const event = this._events[type] 把该对应 type 的所有已经监听的方法存到变量 event。

// only one, let `this._events[type]` to be a function
if (isNullOrUndefined(event)) {
 this._events[type] = fn;
} else if (typeof event === 'function') {
 // already has one function, `this._events[type]` must be a function before
 this._events[type] = [event, fn];
} else if (isArray(event)) {
 // already has more than one function, just push
 this._events[type].push(fn);
}

return this;

如果 type 本身没有正在监听任何方法，this._events[type] = fn 直接把监听的方法 fn 赋给 type 属性 ；如果正在监听一个方法，则把要添加的 fn 和之前的方法变成一个含有2个元素的数组 [event, fn]，然后再赋给 type 属性，如果正在监听超过2个方法，直接 push 即可。最后返回 this ，也就是 EventEmitter 实例本身。

简单来讲不管是监听多少方法，都放到数组里是没必要像上面细分。但性能较差，只有一个方法时 key: fn 的效率比 key: [fn] 要高。

再回头看看三个方法:

addListener(type, fn, context) {
 return _addListener.call(this, type, fn, context);
}

on(type, fn, context) {
 return this.addListener(type, fn, context);
}

once(type, fn, context) {
 return _addListener.call(this, type, fn, context, true);
}

addListener 需要用 call 来改变 this 指向，指到了类的实例。once 则多传了一个标志位 true 来标志它只需要执行一次。这里你会看到我在 addListener 并没有传 false 作为标志位，主要是因为我懒，但并不会影响到程序的逻辑。因为前面的 fn.once = !!once 已经能很好的处理不传值的情况。没传值 !!once 为 false。

接下来讲 emit

emit(type, ...rest) {
 if (isNullOrUndefined(type)) {
  throw new Error('emit must receive at lease one argument');
 }

 const events = this._events[type];

 if (isNullOrUndefined(events)) return false;

 if (typeof events === 'function') {
  events.call(events.context || null, rest);
  if (events.once) {
   this.removeListener(type, events);
  }
 } else if (isArray(events)) {
  events.map(e => {
   e.call(e.context || null, rest);
   if (e.once) {
    this.removeListener(type, e);
   }
  });
 }

 return true;
}

事件触发需要指定具体的 type 否则直接抛出错误。这个很容易理解，你都没有指定名称，我怎么知道该去执行谁的事件。if (isNullOrUndefined(events)) return false，如果 type 对应的方法是 undefined 或者 null ，直接返回 false 。因为压根没有对应 type 的方法可以执行。而 emit 需要知道是否被成功触发。

接着判断 evnts 是不是一个方法，如果是， events.call(events.context || null, rest) 执行该方法，如果指定了执行主体，用 call 改变 this 的指向指向 events.context 主体，否则指向 null ，全局环境。对于浏览器环境来说就是 window。差点忘了 rest ，rest 是方法执行时的其他参数变量，可以不传，也可以为一个或多个。执行结束后判断 events.once ，如果为 true ，就用 removeListener 移除该监听事件。

如果 evnts 是数组，逻辑一样，只是需要遍历数组去执行所有的监听方法。

成功执行结束后返回 true 。

removeListener(type, fn) {
 if (isNullOrUndefined(this._events)) return this;
 // if type is undefined or null, nothing to do, just return this
 if (isNullOrUndefined(type)) return this;
 if (typeof fn !== 'function') {
  throw new Error('fn must be a function');
 }
 const events = this._events[type];
 if (typeof events === 'function') {
  events === fn && delete this._events[type];
 } else {
  const findIndex = events.findIndex(e => e === fn);
  if (findIndex === -1) return this;
  // match the first one, shift faster than splice
  if (findIndex === 0) {
   events.shift();
  } else {
   events.splice(findIndex, 1);
  }
  // just left one listener, change Array to Function
  if (events.length === 1) {
   this._events[type] = events[0];
  }
 }
 return this;
}

removeListener 接收一个事件名称 type 和一个将要被移除的方法 fn 。if (isNullOrUndefined(this._events)) return this 这里表示如果 EventEmitter 实例本身的 _events 为 null 或者 undefined 的话，没有任何事件监听，直接返回 this 。

if (isNullOrUndefined(type)) return this 如果没有提供事件名称，也直接返回 this 。

if (typeof fn !== 'function') {
 throw new Error('fn must be a function');
}

fn 如果不是一个方法，直接抛出错误，很好理解。

接着判断 type 对应的 events 是不是一个方法，是，并且 events === fn 说明 type 对应的方法有且仅有一个，等于我们指定要删除的方法。这个时候 delete this._events[type] 直接删除掉 this._events 对象里 type 即可。

所有的 type 对应的方法都被移除后。想一想 this._events[type] = undefined 和 delete this._events[type] 会有什么不同？

差异是很大的，this._events[type] = undefined 仅仅是将 this._events 对象里的 type 属性赋值为 undefined ，type 这一属性依然占用内存空间，但其实已经没什么用了。如果这样的 type 一多，有可能造成内存泄漏。delete this._events[type] 则直接删除，不占内存空间。前者也是 Node.js 事件模块和 eventemitter3 早期实现的做法。

如果 events 是数组，这里我没有用 isArray 进行判断，而是直接用一个 else ，原因是 this._events[type] 的输入限制在 on 或者 once 中，而它们已经限制了 this._events[type] 只能是方法组成的数组或者是一个方法，最多加上不小心或者人为赋成 undefined 或 null 的情况，但这个情况我们也在前面判断过了。

因为 isArray 这个工具方法其实运行效率是不高的，为了追求一些效率，在不影响运行逻辑情况下可以不用 isArray 。而且 typeof events === 'function' 用 typeof 判断方法也比 isArray 的效率要高，这也是为什么不先判断是否是数组的原因。用 typeof 去判断一个方法也比 Object.prototype.toSting.call(events) === '[object Function] 效率要高。但数组不能用 typeof 进行判断，因为返回的是 object， 这众所周知。虽然如此，在我面试过的很多人中，仍然有很多人不知道。。。

const findIndex = events.findIndex(e => e === fn) 此处用 ES6 的数组方法 findIndex 直接去查找 fn 在 events 中的索引。如果 findIndex === -1 说明我们没有找到要删除的 fn ，直接返回 this 就好。如果 findIndex === 0 ，是数组第一个元素，shift 剔除，否则用 splice 剔除。因为 shift 比 splice 效率高。

findIndex 的效率其实没有 for 循环去查找的高，所以 eventemitter8 的效率在我没有做 benchmark 之前我就知道肯定会比 eventemitter3 效率要低不少。不那么追求执行效率时当然是用最懒的方式来写最爽。所谓的懒即正义。。。

最后还得判断移除 fn 后 events 剩余的数量，如果只有一个，基于之前要做的优化，this._events[type] = events[0] 把含有一个元素的数组变成一个方法，降维打击一下。。。

最后的最后 return this 返回自身，链式调用还能用得上。

removeAllListeners(type) {
 if (isNullOrUndefined(this._events)) return this;
 // if not provide type, remove all
 if (isNullOrUndefined(type)) this._events = Object.create(null);
 const events = this._events[type];
 if (!isNullOrUndefined(events)) {
  // check if type is the last one
  if (Object.keys(this._events).length === 1) {
   this._events = Object.create(null);
  } else {
   delete this._events[type];
  }
 }
 return this;
};

removeAllListeners 指的是要删除一个 type 对应的所有方法。参数 type 是可选的，如果未指定 type ，默认把所有的监听事件删除，直接 this._events = Object.create(null) 操作即可，跟初始化 EventEmitter 类一样。

如果 events 既不是 null 且不是 undefined 说明有可删除的 type ，先用 Object.keys(this._events).length === 1 判断是不是最后一个 type 了，如果是，直接初始化 this._events = Object.create(null)，否则 delete this._events[type] 直接删除 type 属性，一步到位。

最后返回 this 。

到目前为止，所有的核心功能已经讲完。

listeners(type) {
 if (isNullOrUndefined(this._events)) return [];
 const events = this._events[type];
 // use `map` because we need to return a new array
 return isNullOrUndefined(events) ? [] : (typeof events === 'function' ? [events] : events.map(o => o));
}

listenerCount(type) {
 if (isNullOrUndefined(this._events)) return 0;
 const events = this._events[type];
 return isNullOrUndefined(events) ? 0 : (typeof events === 'function' ? 1 : events.length);
}

eventNames() {
 if (isNullOrUndefined(this._events)) return [];
 return Object.keys(this._events);
}

listeners 返回的是 type 对应的所有方法。结果都是一个数组，如果没有，返回空数组；如果只有一个，把它的方法放到一个数组中返回；如果本来就是一个数组，map 返回。之所以用 map 返回而不是直接 return this._events[type] 是因为 map 返回一个新的数组，是深度复制，修改数组中的值不会影响到原数组。this._events[type] 则返回原数组的一个引用，是浅度复制，稍不小心改变值会影响到原数组。造成这个差异的底层原因是数组是一个引用类型，浅度复制只是指针拷贝。这可以单独写一篇文章，不展开了。

listenerCount 返回的是 type 对应的方法的个数，代码一眼就明白，不多说。

eventNames 这个返回的是所有 type 组成的数组，没有返回空数组，否则用 Object.keys(this._events) 直接返回。

最后的最后，export default EventEmitter 把 EventEmitter 导出。

上面是我整理给大家的，希望今后会对大家有帮助。

相关文章：

关于Google发布的JavaScript代码规范你要知道哪些

Angular HMR(热模块替换)功能实现方法

Vue自定义过滤器格式化数字三位加一逗号实现代码

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!