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

场景介绍

静态订阅者在未接收订阅的目标事件时,处于未拉起状态。当系统或应用发布了指定的公共事件后,静态订阅者将被拉起,并执行onReceiveEvent()回调。

开发者可以通过在onReceiveEvent()回调中执行业务逻辑,实现当应用接收到特定公共事件时执行业务逻辑的目的。例如,应用希望在设备开机时执行一些初始化任务,那么该应用可以静态订阅开机事件,在收到开机事件后会拉起该应用,然后执行初始化任务。

静态订阅是通过配置文件声明和实现继承自StaticSubscriberExtensionAbility的类实现对公共事件的订阅。

说明:

需要注意的是,静态订阅公共事件对系统功耗有一定影响,建议谨慎使用。

开发步骤

  1. 静态订阅者声明。

    声明一个静态订阅者,首先需要在工程中新建一个ExtensionAbility,该ExtensionAbility从StaticSubscriberExtensionAbility派生。

    开发者可以在onReceiveEvent()回调中实现业务逻辑。

    import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility'
    
    export default class StaticSubscriber extends StaticSubscriberExtensionAbility {
      onReceiveEvent(event) {
        console.info('onReceiveEvent, event: ' + event.event);
      }
    }
    
  2. 静态订阅者工程配置。

    在完成静态订阅者的代码实现后,需要在module.json5配置文件中进行配置订阅者信息。

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

    其中部分字段解释如下:

    • srcEntry:表示ExtensionAbility的入口文件路径,即步骤2中声明的静态订阅者所在的文件路径。

    • type:表示ExtensionAbility的类型,对于静态订阅者需要声明为staticSubscriber

    • metadata:表示ExtensionAbility的二级配置文件信息。由于不同的ExtensionAbility类型其配置信息不尽相同,因此需要使用不同的config文件表示其具体配置信息。

      • name:表示ExtensionAbility的类型名称,对于静态订阅类型,name必须声明为ohos.extension.staticSubscriber,否则无法识别为静态订阅者。
      • resource:字段表示ExtensionAbility的配置信息路径,由开发者自行定义,在本例中表示路径为resources/base/profile/subscribe.json
  3. 配置metadata指向的二级配置文件。

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

    需要注意二级配置文件必须按照此形式进行声明,否则会无法正确识别。部分字段解释如下:

    • name: 静态订阅ExtensionAbility的名称,需要和module.json5中声明的ExtensionAbility的name一致。
    • permission:订阅者要求的发布者需要具备的权限,对于发布了目标事件但不具备permission中声明的权限的发布者将被视为非法事件不予发布。
    • events:订阅的目标事件列表。
  4. 修改设备的预置配置文件预置配置文件在设备上的路径为/system/etc/app/install_list_permission.json,设备开机启动时会读取该配置文件,在应用安装会对在文件中配置的allowCommonEvent公共事件类型进行授权。预授权配置文件字段内容包括bundleNameapp_signatureallowCommonEvent

    • bundleName字段配置为应用的Bundle名称。
    • app_signature字段配置为应用的指纹信息。指纹信息的配置参见应用特权配置指南
    • allowCommonEvent字段配置为允许静态广播拉起的公共事件项。

    说明:当前仅支持预置应用配置该文件。

    [
      ...
      {
        "bundleName": "com.example.myapplication", // Bundle名称
        "app_signature": ["****"], // 指纹信息
        "allowCommonEvent": ["usual.event.A", "usual.event.B"], // 允许静态广播拉起的公共事件项
        ]
      }
    ]
    

相关示例

针对StaticSubscriberExtensionAbility开发,可参考如下实例: