鸿蒙的应用领域,鸿蒙应用配置文件简介

鸿蒙应用的配置文件

安卓有个清单文件，四大组件、权限等都需要在清单文件中注册，清单文件是个xml文件。类似的，鸿蒙应用有个配置文件，应用的每个HAP的根目录下都存在一个“config.json”配置文件，主要涵盖以下三个方面：

应用的全局配置信息，包含应用的包名、生产厂商、版本号等基本信息。

应用在具体设备上的配置信息。

HAP包的配置信息，包含每个Ability必须定义的基本属性(如包名、类名、类型以及Ability提供的能力)，以及应用访问系统或其他应用受保护部分所需的权限等。

配置文件的内部结构

应用的配置文件“config.json”中由“app”、“deviceConfig”和“module”三个部分组成，缺一不可。

属性名称

含义

app

表示应用的全局配置信息。同一个应用的不同HAP包的“app”配置必须保持一致。

deviceConfig

表示应用在具体设备上的配置信息。

module

表示HAP包的配置信息。该标签下的配置只对当前HAP包生效。

app对象的内部结构

属性名称

子属性名称

含义

bundleName

-

应用的包名，用于标识应用的唯一性。

vendor

-

应用的开发厂商

version

-

应用的版本信息

code

表示应用的版本号，仅用于鸿蒙系统管理该应用，对用户不可见。取值为大于零的整数。

-

name

表示应用的版本号，用于向用户呈现。取值可以自定义。

-

apiVersion

-

表示应用依赖的 API 版本。

compatible

表示应用运行需要的API最小版本。取值为大于零的整数，跟安卓的minSdkVersion一样

-

target

表示应用运行需要的API目标版本。取值为大于零的整数，跟安卓的targetSdkVersion一样

-

app示意：

"app": {

"bundleName": "com.example.myapplication", // 包名

"vendor": "example", // 开发厂商

"version": {

"code": 1, // 用数字表示的版本号，对用户不可见

"name": "1.0" // 用字符串表示的版本号，用于向用户呈现

},

"apiVersion": {

"compatible": 3, // 应用运行需要的API最小版本，跟安卓的minSdkVersion一样

"target": 3 // 应用运行需要的API目标版本，跟安卓的targetSdkVersion一样

}

}

deviceConfig对象的内部结构

deviceConfig包含在具体设备上的应用配置信息，可以包含default、car、tv、wearable、liteWearable、smartVision等属性。default标签内的配置是适用于所有设备通用，其他设备类型如果有特殊的需求，则需要在该设备类型的标签下进行配置。

deviceConfig对象的内部结构说明

属性名称

含义

是否可缺省

default

表示所有设备通用的应用配置信息。

否

car

表示车机特有的应用配置信息。

可缺省

tv

表示智慧屏特有的应用配置信息。

可缺省

wearable

表示智能穿戴特有的应用配置信息。

可缺省

liteWearable

表示轻量级智能穿戴特有的应用配置信息。

可缺省

smartVision

表示智能摄像头特有的应用配置信息。

可缺省

default/car/tv/wearable等对象的内部结构说明

属性名称

含义

是否可缺省

process

表示应用或者Ability的进程名。如果在“deviceConfig”标签下配置了“process”标签，则该应用的所有Ability都运行在这个进程中。 如果在“abilities”标签下也为某个Ability配置了“process”标签，则该Ability就运行在这个进程中。

可缺省，缺省为应用的软件包名

directLaunch

表示应用是否支持在设备未解锁状态直接启动。如果配为“true”，则表示应用支持在设备未解锁状态下启动。使用场景举例：应用支持在设备未解锁情况下接听来电。

可缺省，缺省为false

supportBackup

表示应用是否支持备份和恢复。如果配置为“false”，则不支持为该应用执行备份或恢复操作。

可缺省，缺省为false

compressNativeLibs

表示libs库是否以压缩存储的方式打包到 HAP 包。如果配置为“false”，则libs库以不压缩的方式存储，HAP 包在安装时无需解压libs，运行时会直接从HAP内加载libs库。

可缺省，缺省为true

network

表示网络安全性配置。该标签允许应用通过配置文件的安全声明来自定义其网络安全，无需修改应用代码。

可缺省，缺省为空

network对象的内部结构说明

属性名称

含义

是否可缺省

usesCleartext

表示是否允许应用使用明文网络流量(例如，明文 HTTP)。默认值为“false”。true：允许应用使用明文流量的请求。false：拒绝应用使用明文流量的请求。

可缺省

securityConfig

表示应用的网络安全配置信息。

可缺省

securityConfig对象的内部结构说明

属性名称

子属性名称

含义

是否可缺省

domainSettings

-

表示自定义的网域范围的安全配置，支持多层嵌套，即一个domainSettings对象中允许嵌套更小网域范围的domainSettings对象。

可缺省

cleartextPermitted

表示自定义的网域范围内是否允许明文流量传输。当useCleartext和securityConfig同时存在时，自定义网域是否允许明文流量传输以cleartextPermitted的取值为准。true：允许明文流量传输。false：拒绝明文流量传输。

domains

表示域名配置信息，包含两个参数：subDomains和name。subDomains(布尔类型)：表示是否包含子域名。如果为 “true”，此网域规则将与相应网域及所有子网域(包括子网域的子网域)匹配。否则，该规则仅适用于精确匹配项。name(字符串)：表示域名名称。

deviceConfig示例：

"deviceConfig": {

"default": {

"process": "com.huawei.hiworld.example", // 进程名称

"directLaunch": false, // 不支持在设备未解锁的情况下启动应用

"supportBackup": false, // 不支持备份

"network": {

"usesCleartext": true, // 允许使用明文

"securityConfig": {

"domainSettings": {

"cleartextPermitted": true, // 允许使用明文

"domains": [

{

"subDomains": true, // 包含子域名

"name": "example.ohos.com" // 子域名名称

}

]

}

}

}

}

}

module对象的内部结构

module对象包含HAP包的配置信息，内部结构说明如下

属性名称

含义

是否可缺省

package

表示 HAP 的包结构名称，在应用内应保证唯一性。

否

name

表示 HAP 的类名

否

description

表示 HAP 的描述信息。

可缺省，缺省值为空。

supportedModes

表示应用支持的运行模式。当前只定义了驾驶模式(drive)。

可缺省，缺省值为空。

deviceType

表示允许 Ability 运行的设备类型

否

distro

表示 HAP 发布的具体描述

否

abilities

表示当前模块内的所有Ability。采用对象数组格式，其中每个元素表示一个Ability对象。

可缺省，缺省值为空。

js

表示基于 JS UI 框架开发的 JS 模块集合，其中的每个元素代表一个 JS 模块的信息。

可缺省，缺省值为空。

shortcuts

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

可缺省，缺省值为空。

defPermission

表示应用定义的权限。应用调用者必须申请这些权限，才能正常调用该应用。

可缺省，缺省值为空。

reqPermissions

表示应用运行时向系统申请的权限。

可缺省，缺省值为空。

module示例：

"module": {

"package": "com.example.myapplication.entry", // 包名

"name": ".MyOHOSAbilityPackage", // 类名

"description": "$string:description_application", // 描述信息

"supportedModes": [

"drive" // 支持驾驶模式

],

],

"deviceType": [

"car" // 运行在车机上，可以运行在多个设备上

],

"distro": { // 具体描述

"deliveryWithInstall": true,

"moduleName": "ohos_entry",

"moduleType": "entry"

},

"abilities": [ // 所有的ability

...

],

"shortcuts": [ // 应用的快捷方式

...

],

"js": [ // 基于JS UI框架开发的JS模块集合，其中的每个元素代表一个JS模块的信息

...

],

"reqPermissions": [ // 请求的权限

...

],

"defPermissions": [ // 定义的权限

...

]

}

distro对象的内部结构说明

属性名称

含义

是否可缺省

deliveryWithInstall

表示当前 HAP 是否在支持随应用安装。true：支持随应用安装。false：不支持随应用安装。

否

moduleName

表示当前 HAP 的名称。

否

moduleType

表示当前 HAP 的类型，包括两种类型：entry和feature

否

distro示例：

"distro": {

"deliveryWithInstall": true, // 支持随应用安装

"moduleName": "ohos_entry", // 当前 HAP 的名称

"moduleType": "entry" // 当前 HAP 的类型

}

abilities对象的内部结构说明

属性名称

含义

是否可缺省

name

表示 Ability 名称。

否

description

表示 Ability 的描述。

可缺省，缺省值为空

icon

表示 Ability 图标资源文件的索引。

可缺省，缺省值为空

label

表示 Ability 对用户显示的名称。

可缺省，缺省值为空

uri

表示 Ability 的统一资源标识符。格式为[scheme:] [//authority] [path] [?query] [#fragment]

可缺省，对于data类型的Ability不可缺省

launchType

表示 Ability 的启动模式，支持“standard”和“singleton”两种模式：standard：表示该 Ability 可以有多实例。“standard”模式适用于大多数应用场景。singleton：表示该 Ability 只可以有一个实例。例如，具有全局唯一性的呼叫来电界面即采用“singleton”模式。

可缺省，缺省值为standard

visible

表示 Ability 是否可以被其他应用调用。true：可以被其他应用调用。false：不能被其他应用调用。

可缺省，缺省值为false

permissions

表示其他应用的 Ability 调用此 Ability 时需要申请的权限。通常采用反向域名格式，取值可以是系统预定义的权限，也可以是开发者自定义的权限。如果是自定义权限，取值必须与“defPermissions”标签中定义的某个权限的“name”标签值一致。

可缺省，缺省值为空

skills

表示 Ability 能够接收的 Intent 的特征。

可缺省，缺省值为空

deviceCapability

表示 Ability 运行时要求设备具有的能力。

可缺省，缺省值为空

type

表示 Ability 的类型。取值范围如下：page：表示基于 Page 模板开发的 FA，用于提供与用户交互的能力。service：表示基于 Service 模板开发的PA，用于提供后台运行任务的能力。data：表示基于 Data 模板开发的 PA，用于对外部提供统一的数据访问抽象。。

否

formEnabled

表示 FA 类型的 Ability 是否提供卡片(form)能力。该标签仅适用于page类型的 Ability。true：提供卡片能力。false：不提供卡片能力。

可缺省，缺省值为false

form

表示 AbilityForm 的属性。该标签仅当“formEnabled”为“true”时，才能生效。

可缺省，缺省值为空

orientation

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

可缺省，缺省值为unspecified

backgroundModes

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

可缺省，缺省值为空

readPermission

表示读取 Ability 的数据所需的权限。该标签仅适用于data类型的 Ability。

可缺省，缺省值为空

writePermission

表示向 Ability 写数据所需的权限。该标签仅适用于data类型的 Ability。

可缺省，缺省值为空

directLaunch

表示 Ability 是否支持在设备未解锁状态直接启动。如果配为“true”，则表示 Ability 支持在设备未解锁状态下启动。如果“deviceConfig”和“abilities”中同时配置了“directLaunch”，则采用 Ability 对应的取值；如果同时未配置，则采用系统默认值。

可缺省，缺省值为false

configChanges

表示 Ability 关注的系统配置集合。当已关注的配置发生变更后，Ability 会收到onConfigurationUpdated回调。取值范围：locale：表示语言区域发生变更。layout：表示屏幕布局发生变更。fontSize：表示字号发生变更。orientation：表示屏幕方向发生变更。density：表示显示密度发生变更。

可缺省，缺省值为空

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

multiUserShared

表示 Ability 是否支持多用户状态进行共享，该标签仅适用于data类型的 Ability。配置为“true”时，表示在多用户下只有一份存储数据。需要注意的是，该属性会使visible属性失效。

可缺省，缺省值为false

supportPipMode

表示 Ability 是否支持用户进入画中画模式(用于在在页面最上层悬浮小窗口，俗称“画中画”，常见于视频播放等场景)。该标签仅适用于page类型的 Ability。

可缺省，缺省值为false

abilities示例：

"abilities": [

{

"name": ".MainAbility",

"description": "$string:description_main_ability",

"icon": "$media:hiworld.png",

"label": "HiMusic",

"type": "page",

"formEnabled": false,

"launchType": "standard",

"orientation": "unspecified",

"permissions": [

],

"visible": false,

"skills": [

{

"actions": [

"action.system.home"

],

"entities": [

"entity.system.home"

]

}

],

"configChanges": [

"locale",

"layout",

"fontSize",

"orientation"

],

"directLaunch": false,

"process": "string",

"backgroundModes": [

"dataTransfer",

"audioPlayback",

"audioRecording",

"pictureInPicture",

"voip",

"location",

"bluetoothInteraction",

"wifiInteraction",

"screenFetch"

],

}

]

form对象的内部结构说明

属性名称

含义

是否可缺省

formEntity

表示AbilityForm支持的显示方式，当前支持的位置包括：homeScreen：以桌面图标显示。searchbox：在全局搜索显示。

可缺省，缺省值为空

minHeight

表示AbilityForm缩放时能达到的最小高度，单位：像素。

可缺省，缺省值为0

defaultHeight

表示AbilityForm的默认高度，单位：像素。Form 使用方应当根据该值为 Form 申请相应高度的容器布局。

可缺省，缺省值为0

minWidth

表示AbilityForm缩放时能达到的最小宽度，单位：像素。

可缺省，缺省值为0

defaultWidth

表示AbilityForm的默认宽度，单位：像素。Form使用方应当根据该值为Form申请相应宽度的容器布局。

可缺省，缺省值为空

form示意

"form": {

"formEntity": [

"homeScreen",

"searchbox"

],

"minHeight": 100,

"maxHeight": 200,

"minWidth": 100,

"maxWidth": 200

}

skills对象的内部结构说明

属性名称

子属性名称

含义

是否可缺省

actions

-

表示能够接收的 Intent 的action值，可以包含一个或多个action。取值通常为系统预定义的action值，详见《API 参考》中的ohos.aafwk.content.Intent类，跟安卓的action应当是一个意思

可缺省，缺省值为空

entities

-

表示能够接收的 Intent 的 Ability 的类别(如视频、桌面应用等)，可以包含一个或多个entity。取值通常为系统预定义的类别，详见《API 参考》中的ohos.aafwk.content.Intent类，也可以自定义。

可缺省，缺省值为空

uris

-

表示能够接收的Intent的uri，可以包含一个或者多个uri。

可缺省，缺省值为空

scheme

表示uri的scheme值。

-

不可缺省

host

表示uri的host值

-

可缺省，缺省值为空

port

表示uri的port值

-

可缺省，缺省值为空

path

表示uri的path值

-

可缺省，缺省值为空

type

表示uri的type值

-

可缺省，缺省值为空

skills示例：

"skills": [

{

"actions": [

"action.system.home"

],

"entities": [

"entity.system.home"

],

"uris": [

{

"scheme": "http",

"host": "www.xxx.com",

"port": "8080",

"path": "query/student/name",

"type": "text"

}

]

}

]

shortcuts对象的内部结构说明

属性名称

子属性名称

含义

是否可缺省

shortcutId

-

表示快捷方式的 ID。

否

label

-

表示快捷方式的标签信息，即快捷方式对外显示的文字描述信息。取值可以是描述性内容，也可以是标识label的资源索引。

可缺省，缺省为空

intents

-

表示快捷方式内定义的目标intent信息集合，每个intent可配置两个子标签，targetClass, targetBundle。

可缺省，缺省为空

targetBundle

表示快捷方式目标 Ability 所在应用的包名。

-

可缺省，缺省为空

targetClass

表示快捷方式目标类名。

-

可缺省，缺省为空

shortcuts示意

"shortcuts": [

{

"shortcutId": "id",

"label": "$string:shortcut",

"intents": [

{

"targetBundle": "com.huawei.hiworld.himusic",

"targetClass": "com.huawei.hiworld.himusic.entry.MainAbility"

}

]

}

]

鸿蒙系统配置文件示例

以 JSON 文件为 config.json 的一个简单示例，该示例的应用声明为三个 Ability。

{

"app": {

"bundleName": "com.huawei.hiworld.himusic",

"vendor": "huawei",

"version": {

"code": 2,

"name": "2.0"

}

"apiVersion": {

"compatible": 3,

"target": 3

}

},

"deviceConfig": {

"default": {

}

},

"module": {

"package": "com.huawei.hiworld.himusic.entry",

"name": ".MainApplication",

"supportedModes": [

"drive"

],

"distro": {

"moduleType": "entry",

"deliveryWithInstall": true,

"moduleName": "hap-car"

},

"deviceType": [

"car"

],

"abilities": [

{

"name": ".MainAbility",

"description": "himusic main ability",

"icon": "$media:ic_launcher",

"label": "HiMusic",

"launchType": "standard",

"orientation": "unspecified",

"visible": true,

"skills": [

{

"actions": [

"action.system.home"

],

"entities": [

"entity.system.home"

]

}

],

"type": "page",

"formEnabled": false

},

{

"name": ".PlayService",

"description": "himusic play ability",

"icon": "$media:ic_launcher",

"label": "HiMusic",

"launchType": "standard",

"orientation": "unspecified",

"visible": false,

"skills": [

{

"actions": [

"action.play.music",

"action.stop.music"

],

"entities": [

"entity.audio"

]

}

],

"type": "service",

"formEnabled": false,

"backgroundModes": [

"audioPlayback"

]

},

{

"name": ".UserADataAbility",

"type": "data",

"uri": "dataability://com.huawei.hiworld.himusic.UserADataAbility",

"visible": true

}

],

"reqPermissions": [{

"name": "ohos.permission.DISTRIBUTED_DATASYNC",

"reason": "",

"usedScene": {

"ability": [

"com.huawei.hiworld.himusic.entry.MainAbility",

"com.huawei.hiworld.himusic.entry.PlayService"

],

"when": "inuse"

}

}

]

}

}