customevent 实现组件通信的核心是利用浏览器原生事件系统,通过 new customevent() 创建、dispatchevent() 派发、addeventlistener() 监听,数据通过 detail 传递,推荐使用 document 或 eventtarget 实例作为事件目标,并注意命名规范、内存泄漏及兼容性。

JS 中通过 CustomEvent 实现组件间通信,核心是利用浏览器原生的事件系统——在某个组件中触发自定义事件,在另一个组件中监听该事件。它不依赖框架,轻量、解耦,特别适合纯 JS 组件、Web Components 或跨层级(非父子)的简单通信场景。
创建并派发自定义事件
使用 new CustomEvent() 构造函数创建事件,再通过 dispatchEvent() 派发。关键点是:事件名要唯一可识别,数据通过 detail 属性传递(必须是可序列化值,如对象、字符串、数字)。
- 事件名建议加前缀避免冲突,比如
"my-app:login-success"或"ui:modal-close" -
detail是唯一允许传参的字段,不能直接写new CustomEvent("xxx", { data: {...} }) - 派发目标通常是
document、window或一个共享的元素(如根容器),确保监听方能捕获
示例:
// 组件 A:登录成功后通知全局
const event = new CustomEvent("app:user-login", {
detail: { userId: 123, token: "abc123" }
});
document.dispatchEvent(event);
在其他组件中监听自定义事件
用 addEventListener() 监听同名事件即可。监听位置取决于通信范围:全局通信用 document 或 window;局部通信可绑定到共同父元素或专门的事件总线元素。
将一个或多个视频上传至YouTube。当用户想“上传到YouTube”“发YouTube”“批量上传”“upload to YouTube”“post videos to YouTube”或发布到YouTube时使用此技能。
- 监听和派发需使用同一个目标对象(比如都用
document) - 记得在组件销毁时调用
removeEventListener()避免内存泄漏(尤其在单页应用中) - 事件对象的
detail属性就是派发时传入的数据,直接解构使用
示例:
// 组件 B:监听用户登录事件
function handleLogin(e) {
console.log("收到登录数据:", e.detail); // { userId: 123, token: "abc123" }
}
document.addEventListener("app:user-login", handleLogin);
// 卸载时清理(例如组件 unmount)
// document.removeEventListener("app:user-login", handleLogin);
封装成简易事件总线(可选增强)
如果项目中自定义事件较多,可封装一个轻量总线对象,统一管理派发与监听,提升可维护性。
- 内部仍基于
document(或new EventTarget()),但提供更语义化 API - 支持一次性监听(
once)、移除所有监听(offAll)等扩展能力 - 现代写法也可直接用
new EventTarget()实例替代document,更纯粹、无全局污染
示例(基于 EventTarget):
const bus = new EventTarget();
// 发布
bus.dispatchEvent(new CustomEvent("data:updated", { detail: { count: 42 } }));
// 订阅
bus.addEventListener("data:updated", (e) => {
console.log("新数据:", e.detail.count);
});
注意事项和常见坑
CustomEvent 简单,但几个细节容易出错:
-
事件不会冒泡到 shadow DOM 外部(Web Components 中需手动分发到
composed: true) - 同步执行:监听回调会立即运行,不支持异步等待,如需响应式链式处理,需自行包装 Promise
- 没有内置的“事件中心”概念:必须约定好事件名和数据结构,建议配合 TypeScript 接口或文档说明
- IE 不支持
CustomEvent构造函数(需 polyfill 或用document.createEvent回退)










