HarmonyOS4.0系统性深入开发18公共事件简介

公共事件简介

HarmonyOS通过CES（Common Event Service，公共事件服务）为应用程序提供订阅、发布、退订公共事件的能力。

公共事件从系统角度可分为：系统公共事件和自定义公共事件。

  • 系统公共事件：CES内部定义的公共事件，只有系统应用和系统服务才能发布，例如HAP安装，更新，卸载等公共事件。目前支持的系统公共事件详见系统公共事件列表。
  • 自定义公共事件：应用自定义一些公共事件用来实现跨进程的事件通信能力。

公共事件按发送方式可分为：无序公共事件、有序公共事件和粘性公共事件。

  • 无序公共事件：CES转发公共事件时，不考虑订阅者是否接收到，且订阅者接收到的顺序与其订阅顺序无关。
  • 有序公共事件：CES转发公共事件时，根据订阅者设置的优先级等级，优先将公共事件发送给优先级较高的订阅者，等待其成功接收该公共事件之后再将事件发送给优先级较低的订阅者。如果有多个订阅者具有相同的优先级，则他们将随机接收到公共事件。
  • 粘性公共事件：能够让订阅者收到在订阅前已经发送的公共事件就是粘性公共事件。普通的公共事件只能在订阅后发送才能收到，而粘性公共事件的特殊性就是可以先发送后订阅。发送粘性事件必须是系统应用或系统服务，且需要申请ohos.permission.COMMONEVENT_STICKY权限，配置方式请参阅访问控制授权申请指导。

每个应用都可以按需订阅公共事件，订阅成功，当公共事件发布时，系统会将其发送给对应的应用。这些公共事件可能来自系统、其他应用和应用自身。

图1 公共事件示意图

img

公共事件订阅概述

公共事件服务提供了动态订阅和静态订阅两种订阅方式。动态订阅与静态订阅最大的区别在于，动态订阅是应用运行时行为，而静态订阅是后台服务无需处于运行状态。

  • 动态订阅：指订阅方在运行时调用公共事件订阅的API实现对公共事件的订阅，详见动态订阅公共事件。
  • 静态订阅：订阅方通过配置文件声明和实现继承自StaticSubscriberExtensionAbility的类实现对公共事件的订阅，详见静态订阅公共事件。

动态订阅公共事件

场景介绍

动态订阅是指当应用在运行状态时对某个公共事件进行订阅，在运行期间如果有订阅的事件发布那么订阅了这个事件的应用将会收到该事件及其传递的参数。例如，某应用希望在其运行期间收到电量过低的事件，并根据该事件降低其运行功耗，那么该应用便可动态订阅电量过低事件，收到该事件后关闭一些非必要的任务来降低功耗。订阅部分系统公共事件需要先申请权限，订阅这些事件所需要的权限请见公共事件权限列表。

接口说明

详细接口见接口文档。

接口名接口描述
createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback<CommonEventData>): void创建订阅者对象(callback)
createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise创建订阅者对象(promise)
subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback): void订阅公共事件

开发步骤

  1. 导入CommonEvent模块。

    import commonEvent from '@ohos.commonEventManager';

  2. 创建订阅者信息，详细的订阅者信息数据类型及包含的参数请见CommonEventSubscribeInfo文档介绍。

    // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
let subscriber = null;
// 订阅者信息
let subscribeInfo = {
    events: ["usual.event.SCREEN_OFF"], // 订阅灭屏公共事件
}

  3. 创建订阅者，保存返回的订阅者对象subscriber，用于执行后续的订阅、退订等操作。

    // 创建订阅者回调
commonEvent.createSubscriber(subscribeInfo, (err, data) => {
    if (err) {
        console.error(`[CommonEvent] CreateSubscriberCallBack err=${JSON.stringify(err)}`);
    } else {
        console.info(`[CommonEvent] CreateSubscriber success`);
        subscriber = data;
        // 订阅公共事件回调
    }
})

  4. 创建订阅回调函数，订阅回调函数会在接收到事件时触发。订阅回调函数返回的data内包含了公共事件的名称、发布者携带的数据等信息，公共事件数据的详细参数和数据类型请见CommonEventData文档介绍。

    // 订阅公共事件回调
if (subscriber !== null) {
    commonEvent.subscribe(subscriber, (err, data) => {
        if (err) {
            console.error(`[CommonEvent] SubscribeCallBack err=${JSON.stringify(err)}`);
        } else {
            console.info(`[CommonEvent] SubscribeCallBack data=${JSON.stringify(data)}`);
        }
    })
} else {
    console.error(`[CommonEvent] Need create subscriber`);
}

静态订阅公共事件（仅对系统应用开放）

场景介绍

静态订阅者在未接收订阅的目标事件时，处于未拉起状态，当系统或应用发布了指定的公共事件后，静态订阅者将被拉起，并执行onReceiveEvent回调，开发者可通过在onReceiveEvent回调中执行业务逻辑，实现当应用接收到特定公共事件时执行业务逻辑的目的。例如，某应用希望在设备开机的时候执行一些初始化任务，那么该应用可以静态订阅开机事件，在收到开机事件后会拉起该应用，然后执行初始化任务。静态订阅是通过配置文件声明和实现继承自StaticSubscriberExtensionAbility的类实现对公共事件的订阅。需要注意的是，静态订阅公共事件对系统功耗有一定影响，建议谨慎使用。

开发步骤

  1. 静态订阅者声明

    声明一个静态订阅者，首先需要在工程中新建一个ExtensionAbility, 该ExtensionAbility从StaticSubscriberExtensionAbility派生，其代码实现如下：

    import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility'

export default class StaticSubscriber extends StaticSubscriberExtensionAbility {
    onReceiveEvent(event) {
        console.log('onReceiveEvent, event:' + event.event);
    }
}

    开发者可以在onReceiveEvent中实现业务逻辑。

  2. 静态订阅者工程配置

    在完成静态订阅者的代码实现后，需要将该订阅者配置到系统的module.json5中，配置形式如下：

    {
  "module": {
    ......
    "extensionAbilities": [
      {
        "name": "StaticSubscriber",
        "srcEntrance": "./ets/StaticSubscriber/StaticSubscriber.ts",
        "description": "$string:StaticSubscriber_desc",
        "icon": "$media:icon",
        "label": "$string:StaticSubscriber_label",
        "type": "staticSubscriber",
        "visible": true,
        "metadata": [
          {
            "name": "ohos.extension.staticSubscriber",
            "resource": "$profile:subscribe"
          }
        ]
      }
    ]
    ......
  }
}

    上述json文件主要关注以下字段：

    • srcEntrance : 表示ExtensionAbility的入口文件路径，即步骤2中声明的静态订阅者所在的文件路径
    • type: 表示ExtensionAbility的类型，对于静态订阅者需要声明为“staticSubscriber”
    • metadata: 表示ExtensionAbility的二级配置文件信息。由于不同的ExtensionAbility类型其配置信息不尽相同，因此需要使用不同的config文件表示其具体配置信息。
      • name：表示ExtensionAbility的类型名称，对于静态订阅类型，name必须声明为“ohos.extension.staticSubscriber”，否则无法识别为静态订阅者；
      • resource: 字段表示ExtensionAbility的配置信息路径，由开发者自行定义，在本例中表示路径为“resources/base/profile/subscribe.json"。

    metadata指向的二级配置文件的通常形式如下：

    {
  "commonEvents": [
    {
      "name": "xxx",
      "permission": "xxx",
      "events":[
        "xxx"
      ]
    }
  ]
}

    需要注意二级配置文件必须按照此形式进行声明，否则会无法正确识别。下面对字段进行介绍：

    • name: 静态订阅ExtensionAbility的名称，需要和module.json5中声明的ExtensionAbility的name一致
    • permission：订阅者要求的发布者需要具备的权限，对于发布了目标事件但不具备permission中声明的权限的发布者将被视为非法事件不予发布
    • events: 订阅的目标事件列表

  3. 修改设备系统配置文件

    修改设备系统配置文件 /etc/static_subscriber_config.json，将静态订阅应用者的包名添加至该json文件中即可。

    {
    "xxx",
    "ohos.extension.staticSubscriber",
    "xxx"
}

取消动态订阅公共事件

场景介绍

动态订阅者完成业务需要时，需要主动取消订阅，订阅者通过调用unsubscribe()方法取消订阅事件。

接口说明

接口名接口描述
unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback)取消订阅公共事件

开发步骤

  1. 导入CommonEvent模块。

    import commonEvent from '@ohos.commonEventManager';

  2. 根据动态订阅公共事件章节的步骤来订阅某个事件。

  3. 调用CommonEvent中的unsubscribe方法取消订阅某事件。

    // subscriber为订阅事件时创建的订阅者对象
if (subscriber !== null) {
    commonEvent.unsubscribe(subscriber, (err) => {
        if (err) {
            console.error(`[CommonEvent] UnsubscribeCallBack err=${JSON.stringify(err)}`)
        } else {
            console.info(`[CommonEvent] Unsubscribe`)
            subscriber = null
        }
    })
}

公共事件发布

场景介绍

当需要发布某个自定义公共事件时，可以通过publish()方法发布事件。发布的公共事件可以携带数据，供订阅者解析并进行下一步处理。

注意

已发出的粘性公共事件后来订阅者也可以接收到，其他公共事件都需要先订阅再接收，订阅参考公共事件订阅章节。

接口说明

详细接口见接口文档。

接口名接口描述
publish(event: string, callback: AsyncCallback)发布公共事件。
publish(event: string, options: CommonEventPublishData, callback: AsyncCallback)指定发布信息并发布公共事件。

发布不携带信息的公共事件

不携带信息的公共事件，只能发布无序公共事件。

  1. 导入CommonEvent模块。

    import commonEvent from '@ohos.commonEventManager';

  2. 传入需要发布的事件名称和回调函数，发布事件。

    // 发布公共事件
commonEvent.publish("usual.event.SCREEN_OFF", (err) => {
    if (err) {
        console.error(`[CommonEvent] PublishCallBack err=${JSON.stringify(err)}`);
    } else {
        console.info(`[CommonEvent] Publish success`);
    }
})

发布携带信息的公共事件

携带信息的公共事件，可以发布为无序公共事件、有序公共事件和粘性事件，可以通过参数CommonEventPublishData的isOrdered、isSticky的字段进行设置。

  1. 导入CommonEvent模块。

    import commonEvent from '@ohos.commonEventManager';

  2. 传入需要发布的事件名称和回调函数，发布事件。

    // 公共事件相关信息
let options = {
    code: 1, // 公共事件的初始代码
    data: "initial data", // 公共事件的初始数据
}

  3. 传入需要发布的事件名称、需要发布的指定信息和回调函数，发布事件。

    // 发布公共事件
commonEvent.publish("usual.event.SCREEN_OFF", options, (err) => {
    if (err) {
        console.error('[CommonEvent] PublishCallBack err=' + JSON.stringify(err));
    } else {
        console.info('[CommonEvent] Publish success')
    }
})

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/313978.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

对比学习2024最新SOTA＆应用方案分享，附14篇必读论文和代码

对比学习2024最新SOTA＆应用方案分享，附14篇必读论文和代码

同学们发现没有&#xff0c;对比学习在我们的日常工作生活中已经很常见了&#xff0c;比如推荐系统任务&#xff0c;为用户推荐相似的商品或预测用户的购买行为&#xff1b;又比如图像检索&#xff0c;为用户找相似图片或识别不同物体。另外还有语音识别、人脸识别、NLP&#x…
阅读更多...
43-函数的声明定义，函数表达式定义，函数的调用，声明提升，参数，形参，实参

43-函数的声明定义，函数表达式定义，函数的调用，声明提升，参数，形参，实参

1.函数声明定义 function 函数名(){} 2.函数表达式定义 匿名式函数表达式 var 函数名 function(){} 命名式函数表达式 var 函数名 function 函数关键字(){} 3.函数的调用 var fn function f(){alert("aaa");}//函数名&#xff08;&#xff09;//函数想调用几次…
阅读更多...
京东年度数据报告-2023全年度游戏本十大热门品牌销量（销额）榜单

京东年度数据报告-2023全年度游戏本十大热门品牌销量（销额）榜单

同笔记本市场类似&#xff0c;2023年度游戏本市场的整体销售也呈下滑态势。根据鲸参谋电商数据分析平台的相关数据显示&#xff0c;京东平台上游戏本的年度销量累计超过350万&#xff0c;同比下滑约6%&#xff1b;销售额将近270亿&#xff0c;同比下滑约11%。 鲸参谋综合了京东…
阅读更多...
7、防写一个shell 命令解释器

7、防写一个shell 命令解释器

1、代码部分 #include <stdio.h> #include <stdlib.h> #include <string.h>#define MAX_INPUT_LENGTH 100void parse_command(char *command) {// 用于存储解析后的命令和参数char cmd[MAX_INPUT_LENGTH];char args[MAX_INPUT_LENGTH];// 将输入的命令拷贝到…
阅读更多...
Java Swing 图书借阅系统 窗体项目 期末课程设计 窗体设计

Java Swing 图书借阅系统 窗体项目 期末课程设计 窗体设计

视频教程&#xff1a; 【课程设计】图书借阅系统 功能描述&#xff1a; 图书管理系统有三个角色&#xff0c;系统管理员、图书管理员、借阅者&#xff1b; 系统管理员可以添加借阅用户&#xff1b; ​图书管理员可以添加图书&#xff0c;操作图书借阅和归还&#xff1b; 借…
阅读更多...
JDK安装与配置教程来啦

JDK安装与配置教程来啦

1.从Oracle公司官网下载JDK安装文件。 官网地址为&#xff1a; http://www.oracle.com/technetwork/java/javase/downloads/index.html 目前最新版本是JDK21,下面就以JDK21举例。 2.需要登录Oracle账户&#xff0c;没有的注册一下就行了。 3.在确认安装的盘符&#xff08;例…
阅读更多...
Exception in thread “main“ java.lang.ArrayIndexOutOfBoundsException（数组创建问题）

Exception in thread “main“ java.lang.ArrayIndexOutOfBoundsException（数组创建问题）

数组在Java中使用还是比较多的&#xff0c;通过索引去数组中寻值&#xff0c;也可以通过数组索引去赋值 问题描述&#xff1a; 我们在直接使用未被new的数组时就会出现这种情况&#xff0c; 这边简单创建一个运行类 public class a {public static void main(String[] args)…
阅读更多...
基于LVGL编写的windows串口工具： LCOM

基于LVGL编写的windows串口工具： LCOM

LCOM: Serial Port Tools based on LVGL (PC Software) 一直以来我都想用LVGL做一个真正意义上的PC软件&#xff0c;来验证或者表达LVGL出色的特性&#xff0c;现在我用LCOM做到了&#xff01; LCOM 是一个基于LVGL编写的串口工具&#xff0c;界面简洁&#xff0c;功能出色&a…
阅读更多...
更快更稳的4K响应鼠标，小手玩家也能用，雷柏VT9PRO mini

更快更稳的4K响应鼠标，小手玩家也能用，雷柏VT9PRO mini

雷柏今年推出了不少新品&#xff0c;特别是一系列支持4K回报率的鼠标&#xff0c;凭借敏捷的响应速度&#xff0c;获得了非常好的评价。不过之前雷柏出的4K鼠标都多适合中大手&#xff0c;对小手用户不友好&#xff0c;而且配色较少&#xff0c;都是黑白色的基础款&#xff0c;…
阅读更多...
数字集成系统设计——物理设计

数字集成系统设计——物理设计

目录 一、布局规划 1.1 规划 1.2 I/O单元 1.3 电源网络 1.3.1 要求 1.3.2 网络架构 1.3.3 混合信号芯片示例 1.4 布局 二、时钟分布 2.1 时钟偏斜 2.2 时钟分布网络 2.3 时钟树综合 2.4 时钟树收敛 三、布线与参数提取 3.1 布线(Routing) 3.2 布线规则示例 …
阅读更多...
这是一家有图书馆的公司

这是一家有图书馆的公司

Tubi 技术团队的同事们&#xff0c;除了爱写书、翻译书&#xff0c;也很爱读书。应广大爱书人号召&#xff0c;Tubi 中国团队从 2018 年 7 月开始兴建 Tubi 小书架&#xff0c;迄今已建成了一个有着17 种类别、近 500 本藏书、100 位常驻借阅成员、以音视频开发、广告推荐和团队…
阅读更多...
什么是云服务器ECS及其优势、购买、使用方式和部署建议

什么是云服务器ECS及其优势、购买、使用方式和部署建议

阿里云服务器ECS英文全程Elastic Compute Service&#xff0c;云服务器ECS是一种安全可靠、弹性可伸缩的云计算服务&#xff0c;阿里云提供多种云服务器ECS实例规格&#xff0c;如经济型e实例、通用算力型u1、ECS计算型c7、通用型g7、GPU实例等&#xff0c;阿里云百科aliyunbai…
阅读更多...
接口自动化测试持续集成，Soapui接口功能测试参数化

接口自动化测试持续集成，Soapui接口功能测试参数化

按照自动化测试分层实现的原理&#xff0c;每一层的脚本实现都要进行参数化&#xff0c;自动化的目标就是要实现脚本代码与测试数据分离。 当测试数据进行调整的时候不会对脚本的实现带来震荡&#xff0c;从而提高脚本的稳定性与灵活度&#xff0c;降低脚本的维护成本。 Soapui…
阅读更多...
MySQL安装服务启动失败解决方案

MySQL安装服务启动失败解决方案

在安装MySQL中&#xff0c;应用配置阶段&#xff0c;显示服务启动失败 查看日志说服务启动失败 我的电脑是win764位 新装的操作系统&#xff0c;之前出现过权限不足的提示&#xff0c;首先定位故障为权限问题。由于MySQL80服务在 计算机管理->服务 里面显示户别为&#xff…
阅读更多...
Java实现Excel导入和导出

Java实现Excel导入和导出

一 、环境准备 maven依赖 本次工具类的封装主要依赖于阿里巴巴的JSON包&#xff0c;以及表格处理的POI包&#xff0c;所以我们需要导入这两个库的依赖包&#xff0c;另外&#xff0c;我们还需要文件上传的相关包&#xff0c;毕竟我们在浏览器页面&#xff0c;做Excel导入时&a…
阅读更多...
web学习笔记（十五）

web学习笔记（十五）

目录 1.Date对象 1.1日期对象的概念 1.2Date()方法的使用 1.3Date()常用方法汇总 1.4例题&#xff1a;用函数编写一个倒计时 2.函数 2.1函数的概念 2.2函数的使用 2.3函数的参数 2.4函数的声明 2.5函数的返回值 2.6异步函数 3特殊函数类型 3.1匿名函数 3.2箭头函数…
阅读更多...
[每周一更]-(第82期)：认识自然处理语言（NLP）

[每周一更]-(第82期)：认识自然处理语言（NLP）

GPT的大火&#xff0c;带起了行业内大模型的爆发&#xff1b;国内外都开始拥有或者研发自己的大模型&#xff0c;下边我们从NLP来进一步深入了解大模型、AI。 一、什么是NLP&#xff1f; 自然语言处理&#xff08;英语&#xff1a;Natural Language Processing&#xff0c;缩…
阅读更多...
【python】进阶---＞MySQL数据库（一）

【python】进阶---＞MySQL数据库（一）

一、mysql数据库 关系型数据库 &#xff1a; 一些相关的表和其他数据库对象的集合。 表是由行和列组成。列包含一组命名的属性(也称为字段)。 行包含一组记录&#xff0c;行和列的交集称为数据项(也叫字段值)。 数据库(database) : 存储数据的仓库&#xff0c;本质上就是一个文…
阅读更多...
业务向——基于多多进宝平台的CPS

业务向——基于多多进宝平台的CPS

业务向——基于多多进宝平台的CPS 导读小试牛刀商品活动推广商品详情获取频道推广订单获取及和用户绑定小结 导读 多多进宝是拼多多的开放平台&#xff0c;为广大商家和推广者提供了一个机会&#xff0c;通过推广拼多多的商品来实现收益。多多进宝的CPS&#xff08;按效果付费…
阅读更多...
强化学习应用（一）：基于Q-learning的无人机物流路径规划研究（提供Python代码）

强化学习应用（一）：基于Q-learning的无人机物流路径规划研究（提供Python代码）

一、Q-learning简介 Q-learning是一种强化学习算法&#xff0c;用于解决基于马尔可夫决策过程&#xff08;MDP&#xff09;的问题。它通过学习一个价值函数来指导智能体在环境中做出决策&#xff0c;以最大化累积奖励。 Q-learning算法的核心思想是通过不断更新一个称为Q值的…
阅读更多...
最新文章

Copyright @ 2022~2023