简介
gm-ebus 是一个 Node.js 的事件总线库，可以在不修改代码的情况下实现组件之间的通信。它支持多种事件订阅和发布模式，使得开发者可以灵活地按需使用。
本文将介绍如何使用 gm-ebus 来实现通信，包括基本使用、高级使用、定制化需求等。
在开始学习 gm-ebus 之前，请确保你已经熟悉了 Node.js 的基本使用和事件理论知识。
安装
要使用 gm-ebus，需要安装 npm 包。请在终端中执行以下命令：
npm i gm-ebus
基本使用
使用 gm-ebus 可以分为两个步骤：注册事件和触发事件。
注册事件
使用 on() 方法注册事件。该方法传入两个参数：事件名和事件回调函数。
const ebus = require("gm-ebus");
ebus.on("event1", (arg1, arg2) => {
console.log(`event1 received with ${arg1} and ${arg2}`);
});触发事件
使用 emit() 方法触发事件。该方法传入两个参数：事件名和事件参数。
ebus.emit("event1", "foo", "bar");示例代码
const ebus = require("gm-ebus");
ebus.on("event1", (arg1, arg2) => {
console.log(`event1 received with ${arg1} and ${arg2}`);
});
ebus.emit("event1", "foo", "bar");
// Output: event1 received with foo and bar常用 API
once()
once() 方法与 on() 方法的用法相同，但是事件会在第一次触发后自动解绑。用于只关心一次事件的场景。
off()
off() 方法可以用来解绑注册的事件。它支持解绑单个事件和所有事件。
// 解绑所有事件
ebus.off();
// 解绑指定事件
ebus.off("event1");all()
all() 方法可以监听所有事件，并在任何事件触发时执行回调函数。
ebus.all((eventName, arg1, arg2) => {
console.log(`event ${eventName} received with ${arg1} and ${arg2}`);
});
ebus.emit("event2", "foo", "bar");
// Output: event event2 received with foo and bar高级使用
在复杂的场景中，你可能需要更灵活的方式来处理事件。这时，可以使用 gm-ebus 提供的更高级的 API。
onGroup()
onGroup() 方法可以注册一组事件，它们会被打包成一个组。一个事件只要被触发，该组所有事件就会被触发。第一个参数为组名，之后的参数为每个事件的事件名和事件回调函数。
-- -------------------- ---- ------- ----------------------- ---------- ------ ----- -- - ------------------- -------- ---- ------- --- ---------- --- ---------- ------ ----- -- - ------------------- -------- ---- ------- --- ---------- ---- ------------------- ------ ------- -- ------- ------ -------- ---- --- --- --- -- ------- ------ -------- ---- --- --- ---
emitGroup()
emitGroup() 方法可以触发一组事件，它们会被打包成一个组。一个事件只要被触发，该组所有事件就会被触发。第一个参数为组名，之后的参数为每个事件的事件名和事件参数。
-- -------------------- ---- ------- ----------------------- ---------- ------ ----- -- - ------------------- -------- ---- ------- --- ---------- --- ---------- ------ ----- -- - ------------------- -------- ---- ------- --- ---------- ---- ------------------------- ---------- ------ -------- -- ------- ------ -------- ---- --- --- --- -- ------- ------ -------- ---- --- --- ---
onAny()
onAny() 方法可以监听所有事件，与 all() 方法类似。但是，该方法支持使用正则表达式匹配事件名。
ebus.onAny(/event.*/, (eventName, arg1, arg2) => {
console.log(`event ${eventName} received with ${arg1} and ${arg2}`);
});
ebus.emit("event5", "foo", "bar");
// Output: event event5 received with foo and bar定制化需求
在某些场景下，你可能需要更多的灵活性来处理你的事件。这时，你可以使用 gm-ebus 提供的定制 API。
config()
config() 方法可以用来配置 gm-ebus。目前支持的配置项有：
global：定义是否全局注册事件和触发事件，默认为false。debug：定义是否打开调试模式，默认为false。
const ebus = require("gm-ebus");
ebus.config({
global: true,
debug: true
});getInstance()
getInstance() 方法可以用来获取 gm-ebus 的实例。如果你有多个应用程序需要管理事件，你可以为它们各自创建一个 gm-ebus 实例。
const ebus = require("gm-ebus");
const ebus1 = ebus.getInstance();
const ebus2 = ebus.getInstance();
ebus1.emit("event1", "foo1", "bar1");
ebus2.emit("event1", "foo2", "bar2");总结
本文介绍了 npm 包 gm-ebus 的基本使用、常用 API、高级使用以及定制化需求。希望这篇文章对你有帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066e72255dee6beeee74d3