前言
今天讲解一下公共事件模块功能的实现,主要从“参考资料”,“Api说明”,“代码实现”,“运行效果”,几个方面进行描述
参考文档
参考资料 公共事件模块
Api说明
commonEvent.createSubscriber
createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback): void
以异步方法构造CommonEventSubscriber对象,创建公共事件订阅者对象,使用callback形式返回。
参数:
示例代码
var CommonEventSubscribeInfo = {events: ['publish_event']};
commonEvent.createSubscriber(CommonEventSubscribeInfo, (error, subscriber) => {
if (error != null) {
console.error('Operation failed. Cause:' + JSON.stringify(error));
} else {
var mySubscriber = subscriber;
console.info('createSubscriber success. ' + JSON.stringify(subscriber));
}
});
commonEvent.subscribe
subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback): void
以异步方法订阅公共事件,使用callback形式返回。在调用subscriber接口订阅公共事件前,需要先通过createSubscriber接口创建一个CommonEventSubscriber对象。
参数:
示例代码
commonEvent.subscribe(mySubscriber, (error, commonEventData) => { //mySubscriber为创建的CommonEventSubscriber对象
if (error != null) {
console.error('Operation failed. Cause: ' + JSON.stringify(error));
} else {
console.info('subscribe callback: ' + commonEventData);
}
});
commonEvent.unsubscribe
unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback): void
以异步方法取消订阅公共事件,使用callback形式返回。与subscribe接口相同,需要传入一个已创建的CommonEventSubscriber对象。
参数:
示例:
commonEvent.unsubscribe(mySubscriber, (error, commonEventData) => { //mySubscriber为创建的CommonEventSubscriber对象
if (error != null) {
console.error('Operation failed. Cause: ' + JSON.stringify(error));
} else {
console.info('unsubscribe success');
}
});
补充说明
CommonEventSubscribeInfo
订阅公共事件可选的配置信息。
示例
var CommonEventSubscribeInfo = {events: ['test_event']};
var CommonEventSubscribeInfo = {events: ['test_event1', 'test_event2'], userId:1, priority:100};
CommonEventData
公共事件的回调数据。
代码实现
// @ts-nocheck
import commonEvent from '@ohos.commonEvent';
@Entry
@Component
struct MyCommonEvent {
@State result:string="结果:";
mysubscriber:CommonEventSubscriber;
//todo 订阅通知
private aboutToAppear(){
var that=this;
var CommonEventSubscribeInfo = {events: ['publish_event']};
//todo 创建订阅
commonEvent.createSubscriber(CommonEventSubscribeInfo, (error, subscriber) => {
if (error != null) {
console.error('Operation failed. Cause:' + JSON.stringify(error));
} else {
that.mysubscriber=subscriber;
console.info('createSubscriber success. ' + JSON.stringify(subscriber));
//todo 开始订阅
commonEvent.subscribe(subscriber, (error, commonEventData) => { //mySubscriber为创建的CommonEventSubscriber对象
if (error != null) {
console.error('Operation failed. Cause: ' + JSON.stringify(error));
} else {
console.log('subscribe callback: ' + JSON.stringify(commonEventData));
that.result= JSON.stringify(commonEventData)
}
});
}
});
}
private aboutToDisappear() {
//取消订阅
commonEvent.unsubscribe(this.mysubscriber, (error, commonEventData) => { //mySubscriber为创建的CommonEventSubscriber对象
if (error != null) {
console.error('Operation failed. Cause: ' + JSON.stringify(error));
} else {
console.log('unsubscribe success');
}
});
}
build() {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Button('Send Common').onClick(event => {
this.broadcastInternal()
})
Text(this.result).width("100%").height("30%").fontSize(20).textAlign(TextAlign.Center)
}
.width('100%')
.height('100%')
}
//todo 发送信息
private broadcastInternal() {
// 自定义事件,只支持string类型数据
var data = {
code: 1, data: "111111", isOrdered: true
}
commonEvent.publish("publish_event", data, (error, value) => {
if (error != null) {
console.error('broadcast ---> publish failed. Cause: ' + JSON.stringify(error));
} else {
console.log('broadcast ---> publish common event success. ' + JSON.stringify(value));
}
});
}
}
运行效果
写在最后
有很多小伙伴不知道学习哪些鸿蒙开发技术?不知道需要重点掌握哪些鸿蒙应用开发知识点?而且学习时频繁踩坑,最终浪费大量时间。所以有一份实用的鸿蒙(HarmonyOS NEXT)文档用来跟着学习是非常有必要的。
这份鸿蒙(HarmonyOS NEXT)文档包含了鸿蒙开发必掌握的核心知识要点,内容包含了(ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、OpenHarmony南向开发、鸿蒙项目实战等等)鸿蒙(HarmonyOS NEXT)技术知识点。
希望这一份鸿蒙学习文档能够给大家带来帮助,有需要的小伙伴自行领取,限时开源,先到先得~无套路领取!!
获取这份完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习文档
鸿蒙(HarmonyOS NEXT)5.0最新学习路线
有了路线图,怎么能没有学习文档呢,小编也准备了一份联合鸿蒙官方发布笔记整理收纳的一套系统性的鸿蒙(OpenHarmony )学习手册(共计1236页)与鸿蒙(OpenHarmony )开发入门教学视频,内容包含:ArkTS、ArkUI、Web开发、应用模型、资源分类…等知识点。
获取以上完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习文档
《鸿蒙 (OpenHarmony)开发入门教学视频》
《鸿蒙生态应用开发V3.0白皮书》
《鸿蒙 (OpenHarmony)开发基础到实战手册》
OpenHarmony北向、南向开发环境搭建
《鸿蒙开发基础》
●ArkTS语言
●安装DevEco Studio
●运用你的第一个ArkTS应用
●ArkUI声明式UI开发
.……
《鸿蒙开发进阶》
●Stage模型入门
●网络管理
●数据管理
●电话服务
●分布式应用开发
●通知与窗口管理
●多媒体技术
●安全技能
●任务管理
●WebGL
●国际化开发
●应用测试
●DFX面向未来设计
●鸿蒙系统移植和裁剪定制
……
《鸿蒙进阶实战》
●ArkTS实践
●UIAbility应用
●网络案例
……