1# 静态订阅公共事件（仅对系统应用开放）
2
3## 场景介绍
4
5静态订阅者在未接收订阅的目标事件时，处于未拉起状态。当系统或应用发布了指定的公共事件后，静态订阅者将被拉起，并执行[`onReceiveEvent()`](../../reference/apis-basic-services-kit/js-apis-application-staticSubscriberExtensionAbility-sys.md#staticsubscriberextensionabilityonreceiveevent)回调。
6
7开发者可以通过在[`onReceiveEvent()`](../../reference/apis-basic-services-kit/js-apis-application-staticSubscriberExtensionAbility-sys.md#staticsubscriberextensionabilityonreceiveevent)回调中执行业务逻辑，实现当应用接收到特定公共事件时执行业务逻辑的目的。例如，应用希望在设备开机时执行一些初始化任务，那么该应用可以静态订阅开机事件，在收到开机事件后会拉起该应用，然后执行初始化任务。
8
9静态订阅是通过配置文件声明和实现继承自[`StaticSubscriberExtensionAbility`](../../reference/apis-basic-services-kit/js-apis-application-staticSubscriberExtensionAbility-sys.md)的类实现对公共事件的订阅。
10
11> **说明：**
12>
13> 需要注意的是，静态订阅公共事件对系统功耗有一定影响，建议谨慎使用。
14
15## 开发步骤
16
171. 静态订阅者声明。
18
19   声明一个静态订阅者，首先需要在工程中新建一个ExtensionAbility，该ExtensionAbility从StaticSubscriberExtensionAbility派生。
20
21   开发者可以在[`onReceiveEvent()`](../../reference/apis-basic-services-kit/js-apis-application-staticSubscriberExtensionAbility-sys.md#staticsubscriberextensionabilityonreceiveevent)回调中实现业务逻辑。
22
23   ```ts
24   import { commonEventManager, StaticSubscriberExtensionAbility } from '@kit.BasicServicesKit';
25   import { hilog } from '@kit.PerformanceAnalysisKit';
26
27   const TAG: string = 'StaticSubscriber';
28   const DOMAIN_NUMBER: number = 0xFF00;
29
30   export default class StaticSubscriber extends StaticSubscriberExtensionAbility {
31     onReceiveEvent(event: commonEventManager.CommonEventData): void {
32       hilog.info(DOMAIN_NUMBER, TAG, 'onReceiveEvent, event: ' + event.event);
33       //...
34     }
35   }
36   ```
37
382. 静态订阅者工程配置。
39
40   在完成静态订阅者的代码实现后，需要在[module.json5配置文件](../../quick-start/module-configuration-file.md)中进行配置订阅者信息。
41
42   ```json
43   {
44     "module": {
45   	// ...
46       "extensionAbilities": [
47         {
48           "name": "StaticSubscriber",
49           "srcEntry": "./ets/staticsubscriber/StaticSubscriber.ets",
50           "description": "$string:StaticSubscriber_desc",
51           "icon": "$media:app_icon",
52           "label": "$string:StaticSubscriber_label",
53           "type": "staticSubscriber",
54           "exported": false,
55           "metadata": [
56             {
57               "name": "ohos.extension.staticSubscriber",
58               "resource": "$profile:staticsubscriber"
59             }
60           ]
61         }
62       ],
63   	// ...
64     }
65   }
66   ```
67
68   其中部分字段解释如下：
69
70   - srcEntry：表示ExtensionAbility的入口文件路径，即步骤2中声明的静态订阅者所在的文件路径。
71
72   - type：表示ExtensionAbility的类型，对于静态订阅者需要声明为`staticSubscriber`。
73
74   - metadata：表示ExtensionAbility的二级配置文件信息。由于不同的ExtensionAbility类型其配置信息不尽相同，因此需要使用不同的config文件表示其具体配置信息。
75        - name：表示ExtensionAbility的类型名称，对于静态订阅类型，name必须声明为`ohos.extension.staticSubscriber`，否则无法识别为静态订阅者。
76        - resource：字段表示ExtensionAbility的配置信息路径，由开发者自行定义，在本例中表示路径为`resources/base/profile/subscribe.json`。
77
78
793. 配置metadata指向的二级配置文件。
80
81   ```json
82   {
83     "commonEvents": [
84       {
85         "name": "StaticSubscriber",
86         "permission": "",
87         "events": [
88           "usual.event.AIRPLANE_MODE"
89         ]
90       }
91     ]
92   }
93   ```
94
95   需要注意二级配置文件必须按照此形式进行声明，否则会无法正确识别。部分字段解释如下：
96
97   - name: 静态订阅ExtensionAbility的名称，需要和module.json5中声明的ExtensionAbility的name一致。
98   - permission：订阅者要求的发布者需要具备的权限，对于发布了目标事件但不具备permission中声明的权限的发布者将被视为非法事件不予发布。
99   - events：订阅的目标事件列表。
100
1014. 修改设备的[预置配置文件](https://gitee.com/openharmony/vendor_hihope/blob/master/rk3568/preinstall-config/install_list_capability.json)。预置配置文件在设备上的路径为`/system/variant/phone/base/etc/app/install_list_capability.json`，设备开机启动时会读取该配置文件，在应用安装时会对在文件中配置的`allowCommonEvent`公共事件类型进行授权。预授权配置文件字段内容包括`bundleName`、`app_signature`和`allowCommonEvent`。
102
103   - `bundleName`字段配置为应用的Bundle名称。
104   - `app_signature`字段配置为应用的指纹信息。指纹信息的配置请参见[应用特权配置指南](../../../device-dev/subsystems/subsys-app-privilege-config-guide.md#install_list_capabilityjson中配置)，或者通过[bm工具](../../tools/bm-tool.md)获取并填写该应用的`appId`。
105   - `allowCommonEvent`字段配置为允许静态广播拉起的公共事件项。
106
107   ```json
108   [
109     // ...
110     {
111       "bundleName": "com.samples.stageprocessthread", // Bundle名称
112       "app_signature": ["****"], // 指纹信息
113       "allowCommonEvent": ["usual.event.AIRPLANE_MODE"] // 允许静态广播拉起的公共事件项
114     }
115   ]
116   ```
117
118   > **说明**：
119   >
120   > 当前仅支持预置应用配置该文件。
121
122## 相关实例
123
124针对StaticSubscriberExtensionAbility开发，可参考如下实例：
125
126- [静态订阅（ArkTS）（Full SDK）（API10）](https://gitee.com/openharmony/applications_app_samples/tree/master/code/SystemFeature/ApplicationModels/StaticSubscriber)
127
128