写点什么

【HarmonyOS】鸿蒙利用 emitter 封装工具类

作者:zhongcx
  • 2024-10-11
    广东
  • 本文字数:2581 字

    阅读完需:约 8 分钟

利用 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'
@Componentstruct 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@Componentstruct 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; }}

复制代码


用户头像

zhongcx

关注

还未添加个人签名 2024-09-27 加入

还未添加个人简介

评论

发布
暂无评论
【HarmonyOS】鸿蒙利用emitter封装工具类_zhongcx_InfoQ写作社区