HarmonyOS 鸿蒙Next 利用emitter封装工具类,使得父组件与子组件实现事件监听
HarmonyOS 鸿蒙Next 利用emitter封装工具类,使得父组件与子组件实现事件监听
注意:只能用真机调试,在预览器会提示
The emitter.emit interface in the Previewer is a mocked implementation and may behave differently than on a real device.
调用示例
调用示例
import { MyEmitterUtil } from '../MyEmitterUtil'
@Component
struct MyView {
@Prop controller: MyEmitterUtil
@State info: string = ""
aboutToAppear(): void {
this.controller.onChild((eventData) => {
console.info('====eventData', JSON.stringify(eventData))
if (eventData.flag == "ABC") {
this.info = eventData.data
}
})
}
build() {
Column() {
Text('子组件接收到的数据:' + this.info)
Button('向父组件发送数据').onClick(() => {
this.controller.emitFather("CCC", "EEE")
})
}
}
}
@Entry
@Component
struct Page81 {
controller: MyEmitterUtil = new MyEmitterUtil()
@State info: string = ""
aboutToAppear(): void {
this.controller.onFather((eventData) => {
console.info('====eventData', JSON.stringify(eventData))
if (eventData.flag == "CCC") {
this.info = eventData.data
}
})
}
build() {
Row() {
Column() {
Text('父组件接收到的数据:' + this.info)
Button('向子组件发送数据').onClick(() => {
this.controller.emitChild("ABC", "conter")
})
MyView({ controller: this.controller })
}
.width('100%')
}
.height('100%')
}
}
工具类
import Emitter from '@ohos.events.emitter';
/**
* `MyEmitterUtil` 是一个针对 HarmonyOS 的事件驱动编程封装类,主要用于组件间的通信和数据传递。
*
* 使用要求:
* - API 版本:api 11
* 示例用法:
* 1. 父组件绑定、解绑、向子组件发送事件:
* ```typescript
* aboutToAppear() {
* this.myEmitterUtil.onFather((eventData: EmitterData) => {
* console.info('父组件监听结果: ', JSON.stringify(eventData));
* // 判断事件类型并执行相应操作...
* });
* }
*
* aboutToDisappear() {
* this.myEmitterUtil.offFather();
* }
*
* // 向子组件发送事件
* this.myEmitterUtil.emitChild(MyEmitterUtil.UPDATE_DETAIL, "携带的测试数据");
* ```
*
* 2. 子组件绑定、解绑、向父组件发送事件:
* ```typescript
* aboutToAppear() {
* this.myEmitterUtil.onChild((eventData: EmitterData) => {
* console.info('子组件监听结果: ', JSON.stringify(eventData));
* // 判断事件类型并执行相应操作...
* });
* }
*
* aboutToDisappear() {
* this.myEmitterUtil.offChild();
* }
*
* // 向父组件发送事件
* this.myEmitterUtil.emitFather(MyEmitterUtil.UPDATE_LIST, "测试");
* this.myEmitterUtil.emitFather(MyEmitterUtil.UPDATE_LIST_2, "测试2");
* ```
*
* 参考文档:
* - 请查阅 HarmonyOS 开发文档了解详细信息。
*/
export class MyEmitterUtil {
private static EVENT_ID_COUNTER: number = 0; // 自动递增,生成唯一的事件ID
private readonly eventIdFather: number;
private readonly eventIdChild: number;
constructor() {
this.eventIdFather = MyEmitterUtil.EVENT_ID_COUNTER++;
this.eventIdChild = MyEmitterUtil.EVENT_ID_COUNTER++;
console.info(`事件ID(父组件): ${this.eventIdFather}`);
console.info(`事件ID(子组件): ${this.eventIdChild}`);
}
// 定义业务状态标识常量
static readonly UPDATE_LIST = "UPDATE_LIST";
static readonly UPDATE_LIST_2 = "UPDATE_LIST_2";
static readonly UPDATE_DETAIL = "UPDATE_DETAIL";
/**
* 在组件的`aboutToAppear`生命周期钩子中调用,监听父组件事件
* @param callback 事件回调函数,接受一个`EmitterData`对象作为参数
*/
onFather(callback: (eventData: EmitterData) => void) {
Emitter.on({ eventId: this.eventIdFather }, (event) => {
if (event.data) {
callback(new EmitterData(event.data.flag, event.data.data));
}
});
}
/**
* 在组件的`aboutToDisappear`生命周期钩子中调用,解除父组件事件监听
*/
offFather() {
Emitter.off(this.eventIdFather);
}
/**
* 在组件的`aboutToAppear`生命周期钩子中调用,监听子组件事件
* @param callback 事件回调函数,接受一个`EmitterData`对象作为参数
*/
onChild(callback: (eventData: EmitterData) => void) {
Emitter.on({ eventId: this.eventIdChild }, (event) => {
if (event.data) {
callback(new EmitterData(event.data.flag, event.data.data));
}
});
}
/**
* 在组件的`aboutToDisappear`生命周期钩子中调用,解除子组件事件监听
*/
offChild() {
Emitter.off(this.eventIdChild);
}
/**
* 向父组件发送事件
* @param flag 事件类型标识
* @param data 事件携带的数据
*/
emitFather(flag: string, data: string) {
Emitter.emit(
{ eventId: this.eventIdFather, priority: Emitter.EventPriority.IMMEDIATE },
{ data: { flag, data } }
);
}
/**
* 向子组件发送事件
* @param flag 事件类型标识
* @param data 事件携带的数据
*/
emitChild(flag: string, data: string) {
Emitter.emit(
{ eventId: this.eventIdChild, priority: Emitter.EventPriority.IMMEDIATE },
{ data: { flag, data } }
);
}
}
/**
* 用于封装事件数据的类
*/
export class EmitterData {
flag: string = "";
data: string = "";
constructor(flag: string, data: string) {
this.flag = flag;
this.data = data;
}
}
8 回复
补充:封装思想就是把父组件与子组件共用一个实例,互相发送数据,
ID问题我已经在工具类里封装好了,也不需要考虑,方便使用。
在 API11 private readonly eventIdFather: number; private readonly eventIdChild: number; 不初始化会报错 Property 'eventIdChild' has no initializer and is not definitely assigned in the constructor. <ArkTSCheck> (其实是升级API 11 之后很多校验报错),请问楼主是怎么做到你的代码里不用初始化也不报错的
因为我的代码里有constructor(),在这里给初始化了所以就不报错了哈。 除此之外还可以用?:的形式,比如 eventIdChild?: number
好的,感谢
father跟child不是一样的吗?感觉不用局限父子组件呀,比如我跨page页面之间的传递(登录页跟用户页),应该维护两个方法就够了,类似EventBus的,一个post()发送,一个subscribed()接收。还可以加一下单次发送once的方法。ID封装在里面确实挺好的,方便使用。
👍
在HarmonyOS鸿蒙系统中,通过emitter封装工具类以实现父组件与子组件之间的事件监听,可以借鉴JavaScript中事件发射器的概念。以下是一个简要实现思路:
-
定义Emitter类:
- 创建一个Emitter类,内部维护一个事件监听器映射。
- 提供
on
方法用于注册事件监听器,emit
方法用于触发事件。
-
封装工具类:
- 将Emitter类封装为工具类,提供静态方法供全局使用。
- 静态方法内实例化Emitter对象,管理事件监听与触发。
-
父组件与子组件通信:
- 父组件通过工具类注册事件监听器。
- 子组件在需要时通过工具类触发事件,传递必要参数。
-
事件处理:
- 父组件的监听器接收到事件后,执行相应逻辑处理。
示例代码(简化):
public class Emitter {
// 事件监听器映射
private Map<String, Consumer<Object>> listeners = new HashMap<>();
public void on(String event, Consumer<Object> listener) {
listeners.put(event, listener);
}
public void emit(String event, Object data) {
listeners.getOrDefault(event, o -> {}).accept(data);
}
}
// 工具类(单例模式管理Emitter实例)
public class EventBus {
private static final Emitter emitter = new Emitter();
public static void on(String event, Consumer<Object> listener) { emitter.on(event, listener); }
public static void emit(String event, Object data) { emitter.emit(event, data); }
}
如果问题依旧没法解决请联系官网客服,官网地址是:https://www.itying.com/category-93-b0.html