OpenHarmony静态订阅应用 原创 精华

如果雨停了
发布于 2023-4-17 09:41
浏览
1收藏

OpenHarmony静态订阅应用

1.简介

本文将介绍如何使用静态订阅公共事件,静态订阅者在未接收订阅的目标事件时,处于未拉起状态,当系统或应用发布了指定的公共事件后,静态订阅者将被拉起,并执行onReceiveEvent回调,开发者可通过在onReceiveEvent回调中执行业务逻辑,实现当应用接收到特定公共事件时执行业务逻辑的目的。例如,某应用希望在设备开机的时候执行一些初始化任务,那么该应用可以静态订阅开机事件,在收到开机事件后会拉起该应用,然后执行初始化任务。
文末有样例源码

2.设备与环境

设备:九联s905l3a机顶盒

系统:OpenHarmony 3.2 beta2

SDK:API 9(Full SDK)

3.实现过程

3.1 声明静态订阅者

打开 DevEco Studio 创建一个新的Stage工程,在工程中新建一个目录 StaticSubscriber,然后在该目录下面新建一个ExtensionAbility的ets文件,并让该 ExtensionAbilityStaticSubscriberExtensionAbility 派生。

OpenHarmony静态订阅应用-鸿蒙开发者社区

我们可以在 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)
  }
}

3.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: 订阅的目标事件列表

在这里我监听的是开机事件和系统事件流逝时间:

{
  "commonEvents": [
    {
      "name": "StaticSubscriber",
      "permission": "",
      "events":[
        "usual.event.TIME_TICK",
        "usual.event.BOOT_COMPLETED"
      ]
    }
  ]
}

不知道是不是系统bug,在permission字段添加权限的时候,会导致应用无法成功启动,使用就把权限去掉了。

3.3 应用安装

​ 首先,修改OpenHarmony SDK toolchains lib目录下面的 UnsgnedReleasedProfileTemplate.json 文件的apl字段,将apl字段改成 system_basicsystem_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

​ 然后重新启动,应用监听到开机事件,此时就可以在日志中看到打印:

OpenHarmony静态订阅应用-鸿蒙开发者社区

4.参考文档

静态订阅公共事件

应用配置文件

©著作权归作者所有,如需转载,请注明出处,否则将追究法律责任
StaticSubscriber.zip 82.75K 36次下载
7
收藏 1
回复
举报
4条回复
按时间正序
/
按时间倒序
红叶亦知秋
红叶亦知秋

学习下开机自启动应用

回复
2023-4-17 10:54:10
青舟321
青舟321

配置方式讲解的很到位

回复
2023-4-17 18:58:33
喝一大口可乐
喝一大口可乐

静态订阅除了开机还常用在哪些地方呢

回复
2023-4-18 11:52:43
如果雨停了
如果雨停了 回复了 喝一大口可乐
静态订阅除了开机还常用在哪些地方呢

你可以参考一下官方的系统公共事件:​​OpenAtom OpenHarmony​

回复
2023-4-20 15:44:23
回复
    相关推荐