应用包结构配置文件的说明

在应用开发的工程中，需要在 config.json 配置文件中对应用的包结构进行声明。

配置文件的内部结构

“config.json”由 app，deviceConfig 和 module 三个部分组成，缺一不可。配置文件的内部结构说明参见表 1。

表 1 配置文件的内部结构说明

属性名称	含义	数据类型	是否可缺省
app	表示应用的全局配置信息。同一个应用的不同 HAP 包的 app 配置必须保持一致。参考app 对象内部结构。	对象	否
deviceConfig	表示应用在具体设备上的配置信息。参考deviceconfig 对象内部结构。	对象	否
module	表示 HAP 包的配置信息。该标签下的配置只对当前 HAP 包生效。参考module 对象的内部结构。	对象	否

config.json 示例：

{
  "app": {
    "bundleName": "com.example.myapplication",
    "vendor": "example",
    "version": {
      "code": 1,
      "name": "1.0"
    },
    "apiVersion": {
      "compatible": 4,
      "target": 5,
      "releaseType": "Beta1"
    }
  },
  "deviceConfig": {},
  "module": {
    "package": "com.example.myapplication.entrymodule",
    "name": ".MyApplication",
    "deviceType": ["default"],
    "distro": {
      "moduleName": "entry",
      "moduleType": "entry"
    },
    "abilities": [
      {
        "skills": [
          {
            "entities": ["entity.system.home"],
            "actions": ["action.system.home"]
          }
        ],
        "name": "com.example.myapplication.entrymodule.MainAbility",
        "icon": "$media:icon",
        "description": "$string:mainability_description",
        "label": "$string:app_name",
        "type": "page",
        "launchType": "standard"
      }
    ],
    "js": [
      {
        "pages": ["pages/index/index"],
        "name": "default",
        "window": {
          "designWidth": 720,
          "autoDesignWidth": false
        }
      }
    ]
  }
}

app 对象内部结构

app 对象包含应用全局配置信息，内部结构说明参见表 2。

表 2 app 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
bundleName	表示应用的包名，用于标识应用的唯一性。包名是由字母、数字、下划线（_）和点号（.）组成的字符串，必须以字母开头。支持的字符串长度为 7~127 字节。包名通常采用反向域名形式表示（例如，"com.example.myapplication"）。建议第一级为域名后缀"com"，第二级为厂商/个人名，也可以采用多级。	字符串	否
vendor	表示对应用开发厂商的描述。字符串长度不超过 255 字节。	字符串	可缺省，缺省值为空
version	表示应用的版本信息。参考表 3。	对象	否
apiVersion	标识应用程序所依赖的 OpenHarmony API 版本。参考表 4。	对象	可缺省，缺省值为空

表 3 version 内部结构说明

属性名称	含义	数据类型	是否可缺省
name	表示应用的版本号，用于向应用的终端用户呈现。取值可以自定义，长度不超过 127 字节。自定义规则如下： API5 及更早的版本：推荐使用三段数字版本号（也兼容两段式版本号），如 A.B.C(也兼容 A.B)，其中 A、B、C 取值为 0-999 范围内的整数。除此之外不支持其他格式。 A 段，一般表示主版本号（Major）。 B 段，一般表示次版本号（Minor）。 C 段，一般表示修订版本号（Patch）。 API6 版本起：推荐采用四段式数字版本号，如 A.B.C.D，其中 A、B、C 取值为 0-99 范围内的整数，D 的取值为 0-999 范围内的整数。 A 段，一般表示主版本号（Major）。 B 段，一般表示次版本号（Minor）。 C 段，一般表示特性版本号（Feature）。 D 段，一般表示修订版本号（Patch）。	数值	不可缺省
code	表示应用的版本号，仅用于 OpenHarmony 管理该应用，不对应用的终端用户呈现。取值规则如下： API5 及更早版本：二进制 32 位以内的非负整数，需要从 version.name 的值转换得到。转换规则为： code 值=A _ 1,000,000 + B _ 1,000 + C 例如，version.name 字段取值为 2.2.1，则 code 值为 2002001。 API6 版本起：code 的取值不与 version.name 字段的取值关联，开发者可自定义 code 取值，取值范围为 2^31 以内的非负整数，但是每次应用版本的更新，均需要更新 code 字段的值，新版本 code 取值必须大于旧版本 code 的值。	数值	不可缺省
minCompatibleVersionCode	表示应用可兼容的最低版本号，用于跨设备场景下，判断其他设备上该应用的版本是否兼容。 格式与 version.code 字段的格式要求相同。	数值	可缺省，缺省值为 code 标签值

表 4 apiVersion 内部结构

属性名称	含义	数据类型	是否可缺省
compatible	运行应用所需要的最低 API 版本，取值范围为 0~2147483647。	整数	可缺省
target	用于标识应用运行所需的目标 API 版本，取值范围为 0~2147483647。	整数	可缺省
releaseType	用于标识应用运行所需的目标 API 版本的类型。	字符串	可缺省

app 实例：

"app": {
    "bundleName": "com.example.myapplication",
    "vendor": "example",
    "version": {
      "code": 1,
      "name": "1.0"
    },
    "apiVersion": {
      "compatible": 4,
      "target": 5,
      "releaseType": "Beta1"
    }
  }

deviceConfig 对象的内部结构

deviceConfig 包含设备上的应用配置信息，可以包含 default，tv，car，wearable 等属性。default 标签内的配置是适用于所有通用设备，其他设备类型如果有特殊的需求，则需要在该设备类型的标签下进行配置。内部结构说明参见表 5。

表 5 deviceConfig 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
default	表示所有设备通用的应用配置信息。参考表 6。	对象	否
tablet	表示平板的应用配置信息。参考表 6。	对象	可缺省，缺省值为空
tv	表示智慧屏特有的应用配置信息。参考表 6。	对象	可缺省，缺省值为空
car	表示车机特有的应用配置信息。参考表 6。	对象	可缺省，缺省值为空
wearable	表示智能穿戴特有的应用配置信息。参考表 6。	对象	可缺省，缺省值为空

default、tablet、tv、car、wearable 等对象的内部结构说明，可参见表 6。

表 6 不同设备的内部结构说明

属性名称	含义	数据类型	是否可缺省
process	表示应用或者 Ability 的进程名。如果在 deviceConfig 标签下配置了 process 标签，则该应用的所有 Ability 都运行在这个进程中。如果在 abilities 标签下也为某个 Ability 配置了 process 标签，则该 Ability 就运行在这个进程中。该标签仅适用于默认设备、平板、智慧屏、车机、智慧穿戴。该标签最大长度为 31。	字符串	是
supportBackup	表示应用是否支持备份和恢复。如果配置为"false"，则不支持为该应用执行备份或恢复操作。 该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。	布尔值	可缺省，缺省值为"false"
compressNativeLibs	表示 libs 库是否以压缩存储的方式打包到 HAP 包。如果配置为"false"，则 libs 库以不压缩的方式存储，HAP 包在安装时无需解压 libs，运行时会直接从 HAP 内加载 libs 库。 该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。	布尔值	可缺省，缺省值为"true"
directLaunch	指定设备被锁定时是否可以启动应用程序。如果要在不解锁设备的情况下启动应用程序，请将此设备设置为"true"。运行 OHOS 的设备不支持此属性。	布尔值	可缺省，缺省值为"false"
ark	标识 maple 配置信息。参考表 7。	对象	是缺省为空
network	表示网络安全性配置。该标签允许应用通过配置文件的安全声明来自定义其网络安全，无需修改应用代码。参考表 9。	对象	可缺省，缺省值为空

表 7 ark 对象的内部结构说明·

属性名称	含义	数据类型	是否可缺省
reqVersion	支持应用的 maple 版本号。参考表 8。	对象	不可缺省
flag	指定 maple 应用程序的类型。	字符串	不可缺省且只能为"m"，"mo"，"z"

表 8 reqVersion 对象内部结构说明

属性名称	含义	数据类型	是否可缺省
compatible	表示支持应用程序的最低 maple 版本，采用 32 位无符号整形表示。	整数	不可缺省
target	指定 maple 应用程序的类型，采用 32 位无符号整形表示。	整数	不可缺省

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

属性名称	含义	数据类型	是否可缺省
cleartextTraffic	表示是否允许应用使用明文网络流量（例如，明文 HTTP）。 true：允许应用使用明文流量请求。 false：拒绝应用使用明文流量的请求。	布尔值	可缺省，缺省值为"false"
securityConfig	表示应用的网络安全配置信息。参考表 10。	对象	可缺省，缺省为空

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

属性名称	子属性名称	含义	数据类型	是否可缺省
domainSettings	-	表示自定义的网域范围的安全配置，支持多层嵌套，即一个 domainSettings 对象中允许嵌套更小网域范围的 domainSettings 对象。	对象类型	可缺省，缺省为空
	cleartextPermitted	表示自定义的网域范围内是否允许明文流量传输。当 cleartextTraffic 和 security 同时存在时，自定义网域是否允许明文流量传输以 cleartextPermitted 的取值为准。 true：允许明文流量传输。 false：拒绝明文流量传输。	布尔类型	否
	domains	表示域名配置信息，包含两个参数：subdomains 和 name。 subdomains(布尔类型)：表示是否包含子域名。如果为"true"，此网域规则将与相应网域及所有子网域（包括子网域的子网域）匹配。否则，该规则仅适用于精确匹配项。 name(字符串)：表示域名名称。	对象数组	否

deviceConfig 示例：

"deviceConfig": {
	"default": {
		"process": "com.example.test.example",
		"supportBackup": false,
		"network": {
			"cleartextTraffic": true,
			"securityConfig": {
				"domainSettings": {
					"cleartextPermitted": true,
					"domains": [
						{
							"subdomains": true,
							"name": "example.ohos.com"
						}
					]
				}
			}
		}
	}
}

module 对象的内部结构

module 对象包含 HAP 包的配置信息，内部结构说明参见表 11。

表 11 module 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
mainAbility	服务中心图标露出的 ability，常驻进程拉起时会启动 mainAbility。	字符串	如果存在 page 类型的 ability，则该字段不可缺省。
package	表示 HAP 的包结构名称，在应用内保证唯一性。采用反向域名格式（建议与 HAP 的工程目录保持一致）。字符串长度不超过 127 字节。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。	字符串	否
name	表示 HAP 的类名。采用反向域名 方式表示，前缀要与同级的 package 标签指定的包名一致，也可采用"."开头的命名方式。字符串长度不超过 255 字节。 该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。	字符串	否
description	表示 HAP 的描述信息。字符串长度不超过 255 字节。如果字符串超出长度或者需要支持多语言，可以采用资源索引的方式添加描述内容。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。	字符串	可缺省，缺省值为空
supportedModes	表示应用支持的运行模式，当前只定义了驾驶模式（drive）。该标签只适用于车机。	字符串数组	可缺省，缺省值为空
deviceType	表示允许 Ability 运行的设备类型。系统预定义的设备类型包括：tablet(平板)、tv（智慧屏）、car(车机)、wearable(智能穿戴)等。	字符串数组	否
distro	表示 HAP 发布的具体描述。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。参考表 12。	对象	否
metaData	表示 HAP 的元信息。参考表 13。	对象	可缺省，缺省值为空
abilities	表示当前模块内的所有 Ability。采用对象数据格式。其中的每个元素表示一个快捷方式对象。参考表 17。	对象数组	可缺省，缺省值为空
js	表示基于 ArkUI 框架开发的 JS 模块集合，其中的每个元素代表一个 JS 模块的信息。参考表 22。	对象数组	可缺省，缺省值为空
shortcuts	表示应用的快捷方式信息。采用对象数组格式，其中的每个元素表示一个快捷方式对象。参考表 25。	对象数组	可缺省，缺省值为空
reqPermissions	表示应用运行时向系统申请的权限。参考表 21。	对象数组	可缺省，缺省值为空
colorMode	表示应用自身的颜色模式。 dark：表示按照深色模式选取资源。 light：表示按照浅色模式选取资源。 auto：表示跟随系统的颜色模式值选取资源。 该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。	字符串	可缺省，缺省值为"auto"
distroFilter	表示应用的分发规则。 该标签用于定义 HAP 包对应的细分设备规格的分发策略，以便在应用市场进行云端分发应用包时做精准匹配。该标签可配置的分发策略维度包括 API Version、屏幕形状、屏幕分辨率。在进行分发时，通过 deviceType 与这三个属性的匹配关系，唯一确定一个用于分发到设备的 HAP。参考表 29。	对象	可缺省，缺省值为空。但当应用中包含多个 entry 模块时，必须配置该标签。
reqCapabilities	表示运行应用程序所需的设备能力	字符串数组	可缺省，缺省为空
commonEvents	静态广播，参考表 35。	对象数组	可缺省，缺省为空
allowClassMap	HAP 的元信息。标记值为 true 或 false。如果标记值为 true，则 hap 使用 OpenHarmony 框架提供的 Java 对象代理机制。默认值为 false。	布尔值	可缺省，缺省值为 false
entryTheme	此标签表示 OpenHarmony 内部主题的关键字。将标记值设置为名称的资源索引。	字符串	可缺省，缺省值为空

module 示例：

"module": {
	"mainAbility": "MainAbility",
	"package": "com.example.myapplication.rntry",
	"name": ".MyOHOSAbilityPackage",
	"description": "$string:description_application",
	"supportModes": [
		"drive"
	],
	"deviceType": [
		"car"
	],
	"distro": {
		"moduleName": "ohos_entry",
		"moduleType": "entry"
	},
	"abilities": [
		...
	],
	"shortcuts": [
		...
	],
	"js": [
		...
	],
	"reqPermissions": [
		...
	],
	"colorMode": "light"
}

表 12 distro 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
moduleName	表示当前 HAP 的名称，最大长度为 31。	字符串	不可缺省
moduleType	表示当前 HAP 的类型，包括两种类型：entry 和 feature。另外，如果表示 HAR 类型，请设置为 har。	字符串	不可缺省
installationFree	表示当前 HAP 是否支持免安装特性。 true：表示支持免安装特性，且符合免安装约束。 false：表示不支持免安装特性。 另外还需注意： 当 entry.hap 该字段配置为 true 时，与该 entry.hap 相关的所有 feature.hap 该字段也需要配置为 true。 当 entry.hap 该字段配置为 false 时，与该 entry.hap 相关的各 feature.hap 该字段可按业务 需求配置 true 或 false。	布尔值	否

distro 示例：

"distro": {
	"moduleName": "ohos_entry",
	"moduleType": "entry",
	"installationFree": true
}

表 13 metaData 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
parameters	表示调用 Ability 时所有调用参数的元信息。每个调用参数的元信息由以下三个标签组成：description、name、type。参考表 14。	对象数组	可缺省，缺省值为空
results	表示 Ability 返回值的元信息。每个返回值的元信息由以下三个标签组成：description、name、type。参考表 15。	对象数组	可缺省，缺省值为空。
customizeData	该标签标识父级组件的自定义元信息，Parameters 和 results 在 application 不可配。参考表 16	对象数组	可缺省，缺省值为空。

表 14 parameters 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
description	表示对调用参数的描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引以支持多语言。该标签最大长度为 255。	字符串	可缺省，缺省值为空
name	表示调用参数的名称。该标签最大长度为 255。	字符串	可缺省，缺省值为空
type	表示调用参数的类型，如 Integer。	字符串	不可缺省

表 15 results 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
description	表示对返回值的描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引以支持多语言。该标签最大长度为 255。	字符串	可缺省，缺省值为空。
name	表示返回值的名字。该标签最大长度为 255。	字符串	可缺省，缺省值为空。
type	表示返回值的类型，如 Integer。	字符串	否

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

属性名称	含义	数据类型	是否可缺省
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"
    }]
}

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

属性名称	含义	数据类型	是否可缺省
process	运行应用程序或 Ability 的进程名称。如果在 deviceConfig 标记中配置了进程，则应用程序的所有能力都在此进程中运行。您还可以为特定能力设置流程属性，以便该能力可以在此流程中运行。如果此属性设置为与其他应用程序相同的进程名称，则所有这些应用程序可以在同一进程中运行，前提是他们具有相同的联合用户 ID 和相同的签名。运行 OHOS 的设备不支持此属性。	字符串	可缺省，缺省值为空。
name	表示 Ability 名称。取值可采用反向域名方式表示，由包名和类名组成，如“com.example.myapplication.MainAbility”；也可采用“.”开头的类名方式表示，如“.MainAbility”。 Ability 的名称，需在一个应用的范围内保证唯一。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。 说明：在使用 DevEco Studio 新建项目时，默认生成首个 Ability 的配置，及“config.json”中“MainAbility”的配置。如使用其他 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 的启动模式，支持“standard”和“singleton”两种模式： standard：表示该 Ability 可以有多实例。该模式适用于大多数应用场景。 singleton：表示该 Ability 在所有任务栈中仅可以有一个实例。例如，具有全局唯一性的呼叫来电界面即采用“singleton”模式。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。	字符串	可缺省，缺省值为“singleton”。
visible	表示 Ability 是否可以被其他应用调用。 true：可以被其他应用调用。 false：不能被其他应用调用。	布尔类型	可缺省，缺省值为“false”。
permissions	表示其他应用的 Ability 调用此 Ability 时需要申请的权限集合，一个数组元素为一个权限名称。通常采用反向域名格式（最大 255 字节），取值为系统预定义的权限。	字符串数组	可缺省，缺省值为空。
skills	表示 Ability 能够接收的 want 的特征。	对象数组	可缺省，缺省值为空。
deviceCapability	表示 Ability 运行时要求设备具有的能力，采用字符串数组的格式表示。	字符串数组	可缺省，缺省值为空。
metaData	元数据，参考表 13。	对象	可缺省，缺省值为空。
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。
multiUserShared	表示 Ability 是否支持多用户状态进行共享，该标签仅适用于 data 类型的 Ability。配置为“true”时，表示在多用户下只有一份存储数据。需要注意的是，该属性会使 visible 属性失效。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。	布尔类型	可缺省，缺省值为“false”。
supportPipMode	表示 Ability 是否支持用户进入 PIP 模式（用于在页面最上层悬浮小窗口，俗称“画中画”，常见于视频播放等场景）。该标签仅适用于 page 类型的 Ability。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。	布尔类型	可缺省，缺省值为“false”。
formsEnabled	表示 Ability 是否支持卡片（forms）功能。该标签仅适用于 page 类型的 Ability。 true：支持卡片能力。 false：不支持卡片能力。	布尔类型	可缺省，缺省值为“false”。
forms	表示服务卡片的属性。该标签仅当 formsEnabled 为“true”时，才能生效。参考表 27。	对象数组	可缺省，缺省值为空。
srcLanguage	Ability 开发语言的类型。	字符串	取值为 js 或 ets
srcPath	该标签表示 Ability 对应的 JS 组件代码路径	字符串	可缺省，缺省值为空。
uriPermission	表示该 Ability 有权访问的应用程序数据。此属性由模式和路径子属性组成。此属性仅对类型提供者的能力有效。运行 OHOS 的设备不支持此属性。参考表 18。	对象	可缺省，缺省值为空。

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

属性名称	含义	数据类型	是否可缺省
path	uriPermission 标识的路径	字符串	不可缺省
mode	uriPeimission 的匹配模式	字符串	可缺省，缺省值为 default。

abilities 示例：

"abilities": [
    {
        "name": ".MainAbility",
        "description": "test main ability",
        "icon": "$media:ic_launcher",
        "label": "$media:example",
        "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": "example play ability",
        "icon": "$media:ic_launcher",
        "label": "$media:example",
        "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.example.world.test.UserADataAbility",
        "visible": true
    }
]

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

属性名称	含义	数据类型	是否可缺省
actions	表示能够接收的 want 的 action 值，可以包含一个或多个 action。取值通常为系统预定义的 action 值。	字符串数组	可缺省，缺省值为空。
entities	表示能够接收的 want 的 Ability 的类别（如视频、桌面应用等），可以包含一个或多个 entity。	字符串数组	可缺省，缺省值为空。
uris	表示能够接收的 want 的 uri，可以包含一个或者多个 uri。参考表 20。	对象数组	可缺省，缺省值为空。

表 20 uris 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
scheme	表示 uri 的 scheme 值。	字符串	不可缺省。
host	表示 uri 的 host 值。	字符串	可缺省，缺省值为空。
port	表示 uri 的 port 值。	字符串	可缺省，缺省值为空。
pathStartWith	表示 uri 的 pathStartWith 值。	字符串	字符串
path	表示 uri 的 path 值。	字符串	可缺省，缺省值为空。
pathRegx	表示 uri 的 pathRegx 值。	字符串	可缺省，缺省值为空。
type	表示 uri 的 type 值。	字符串	可缺省，缺省值为空。

skills 示例：

"skills": [
    {
        "actions": [
            "action.system.home"
        ],
        "entities": [
            "entity.system.home"
        ],
        "uris": [
            {
                 "scheme": "http",
                 "host": "www.example.com",
                 "port": "8080",
                 "path": "query/student/name",
                 "type": "text/*"
             }
         ]
    }
]

表 21 reqPermissions 权限申请字段说明

属性名称	含义	类型	取值范围	默认值	规则约束
name	必须，填写需要使用的权限名称。	字符串	自定义	无	未填写时，解析失败。
reason	可选，当申请的权限为 user_grant 权限时此字段必填。描述申请权限的原因。	字符串	显示文字长度不能超过 256 个字节。	空	user_grant 权限必填，否则不允许在应用市场上架。需做多语种适配。
usedScene	可选，当申请的权限为 user_grant 权限时此字段必填。描述权限使用的场景和时机。场景类型有：ability、when（调用时机）。可配置多个 ability。	对象	ability：ability 的名称 when：inuse（使用时）、always（始终）	ability：空 when：inuse	user_grant 权限必填 ability，可选填 when。

表 22 js 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
name	表示 JS Component 的名字。该标签不可缺省，默认值为 default。	字符串	否
pages	表示 JS Component 的页面用于列举 JS Component 中每个页面的路由信息[页面路径+页面名称]。该标签不可缺省，取值为数组，数组第一个元素代表 JS FA 首页。	数组	否
window	用于定义与显示窗口相关的配置。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。参考表 23。	对象	可缺省
type	表示 JS 应用的类型。取值范围如下： normal：标识该 JS Component 为应用实例。 form：标识该 JS Component 为卡片实例。	字符串	可缺省，缺省值为“normal”
mode	定义 JS 组件的开发模式。参考表 24。	对象	可缺省，缺省值为空

表 23 window 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
designWidth	表示页面设计基准宽度。以此为基准，根据实际设备宽度来缩放元素大小。	数值	可缺省，缺省值为 720px
autoDesignWidth	表示页面设计基准宽度是否自动计算。当配置为 true 时，designWidth 将会被忽略，设计基准宽度由设备宽度与屏幕密度计算得出。	布尔类型	可缺省，缺省值为“false”

表 24 mode 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
type	定义 JS 组件的功能类型	字符串，取值为"pageAbility"、"form"	可缺省，缺省值为 pageAbility
syntax	定义 JS 组件的语法类型	字符串，取值为"hml"，"ets"	是，默认值为"hml"

js 示例：

"js": [
    {
        "name": "default",
        "pages": [
            "pages/index/index",
            "pages/detail/detail"
        ],
        "window": {
            "designWidth": 720,
            "autoDesignWidth": false
        },
        "type": "form"
    }
]

表 25 shortcuts 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
shortcutId	表示快捷方式的 ID。字符串的最大长度为 63 字节。	字符串	否
label	表示快捷方式的标签信息，即快捷方式对外显示的文字描述信息。取值可以是描述性内容，也可以是标识 label 的资源索引。字符串最大长度为 63 字节。	字符串	可缺省，缺省为空。
icon	表示快捷方式的图标信息。取值为表示 icon 的资源索引。	字符串	可缺省，缺省为空。
intents	表示快捷方式内定义的目标 intent 信息集合，每个 intent 可配置两个子标签，targetClass, targetBundle。参考表 26。	对象数组	可缺省，缺省为空。

表 26 intents 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
targetClass	表示快捷方式目标类名。	字符串	可缺省，缺省值为空。
targetBundle	表示快捷方式目标 Ability 所在应用的包名。	字符串	可缺省，缺省值为空。

shortcuts 示例：

"shortcuts": [
    {
        "shortcutId": "id",
        "label": "$string:shortcut",
        "intents": [
            {
                "targetBundle": "com.example.world.test",
                "targetClass": "com.example.world.test.entry.MainAbility"
            }
        ]
    }
]

表 27 forms 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
name	表示卡片的类名。字符串最大长度为 127 字节。	字符串	否
description	表示卡片的描述。取值可以是描述性内容，也可以是对描述性内容的资源索引，以支持多语言。字符串最大长度为 255 字节。	字符串	可缺省，缺省为空。
isDefault	表示该卡片是否为默认卡片，每个 Ability 有且只有一个默认卡片。 true：默认卡片。 false：非默认卡片。	布尔值	否
type	表示卡片的类型。取值范围如下： JS：JS 卡片。	字符串	否
colorMode	表示卡片的主题样式，取值范围如下： auto：自适应。 dark：深色主题。 light：浅色主题。	字符串	可缺省，缺省值为“auto”。
supportDimensions	表示卡片支持的外观规格，取值范围： 1 _ 2：表示 1 行 2 列的二宫格。 2 _ 2：表示 2 行 2 列的四宫格。 2 _ 4：表示 2 行 4 列的八宫格。 4 _ 4：表示 4 行 4 列的十六宫格。	字符串数组	否
defaultDimension	表示卡片的默认外观规格，取值必须在该卡片 supportDimensions 配置的列表中。	字符串	否
updateEnabled	表示卡片是否支持周期性刷新，取值范围： true：表示支持周期性刷新，可以在定时刷新（updateDuration）和定点刷新（scheduledUpdateTime）两种方式任选其一，优先选择定时刷新。 false：表示不支持周期性刷新。	布尔类型	否
scheduledUpdateTime	表示卡片的定点刷新的时刻，采用 24 小时制，精确到分钟。	字符串	可缺省，缺省值为“0:0”。
updateDuration	表示卡片定时刷新的更新周期，单位为 30 分钟，取值为自然数。 当取值为 0 时，表示该参数不生效。 当取值为正整数 N 时，表示刷新周期为 30*N 分钟。	数值	可缺省，缺省值为“0”。
formConfigAbility	表示用于调整卡片的设施或活动的名称。	字符串	可缺省，缺省值为空。
formVisibleNotify	标识是否允许卡片使用卡片可见性通知	字符串	可缺省，缺省值为空。
jsComponentName	表示 JS 卡片的 Component 名称。字符串最大长度为 127 字节。仅当卡片类型为 JS 卡片时，需要配置该标签。	字符串	否
metaData	表示卡片的自定义信息，包含 customizeData 数组标签。参考表 13。	对象	可缺省，缺省值为空。
customizeData	表示自定义的卡片信息。参考表 28。	对象数组	可缺省，缺省值为空。

表 28 customizeData 对象内部结构说明

属性名称	含义	数据类型	是否可缺省
name	表示数据项的键名称。字符串最大长度为 255 字节。	字符串	可缺省，缺省值为空。
value	表示数据项的值。字符串最大长度为 255 字节。	字符串	可缺省，缺省值为空。
extra	表示当前 custom 数据的格式，取值为表示 extra 的资源值。	字符串	可缺省，缺省值为空。

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_Js",
        "description": "It's JS Form",
        "type": "Js",
        "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.example.weather.testWidget"
                }
            ]
        }
    }
]

表 29 distroFilter 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
apiVersion	表示支持的 apiVersion 范围。参考表 30。	对象	可选
screenShape	表示屏幕形状的支持策略。参考表 31。	对象数组	可选
screenWindow	表示应用运行时窗口的分辨率支持策略。该字段仅支持对轻量级智能穿戴设备进行配置。参考表 32。	对象数组	可选
screenDensity	表示屏幕的像素密度（dpi：Dots Per Inch）。参考表 33。	对象数组	可选
countryCode	表示分发应用时的国家码。具体值参考 ISO-3166-1 的标准，支持多个国家和地区的枚举定义。参考表 34。	对象数组	可选

表 30 apiVersion 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
policy	表示该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足 value 枚举值匹配规则的表示匹配该属性。	字符串	可缺省，缺省值为空。
value	支持的取值为 API Version 存在的整数值，例如 4、5、6。场景示例：某应用，针对相同设备型号，同时在网的为使用 API 5 和 API 6 开发的两个软件版本，则允许上架 2 个 entry 类型的安装包，分别支持到对应设备侧软件版本的分发。	数组	可缺省，缺省值为空。

表 31 screenShape 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
policy	表示该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足 value 枚举值匹配规则的表示匹配该属性。	字符串	可缺省，缺省值为空。
value	支持的取值为 circle（圆形）、rect（矩形）。场景示例：针对智能穿戴设备，可为圆形表盘和矩形表盘分别提供不同的 HAP。	数组	可缺省，缺省值为空。

表 32 screenWindow 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
policy	表示该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足 value 枚举值匹配规则的表示匹配该属性。	字符串	可缺省，缺省值为空。
value	单个字符串的取值格式为：“宽 _ 高”，取值为整数像素值，例如“454 _ 454”。	数组	可缺省，缺省值为空。

表 33 screenDensity 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
policy	表示该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足 value 枚举值匹配规则的表示匹配该属性。	字符串	可缺省，缺省值为空。
value	取值范围如下： sdpi：表示小规模的屏幕密度（Small-scale Dots Per Inch），适用于 dpi 取值为（0,120]的设备。 mdpi：表示中规模的屏幕密度(Medium-scale Dots Per Inch)，适用于 dpi 取值为（120,160]的设备。 ldpi：表示大规模的屏幕密度(Large-scale Dots Per Inch)，适用于 dpi 取值为（160,240]的设备。 xldpi：表示特大规模的屏幕密度(Extra Large-scale Dots Per Inch)，适用于 dpi 取值为（240,320]的设备。 xxldpi：表示超大规模的屏幕密度(Extra Extra Large-scale Dots Per Inch)，适用于 dpi 取值为（320,480]的设备。 xxxldpi：表示超特大规模的屏幕密度(Extra Extra Extra Large-scale Dots Per Inch)，适用于 dpi 取值为（480,640]的设备。	数组	可缺省，缺省值为空。

表 34 countryCode 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
policy	表示该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足 value 枚举值匹配规则的表示匹配该属性。	字符串	可缺省，缺省值为空。
value	该标签表示应用需要分发的国家码，标签为字符串数组，子串表示支持的国家或地区，由两个大写字母表示。	字符串数组	可缺省，缺省值为空。

distroFilter 示例：

"distroFilter":  {
    "apiVersion": {
        "policy": "include",
        "value": [4,5]
    },
    "screenShape": {
        "policy": "include",
        "value": ["circle","rect"]
    },
    "screenWindow": {
        "policy": "include",
        "value": ["454*454","466*466"]
    },
    "screenDensity":{
    	"policy": "exclude",
    	"value": ["ldpi","xldpi"]
	},
	"countryCode": {
        "policy":"include",
        "value":["CN", "HK"]
    }
}

表 35 commonEvents 对象的内部结构说明

属性名称	含义	数据类型	是否可缺省
name	表示静态广播名称	字符串	不可缺省
permission	此标签表示实现静态公共事件所需要申请的权限	字符串数组	可缺省，缺省值为空
data	此标记配置当前静态公共事件要携带的附加数据数组	字符串数组	可缺省，缺省值为空
type	该标签用于配置当前静态公共事件的分类数组	字符串数组	可缺省，缺省值为空
events	此标签标记可接收的意图的一组事件值。一般由系统预定义，也可以自定义。	字符串数组	不可缺省

commonEvents 示例：

"commonEvents": [
	{
		"name":"MainAbility",
		"permission": "string",
		"data":[
			"string",
			"string"
		],
		"events": [
			"string",
			"string"
		]
	}
]