Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
7b390dfb
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
7b390dfb
编写于
5月 19, 2023
作者:
zyjhandsome
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
优化开发步骤的内容,配置文件等进行了补充说明
Signed-off-by:
zyjhandsome
<
zyjhandsome@126.com
>
上级
57711b38
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
46 addition
and
33 deletion
+46
-33
zh-cn/application-dev/application-models/common-event-static-subscription.md
...ev/application-models/common-event-static-subscription.md
+46
-33
未找到文件。
zh-cn/application-dev/application-models/common-event-static-subscription.md
浏览文件 @
7b390dfb
...
...
@@ -2,29 +2,37 @@
## 场景介绍
静态订阅者在未接收订阅的目标事件时,处于未拉起状态,当系统或应用发布了指定的公共事件后,静态订阅者将被拉起,并执行onReceiveEvent回调,开发者可通过在onReceiveEvent回调中执行业务逻辑,实现当应用接收到特定公共事件时执行业务逻辑的目的。例如,某应用希望在设备开机的时候执行一些初始化任务,那么该应用可以静态订阅开机事件,在收到开机事件后会拉起该应用,然后执行初始化任务。静态订阅是通过配置文件声明和实现继承自StaticSubscriberExtensionAbility的类实现对公共事件的订阅。
**需要注意的是,静态订阅公共事件对系统功耗有一定影响,建议谨慎使用**
。
静态订阅者在未接收订阅的目标事件时,处于未拉起状态。当系统或应用发布了指定的公共事件后,静态订阅者将被拉起,并执行
[
`onReceiveEvent()`
](
../reference/apis/js-apis-application-staticSubscriberExtensionAbility.md#staticsubscriberextensionabilityonreceiveevent
)
回调。
开发者可以通过在
[
`onReceiveEvent()`
](
../reference/apis/js-apis-application-staticSubscriberExtensionAbility.md#staticsubscriberextensionabilityonreceiveevent
)
回调中执行业务逻辑,实现当应用接收到特定公共事件时执行业务逻辑的目的。例如,应用希望在设备开机时执行一些初始化任务,那么该应用可以静态订阅开机事件,在收到开机事件后会拉起该应用,然后执行初始化任务。
静态订阅是通过配置文件声明和实现继承自
[
`StaticSubscriberExtensionAbility`
](
../reference/apis/js-apis-application-staticSubscriberExtensionAbility.md
)
的类实现对公共事件的订阅。
> **说明:**
>
> 需要注意的是,静态订阅公共事件对系统功耗有一定影响,建议谨慎使用。
## 开发步骤
1.
静态订阅者声明
1.
静态订阅者声明
。
声明一个静态订阅者,首先需要在工程中新建一个ExtensionAbility,该ExtensionAbility从StaticSubscriberExtensionAbility派生,其代码实现如下:
声明一个静态订阅者,首先需要在工程中新建一个ExtensionAbility,该ExtensionAbility从StaticSubscriberExtensionAbility派生。
开发者可以在
[
`onReceiveEvent()`
](
../reference/apis/js-apis-application-staticSubscriberExtensionAbility.md#staticsubscriberextensionabilityonreceiveevent
)
回调中实现业务逻辑。
```
ts
import
StaticSubscriberExtensionAbility
from
'
@ohos.application.StaticSubscriberExtensionAbility
'
export
default
class
StaticSubscriber
extends
StaticSubscriberExtensionAbility
{
onReceiveEvent
(
event
)
{
console
.
info
(
'
onReceiveEvent, event:
'
+
event
.
event
);
console
.
info
(
'
onReceiveEvent, event:
'
+
event
.
event
);
}
}
```
开发者可以在onReceiveEvent中实现业务逻辑。
2.
静态订阅者工程配置
2.
静态订阅者工程配置。
在完成静态订阅者的代码实现后,需要
将该订阅者配置到系统的module.json5中,配置形式如下:
在完成静态订阅者的代码实现后,需要
在
[
module.json5配置文件
](
../quick-start/module-configuration-file.md
)
中进行配置订阅者信息。
```
ts
{
...
...
@@ -33,7 +41,7 @@
"
extensionAbilities
"
:
[
{
"
name
"
:
"
StaticSubscriber
"
,
"
srcEntry
"
:
"
./ets/
StaticS
ubscriber/StaticSubscriber.ts
"
,
"
srcEntry
"
:
"
./ets/
statics
ubscriber/StaticSubscriber.ts
"
,
"
description
"
:
"
$string:StaticSubscriber_desc
"
,
"
icon
"
:
"
$media:icon
"
,
"
label
"
:
"
$string:StaticSubscriber_label
"
,
...
...
@@ -52,19 +60,20 @@
}
```
上述json文件主要关注以下字段
:
其中部分字段解释如下
:
-
srcEntry
: 表示ExtensionAbility的入口文件路径,即步骤2中声明的静态订阅者所在的文件路径
-
srcEntry
:表示ExtensionAbility的入口文件路径,即步骤2中声明的静态订阅者所在的文件路径。
-
type
: 表示ExtensionAbility的类型,对于静态订阅者需要声明为“staticSubscriber”
-
type
:表示ExtensionAbility的类型,对于静态订阅者需要声明为
`staticSubscriber`
。
-
metadata
:
表示ExtensionAbility的二级配置文件信息。由于不同的ExtensionAbility类型其配置信息不尽相同,因此需要使用不同的config文件表示其具体配置信息。
-
name:表示ExtensionAbility的类型名称,对于静态订阅类型,name必须声明为
“ohos.extension.staticSubscriber”,否则无法识别为静态订阅者;
-
resource
: 字段表示ExtensionAbility的配置信息路径,由开发者自行定义,在本例中表示路径为“resources/base/profile/subscribe.json"
。
-
metadata
:
表示ExtensionAbility的二级配置文件信息。由于不同的ExtensionAbility类型其配置信息不尽相同,因此需要使用不同的config文件表示其具体配置信息。
-
name:表示ExtensionAbility的类型名称,对于静态订阅类型,name必须声明为
`ohos.extension.staticSubscriber`
,否则无法识别为静态订阅者。
-
resource
:字段表示ExtensionAbility的配置信息路径,由开发者自行定义,在本例中表示路径为
`resources/base/profile/subscribe.json`
。
metadata指向的二级配置文件的通常形式如下:
```
ts
3.
配置metadata指向的二级配置文件。
```
json
{
"commonEvents"
:
[
{
...
...
@@ -78,28 +87,32 @@
}
```
需要注意二级配置文件必须按照此形式进行声明,否则会无法正确识别。下面对字段进行介绍:
-
name: 静态订阅ExtensionAbility的名称,需要和module.json5中声明的ExtensionAbility的name一致
需要注意二级配置文件必须按照此形式进行声明,否则会无法正确识别。部分字段解释如下:
-
permission:订阅者要求的发布者需要具备的权限,对于发布了目标事件但不具备permission中声明的权限的发布者将被视为非法事件不予发布
-
name: 静态订阅ExtensionAbility的名称,需要和module.json5中声明的ExtensionAbility的name一致。
-
permission:订阅者要求的发布者需要具备的权限,对于发布了目标事件但不具备permission中声明的权限的发布者将被视为非法事件不予发布。
-
events:订阅的目标事件列表。
-
events: 订阅的目标事件列表
4.
修改设备的
[
预置配置文件
](
https://gitee.com/openharmony/vendor_hihope/blob/master/rk3568/preinstall-config/install_list_permissions.json
)
。
[
预置配置文件
](
https://gitee.com/openharmony/vendor_hihope/blob/master/rk3568/preinstall-config/install_list_permissions.json
)
在设备上的路径为
`/system/etc/app/install_list_permission.json`
,设备开机启动时会读取该配置文件,在应用安装会对在文件中配置的
`allowCommonEvent`
公共事件类型进行授权。预授权配置文件字段内容包括
`bundleName`
、
`app_signature`
和
`allowCommonEvent`
。
3.
修改设备系统配置文件
-
`bundleName`
字段配置为应用的Bundle名称。
-
`app_signature`
字段配置为应用的指纹信息。指纹信息的配置参见
[
应用特权配置指南
](
../../device-dev/subsystems/subsys-app-privilege-config-guide.md#install_list_capabilityjson中配置
)
。
-
`allowCommonEvent`
字段配置为允许静态广播拉起的公共事件项。
修改设备系统配置文件 **/system/etc/app/install_list_capability.json**,将静态订阅应用者的包名添加至该json文件中即可
。
> **说明**:当前仅支持预置应用配置该文件
。
```json
{
"install_list": [
{
"bundleName": "ohos.extension.staticSubscriber",
"allowCommonEvent": ["usual.event.A", "usual.event.B"],
}
]
}
```
json
[
...
{
"bundleName"
:
"com.example.myapplication"
,
//
Bundle名称
"app_signature"
:
[
"****"
],
//
指纹信息
"allowCommonEvent"
:
[
"usual.event.A"
,
"usual.event.B"
],
//
允许静态广播拉起的公共事件项
]
}
]
```
## 相关示例
针对StaticSubscriberExtensionAbility开发,可参考如下实例:
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录