Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
90f80ca5
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看板
提交
90f80ca5
编写于
4月 12, 2023
作者:
zyjhandsome
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
删除表格说明中的“> ”。
Signed-off-by:
zyjhandsome
<
zyjhandsome@126.com
>
上级
5880c4c5
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
10 addition
and
10 deletion
+10
-10
zh-cn/application-dev/quick-start/module-configuration-file.md
.../application-dev/quick-start/module-configuration-file.md
+10
-10
未找到文件。
zh-cn/application-dev/quick-start/module-configuration-file.md
浏览文件 @
90f80ca5
...
...
@@ -75,11 +75,11 @@ module.json5配置文件包含以下标签。
| type | 标识当前Module的类型。类型有4种,分别:
<br/>
-
entry:应用的主模块。
<br/>
-
feature:应用的动态特性模块。
<br/>
-
har:静态共享包模块。
<br/>
-
shared:动态共享包模块。 | 字符串 | 该标签不可缺省。 |
| srcEntry | 标识当前Module所对应的代码路径,标签值为字符串(最长为127字节)。 | 字符串 | 该标签可缺省,缺省值为空。 |
| description | 标识当前Module的描述信息,标签值是字符串类型(最长255字节)或对描述内容的字符串资源索引。 | 字符串 | 该标签可缺省,缺省值为空。 |
| process | 标识当前Module的进程名,标签值为字符串类型(最长为31个字节)。如果在HAP标签下配置了process,该应用的所有UIAbility、DataShareExtensionAbility、ServiceExtensionAbility都运行在该进程中。
<br/>
>
**说明:**
<br/>
>
仅支持系统应用配置,三方应用配置不生效。 | 字符串 | 可缺省,缺省为app.json5文件下app标签下的bundleName。 |
| process | 标识当前Module的进程名,标签值为字符串类型(最长为31个字节)。如果在HAP标签下配置了process,该应用的所有UIAbility、DataShareExtensionAbility、ServiceExtensionAbility都运行在该进程中。
<br/>
**说明:**
<br/>
仅支持系统应用配置,三方应用配置不生效。 | 字符串 | 可缺省,缺省为app.json5文件下app标签下的bundleName。 |
| mainElement | 标识当前Module的入口UIAbility名称或者ExtensionAbility名称。标签最大字节长度为255。 | 字符串 | 该标签可缺省,缺省值为空。 |
|
[
deviceTypes
](
#devicetypes标签
)
| 标识当前Module可以运行在哪类设备上,标签值采用字符串数组的表示。 | 字符串数组 | 该标签不可缺省,可以为空值。 |
| deliveryWithInstall | 标识当前Module是否在用户主动安装的时候安装,表示该Module对应的HAP是否跟随应用一起安装。
<br/>
-
true:主动安装时安装。
<br/>
-
false:主动安装时不安装。 | 布尔值 | 该标签不可缺省。 |
| installationFree | 标识当前Module是否支持免安装特性。
<br/>
-
true:表示支持免安装特性,且符合免安装约束。
<br/>
-
false:表示不支持免安装特性。
<br/>
>
**说明:**
<br/>
> 当应用的entry类型Module的该字段配置为true时,该应用的feature类型的该字段也需要配置为true。
<br/>
>
当应用的entry类型Module的该字段配置为false时,该应用的feature类型的该字段根据业务需求配置true或false。 | 布尔值 | 该标签不可缺省。 |
| installationFree | 标识当前Module是否支持免安装特性。
<br/>
-
true:表示支持免安装特性,且符合免安装约束。
<br/>
-
false:表示不支持免安装特性。
<br/>
**说明:**
<br/>
当应用的entry类型Module的该字段配置为true时,该应用的feature类型的该字段也需要配置为true。
<br/>
当应用的entry类型Module的该字段配置为false时,该应用的feature类型的该字段根据业务需求配置true或false。 | 布尔值 | 该标签不可缺省。 |
| virtualMachine | 标识当前Module运行的目标虚拟机类型,供云端分发使用,如应用市场和分发中心。
<br/>
该标签值为字符串。如果目标虚拟机类型为ArkTS引擎,则其值为“ark+版本号”。 | 字符串 | 该标签由IDE构建HAP的时候自动插入。 |
|
[
pages
](
#pages标签
)
| 标识当前Module的profile资源,用于列举每个页面信息。该标签最大长度为255个字节。 | 字符串 | 在有UIAbility的场景下,该标签不可缺省。 |
|
[
metadata
](
#metadata标签
)
| 标识当前Module的自定义元信息,标签值为数组类型,只对当前Module、UIAbility、ExtensionAbility生效。 | 对象数组 | 该标签可缺省,缺省值为空。 |
...
...
@@ -302,14 +302,14 @@ OpenHarmony系统对无图标应用严格管控。如果HAP中没有配置入口
| removeMissionAfterTerminate | 标识当前UIAbility组件销毁后是否从任务列表中移除任务,为布尔类型:
<br/>
-
true表示销毁后移除任务。
<br/>
-
false表示销毁后不移除任务。 | 布尔值 | 该标签可缺省,缺省值为false。 |
| orientation | 标识当前UIAbility组件启动时的方向。该方向的取值范围包括:
<br/>
-
unspecified:未指定方向,由系统自动判断显示方向。
<br/>
-
landscape:横屏。
<br/>
-
portrait:竖屏。
<br/>
-
landscape_inverted:反向横屏。
<br/>
-
portrait_inverted:反向竖屏。
<br/>
-
auto_rotation:随传感器旋转。
<br/>
-
auto_rotation_landscape:传感器横屏旋转,包括了横屏和反向横屏。
<br/>
-
auto_rotation_portrait:传感器竖屏旋转,包括了竖屏和反向竖屏。
<br/>
-
auto_rotation_restricted:传感器开关打开,方向可随传感器旋转。
<br/>
-
auto_rotation_landscape_restricted:传感器开关打开,方向可随传感器旋转为横屏,
包括了横屏和反向横屏。
<br/>
-
auto_rotation_portrait_restricted:传感器开关打开,方向随可传感器旋转为竖屏,
包括了横屏和反向横屏。
<br/>
-
locked:传感器开关关闭,方向锁定。 | 字符串 | 该标签可缺省,缺省值为unspecified。 |
| supportWindowMode | 标识当前UIAbility组件所支持的窗口模式,包含:
<br/>
-
fullscreen:全屏模式。
<br/>
-
split:分屏模式。
<br/>
-
floating:悬浮窗模式。 | 字符串数组 | 该标签可缺省,缺省值为
<br/>
["fullscreen",
"split",
"floating"]。 |
| priority | 标识当前UIAbility组件的优先级。
[
隐式查询
](
../application-models/explicit-implicit-want-mappings.md
)
时,优先级越高,UIAbility在返回列表越靠前。该标签取值为integer类型,取值范围0-10。数值越大,优先级越高。
<br/>
>
**说明:**
<br/>
>
仅支持系统应用配置,三方应用配置不生效。 | 数值 | 该标签可缺省,缺省值为0。 |
| priority | 标识当前UIAbility组件的优先级。
[
隐式查询
](
../application-models/explicit-implicit-want-mappings.md
)
时,优先级越高,UIAbility在返回列表越靠前。该标签取值为integer类型,取值范围0-10。数值越大,优先级越高。
<br/>
**说明:**
<br/>
仅支持系统应用配置,三方应用配置不生效。 | 数值 | 该标签可缺省,缺省值为0。 |
| maxWindowRatio | 标识当前UIAbility组件支持的最大的宽高比。该标签最小取值为0。 | 数值 | 该标签可缺省,缺省值为平台支持的最大的宽高比。 |
| minWindowRatio | 标识当前UIAbility组件支持的最小的宽高比。该标签最小取值为0。 | 数值 | 该标签可缺省,缺省值为平台支持的最小的宽高比。 |
| maxWindowWidth | 标识当前UIAbility组件支持的最大的窗口宽度,宽度单位为vp。该标签最小取值为0,但不能小于minWindowWidth;最大取值不能超过平台支持的最大窗口宽度。窗口尺寸可以参考:
[
约束与限制
](
../windowmanager/window-overview.md#约束与限制
)
。 | 数值 | 该标签可缺省,缺省值为平台支持的最大的窗口宽度。 |
| minWindowWidth | 标识当前UIAbility组件支持的最小的窗口宽度,
宽度单位为vp。该标签最小取值为0,但不能小于平台支持的最小窗口宽度;最大取值不能大于maxWindowWidth。窗口尺寸可以参考:
[
约束与限制
](
../windowmanager/window-overview.md#约束与限制
)
。 | 数值 | 该标签可缺省,缺省值为平台支持的最小的窗口宽度。 |
| maxWindowHeight | 标识当前UIAbility组件支持的最大的窗口高度,
高度单位为vp。该标签最小取值为0,但不能小于minWindowHeight;最大取值不能超过平台支持的最大窗口高度。 窗口尺寸可以参考:
[
约束与限制
](
../windowmanager/window-overview.md#约束与限制
)
。| 数值 | 该标签可缺省,缺省值为平台支持的最大的窗口高度。 |
| minWindowHeight | 标识当前UIAbility组件支持的最小的窗口高度,
高度单位为vp。该标签最小取值为0,但不能小于平台支持的最小窗口高度;最大取值不能大于maxWindowHeight。窗口尺寸可以参考:
[
约束与限制
](
../windowmanager/window-overview.md#约束与限制
)
。| 数值 | 该标签可缺省,缺省值为平台支持的最小的窗口高度。 |
| excludeFromMissions | 标识当前UIAbility组件是否在最近任务列表中显示。
<br/>
-
true:表示不在任务列表中显示。
<br/>
-
false:表示在任务列表中显示。
<br/>
>
**说明:**
<br/>
>
仅支持系统应用配置,三方应用配置不生效。 | 布尔值 | 该标签可缺省,缺省值为false。 |
| excludeFromMissions | 标识当前UIAbility组件是否在最近任务列表中显示。
<br/>
-
true:表示不在任务列表中显示。
<br/>
-
false:表示在任务列表中显示。
<br/>
**说明:**
<br/>
仅支持系统应用配置,三方应用配置不生效。 | 布尔值 | 该标签可缺省,缺省值为false。 |
| recoverable | 标识当前是否支持在检测到应用故障后,恢复到应用原界面。
<br/>
-
true:支持检测到出现故障后,恢复到原界面。
<br/>
-
false:不支持检测到出现故障后,恢复到原界面。 | 布尔值 | 该标签可缺省,缺省值为false。 |
abilities示例:
...
...
@@ -426,11 +426,11 @@ skills示例:
| srcEntry | 标识当前ExtensionAbility组件所对应的代码路径,标签值最大长度为127字节。 | 字符串 | 该标签不可缺省。 |
| description | 标识当前ExtensionAbility组件的描述,标签值最大长度为255字节,标签也可以是描述内容的资源索引,用于支持多语言。 | 字符串 | 该标签可缺省,缺省值为空。 |
| icon | 标识当前ExtensionAbility组件的图标,标签值为资源文件的索引。如果ExtensionAbility组件被配置为MainElement,该标签必须配置。 | 字符串 | 该标签可缺省,缺省值为空。 |
| label | 标识当前ExtensionAbility组件对用户显示的名称,标签值配置为该名称的资源索引以支持多语言。
<br/>
>
**说明:**
<br/>
>
如果ExtensionAbility被配置当前Module的mainElement时,该标签必须配置,且应用内唯一。 | 字符串 | 该标签不可缺省。 |
| type | 标识当前ExtensionAbility组件的类型,取值为:
<br/>
-
form:卡片的ExtensionAbility。
<br/>
-
workScheduler:延时任务的ExtensionAbility。
<br/>
-
inputMethod:输入法的ExtensionAbility。
<br/>
-
service:后台运行的service组件。
<br/>
-
accessibility:辅助能力的ExtensionAbility。
<br/>
-
dataShare:数据共享的ExtensionAbility。
<br/>
-
fileShare:文件共享的ExtensionAbility。
<br/>
-
staticSubscriber:静态广播的ExtensionAbility。
<br/>
-
wallpaper:壁纸的ExtensionAbility。
<br/>
-
backup:数据备份的ExtensionAbility。
<br/>
-
window:该ExtensionAbility会在启动过程中创建一个window,为开发者提供界面开发。开发者开发出来的界面将通过abilityComponent控件组合到其他应用的窗口中。
<br/>
-
thumbnail:获取文件缩略图的ExtensionAbility,开发者可以对自定义文件类型的文件提供缩略。
<br/>
-
preview:该ExtensionAbility会将文件解析后在一个窗口中显示,开发者可以通过将此窗口组合到其他应用窗口中。
<br/>
-
print:打印框架的ExtensionAbility。
<br/>
>
**说明:**
<br/>
>
其中service和dataShare类型,仅支持系统应用配置,三方应用配置不生效。 | 字符串 | 该标签不可缺省。 |
| label | 标识当前ExtensionAbility组件对用户显示的名称,标签值配置为该名称的资源索引以支持多语言。
<br/>
**说明:**
<br/>
如果ExtensionAbility被配置当前Module的mainElement时,该标签必须配置,且应用内唯一。 | 字符串 | 该标签不可缺省。 |
| type | 标识当前ExtensionAbility组件的类型,取值为:
<br/>
-
form:卡片的ExtensionAbility。
<br/>
-
workScheduler:延时任务的ExtensionAbility。
<br/>
-
inputMethod:输入法的ExtensionAbility。
<br/>
-
service:后台运行的service组件。
<br/>
-
accessibility:辅助能力的ExtensionAbility。
<br/>
-
dataShare:数据共享的ExtensionAbility。
<br/>
-
fileShare:文件共享的ExtensionAbility。
<br/>
-
staticSubscriber:静态广播的ExtensionAbility。
<br/>
-
wallpaper:壁纸的ExtensionAbility。
<br/>
-
backup:数据备份的ExtensionAbility。
<br/>
-
window:该ExtensionAbility会在启动过程中创建一个window,为开发者提供界面开发。开发者开发出来的界面将通过abilityComponent控件组合到其他应用的窗口中。
<br/>
-
thumbnail:获取文件缩略图的ExtensionAbility,开发者可以对自定义文件类型的文件提供缩略。
<br/>
-
preview:该ExtensionAbility会将文件解析后在一个窗口中显示,开发者可以通过将此窗口组合到其他应用窗口中。
<br/>
-
print:打印框架的ExtensionAbility。
<br/>
**说明:**
<br/>
其中service和dataShare类型,仅支持系统应用配置,三方应用配置不生效。 | 字符串 | 该标签不可缺省。 |
| permissions | 标识当前ExtensionAbility组件自定义的权限信息。当其他应用访问该ExtensionAbility时,需要申请相应的权限信息。
<br/>
一个数组元素为一个权限名称。通常采用反向域名格式(最大255字节),可以是系统预定义的权限,也可以是该应用自定义的权限。如果是后者,需与defPermissions标签中定义的某个权限的name标签值一致。 | 字符串数组 | 该标签可缺省,缺省值为空。 |
| uri | 标识当前ExtensionAbility组件提供的数据URI,为字符数组类型(最大长度255),用反向域名的格式表示。
<br/>
>
**说明:**
<br/>
>
该标签在type为dataShare类型的ExtensionAbility时,不可缺省。 | 字符串 | 该标签可缺省,缺省值为空。 |
|skills | 标识当前ExtensionAbility组件能够接收的
[
Want
](
../application-models/want-overview.md
)
的特征集,为数组格式。
<br/>
配置规则:entry包可以配置多个具有入口能力的skills标签(配置了ohos.want.action.home和entity.system.home)的ExtensionAbility,其中第一个配置了skills标签的ExtensionAbility中的label和icon作为OpenHarmony服务或应用的label和icon。
<br/>
>
**说明:**
<br/>
> OpenHarmony服务的Feature包不能配置具有入口能力的skills标签。
<br/>
>
OpenHarmony应用的Feature包可以配置具有入口能力的skills标签。 | 数组 | 该标签可缺省,缺省值为空。 |
| uri | 标识当前ExtensionAbility组件提供的数据URI,为字符数组类型(最大长度255),用反向域名的格式表示。
<br/>
**说明:**
<br/>
该标签在type为dataShare类型的ExtensionAbility时,不可缺省。 | 字符串 | 该标签可缺省,缺省值为空。 |
|skills | 标识当前ExtensionAbility组件能够接收的
[
Want
](
../application-models/want-overview.md
)
的特征集,为数组格式。
<br/>
配置规则:entry包可以配置多个具有入口能力的skills标签(配置了ohos.want.action.home和entity.system.home)的ExtensionAbility,其中第一个配置了skills标签的ExtensionAbility中的label和icon作为OpenHarmony服务或应用的label和icon。
<br/>
**说明:**
<br/>
OpenHarmony服务的Feature包不能配置具有入口能力的skills标签。
<br/>
OpenHarmony应用的Feature包可以配置具有入口能力的skills标签。 | 数组 | 该标签可缺省,缺省值为空。 |
|
[
metadata
](
#metadata标签
)
| 标识当前ExtensionAbility组件的元信息。 | 对象 | 该标签可缺省,缺省值为空。 |
| exported | 标识当前ExtensionAbility组件是否可以被其他应用调用,为布尔类型。
<br/>
-
true:表示可以被其他应用调用。
<br/>
-
false:表示不可以被其他应用调用。 | 布尔值 | 该标签可缺省,缺省值为false。 |
...
...
@@ -483,8 +483,8 @@ extensionAbilities示例:
| 属性 | 含义 | 类型 | 取值范围 | 默认值 |
| -------- | -------- | -------- | -------- | -------- |
| name | 必须,填写需要使用的权限名称。 | 字符串 | 自定义。 | 无。 |
| reason | 可选,当申请的权限为user_grant权限时此字段必填,用于描述申请权限的原因。
<br/>
>
**说明:**
<br/>
>
当申请的权限为user_grant权限时,如果未填写该字段则不允许在应用市场上架,并且需要进行多语种适配。 | 字符串 | 使用string类资源引用。格式为$string:
\*\*\*
。 | 空。 |
| usedScene | 可选,当申请的权限为user_grant权限时此字段必填。描述权限使用的场景由abilities和when组成。其中abilities可以配置为多个UIAbility组件,when表示调用时机。
<br/>
>
**说明:**
<br/>
>
默认为可选,当申请的权限为user_grant权限时,abilities标签必填,when标签可选。 | abilities:UIAbility或者ExtensionAbility名称的字符串数组
<br/>
when:字符串 | abilities:UIAbility或者ExtensionAbility组件的名称。
<br/>
when:inuse(使用时)、always(始终)。 | abilities:空。
<br/>
when:空。 |
| reason | 可选,当申请的权限为user_grant权限时此字段必填,用于描述申请权限的原因。
<br/>
**说明:**
<br/>
当申请的权限为user_grant权限时,如果未填写该字段则不允许在应用市场上架,并且需要进行多语种适配。 | 字符串 | 使用string类资源引用。格式为$string:
\*\*\*
。 | 空。 |
| usedScene | 可选,当申请的权限为user_grant权限时此字段必填。描述权限使用的场景由abilities和when组成。其中abilities可以配置为多个UIAbility组件,when表示调用时机。
<br/>
**说明:**
<br/>
默认为可选,当申请的权限为user_grant权限时,abilities标签必填,when标签可选。 | abilities:UIAbility或者ExtensionAbility名称的字符串数组
<br/>
when:字符串 | abilities:UIAbility或者ExtensionAbility组件的名称。
<br/>
when:inuse(使用时)、always(始终)。 | abilities:空。
<br/>
when:空。 |
requestPermissions示例:
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录