AiShang - 爱尚博客AiShang - 爱尚博客AiShang - 爱尚博客

鸿蒙开发入门:module对象内部结构

module对象内部结构

module对象包含HAP的配置信息。

表1 module对象内部结构说明

属性名称

含义

数据类型

是否可缺省

mainAbility

服务中心图标露出的Ability,常驻进程拉起时会启动mainAbility。

字符串

可缺省,缺省值为空。

package

标识HAP的包结构名称,在应用内保证唯一性。采用反向域名格式(建议与HAP的工程目录保持一致)。字符串长度为1-127个字节。

字符串

不可缺省。

name

标识HAP的类名。采用反向域名方式标识,前缀要与同级的package标签指定的包名一致,也可采用"."开头的命名方式。字符串长度不超过255字节。

字符串

可缺省,缺省值为空。

description

标识HAP的描述信息。字符串长度不超过255字节。如果字符串超出长度或者需要支持多语言,可以采用资源索引的方式添加描述内容。

字符串

可缺省,缺省值为空。

supportedModes

标识应用支持的运行模式,当前只定义了驾驶模式(drive)。该标签只适用于车机。

字符串数组

可缺省,缺省值为空。

deviceType

标识允许Ability运行的设备类型。系统预定义的设备类型包括:phone(手机)、tablet(平板)、tv(智慧屏)、car(车机)、wearable(智能穿戴)等。

字符串数组

不可缺省。

distro

标识HAP发布的具体描述。

对象

不可缺省。

metaData

标识HAP的元信息。

对象

可缺省,缺省值为空。

abilities

标识当前模块内的所有Ability。采用对象数据格式。

对象数组

可缺省,缺省值为空。

js

标识基于ArkUI框架开发的JS模块集合,其中的每个元素代表一个JS模块的信息。

对象数组

可缺省,缺省值为空。

shortcuts

标识应用的快捷方式信息。采用对象数组格式,其中的每个元素表示一个快捷方式对象。

对象数组

可缺省,缺省值为空。

reqPermissions

标识应用运行时向系统申请的权限。

对象数组

可缺省,缺省值为空。

colorMode

标识应用自身的颜色模式,目前支持如下三种模式:- dark:表示按照深色模式选取资源。- light:表示按照浅色模式选取资源。- auto:表示跟随系统的颜色模式值选取资源。

字符串

可缺省,缺省值为"auto"。

distroFilter

标识应用的分发规则。该标签用于定义HAP对应的细分设备规格的分发策略,以便在应用市场进行云端分发应用包时做精准匹配。该标签可配置的分发策略维度包括API Version、屏幕形状、屏幕分辨率。在进行分发时,通过deviceType与这三个属性的匹配关系,唯一确定一个用于分发到设备的HAP。

对象

可缺省,缺省值为空。但当应用中包含多个entry模块时,必须配置该标签。

commonEvents

定义了公共事件静态订阅者的信息,该字段中需要声明静态订阅者的名称、权限要求及订阅事件列表信息,当订阅的公共事件发送时,该公共事件静态订阅者将被拉起。这里的静态订阅者区分于常用的动态订阅者,前者无需在业务代码中主动调用订阅事件的接口,在公共事件发布时可能未被拉起,而动态订阅者则在业务代码中主动调用公共事件订阅的相关API,因此需要应用处于活动状态。

对象数组

可缺省,缺省为空。

entryTheme

此标签标识HarmonyOS内部主题的关键字。将标记值设置为名称的资源索引。

字符串

可缺省,缺省值为空。

testRunner

此标签用于支持对测试框架的配置。

对象

可缺省,缺省值为空。

module示例:

登录后复制
{ "module": { "mainAbility": ".EntryAbility", "deviceType": [ "tv", "tablet" ], "abilities": [ { "skills": [ { "entities": [ "entity.system.home" ], "actions": [ "action.system.home" ] } ], "orientation": "unspecified", "visible": true, "srcPath": "EntryAbility", "name": ".EntryAbility", "srcLanguage": "ets", "icon": "$media:icon", "description": "$string:MainAbility_desc", "formsEnabled": false, "label": "$string:MainAbility_label", "type": "page", "launchType": "multiton" } ], "distro": { "moduleType": "entry", "installationFree": false, "deliveryWithInstall": true, "moduleName": "entry" }, "package": "com.example.entry", "srcPath": "", "name": ".entry", "js": [ { "mode": { "syntax": "ets", "type": "pageAbility" }, "pages": [ "pages/Index" ], "name": ".EntryAbility", "window": { "designWidth": 720, "autoDesignWidth": false } } ] }}1.

distro对象内部结构

表2 distro对象内部结构说明

属性名称

含义

数据类型

是否可缺省

moduleName

标识当前HAP的名称,最大长度为31个字节。

字符串

不可缺省。

moduleType

标识当前HAP的类型,包括三种类型:entry、feature和har。

字符串

不可缺省。

installationFree

标识当前HAP是否支持免安装特性。true:表示支持免安装特性,且符合免安装约束。false:表示不支持免安装特性。另外还需注意:当entry.hap该字段配置为true时,与该entry.hap相关的所有feature.hap该字段也需要配置为true。当entry.hap该字段配置为false时,与该entry.hap相关的各feature.hap该字段可按业务需求配置true或false。

布尔值

不可缺省。

deliveryWithInstall

标识当前HAP是否在用户主动安装HAP所在应用的时候一起安装。true: 安装应用时当前HAP随应用一起下载安装。false:安装应用时当前HAP并不下载安装,后续使用是按需下载。

布尔值

不可缺省。

distro示例:

登录后复制
"distro": { "moduleName": "ohos_entry", "moduleType": "entry", "installationFree": true, "deliveryWithInstall": true}1.

metadata对象内部结构

表3 metadata对象内部结构说明

属性名称

含义

数据类型

是否可缺省

parameters

标识调用Ability时所有调用参数的元信息。每个调用参数的元信息由以下三个标签组成:description、name、type。

对象数组

可缺省,缺省值为空

results

标识Ability返回值的元信息。每个返回值的元信息由以下三个标签组成:description、name、type。

对象数组

可缺省,缺省值为空。

customizeData

该标签标识父级组件的自定义元信息,Parameters和results在application不可配。

对象数组

可缺省,缺省值为空。

parameters对象内部结构

表4 parameters对象内部结构说明

属性名称

含义

数据类型

是否可缺省

description

标识对调用参数的描述,可以是表示描述内容的字符串,也可以是对描述内容的资源索引以支持多语言。该标签最大长度为255个字节。

字符串

可缺省,缺省值为空。

name

标识调用参数的名称。该标签最大长度为255个字节。

字符串

不可缺省。

type

标识调用参数的类型,如Integer。

字符串

不可缺省。

results对象内部结构

表5 results对象内部结构说明

属性名称

含义

数据类型

是否可缺省

description

标识对返回值的描述,可以是表示描述内容的字符串,也可以是对描述内容的资源索引以支持多语言。该标签最大长度为255个字节。

字符串

可缺省,缺省值为空。

name

标识返回值的名字。该标签最大长度为255个字节。

字符串

可缺省,缺省值为空。

type

标识返回值的类型,如Integer。

字符串

不可缺省

customizeData对象的内部结构

表6 customizeData对象的内部结构说明

属性名称

含义

数据类型

是否可缺省

name

标识数据项的键名称,字符串类型(最大长度255字节)。

字符串

可缺省,缺省值为空。

value

标识数据项的值名称,字符串类型(最大长度255字节)。

字符串

可缺省,缺省值为空。

extra

标识用户自定义数据格式,标签值为标识该数据的资源的索引值。

字符串

可缺省,缺省值为空。

metadata对象示例:

登录后复制
"metaData": { "parameters" : [{ "name" : "a test for metadata parameter", "type" : "Float", // "$string:parameters_description"为文件资源索引值 "description" : "$string:parameters_description" }], "results" : [{ "name" : "a test for metadata result", "type" : "Float", "description" : "$string:results_description" }], "customizeData" : [{ "name" : "a customizeData", "value" : "string", "extra" : "$string:customizeData_description" }]}1.

deviceType标签

表7 deviceType标签配置说明

设备类型

枚举值

说明

平板

tablet

-

智慧屏

tv

-

智能手表

wearable

系统能力较丰富的手表,具备电话功能。

车机

car

-

手机

phone

-

abilities对象的内部结构

表8 abilities对象的内部结构说明

属性名称

含义

数据类型

是否可缺省

process

运行应用程序或Ability的进程名称。如果在deviceConfig标记中配置了进程,则应用程序的所有能力都在此进程中运行。您还可以为特定能力设置流程属性,以便该能力可以在此流程中运行。如果此属性设置为与其他应用程序相同的进程名称,则所有这些应用程序可以在同一进程中运行,前提是他们具有相同的联合用户ID和相同的签名。该标签最大字节数为31个字节。

字符串

可缺省,缺省值为空。

name

标识Ability名称。取值可采用反向域名方式表示,由包名和类名组成,如"com.example.myapplication.EntryAbility";也可采用".“开头的类名方式表示,如”.EntryAbility"。Ability的名称,需在一个应用的范围内保证唯一。说明:在使用DevEco Studio新建项目时,默认生成首个Ability的配置,即"config.json"中"EntryAbility"的配置。如使用其他IDE工具,可自定义名称。该标签最大长度为127个字节。

字符串

不可缺省

description

标识对Ability的描述。取值可以是描述性内容,也可以是对描述性内容的资源索引,以支持多语言。该标签最大长度为255个字节。

字符串

可缺省,缺省值为空。

icon

标识Ability图标资源文件的索引。取值示例:$media:ability_icon。如果在该Ability的skills属性中,actions的取值包含 “action.system.home”,entities取值中包含"entity.system.home",则该Ability的icon将同时作为应用的icon。如果存在多个符合条件的Ability,则取位置靠前的Ability的icon作为应用的icon。说明:应用的"icon"和"label"是用户可感知配置项,需要区别于当前所有已有的应用"icon"或"label"(至少有一个不同)。

字符串

可缺省,缺省值为空。

label

标识Ability对用户显示的名称。取值可以是Ability名称,也可以是对该名称的资源索引,以支持多语言。如果在该Ability的skills属性中,actions的取值包含 “action.system.home”,entities取值中包含"entity.system.home",则该Ability的label将同时作为应用的label。如果存在多个符合条件的Ability,则取位置靠前的Ability的label作为应用的label。说明: 应用的"icon"和"label"是用户可感知配置项,需要区别于当前所有已有的应用"icon"或"label"(至少有一个不同)。该标签为资源文件中定义的字符串的引用,或以"{}"包括的字符串。该标签最大长度为255个字节。

字符串

可缺省,缺省值为空。

uri

标识Ability的统一资源标识符。该标签最大长度为255个字节。

字符串

可缺省,对于data类型的Ability不可缺省。

launchType

标识Ability的启动模式,支持"multiton"和"singleton"两种模式:multiton:表示该Ability可以有多实例。该模式适用于大多数应用场景。singleton:表示该Ability在所有任务栈中仅可以有一个实例。例如,具有全局唯一性的呼叫来电界面即采用"singleton"模式。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。

字符串

可缺省,缺省值为"singleton"。

visible

标识Ability是否可以被其他应用调用。true:可以被其他应用调用。false:不能被其他应用调用。

布尔类型

可缺省,缺省值为"false"。

permissions

标识其他应用的Ability调用此Ability时需要申请的权限集合,一个数组元素为一个权限名称。通常采用反向域名格式(最大255字节),取值为系统预定义的权限。

字符串数组

可缺省,缺省值为空。

skills

标识Ability能够接收的want的特征。

对象数组

可缺省,缺省值为空。

deviceCapability

标识Ability运行时要求设备具有的能力,采用字符串数组的格式表示。该标签为数组,支持最多配置512个元素,单个元素最大字节长度为64。

字符串数组

可缺省,缺省值为空。

metaData

元数据。

对象

可缺省,缺省值为空。

type

标识Ability的类型。取值范围如下:page:表示基于Page模板开发的FA,用于提供与用户交互的能力。service:表示基于Service模板开发的PA,用于提供后台运行任务的能力。data:表示基于Data模板开发的PA,用于对外部提供统一的数据访问对象。CA:表示支持其他应用以窗口方式调起该Ability。

字符串

不可缺省。

orientation

标识该Ability的显示模式。该标签仅适用于page类型的Ability。取值范围如下:unspecified:由系统自动判断显示方向。landscape:横屏模式。portrait:竖屏模式。followRecent:跟随栈中最近的应用。

字符串

可缺省,缺省值为"unspecified"。

backgroundModes

标识后台服务的类型,可以为一个服务配置多个后台服务类型。该标签仅适用于service类型的Ability。取值范围如下:dataTransfer:通过网络/对端设备进行数据下载、备份、分享、传输等业务。audioPlayback:音频输出业务。audioRecording:音频输入业务。pictureInPicture:画中画、小窗口播放视频业务。voip:音视频电话、VOIP业务。location:定位、导航业务。bluetoothInteraction:蓝牙扫描、连接、传输业务。wifiInteraction:WLAN扫描、连接、传输业务。screenFetch:录屏、截屏业务。multiDeviceConnection:多设备互联业务

字符串数组

可缺省,缺省值为空。

grantPermission

指定是否可以向Ability内任何数据授予权限。

布尔值

可缺省,缺省值为空。

readPermission

标识读取Ability的数据所需的权限。该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。

字符串

可缺省,缺省为空。

writePermission

标识向Ability写数据所需的权限。该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。

字符串

可缺省,缺省为空。

configChanges

标识Ability关注的系统配置集合。当已关注的配置发生变更后,Ability会收到onConfigurationUpdated回调。取值范围:mcc:表示IMSI移动设备国家/地区代码(MCC)发生变更。典型场景:检测到SIM并更新MCC。mnc:IMSI移动设备网络代码(MNC)发生变更。典型场景:检测到SIM并更新MNC。locale:表示语言区域发生变更。典型场景:用户已为设备文本的文本显示选择新的语言类型。layout:表示屏幕布局发生变更。典型场景:当前有不同的显示形态都处于活跃状态。fontSize:表示字号发生变更。典型场景:用户已设置新的全局字号。orientation:表示屏幕方向发生变更。典型场景:用户旋转设备。density:表示显示密度发生变更。典型场景:用户可能指定不同的显示比例,或当前有不同的显示形态同时处于活跃状态。size:显示窗口大小发生变更。smallestSize:显示窗口较短边的边长发生变更。colorMode:颜色模式发生变更。

字符串数组

可缺省,缺省为空。

mission

标识Ability指定的任务栈。该标签仅适用于page类型的Ability。默认情况下应用中所有Ability同属一个任务栈。

字符串

可缺省,缺省为应用的包名。

targetAbility

标识当前Ability重用的目标Ability。该标签仅适用于page类型的Ability。如果配置了targetAbility属性,则当前Ability(即别名Ability)的属性中仅name、icon、label、visible、permissions、skills生效,其他属性均沿用targetAbility中的属性值。目标Ability必须与别名Ability在同一应用中,且在配置文件中目标Ability必须在别名之前进行声明。

字符串

可缺省,缺省值为空。表示当前Ability不是一个别名Ability。

formsEnabled

标识Ability是否支持卡片(forms)功能。该标签仅适用于page类型的Ability。true:支持卡片能力。false:不支持卡片能力。

布尔值

可缺省,缺省值为false。

forms

标识服务卡片的属性。该标签仅当formsEnabled为"true"时,才能生效。

对象数组

可缺省,缺省值为空。

srcLanguage

Ability开发语言的类型,开发者创建工程时由开发者手动选择开发语言。

字符串

可缺省,缺省值为“js”。

srcPath

该标签标识Ability对应的JS组件代码路径,该标签最大长度为127字节。

字符串

不可缺省。

uriPermission

标识该Ability有权访问的应用程序数据。此属性由模式和路径子属性组成。此属性仅对类型提供者的能力有效。

对象

可缺省,缺省值为空。

startWindowIcon

标识该Ability启动页面图标资源文件的索引。该标签仅适用于page类型的Ability。取值示例:$media:icon。

字符串

可缺省,缺省值为空。

startWindowBackground

标识该Ability启动页面背景颜色资源文件的索引。该标签仅适用于page类型的Ability。取值示例:$color:red。

字符串

可缺省,缺省值为空。

removeMissionAfterTerminate

该标签标识Ability销毁后是否从任务列表中移除任务。该标签仅适用于page类型的Ability。true表示销毁后移除任务, false表示销毁后不移除任务。

布尔值

可缺省,缺省值为false。

uriPermission对象的内部结构

表9 uriPermission对象的内部结构说明

属性名称

含义

数据类型

是否可缺省

path

uriPermission标识的路径,该标签最大字节长度为255个字节。

字符串

不可缺省。

mode

uriPermission的匹配模式。

字符串

可缺省,缺省值为default。

abilities示例:

登录后复制
"abilities": [ { "name": ".EntryAbility", "description": "test main ability", // $media:ic_launcher 为媒体类资源 "icon": "$media:ic_launcher", // $string:example 为字符串类资源 "label": "$string:example", "launchType": "multiton", "orientation": "unspecified", "permissions": [], "visible": true, "skills": [ { "actions": [ "action.system.home" ], "entities": [ "entity.system.home" ] } ], "configChanges": [ "locale", "layout", "fontSize", "orientation" ], "type": "page", "startWindowIcon": "$media:icon", "startWindowBackground": "$color:red", "removeMissionAfterTerminate": true }, { "name": ".PlayService", "description": "example play ability", "icon": "$media:ic_launcher", "label": "$string:example", "launchType": "multiton", "orientation": "unspecified", "visible": false, "skills": [ { "actions": [ "action.play.music", "action.stop.music" ], "entities": [ "entity.audio" ] } ], "type": "service", "backgroundModes": [ "audioPlayback" ] }, { "name": ".UserADataAbility", "type": "data", "uri": "dataability://com.example.world.test.UserADataAbility", "visible": true }]1.

skills对象的内部结构

表10 skills对象的内部结构说明

属性名称

含义

数据类型

是否可缺省

actions

标识能够接收的want的action值,可以包含一个或多个action。取值通常为系统预定义的action值。

字符串数组

可缺省,缺省值为空。

entities

标识能够接收的want的Ability的类别(如视频、桌面应用等),可以包含一个或多个entity。

字符串数组

可缺省,缺省值为空。

uris

该标签标识向want过滤器添加数据规范集合。该规范可以是只有数据类型(mimeType属性),可以是只有URI,也可以是既有数据类型又有URI。URI由其各个部分的单独属性指定:

未经允许不得转载:AiShang - 爱尚博客 » 鸿蒙开发入门:module对象内部结构