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

2025-06-12
浏览 (7)

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

场景介绍

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

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

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

说明：

静态订阅公共事件对系统功耗有一定影响，建议谨慎使用。

生命周期

StaticSubscriberExtensionAbility在onReceiveEvent()执行完15秒后销毁。

开发步骤

静态订阅者声明。

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

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

   import { commonEventManager, StaticSubscriberExtensionAbility } from '@kit.BasicServicesKit';
   import { hilog } from '@kit.PerformanceAnalysisKit';

   const TAG: string = 'StaticSubscriber';
   const DOMAIN_NUMBER: number = 0xFF00;
   
   export default class StaticSubscriber extends StaticSubscriberExtensionAbility {
     onReceiveEvent(event: commonEventManager.CommonEventData): void {
       hilog.info(DOMAIN_NUMBER, TAG, 'onReceiveEvent, event: ' + event.event);
       //...
     }
   }

静态订阅者工程配置。

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

   {
     "module": {
   	// ...
       "extensionAbilities": [
         {
           "name": "StaticSubscriber",
           "srcEntry": "./ets/staticsubscriber/StaticSubscriber.ets",
           "description": "$string:StaticSubscriber_desc",
           "icon": "$media:app_icon",
           "label": "$string:StaticSubscriber_label",
           "type": "staticSubscriber",
           "exported": false,
           "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。
配置metadata指向的二级配置文件subscribe.json。

说明：

二级配置文件必须按照此形式进行声明，否则会无法正确识别。

   {
     "commonEvents": [
       {
         "name": "StaticSubscriber",
         "permission": "",
         "events": [
           "usual.event.AIRPLANE_MODE"
         ],
         "filter": [
           {
             "event": "usual.event.AIRPLANE_MODE",
             "conditions": {
               "code": 0,
               "data": "send common event data",
               "parameters": {
                 "bundleType": 1,
                 "userId": 100
               }
             }
           }
         ]
       }
     ]
   }

commonEvents标签标识订阅者配置静态订阅事件，轻量级设备上不支持此标签和子标签。标签值为对象数组类型，包含name、permission、events、filter四个子标签。

表1 commonEvents标签说明

filter标签标识订阅者可以根据需要配置过滤的静态订阅事件，标签值为对象数组类型，包含event、conditions两个子标签。

表2 filter标签说明

|属性名称|含义 |数据类型|是否可缺省 | |————|————————————————————|————|—————-| |event |标识静态订阅事件需要过滤的事件名，与事件列表进行匹配，否则配置无效。|字符串 |该标签不可缺省。| |conditions |标识当前事件的过滤条件，从发布者CommonEventPublishData中进行过滤。|对象 |该标签不可缺省。|

conditions标签标识静态订阅过滤事件需要的条件配置，标签值为对象类型，包含code、data、parameters三个子标签。

表3 conditions标签说明

修改设备的预置配置文件。预置配置文件在设备上的路径为/system/variant/phone/base/etc/app/install_list_capability.json，设备开机启动时会读取该配置文件，在应用安装时会对在文件中配置的allowCommonEvent公共事件类型进行授权。预授权配置文件字段内容包括bundleName、app_signature和allowCommonEvent。
- bundleName字段配置为应用的Bundle名称。
- app_signature字段配置为应用的指纹信息。指纹信息的配置请参见应用特权配置指南，或者通过bm工具获取并填写该应用的appId。
- allowCommonEvent字段配置为允许静态广播拉起的公共事件项。

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