静态订阅者在未接收订阅的目标事件时,处于未拉起状态,当系统或应用发布了指定的公共事件后,静态订阅者将被拉起,并执行 onReceiveEvent 回调。
开发者可通过在 onReceiveEvent 回调中执行业务逻辑,实现当应用接收到特定公共事件时执行业务逻辑的目的。
例如,某应用希望在设备开机的时候执行一些初始化任务,那么该应用可以静态订阅开机事件,在收到开机事件后会拉起该应用,然后执行初始化任务。
设备与环境:
-
设备:九联 s905l3a 机顶盒
-
系统:OpenHarmony 3.2 beta2
-
SDK:API 9(Full SDK)
实现过程
①声明静态订阅者
打开 DevEco Studio 创建一个新的 Stage 工程,在工程中新建一个目录 StaticSubscriber。
然后在该目录下面新建一个 ExtensionAbility 的 ets 文件,并让该 ExtensionAbility 从 StaticSubscriberExtensionAbility 派生。
我们可以在 onReceiveEvent(event){ } 中实现自己的业务逻辑,在这里我们实现通过订阅开机公共事件,来启动定时器,在日志中打印信息。
import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility'
import Logger from '../model/Logger'
export default class StaticSubscriber extends StaticSubscriberExtensionAbility {
num:number=0
onReceiveEvent(event) {
Logger.info(`rgytl ---- 监听到公共的事件为: ${event.event}`)
setInterval(() => {
this.num = this.num+1
Logger.info("rgytl ---- num = " + this.num)
}, 1000)
}
}
②静态订阅者工程配置
在完成静态订阅者的代码实现后,需要将该订阅者配置到系统的 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:订阅的目标事件列表。
在这里我监听的是开机事件和系统事件流逝时间:
{
"commonEvents": [
{
"name": "StaticSubscriber",
"permission": "",
"events":[
"usual.event.TIME_TICK",
"usual.event.BOOT_COMPLETED"
]
}
]
}
不知道是不是系统 bug,在 permission 字段添加权限的时候,会导致应用无法成功启动,使用就把权限去掉了。
③应用安装
首先,修改 OpenHarmony SDK toolchains lib 目录下面的 UnsgnedReleasedProfileTemplate.json 文件的 apl 字段,将 apl 字段改成 system_basic 或 system_core。
"bundle-info":{
"developer-id":"OpenHarmony",
"distribution-certificate":"xxxxxxx",
"app-feature":"hos_system_app",
"bundle-name":"com.example.xxxx",
"apl":"system_core"
},
然后,进入 905 设备系统,修改 905 设备系统配置文件,通过 hdc file recv /etc/static_subscriber_config.json D:\ 命令将系统配置文件存放到电脑中。
然后修改 static_subscriber_config.json 文件,在该文件中加入我们这个应用的包名:
{
"xxx",
"ohos.extension.staticSubscriber",
"xxx"
}
最后把修改好的配置文件重新加入到设备系统中:
hdc shell "mount -o remount,rw /"
hdc file send D:\static_subscriber_config.json /etc/static_subscriber_config.json
然后重新启动,应用监听到开机事件,此时就可以在日志中看到打印:
标签:实战,订阅,ExtensionAbility,name,鸿蒙,静态,StaticSubscriber,json From: https://blog.csdn.net/weqwe6668/article/details/141676993