鸿蒙OS 配置文件(Stage 模型)
在HarmonyOS应用开发中,配置文件就像应用的“身份证”和“说明书”,它们向系统和应用市场提供应用的关键信息。 在基于Stage模型开发的应用项目代码下,都存在一个app.json5
及一个或多个module.json5
这两种配置文件。
一、app.json5:应用的全局配置文件
app.json5
文件位于项目的根目录下,用于描述整个应用的全局信息。
1.1 主要内容:
- 应用基本信息: 包名(
bundleName
)、开发者信息(vendor
)、版本号(versionCode
、versionName
)、应用图标(icon
)、应用名称(label
)、应用描述(description
)等。 - API版本信息: 最低支持的API版本(
minAPIVersion
)、目标API版本(targetAPIVersion
)、API发布类型(apiReleaseType
)等。 - 调试信息: 是否开启调试模式(
debug
)。 - 特定设备类型配置: 可以针对不同类型的设备(例如
car
)进行特定的配置。
1.2 示例:
{
"app": {
"bundleName": "com.example.myapp",
"vendor": "MyCompany",
"versionCode": 1,
"versionName": "1.0",
"icon": "$media:app_icon",
"label": "$string:app_name",
"description": "$string:app_description",
"minAPIVersion": 9,
"targetAPIVersion": 9,
"apiReleaseType": "Release",
"debug": false
}
}
二、module.json5:模块级配置文件
每个模块(Module)都有自己的 module.json5
文件,用于描述模块的具体信息。
2.1 主要内容:
- 模块基本信息: 模块名称(
name
)、模块类型(type
)、模块描述(description
)、支持的设备类型(deviceTypes
)等。 - 应用组件信息: 描述模块中包含的UIAbility和ExtensionAbility组件信息。
- 权限信息: 声明应用运行所需的权限。
- 页面信息: 声明模块中包含的页面路由信息(
pages
)。 - 虚拟机信息: 指定模块运行的虚拟机类型(
virtualMachine
)。 - 其他信息: 例如是否随应用安装(
deliveryWithInstall
)、是否免费安装(installationFree
)等。
2.2 示例:
{
"module": {
"name": "entry",
"type": "entry",
"description": "Entry module",
"deviceTypes": ["phone", "tablet"],
"abilities": [
{
"name": "com.example.myapp.MainAbility",
"icon": "$media:icon",
"label": "$string:app_name",
"skills": []
}
],
"requestPermissions": [
{
"name": "ohos.permission.READ_CONTACTS"
}
]
}
}
三、总结
app.json5
和 module.json5
是HarmonyOS应用开发中不可或缺的配置文件。 理解它们的作用和内容,对于开发者正确配置应用、发布应用至关重要。