鸿蒙OS开发教程3：鸿蒙app中的Manifest配置文件

应用配置文件概述（Stage模型）

我们在开发移动应用时，无论是Android还是iOS都必然有一个应用配置文件，如：Android中的AndroidManifest.xml文件，这些配置文件会向编译工具、操作系统和应用市场提供应用的基本信息，而在HarmonyOS系统中拆分成了两个文件：app.json5和module.json5。

在基于Stage模型开发的应用项目代码下，都存在一个app.json5及一个或多个module.json5这两种配置文件。

app.json5主要包含以下内容：

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

• 特定设备类型的配置信息。

module.json5主要包含以下内容：

• Module的基本配置信息，例如Module名称、类型、描述、支持的设备类型等基本信息。

• 应用组件信息，包含UIAbility组件和ExtensionAbility组件的描述信息。

• 应用运行过程中所需的权限信息。

app.json5配置文件

先通过一个示例，整体认识一下app.json5配置文件。

{

"app": {

"bundleName": "com.application.myapplication",

"vendor": "example",

"versionCode": 1000000,

"versionName": "1.0.0",

"icon": "$media:app_icon",

"label": "$string:app_name",

"description": "$string:description_application",

"minAPIVersion": 9,

"targetAPIVersion": 9,

"apiReleaseType": "Release",

"debug": false,

"car": {

"minAPIVersion": 8,

}

},

}

app.json5配置文件包含以下标签。

表1 app.json5文件配置标签说明

属性名称	含义	数据类型	是否可缺省
bundleName	标识应用的Bundle名称，用于标识应用的唯一性。该标签不可缺省。标签的值命名规则 ： - 字符串以字母、数字、下划线和符号“.”组成。 - 以字母开头。 - 最小长度7个字节，最大长度127个字节。 推荐采用反域名形式命名（如com.example.demo，建议第一级为域名后缀com，第二级为厂商/个人名，第三级为应用名，也可以多级）。	字符串	该标签不可缺省。
bundleType	标识应用的Bundle类型，用于区分应用或者原子化服务。该标签可选值为app和atomicService ： - app：当前Bundle为普通应用。 - atomicService：当前Bundle为元服务。	字符串	该标签可以缺省，缺省为app。
debug	标识应用是否可调试，该标签由IDE编译构建时生成。 - true：可调试。 - false：不可调试。	布尔值	该标签可以缺省，缺省为false。
icon	标识应用的图标，标签值为图标资源文件的索引。	字符串	该标签不可缺省。
label	标识应用的名称，标签值为字符串资源的索引。	字符串	该标签不可缺省。
description	标识应用的描述信息，标签值是字符串类型（最大255个字节）或对描述内容的字符串资源索引。	字符串	该标签可缺省，缺省值为空。
vendor	标识对应用开发厂商的描述。该标签的值是字符串类型（最大255个字节）。	字符串	该标签可以缺省，缺省为空。
versionCode	标识应用的版本号，该标签值为32位非负整数。此数字仅用于确定某个版本是否比另一个版本更新，数值越大表示版本越高。开发者可以将该值设置为任何正整数，但是必须确保应用的新版本都使用比旧版本更大的值。该标签不可缺省，versionCode值应小于2^31次方。	数值	该标签不可缺省。
versionName	标识应用版本号的文字描述，用于向用户展示。 该标签仅由数字和点构成，推荐采用“A.B.C.D”四段式的形式。四段式推荐的含义如下所示。 第一段：主版本号/Major，范围0-99，重大修改的版本，如实现新的大功能或重大变化。 第二段：次版本号/Minor，范围0-99，表示实现较突出的特点，如新功能添加或大问题修复。 第三段：特性版本号/Feature，范围0-99，标识规划的新版本特性。 第四段：修订版本号/Patch，范围0-999，表示维护版本，修复bug。 标签最大字节长度为127。	字符串	该标签不可缺省。
minCompatibleVersionCode	标识应用能够兼容的最低历史版本号，用于跨设备兼容性判断。 说明 当前版本暂不支持跨设备能力。	数值	该标签可缺省，缺省值等于versionCode标签值。
minAPIVersion	标识应用运行需要的SDK的API最小版本。	数值	由build-profile.json5中的compatibleSdkVersion生成。
targetAPIVersion	标识应用运行需要的API目标版本。	数值	由build-profile.json5中的compileSdkVersion生成。
apiReleaseType	标识应用运行需要的API目标版本的类型，采用字符串类型表示。取值为“CanaryN”、“BetaN”或者“Release”，其中，N代表大于零的整数。 - Canary：受限发布的版本。 - Beta：公开发布的Beta版本。 - Release：公开发布的正式版本。 该字段由DevEco Studio读取当前使用的SDK的Stage来生成。	字符串	该标签可缺省，由IDE生成并覆盖。
multiProjects	标识当前工程是否支持多个工程的联合开发。 - true：当前工程支持多个工程的联合开发。 - false：当前工程不支持多个工程的联合开发。多工程开发可以参考文档：多工程构建。	布尔值	可缺省，缺省值为false。
tablet	标识对tablet设备做的特殊配置，可以配置的属性字段有上文提到的：minAPIVersion、distributedNotificationEnabled。 如果使用该属性对tablet设备做了特殊配置，则应用在tablet设备中会采用此处配置的属性值，并忽略在app.json5公共区域配置的属性值。	对象	该标签可缺省，缺省时tablet设备使用app.json5公共区域配置的属性值。
tv	标识对tv设备做的特殊配置，可以配置的属性字段有上文提到的：minAPIVersion、distributedNotificationEnabled。 如果使用该属性对tv设备做了特殊配置，则应用在tv设备中会采用此处配置的属性值，并忽略在app.json5公共区域配置的属性值。	对象	该标签可缺省，缺省时tv设备使用app.json5公共区域配置的属性值。
wearable	标识对wearable设备做的特殊配置，可以配置的属性字段有上文提到的：minAPIVersion、distributedNotificationEnabled。 如果使用该属性对wearable设备做了特殊配置，则应用在wearable设备中会采用此处配置的属性值，并忽略在app.json5公共区域配置的属性值。	对象	该标签可缺省，缺省时wearable设备使用app.json5公共区域配置的属性值。
car	标识对car设备做的特殊配置，可以配置的属性字段有上文提到的：minAPIVersion、distributedNotificationEnabled。 如果使用该属性对car设备做了特殊配置，则应用在car设备中会采用此处配置的属性值，并忽略在app.json5公共区域配置的属性值。	对象	该标签可缺省，缺省时car设备使用app.json5公共区域配置的属性值。
phone	标识对phone设备做的特殊配置，可以配置的属性字段有上文提到的：minAPIVersion、distributedNotificationEnabled。 如果使用该属性对phone设备做了特殊配置，则应用在phone设备中会采用此处配置的属性值，并忽略在app.json5公共区域配置的属性值。	对象	该标签可缺省，缺省时phone设备使用app.json5公共区域配置的属性值。

module.json5配置文件

先通过一个示例，整体认识一下module.json5配置文件。

{

"module": {

"name": "entry",

"type": "entry",

"description": "$string:module_desc",

"mainElement": "EntryAbility",

"deviceTypes": [

"tv",

"tablet"

],

"deliveryWithInstall": true,

"installationFree": false,

"pages": "$profile:main_pages",

"virtualMachine": "ark",

"metadata": [

{

"name": "string",

"value": "string",

"resource": "$profile:distributionFilter_config"

}

],

"abilities": [

{

"name": "EntryAbility",

"srcEntry": "./ets/entryability/EntryAbility.ts",

"description": "$string:EntryAbility_desc",

"icon": "$media:icon",

"label": "$string:EntryAbility_label",

"startWindowIcon": "$media:icon",

"startWindowBackground": "$color:start_window_background",

"exported": true,

"skills": [

{

"entities": [

"entity.system.home"

],

"actions": [

"ohos.want.action.home"

]

}

]

}

],

"requestPermissions": [

{

"name": "ohos.abilitydemo.permission.PROVIDER",

"reason": "$string:reason",

"usedScene": {

"abilities": [

"FormAbility"

],

"when": "inuse"

}

}

]

}

}

module.json5配置文件包含以下标签。

表1 module.json5配置文件配置标签说明

属性名称	含义	数据类型	是否可缺省
name	标识当前Module的名称，标签值采用字符串表示（最大长度31个字节），该名称在整个应用要唯一，仅支持英文字符。	字符串	该标签不可缺省。
type	标识当前Module的类型。类型有两种，分别： - entry：应用的主模块。 - feature：应用的动态特性模块。	字符串	该标签不可缺省。
srcEntry	标识当前Module所对应的代码路径，标签值为字符串（最长为127字节）。