【HarmonyOS之旅】HarmonyOS开发基础知识(二)
目录
1 -> 配置文件说明(Java)
1.1 -> 配置文件的内部结构
1.2 -> app对象的内部结构
1.3 -> deviceConfig对象的内部结构
1.4 -> module对象的内部结构
1.5 -> HAP与HAR的配置文件的合并
1.5.1 -> 配置文件合并规则
1.5.2 -> mergeRule对象的使用
1.5.3 -> bundleName占位符的使用
2 -> 应用数据管理
2.1 -> 本地应用数据管理
2.2 -> 分布式数据服务
2.3 -> 分布式文件服务
2.4 -> 数据搜索服务
2.5 -> 数据存储管理
3 -> 应用安全管理
3.1 -> 应用开发准备阶段
3.2 -> 应用开发调试阶段
3.2.1 -> 编码安全
3.2.2 -> 权限使用
3.3 -> 应用发布分发阶段
1 -> 配置文件说明(Java)
此部分提供配置文件“config.json”中所有属性的详细解释。
DevEco Studio提供了两种编辑“config.json”文件的方式。在“config.json”的编辑窗口中,可在右上角切换代码编辑视图或可视化编辑视图。
1.1 -> 配置文件的内部结构
“config.json”由app、deviceConfig和module三个部分组成,缺一不可。
属性名称 | 含义 | 数据类型 | 是否可缺省 |
app | 表示应用的全局配置信息。同一个应用的不同HAP包的app配置必须保持一致。 | 对象 | 不可缺省 |
deviceConfig | 表示应用在具体设备上的配置信息。 | 对象 | 不可缺省 |
module | 表示HAP包的配置信息。该标签下的配置只对当前HAP包生效。 | 对象 | 不可缺省 |
1.2 -> app对象的内部结构
app对象包含应用的全局配置信息。
属性名称 | 子属性名称 | 含义 | 数据类型 | 是否可缺省 |
bundleName | —— | 表示应用的包名,用于标识应用的唯一性。 包名是由字母、数字、下划线(_)和点号(.)组成的字符串,必须以字母开头。支持的字符串长度为7~127字节。 包名通常采用反域名形式表示(例如,“com.example.myapplication”)。建议第一级为域名后缀“com”,第二级为厂商/个人名,第三级为应用名,也可以采用多级。 对于元服务,其包名必须以“.hmservice”结尾。 例如,“com.example.myapplication.hmservice”。 使用DevEco Studio创建元服务(Atomic Service)时,会自动添加“.hmservice”。 说明 如需使用ohos.data.orm包的接口,则应用的包名不能使用大写字母。 | 字符串 | 不可缺省 |
vendor | —— | 表示对应用开发厂商的描述。字符串长度不超过255字节 | 字符串 | 可缺省,缺省值为空 |
version | —— | 表示应用的版本信息。 | 对象 | 不可缺省 |
name | 表示应用的版本号,用于向应用的终端用户呈现。取值可以自定义,长度不超过127个字节。自定义规则如下: API 5及更早版本:推荐使用三段式数字版本号(也兼容两段式版本号),如A.B.C(也兼容A.B),其中A、B、C取值为0~999范围内的整数。除此之外不支持其他格式。 B段,一般表示次版本号(Minor)。 C段,一般表示修订版本号(Patch)。 API 6版本起:推荐采用四段式数字版本号,如A.B.C.D,其中A、B、C取值为0~99范围内的整数,D取值为0~999范围内的整数。 B段,一般表示次版本号(Minor)。 C段,一般表示特性版本号(Feature)。 D段,一般表示修订版本号(Patch)。 | 字符串 | 不可缺省 | |
code | 表示应用的版本号,仅用于HarmonyOS管理该应用,不对应用的终端用户呈现。取值规则如下: API 5及更早版本:二进制32位以内的非负整数,需要从version.name的值转换得到。 例如,version.name字段取值为2.2.1,则code的值为2002001。 API 6版本起:code的取值不与version.name字段的取值关联,开发者可自定义code的取值,取值范围为小于231的非负整数,但是每次应用的版本更新,均需更新code字段的值,新版本code取值必须大于旧版本code的值。 | 数值 | 不可缺省 | |
minCompatibleVersionCode | 表示应用可兼容的最低版本号,用于在跨设备场景下,判断其他设备上该应用的版本是否兼容。格式与version.code字段的格式要求相同。 | 数值 | 可缺省,缺省值为code标签值 | |
smartWindowSize | —— | 该标签用于在悬浮窗场景下表示应用的模拟窗口的尺寸。 配置格式为“正整数*正整数”,单位为vp。 正整数取值范围为[200,2000]。 | 字符串 | 可缺省,缺省值为code标签值 |
smartWindowDeviceType | —— | 表示应用可以在哪些设备上使用模拟窗口打开。 取值为: 智能手机:phone | 字符串 | 可缺省,缺省值为code标签值 |
targetBundleList | —— | 表示允许以免安装方式拉起的其他HarmonyOS应用,列表取值为每个HarmonyOS应用的bundleName,多个bundleName之间用英文“,”区分,最多配置5个bundleName。 如果被拉起的应用不支持免安装方式,则拉起失败。 | 字符串 | 可缺省,缺省值为code标签值 |
app示例:
app示例:
"app": {
"bundleName": "com.huawei.hiworld.example",
"vendor": "huawei",
"version": {
"code": 2,
"name": "2.0.0"
}
}
1.3 -> deviceConfig对象的内部结构
deviceConfig包含在具体设备上的应用配置信息,可以包含default、phone、tablet、tv、car、wearable、liteWearable和smartVision等属性。default标签内的配置是适用于所有设备通用,其他设备类型如果有特殊的需求,则需要在该设备类型的标签下进行配置。
属性名称 | 含义 | 数据类型 | 是否可缺省 |
default | 表示所有设备通用的应用配置信息。 | 对象 | 可缺省,缺省值为空 |
phone | 表示手机类设备的应用信息配置。 | 对象 | 可缺省,缺省值为空 |
tablet | 表示平板的应用配置信息。 | 对象 | 可缺省,缺省值为空 |
tv | 表示智慧屏特有的应用配置信息。 | 对象 | 可缺省,缺省值为空 |
car | 表示车机特有的应用配置信息。 | 对象 | 可缺省,缺省值为空 |
wearable | 表示智能穿戴特有的应用配置信息。 | 对象 | 可缺省,缺省值为空 |
liteWearable | 表示轻量级智能穿戴特有的应用配置信息。 | 对象 | 可缺省,缺省值为空 |
smartVision | 表示智能摄像头特有的应用配置信息。 | 对象 | 可缺省,缺省值为空 |
default、phone、tablet、tv、car、wearable、liteWearable和smartVision等对象的内部结构说明。
属性名称 | 含义 | 数据类型 | 是否可缺省 |
jointUserld | 表示应用的共享userid。 通常情况下,不同的应用运行在不同的进程中,应用的资源是无法共享。如果开发者的多个应用之间需要共享资源,则可以通过相同的jointUserId值实现,前提是这些应用的签名相同。 该标签仅对系统应用生效,且仅适用于手机、平板、智慧屏、车机、智能穿戴。 该字段在API Version 3及更高版本不再支持配置。 | 字符串 | 可缺省,缺省值为空 |
process | 表示应用或者Ability的进程名。 如果在deviceConfig标签下配置了process标签,则该应用的所有Ability都运行在这个进程中。 如果在abilities标签下也为某个Ability配置了process标签,则该Ability就运行在这个进程中。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 字符串 | 可缺省,缺省为应用软件的包名 |
supportBackup | 表示应用是否支持备份和恢复。如果配置为“false”,则不支持为该应用执行备份或恢复操作。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 布尔值 | 可缺省,缺省值为“false” |
compressNativeLibs | 表示libs库是否以压缩存储的方式打包到HAP包。如果配置为“false”,则libs库以不压缩的方式存储,HAP包在安装时无需解压libs,运行时会直接从HAP内加载libs库。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 布尔值 | 可缺省,缺省值为“true” |
network | 表示网络安全性配置。该标签允许应用通过配置文件的安全声明来自定义其网络安全,无需修改应用代码。 | 对象 | 可缺省,缺省值为空 |
属性名称 | 含义 | 数据类型 | 是否可缺省 |
cleartextTraffic | 表示是否允许应用使用明文网络流量(例如,明文HTTP)。
| 布尔值 | 可缺省,缺省值为“false” |
securityConfig | 表示应用的网络安全配置信息。 | 对象 | 可缺省,缺省值为空 |
属性名称 | 子属性名称 | 含义 | 数据类型 | 是否可缺省 |
domainSettings | —— | 表示自定义的网域范围的安全配置,支持多层嵌套,即一个domainSettings对象中允许嵌套更小网域范围的domainSettings对象。 | 对象 | 可缺省,缺省值为空 |
cleartextPermitted | 表示自定义的网域范围内是否允许明文流量传输。当cleartextTraffic和securityConfig同时存在时,自定义网域是否允许明文流量传输以cleartextPermitted的取值为准。
| 布尔值 | 不可缺省 | |
domains | 表示域名配置信息,包含两个参数:subdomains和name。
| 对象 | 不可缺省 |
deviceConfig示例:
"deviceConfig": {
"default": {
"process": "com.huawei.hiworld.example",
"supportBackup": false,
"network": {
"cleartextTraffic": true,
"securityConfig": {
"domainSettings": {
"cleartextPermitted": true,
"domains": [
{
"subdomains": true,
"name": "example.ohos.com"
}
]
}
}
}
}
}
1.4 -> module对象的内部结构
module对象包含HAP包的配置信息。
属性名称 | 含义 | 数据类型 | 是否可缺省 |
mainAbility | 表示HAP包的入口ability名称。该标签的值应配置为“module > abilities”中存在的Page类型ability的名称。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 字符串 | 如果存在page类型的ability,则该字段不可缺省。 |
package | 表示HAP的包结构名称,在应用内应保证唯一性。采用反向域名格式(建议与HAP的工程目录保持一致)。字符串长度不超过127字节。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 字符串 | 不可缺省 |
name | 表示HAP的类名。采用反向域名方式表示,前缀需要与同级的package标签指定的包名一致,也可采用“.”开头的命名方式。字符串长度不超过255字节。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 字符串 | 不可缺省 |
description | 表示HAP的描述信息。字符串长度不超过255字节。如果字符串超出长度或者需要支持多语言,可以采用资源索引的方式添加描述内容。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 字符串 | 可缺省,缺省值为空 |
supportedModes | 表示应用支持的运行模式。当前只定义了驾驶模式(drive)。 该标签仅适用于车机。 | 字符串 | 可缺省,缺省值为空 |
deviceType | 表示允许Ability运行的设备类型。系统预定义的设备类型包括:phone(手机)、tablet(平板)、tv(智慧屏)、car(车机)、wearable(智能穿戴)、liteWearable(轻量级智能穿戴)等。 | 字符串 | 不可缺省 |
distro | 表示HAP发布的具体描述。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 对象 | 不可缺省 |
metaData | 表示HAP的元信息。 | 对象 | 可缺省,缺省值为空 |
abilities | 表示当前模块内的所有Ability。采用对象数组格式,其中每个元素表示一个Ability对象。 | 对象 | 可缺省,缺省值为空 |
js | 表示基于ArkUI框架开发的JS模块集合,其中的每个元素代表一个JS模块的信息。 | 对象 | 可缺省,缺省值为空 |
shortcuts | 表示应用的快捷方式信息。采用对象数组格式,其中的每个元素表示一个快捷方式对象。 | 对象 | 可缺省,缺省值为空 |
defPermissions | 表示应用定义的权限。应用调用者必须申请这些权限,才能正常调用该应用。 | 对象 | 可缺省,缺省值为空 |
reqPermissions | 表示应用运行时向系统申请的权限。 | 对象 | 可缺省,缺省值为空 |
colorMode | 表示应用自身的颜色模式。
该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 字符串 | 可缺省,缺省值为“auto” |
resizeable | 表示应用是否支持多窗口特性。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 布尔值 | 可缺省,缺省值为“true” |
distroFilter | 表示应用的分发规则。 该标签用于定义HAP包对应的细分设备规格的分发策略,以便在应用市场进行云端分发应用包时做精准匹配。 该标签可配置的分发策略维度包括API Version、屏幕形状、屏幕分辨率。在进行分发时,通过deviceType与这三个属性的匹配关系,唯一确定一个用于分发到对应设备的HAP。 | 对象 | 可缺省。缺省值为空。但当应用中包含多个entry模块时,必须配置该标签。 |
module示例:
"module": {
"mainAbility": "MainAbility",
"package": "com.example.myapplication.entry",
"name": ".MyOHOSAbilityPackage",
"description": "$string:description_application",
"supportedModes": [
"drive"
],
"deviceType": [
"car"
],
"distro": {
"deliveryWithInstall": true,
"moduleName": "ohos_entry",
"moduleType": "entry"
},
"abilities": [
...
],
"shortcuts": [
...
],
"js": [
...
],
"reqPermissions": [
...
],
"defPermissions": [
...
],
"colorMode": "light"
}
属性名称 | 含义 | 数据类型 | 是否可缺省 |
deliveryWithInstall | 表示当前HAP是否支持随应用安装。
说明 该属性建议设置为true。 设置false可能导致最终应用上架应用市场异常。 | 布尔值 | 不可缺省 |
moduleName | 表示当前HAP的名称。 | 字符串 | 不可缺省 |
moduleType | 表示当前HAP的类型,包括两种类型:entry和feature。 另外,如果表示HAR类型,请设置为har。 | 字符串 | 不可缺省 |
installationFree | 表示当前HAP是否支持免安装特性。
另外还需注意:
| 布尔值 | 不可缺省 |
distro示例:
"distro": {
"deliveryWithInstall": true,
"moduleName": "ohos_entry",
"moduleType": "entry",
"installationFree": true
}
属性名称 | 子属性名称 | 含义 | 数据类型 | 是否可缺省 |
parameters | —— | 表示调用Ability时所有调用参数的元信息。每个调用参数的元信息由以下三个标签组成:description、name、type。 | 对象 | 可缺省,缺省值为空 |
description | 表示对调用参数的描述,可以是表示描述内容的字符串,也可以是对描述内容的资源索引以支持多语言。 | 字符串 | 可缺省,缺省值为空 | |
name | 表示调用参数的名称。 | 字符串 | 可缺省,缺省值为空 | |
type | 表示调用参数的类型,如Integer。 | 字符串 | 不可缺省 | |
results | —— | 表示Ability返回值的元信息。每个返回值的元信息由以下三个标签组成:description、name、type。 | 对象 | 可缺省,缺省值为空 |
description | 表示对返回值的描述,可以是表示描述内容的字符串,也可以是对描述内容的资源索引以支持多语言。 | 字符串 | 可缺省,缺省值为空 | |
name | 表示返回值的名字。 | 字符串 | 可缺省,缺省值为空 | |
type | 表示返回值的类型,如Integer。 | 字符串 | 不可缺省 | |
customizeData | —— | 表示父级组件的自定义元信息,parameters和results在module中不可配。 | 对象 | 可缺省,缺省值为空 |
name | 表示数据项的键名称,字符串类型(最大长度255字节)。 | 字符串 | 可缺省,缺省值为空 | |
value | 表示数据项的值,字符串类型(最大长度255字节)。 | 字符串 | 可缺省,缺省值为空 | |
extra | 表示用户自定义数据格式,标签值为标识该数据的资源的索引值。 | 字符串 | 可缺省,缺省值为空 |
metaData示例:
"metaData": {
"parameters" : [{
"name" : "string",
"type" : "Float",
"description" : "$string:parameters_description"
}],
"results" : [{
"name" : "string",
"type" : "Float",
"description" : "$string:results_description"
}],
"customizeData" : [{
"name" : "string",
"value" : "string",
"extra" : "$string:customizeData_description"
}]
}
属性名称 | 含义 | 数据类型 | 是否可缺省 |
name | 表示Ability名称。取值可采用反向域名方式表示,由包名和类名组成,如“com.example.myapplication.MainAbility”;也可采用“.”开头的类名方式表示,如“.MainAbility”。 Ability的名称,需在一个应用的范围内保证唯一。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 说明 在使用DevEco Studio新建项目时,默认生成首个Ability的配置,包括生成“MainAbility.java”文件,及“config.json”中“MainAbility”的配置。如使用其他IDE工具,可自定义名称。 | 字符串 | 不可缺省 |
description | 表示对Ability的描述。取值可以是描述性内容,也可以是对描述性内容的资源索引,以支持多语言。 | 字符串 | 可缺省,缺省值为空 |
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”(至少有一个不同)。 | 字符串 | 可缺省,缺省值为空 |
uri | 表示Ability的统一资源标识符。格式为[scheme:][//authority][path][?query][#fragment]。 | 字符串 | 可缺省,对于data类型的Ability不可缺省 |
lunchType | 表示Ability的启动模式,支持“standard”、“singleMission”和“singleton”三种模式:
该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 字符串 | 可缺省,缺省值为“standard” |
permissions | 表示其他应用的Ability调用此Ability时需要申请的权限。通常采用反向域名格式,取值可以是系统预定义的权限,也可以是开发者自定义的权限。如果是自定义权限,取值必须与defPermissions标签中定义的某个权限的name标签值一致。 | 字符串 | 可缺省,缺省值为空 |
skills | 表示Ability能够接收的Intent的特征。 | 对象 | 可缺省,缺省值为空 |
deviceCapability | 表示Ability运行时要求设备具有的能力,采用字符串数组的格式表示。 | 字符串 | 可缺省,缺省值为空 |
metaData | 表示Ability的元信息。
该标签仅适用于智慧屏、智能穿戴、车机。 | 对象 | 可缺省,缺省值为空 |
type | 表示Ability的类型。取值范围如下:
| 字符串 | 不可缺省 |
orientation | 表示该Ability的显示模式。该标签仅适用于page类型的Ability。取值范围如下:
| 字符串 | 可缺省,缺省值为“unspecified” |
backgroundModes | 表示后台服务的类型,可以为一个服务配置多个后台服务类型。该标签仅适用于service类型的Ability。取值范围如下:
| 字符串 | 可缺省,缺省值为空 |
readPermission | 表示读取Ability的数据所需的权限。该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 字符串 | 可缺省,缺省值为空 |
writePermission | 表示向Ability写数据所需的权限。该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 字符串 | 可缺省,缺省值为空 |
configChanges | 表示Ability关注的系统配置集合。当已关注的配置发生变更后,Ability会收到onConfigurationUpdated回调。取值范围:
| 字符串 | 可缺省,缺省值为空 |
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是否支持用户进入PIP模式(用于在页面最上层悬浮小窗口,俗称“画中画”,常见于视频播放等场景)。该标签仅适用于page类型的Ability。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 布尔值 | 可缺省,缺省值为“false” |
formsEnabled | 表示Ability是否支持卡片(forms)功能。该标签仅适用于page类型的Ability。
| 布尔值 | 可缺省,缺省值为“false” |
forms | 表示服务卡片的属性。该标签仅当formsEnabled为“true”时,才能生效。 | 对象 | 可缺省,缺省值为空 |
resizeable | 表示Ability是否支持多窗口特性。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 布尔值 | 可缺省,缺省值为“true” |
abilities示例:
"abilities": [
{
"name": ".MainAbility",
"description": "himusic main ability",
"icon": "$media:ic_launcher",
"label": "HiMusic",
"launchType": "standard",
"orientation": "unspecified",
"permissions": [
],
"visible": true,
"skills": [
{
"actions": [
"action.system.home"
],
"entities": [
"entity.system.home"
]
}
],
"configChanges": [
"locale",
"layout",
"fontSize",
"orientation"
],
"type": "page"
},
{
"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",
"backgroundModes": [
"audioPlayback"
]
},
{
"name": ".UserADataAbility",
"type": "data",
"uri": "dataability://com.huawei.hiworld.himusic.UserADataAbility",
"visible": true
}
]
属性名称 | 子属性名称 | 含义 | 数据类型 | 是否可缺省 |
actions | —— | 表示能够接收的Intent的action值,可以包含一个或多个action。 取值通常为系统预定义的action值,详见《API参考》中的ohos.aafwk.content.Intent类。 | 字符串 | 可缺省,缺省值为空 |
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/*"
}
]
}
]
属性名称 | 子属性名称 | 含义 | 数据类型 | 是否可缺省 |
name | —— | 表示JS Component的名字。该标签不可缺省,默认值为".default"。 | 字符串 | 不可缺省 |
pages | —— | 表示JS Component的页面。用于列举JS Component中每个页面的路由信息[页面路径+页面名称]。该标签不可缺省,取值为数组,数组第一个元素代表JS FA首页。 | 数组 | 不可缺省 |
window | —— | 用于定义与显示窗口相关的配置。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 对象 | 可缺省 |
designWidth | 表示页面设计基准宽度。以此为基准,根据实际设备宽度来缩放元素大小。 | 数组 | 可缺省,缺省值为720px | |
autoDesignWidth | 表示页面设计基准宽度是否自动计算。当配置为true时,designWidth将会被忽略,设计基准宽度由设备宽度与屏幕密度计算得出。 | 布尔值 | 可缺省,缺省值为“false” | |
type | —— | 表示JS应用的类型。取值范围如下:
| 字符串 | 可缺省,缺省值为“normal” |
mode | —— | 用于定义JS Component的开发模式。该标签可缺省,标签值为对象,包含type和syntax两个子标签。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 mode属性,其优先级高于type属性。 该属性从API Version 6开始支持。 | 对象 | 可缺省 |
type | 定义该JS Component的功能类型。支持以下类型:
| 字符串 | 可缺省,缺省值为“pageAbility” | |
syntax | 定义该JS Component的语法类型。支持以下类型:
当type设置为form类型时,syntax仅可选择hml语法类型。 | 字符串 | 可缺省,缺省值为“hml” |
js示例:
"js": [
{
"name": ".default",
"pages": [
"pages/index/index",
"pages/detail/detail"
],
"window": {
"designWidth": 720,
"autoDesignWidth": false
},
"type": "form",
"mode": {
"type": form,
"syntax": hml
}
}
]
属性名称 | 子属性名称 | 含义 | 数据类型 | 是否可缺省 |
shortcutld | —— | 表示快捷方式的ID。字符串的最大长度为63字节。 | 字符串 | 不可缺省 |
label | —— | 表示快捷方式的标签信息,即快捷方式对外显示的文字描述信息。取值可以是描述性内容,也可以是标识label的资源索引。字符串最大长度为63字节。 | 字符串 | 可缺省,缺省值为空 |
intents | —— | 表示快捷方式内定义的目标intent信息集合,每个intent可配置两个子标签,targetClass, targetBundle。 | 对象 | 可缺省,缺省值为空 |
targetClass | 表示快捷方式目标类名。 | 字符串 | 可缺省,缺省值为空 | |
targetBundle | 表示快捷方式目标Ability所在应用的包名。 | 字符串 | 可缺省,缺省值为空 |
shortcuts示例:
"shortcuts": [
{
"shortcutId": "id",
"label": "$string:shortcut",
"intents": [
{
"targetBundle": "com.huawei.hiworld.himusic",
"targetClass": "com.huawei.hiworld.himusic.entry.MainAbility"
}
]
}
]
属性名称 | 子属性名称 | 含义 | 数据类型 | 是否可缺省 |
name | —— | 表示卡片的类名。字符串最大长度为127字节。 | 字符串 | 不可缺省 |
description | —— | 表示卡片的描述。取值可以是描述性内容,也可以是对描述性内容的资源索引,以支持多语言。字符串最大长度为255字节。 | 字符串 | 可缺省,缺省值为空 |
isDefault | —— | 表示该卡片是否为默认卡片,每个Ability有且只有一个默认卡片。
| 布尔值 | 不可缺省 |
type | —— | 表示卡片的类型。取值范围如下:
| 字符串 | 不可缺省 |
colorMode | —— | 表示卡片的主题样式,取值范围如下:
| 字符串 | 可缺省,缺省值为“auto” |
supportDimensions | —— | 表示卡片支持的外观规格,取值范围:
| 字符串 | 不可缺省 |
defaultDimension | —— | 表示卡片的默认外观规格,取值必须在该卡片supportDimensions配置的列表中。 | 字符串 | 不可缺省 |
landscapeLayouts | —— | 表示卡片外观规格对应的横向布局文件,与supportDimensions中的规格一一对应。 仅当卡片类型为Java卡片时,需要配置该标签。 | 字符串 | 不可缺省 |
portraitLayouts | —— | 表示卡片外观规格对应的竖向布局文件,与supportDimensions中的规格一一对应。 仅当卡片类型为Java卡片时,需要配置该标签。 | 字符串 | 不可缺省 |
updateEnabled | —— | 表示卡片是否支持周期性刷新,取值范围:
| 布尔值 | 不可缺省 |
scheduledUpdateTime | —— | 表示卡片的定点刷新的时刻,采用24小时制,精确到分钟。 | 字符串 | 可缺省,缺省值为“0:0” |
updateDuration | —— | 表示卡片定时刷新的更新周期,单位为30分钟,取值为自然数。
| 数值 | 可缺省,缺省值为“0” |
formConfigAbility | —— | 表示卡片的配置跳转链接,采用URI格式。 | 字符串 | 可缺省,缺省值为空 |
jsComponentName | —— | 表示JS卡片的Component名称。字符串最大长度为127字节。 仅当卡片类型为JS卡片时,需要配置该标签。 | 字符串 | 不可缺省 |
metaData | —— | 表示卡片的自定义信息,包含customizeData数组标签。 | 对象 | 可缺省,缺省值为空 |
customizeData | —— | 表示自定义的卡片信息。 | 对象 | 可缺省,缺省值为空 |
name | 表示数据项的键名称。字符串最大长度为255字节。 | 字符串 | 可缺省,缺省值为空 | |
value | 表示数据项的值。字符串最大长度为255字节。 | 字符串 | 可缺省,缺省值为空 |
forms示例:
"forms": [
{
"name": "Form_Js",
"description": "It's Js Form",
"type": "JS",
"jsComponentName": "card",
"colorMode": "auto",
"isDefault": true,
"updateEnabled": true,
"scheduledUpdateTime": "11:00",
"updateDuration": 1,
"defaultDimension": "2*2",
"supportDimensions": [
"2*2",
"2*4",
"4*4"
]
},
{
"name": "Form_Java",
"description": "It's Java Form",
"type": "Java",
"colorMode": "auto",
"isDefault": false,
"updateEnabled": true,
"scheduledUpdateTime": "21:05",
"updateDuration": 1,
"defaultDimension": "1*2",
"supportDimensions": [
"1*2"
],
"landscapeLayouts": [
"$layout:ability_form"
],
"portraitLayouts": [
"$layout:ability_form"
],
"formConfigAbility": "ability://com.example.myapplication.fa/.MainAbility",
"metaData": {
"customizeData": [
{
"name": "originWidgetName",
"value": "com.huawei.weather.testWidget"
}
]
}
}
]
属性名称 | 子属性名称 | 含义 | 数据类型 | 是否可缺省 |
apiVersion | —— | 表示支持的apiVersion范围。 | 对象 | 可选 |
policy | 表示该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单,满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | ||
value | 支持的取值为API Version存在的整数值,例如4、5、6。 场景示例:某应用,针对相同设备型号,同时在网的为使用API 5和API 6开发的两个软件版本,则允许上架2个entry类型的安装包,分别支持到对应设备侧软件版本的分发。 | 数组 | ||
screenShape | —— | 表示屏幕形状的支持策略。 | 对象 | 可选 |
policy | 表示该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单,满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | ||
value | 支持的取值为circle(圆形)、rect(矩形)。 场景示例:针对智能穿戴设备,可为圆形表盘和矩形表盘分别提供不同的HAP。 | 字符串 | ||
screenWindow | —— | 表示应用运行时窗口的分辨率支持策略。 该字段仅支持对轻量级智能穿戴设备进行配置。 | 对象 | 可选 |
policy | 表示该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单,满足value枚举值匹配规则的表示匹配该属性。 该字段仅支持配置白名单,即“include”。 | 字符串 | ||
value | 单个字符串的取值格式为:“宽*高”,取值为整数像素值,例如“454*454”。 | 字符串 |
distroFilter示例:
"distroFilter":
{
"apiVersion": {
"policy": "include",
"value": [4,5]
},
"screenShape": {
"policy": "include",
"value": ["circle","rect"]
},
"screenWindow": {
"policy": "include",
"value": ["454*454","466*466"]
}
}
1.5 -> HAP与HAR的配置文件的合并
如果应用模块中调用了HAR,在编译构建HAP时,需要将HAP的“config.json”文件与一个或多个HAR的“config.json”文件,合并为一个“config.json”文件。在合并过程中,不同文件的同一个标签的取值可能发生冲突,此时,需要通过配置mergeRule来解决冲突。
1.5.1 -> 配置文件合并规则
HAP与HAR的“config.json”文件合并时,需要将HAR的配置信息全部合并到HAP的配置文件。
HAP的优先级总是高于HAR。当HAP依赖于多个HAR时,先加载的HAR的优先级高于后加载的HAR,按照HAR的加载顺序依次合并到HAP文件。
序号 | HAP | HAR | 合并结果 |
1 | 无标签值 | 无标签值 | 无标签值 |
2 | 有标签值,取值为A | 无标签值 | 有标签值,取值为A |
3 | 无标签值 | 有标签值,取值为B | 有标签值,取值为B |
4 | 有标签值,取值为A | 有标签值,取值为A | 有标签值,取值为A |
5 | 有标签值,取值为A | 有标签值,取值为B | 冲突,需要添加mergeRule。 |
1.5.2 -> mergeRule对象的使用
mergeRule通常在HAP的“config.json”文件中使用,可以在abilities、defPermissions、 reqPermissions、js等属性中添加。不同属性的合并策略。
注意
- HAR配置文件中不能包含“action.system.home”和“entity.system.home”配置项,否则会导致编译报错。
- abilities对象中name字段的取值,必须为完整的类名,否则会导致合并出错。
属性名称 | 合并规则 | ||
一级 | 二级 | 三级 | |
app | —— | —— | 只保留HAP的“config.json”文件中的app对象。 |
deviceConfig | —— | —— | 只保留HAP的“config.json”文件中的deviceConfig对象。 |
module | package | —— | 只保留HAP的“config.json”文件中的取值。 |
name | —— | 只保留HAP的“config.json”文件中的取值。 | |
description | —— | 只保留HAP的“config.json”文件中的取值。 | |
supportedModes | —— | 只保留HAP的“config.json”文件中的取值。 | |
deviceType | —— | 只保留HAP的“config.json”文件中的取值。 | |
distro | —— | 只保留HAP的“config.json”文件中的取值。 | |
shortcuts | —— | 只保留HAP的“config.json”文件中的取值。 | |
defPermissions | —— |
| |
reqPermissions | —— |
| |
js | —— |
| |
abilities | —— |
| |
permissions | 取值为HAP与HAR的“config.json”文件中相应属性值的并集。 | ||
skills | 取值为HAP与HAR的“config.json”文件中相应属性值的并集。 | ||
backgroundModes | 取值为HAP与HAR的“config.json”文件中相应属性值的并集。 | ||
configChanges | 取值为HAP与HAR的“config.json”文件中相应属性值的并集。 | ||
targetAbility | 如果targetAbility与abilities中的name冲突,则导致编译报错。 | ||
其他 | abilities中的其他属性如果发生合并冲突,则需要添加mergeRule字段。 |
属性名称 | 含义 | 数据类型 | 是否可缺省 |
remove | 表示HAP与HAR的“config.json”文件合并时,需要移除的标签。 | 字符串 | 可缺省 |
replace | 表示HAP与HAR的“config.json”文件合并冲突时,需要替换的标签,始终保留高优先级的值。 | 字符串 | 可缺省 |
mergeRule的使用示例:
在下面的示例中,HAP与HAR中的Ability的name取值相同,需要对两者“config.json”文件中的Ability进行合并。由于两个文件中的部分字段(例如launchType)存在冲突,需要在HAP的abilities标签下添加mergeRule。
1. 合并前HAP的“config.json”文件,如下所示:
其中,remove表示合并后需要移除的子标签,replace表示合并后需要替换的子标签(HAP替换HAR)。
"abilities": [
{
"mergeRule": {
"remove": ["orientation"],
"replace": ["launchType"]
}
"name": "com.harmony.myapplication.entry.MainAbility",
"type": "page",
"launchType": "standard",
"visible": false
}
],
2. 合并前HAR的“config.json”文件,如下所示:
"abilities": [
{
"name": "com.harmony.myapplication.entry.MainAbility",
"type": "page",
"launchType": "singleton",
"orientation": "portrait",
"visible": false
}
],
3. 将上述两个“config.json”文件按照mergeRule进行合并,处理完成后mergeRule字段也会被移除。合并后的结果文件,如下所示:
"abilities": [
{
"name": "com.harmony.myapplication.entry.MainAbility",
"type": "page",
"launchType": "standard",
"visible": false
}
],
1.5.3 -> bundleName占位符的使用
HAR的“config.json”文件中多处需要使用包名,例如自定义权限、自定义action等场景,但是包名只有当HAR编译到HAP时才能确定下来。在编译之前,HAR中的包名可以采用占位符来表示,采用{bundleName}形式。
支持bundleName占位符的标签有actions、entities、permissions、readPermission、writePermission、defPermissions.name。
使用示例:
1. HAR中自定义action时,使用{bundleName}来代替包名。如下所示:
"skills": [
{
"actions": [
"{bundleName}.ACTION_PLAY"
],
"entities": [
"{bundleName}.ENTITY_PLAY"
],
}
],
2. 将HAR编译到bundleName为“com.huawei.hiworld”的HAP包后,原来的{bundleName}将被替换为HAP的实际包名。替换后的结果如下所示:
"app": {
"bundleName": "com.huawei.hiworld",
……
},
"module": {
"abilities": [
{
"skills": [
{
"actions": [
"com.huawei.hiworld.ACTION_PLAY"
],
"entities": [
"com.huawei.hiworld.ENTITY_PLAY"
],
}
],
2 -> 应用数据管理
HarmonyOS应用数据管理支持单设备的各种结构化数据的持久化,以及跨设备之间数据的同步、共享以及搜索功能。开发者通过应用数据管理,能够方便地完成应用程序数据在不同终端设备间的无缝衔接,满足用户跨设备使用数据的一致性体验。
2.1 -> 本地应用数据管理
提供单设备上结构化数据的存储和访问能力。使用SQLite作为持久化存储引擎,提供了多种类型的本地数据库,分别是关系型数据库(Relational Database)和对象关系映射数据库(Object Relational Mapping Database),此外还提供一种轻量级偏好数据库(Light Weight Preference Database),用以满足开发人员使用不同数据模型对应用数据进行持久化和访问的需求。
2.2 -> 分布式数据服务
分布式数据库支持用户数据跨设备相互同步,为用户提供在多种终端设备上一致的数据访问体验。通过调用分布式数据接口,应用可以将数据保存到分布式数据库中。通过结合帐号、应用唯一标识和数据库三元组,分布式数据库对属于不同应用的数据进行隔离。
2.3 -> 分布式文件服务
在多个终端设备间为单个设备上应用程序创建的文件提供多终端的分布式共享能力。每台设备上都存储一份全量的文件元数据,应用程序通过文件元数据中的路径,可以实现同一应用文件的跨设备访问。
2.4 -> 数据搜索服务
在单个设备上,为应用程序提供搜索引擎级的全文索引管理、建立索引和搜索功能。
2.5 -> 数据存储管理
为应用开发者提供系统存储路径、存储设备列表,存储设备属性的查询和管理功能。
3 -> 应用安全管理
3.1 -> 应用开发准备阶段
- 依据国家《移动互联网应用程序信息服务管理规定》,同时为了促进生态健康有序发展,保护应用开发者和用户的合法权益,需要每一位HarmonyOS开发者注册账号,并建议同步进行实名认证。实名认证包括个人开发者实名认证和企业开发者实名认证,没有完成实名认证的开发者,无法进行应用上架发布。
- 建议使用官方渠道下载的开发工具。
- 在发布HarmonyOS应用前,可以在本地进行应用调试。HarmonyOS通过数字证书和Profile文件对应用进行管控,只有经过签名的HAP才允许安装到设备上运行。
3.2 -> 应用开发调试阶段
3.2.1 -> 编码安全
- 避免不对外交互的Ability可以被其他应用直接访问。
- 避免带有敏感功能公共事件可以被其他应用直接访问。
- 避免通过隐式方式进行调用组件,防止组件劫持。
- 避免通过隐式方式发送公共事件,防止公共事件携带的数据被劫持。
- 应用作为数据使用方需校验数据提供方的身份,防止被仿冒进行攻击。
- 对跨信任边界传入的Intent须进行合法性判断,防止应用异常崩溃。
- 避免在配置文件中开启应用备份和恢复开关。
- 避免将敏感数据存放到剪贴板中。
- 避免将敏感数据写入公共数据库、存储区中。
- 避免直接使用不可信数据来拼接SQL语句。
- 避免向可执行函数传递不可信数据。
- 避免使用Socket方式进行本地通信,如需使用,localhost端口号随机生成,并对端口连接对象进行身份认证和鉴权。
- 建议使用Https代替Http进行通信,并对Https证书进行严格校验。
- 建议使用校验机制保证WebView在加载网站服务时URL地址的合法性。
- 对于涉及支付及高保密数据的应用,建议进行手机root环境监测。
- 建议开启安全编译选项,增加应用分析逆向难度。
- 禁止应用执行热更新操作,应用更新可以通过应用市场上架来完成。
- 建议应用在开发阶段进行自测试。
3.2.2 -> 权限使用
- 应用申请的权限,都必须有明确、合理的使用场景和功能说明,确保用户能够清晰明了地知道申请权限的目的、场景、用途;禁止诱导、误导用户授权;应用使用权限必须与申请所述一致。
- 应用权限申请遵循最小化原则,只申请业务功能所必要的权限,禁止申请不必要的权限。
- 应用在首次启动时,避免频繁弹窗申请多个敏感权限;敏感权限须在用户使用对应业务功能时动态申请。
- 用户拒绝授予某个权限时,与此权限无关的其他业务功能应能正常使用,不能影响应用的正常注册或登录。
- 业务功能所需要的权限被用户拒绝且禁止后不再提示,当用户主动触发使用此业务功能或为实现业务功能所必须时,应用程序可通过界面内文字引导,让用户主动到“系统设置”中授权。
- 非系统应用自定义权限名,禁止使用系统权限名前缀(如: 以ohos开头为系统权限),建议以应用包名或公司反域名为前缀,防止与系统或其他应用定义的权限重名。
3.3 -> 应用发布分发阶段
应用调试完毕后,可以进行打包HarmonyOS应用,在AGC提交上架申请。为了确保HarmonyOS应用的完整性,确保提交应用的开发者身份合法,HarmonyOS通过数字证书和Profile文件对应用进行管控。上架到华为应用市场的APP必须通过签名才允许上架。因此,为了保证应用能够顺利发布,需要提前申请相应的发布证书与发布Profile。
提交发布申请后,应用市场将对应用进行安全审核,包括权限、隐私、安全等,如果审核不通过则不能上架;应用发布成功后,华为应用市场会对上架应用进行重签名,原有的应用签名将被替换为新签名。
感谢各位大佬支持!!!
互三啦!!!