• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 静态订阅公共事件（仅对系统应用开放）
2
3## 场景介绍
4
5静态订阅者在未接收订阅的目标事件时，处于未拉起状态，当系统或应用发布了指定的公共事件后，静态订阅者将被拉起，并执行onReceiveEvent回调，开发者可通过在onReceiveEvent回调中执行业务逻辑，实现当应用接收到特定公共事件时执行业务逻辑的目的。例如，某应用希望在设备开机的时候执行一些初始化任务，那么该应用可以静态订阅开机事件，在收到开机事件后会拉起该应用，然后执行初始化任务。静态订阅是通过配置文件声明和实现继承自StaticSubscriberExtensionAbility的类实现对公共事件的订阅。**需要注意的是，静态订阅公共事件对系统功耗有一定影响，建议谨慎使用**。
6
7
8
9## 开发步骤
10
111. 静态订阅者声明
12
13   声明一个静态订阅者，首先需要在工程中新建一个ExtensionAbility, 该ExtensionAbility从StaticSubscriberExtensionAbility派生，其代码实现如下：
14
15   ```ts
16   import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility'
17
18   export default class StaticSubscriber extends StaticSubscriberExtensionAbility {
19       onReceiveEvent(event) {
20           console.log('onReceiveEvent, event:' + event.event);
21       }
22   }
23   ```
24
25   开发者可以在onReceiveEvent中实现业务逻辑。
26
27
28
292. 静态订阅者工程配置
30
31   在完成静态订阅者的代码实现后，需要将该订阅者配置到系统的module.json5中，配置形式如下：
32
33   ```ts
34   {
35     "module": {
36       ......
37       "extensionAbilities": [
38         {
39           "name": "StaticSubscriber",
40           "srcEntrance": "./ets/StaticSubscriber/StaticSubscriber.ts",
41           "description": "$string:StaticSubscriber_desc",
42           "icon": "$media:icon",
43           "label": "$string:StaticSubscriber_label",
44           "type": "staticSubscriber",
45           "visible": true,
46           "metadata": [
47             {
48               "name": "ohos.extension.staticSubscriber",
49               "resource": "$profile:subscribe"
50             }
51           ]
52         }
53       ]
54       ......
55     }
56   }
57   ```
58
59   上述json文件主要关注以下字段：
60
61   - srcEntrance : 表示ExtensionAbility的入口文件路径，即步骤2中声明的静态订阅者所在的文件路径
62
63   - type: 表示ExtensionAbility的类型，对于静态订阅者需要声明为“staticSubscriber”
64
65   - metadata: 表示ExtensionAbility的二级配置文件信息。由于不同的ExtensionAbility类型其配置信息不尽相同，因此需要使用不同的config文件表示其具体配置信息。
66        - name：表示ExtensionAbility的类型名称，对于静态订阅类型，name必须声明为“ohos.extension.staticSubscriber”，否则无法识别为静态订阅者；
67        - resource: 字段表示ExtensionAbility的配置信息路径，由开发者自行定义，在本例中表示路径为“resources/base/profile/subscribe.json"。
68
69   metadata指向的二级配置文件的通常形式如下：
70
71   ```ts
72   {
73     "commonEvents": [
74       {
75         "name": "xxx",
76         "permission": "xxx",
77         "events":[
78           "xxx"
79         ]
80       }
81     ]
82   }
83   ```
84
85   需要注意二级配置文件必须按照此形式进行声明，否则会无法正确识别。下面对字段进行介绍：
86
87   - name: 静态订阅ExtensionAbility的名称，需要和module.json5中声明的ExtensionAbility的name一致
88
89   - permission：订阅者要求的发布者需要具备的权限，对于发布了目标事件但不具备permission中声明的权限的发布者将被视为非法事件不予发布
90
91   - events: 订阅的目标事件列表
92
933. 修改设备系统配置文件
94
95    修改设备系统配置文件 **/etc/static_subscriber_config.json**，将静态订阅应用者的包名添加至该json文件中即可。
96
97    ```json
98    {
99        "xxx",
100        "ohos.extension.staticSubscriber",
101        "xxx"
102    }
103    ```
104
105