JS 中怎么通过自定义事件(CustomEvent)实现组件间通信

冬强姑娘_2510

冬强姑娘_2510

2026-10-14

391人浏览

原创

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

js 中怎么通过自定义事件(customevent)实现组件间通信

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;局部通信可绑定到共同父元素或专门的事件总线元素。

Wjs Uploading Video
Wjs Uploading Video

将一个或多个视频上传至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 回退)

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

javascript js

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4826

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1189

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4744

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

940

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1856

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3425

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4433

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2900

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

928

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习