Простая шина событий на JavaScript

Использование шины событий имеет свои плюсы и минусы. Поэтому она должна добавляться осторожно, иначе вы можете получить код, который будет трудно поддерживать и понимать. Но нет никаких сомнений в том, что шина событий может значительно ускорить процесс прототипирования или улучшить архитектуру малого и среднего приложения. Большому приложению могут потребоваться некоторые дополнительные инструменты и подходы. В этой статье рассмотрим как реализовать простую шину событий в JavaScript.

Что такое шина событий (event bus)?

Шина событий реализует шаблон издатель/подписчик. Его можно использовать для разъединения компонентов приложения, так что компонент может реагировать на события, инициируемые другим компонентом, без их прямых зависимостей друг от друга. Им нужно только знать шину событий. Каждый подписчик может подписаться на определенное событие. Подписчик будет уведомлен, когда событие, на которое он подписан, будет опубликовано в шине событий. Издатель может публиковать события в шине событий, когда что-то происходит.

Реализация шины событий

В этой реализации подписчик (subscriber) является простой функцией. Функция вызывается, когда интересующее событие публикуется в шине событий. Для сопоставления события с подписчиками можно использовать простой объект. Формат данных в этом объекте будет следующим: { eventType: { id: callback } }. Например:

{  
  event1: {
    1: func1,
    2: func2
  },  
  event2: {
    3: func3
  }  
}

События event1 и event2 могут быть любого типа. В большинстве случаев имеет смысл использовать простые строки. Подписчики func1, func2 и func3 являются простыми JavaScript функциями.
func1 и func2 являются подписчиками, подписанными на события типа event1. func3 является подписчиком, подписанным на события типа event2. Идентификаторы 1, 2 и 3 будут использоваться позже для отмены подписки на подписчиков.

Как подписаться на событие?

Функция subscribe принимает в качестве аргументов интересующее событие и подписчика. Функция возвращает объект, предоставляющий функцию отмены подписки - unsubscribe. Функция unsubscribe может быть вызвана для удаления зарегистрированного подписчика. В этом примере используем генератор id для получения уникальных идентификаторов.
Идентификаторы используются для быстрой идентификации (за время O(1)) подписчика при вызове функции unsubscribe. Вместо использования генератора id можно рассмотреть реализацию на основе ES6 символов.

const subscriptions = {}
const getNextUniqueId = getIdGenerator()
function subscribe(eventType, callback) {
  const id = getNextUniqueId()

  // создаем новый элемент для eventType
  if(!subscriptions[eventType]) {
    subscriptions[eventType] = {}
  }
 
  // регистрируем функцию обратного вызова
  subscriptions[eventType][id] = callback
  return {
    unsubscribe: () => {
      delete subscriptions[eventType][id]
      if(Object.keys(subscriptions[eventType]).length === 0) {
        delete subscriptions[eventType]
      }
    }
  }
}

Как опубликовать событие?

Функция публикации принимает в качестве аргументов событие и аргументы для подписчиков. Если подписчиков на eventType нет, то просто завершаем функцию. В противном случае перебираются идентификаторы подписчиков, зарегистрированных для eventType, и вызывается каждая функция с предоставленными аргументами.

function publish(eventType, arg) {
  if(!subscriptions[eventType]) {
    return
  }
  Object.keys(subscriptions[eventType])
    .forEach(id => subscriptions[eventType][id](arg))
}

Пример использования

В качестве простого примера предположим, что мы хотим печатать что-то в консоли каждый раз, когда появляется событие типа print. Мы можем подписаться на событие следующим образом:

const subscription = EventBus.subscribe(
  "print",
  message => console.log(`printing: ${message}`)
)

Затем мы можем выпустить событие, подобное этому:

EventBus.publish("print", "some text")

Если в какой-то момент мы захотим прекратить прослушивание события с типом print, мы можем отписаться следующим образом:

subscription.unsubscribe()

Полная реализация

Вот полная реализация этой шины событий. Он может быть легко преобразован в простую функцию Javascript.

// eventBus.js

const subscriptions = {}
const getNextUniqueId = getIdGenerator()

function subscribe(eventType, callback) {
  const id = getNextUniqueId()

  if(!subscriptions[eventType]) {
    subscriptions[eventType] = {}
  }

  subscriptions[eventType][id] = callback

  return { 
    unsubscribe: () => {
      delete subscriptions[eventType][id]
      if(Object.keys(subscriptions[eventType]).length === 0) {
        delete subscriptions[eventType]
      }
    }
  }
}

function publish(eventType, arg) {
  if(!subscriptions[eventType]) {
    return
  }
  
  Object.keys(subscriptions[eventType]).forEach(key => subscriptions[eventType][key](arg))
}

function getIdGenerator() {
  let lastId = 0
  
  return function getNextUniqueId() {
    lastId += 1
    return lastId
  }
}

module.exports = { publish, subscribe }

События играют важную роль в web приложениях. С их помощью различные компоненты могут общаться друг с другом. Также они необходимы при реализации микрофронтенд архитектуры.

Как создать кастомное событие?

Есть несколько способов создать кастомное событие:

• при помощи конструктора Event,
• при помощи конструктора CustomEvent (предпочтительно)

Для того, чтобы в событии отправить дополнительные данные нужно воспользоваться CustomEvent.

Конструктор Event

Создать событие с помощью конструктора Event можно следующим образом:

const event = new Event('ADD_NOTIFICATION');

Имена событий не чувствительны к регистру (ADD_NOTIFICATION, add_notification будут восприниматься как одно и то же событие).

Конструктор CustomEvent

При помощи CustomEvent можно передавать дополнительные данные. Для этого нужно добавить их в поле detail.

const event = new CustomEvent('ADD_NOTIFICATION', {
  detail: {
    type: 'message',
    payload: 'Привет'
  }
});

Отправка событий

Событие создано, теперь нужно его отправить. Для отправки используется метод dispatchEvent(). Он принимает параметр event.

// event - объект, созданный выше
window.dispatchEvent(event);

Также в приложении есть код, который прослушивает это событие.

const handleAddNotification = (event) => {
  // ...
}
 
window.addEventListener('ADD_NOTIFICATION', handleAddNotification);

Где можно использовать кастомные события

Микрофронтенд приложения. В отличие от монолита, микрофронтенд архитектура предполагает наличие несколько изолированных частей приложения, которые используются вместе. Эти части могут быть написаны на разных фреймворках. Для того, чтобы эти части могли обмениваться между собой данными нужен слой для общения. CustomEvent - это нативное решение, не зависящее от фреймворка, отлично подходит для этих целей.