HarmonyOS鸿蒙app.json5配置文件

本文详细解读了鸿蒙系统app.json5配置文件的各个标签,包括bundleName、versionCode、API兼容性等,对开发者构建和优化应用提供指导,同时还分享了最新的鸿蒙学习资源链接。
摘要由CSDN通过智能技术生成

先通过一个示例,整体认识一下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,
    },
    "targetBundleName": "com.application.test",
    "targetPriority": 50
  },
}

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

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

属性名称含义数据类型是否可缺省
bundleName标识应用的Bundle名称,用于标识应用的唯一性。该标签不可缺省。标签的值命名规则 :
- 字符串以字母、数字、下划线和符号“.”组成。
- 以字母开头。
- 最小长度7个字节,最大长度128个字节。
推荐采用反域名形式命名(如com.example.demo,建议第一级为域名后缀com,第二级为厂商/个人名,第三级为应用名,也可以多级)。
其中,随系统源码编译的应用建议命名为“com.ohos.demo”形式, ohos标识OpenHarmony系统应用。
字符串该标签不可缺省。
bundleType标识应用的Bundle类型,用于区分应用或者原子化服务。该标签可选值为app和atomicService :
- app:当前Bundle为普通应用。
- atomicService:当前Bundle为原子化服务。
- shared:当前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。
asanEnabled标识应用程序是否开启asan检测,用于辅助定位buffer越界造成的crash问题。
- true:当前工程开启asan检测。
- false:当前工程不开启asan检测。Release版本不支持开启asan检测。
布尔值可缺省,缺省值为false。
tablet标识对tablet设备做的特殊配置,可以配置的属性字段有上文提到的:minAPIVersion。
如果使用该属性对tablet设备做了特殊配置,则应用在tablet设备中会采用此处配置的属性值,并忽略在app.json5公共区域配置的属性值。
对象该标签可缺省,缺省时tablet设备使用app.json5公共区域配置的属性值。
tv标识对tv设备做的特殊配置,可以配置的属性字段有上文提到的:minAPIVersion。
如果使用该属性对tv设备做了特殊配置,则应用在tv设备中会采用此处配置的属性值,并忽略在app.json5公共区域配置的属性值。
对象该标签可缺省,缺省时tv设备使用app.json5公共区域配置的属性值。
wearable标识对wearable设备做的特殊配置,可以配置的属性字段有上文提到的:minAPIVersion。
如果使用该属性对wearable设备做了特殊配置,则应用在wearable设备中会采用此处配置的属性值,并忽略在app.json5公共区域配置的属性值。
对象该标签可缺省,缺省时wearable设备使用app.json5公共区域配置的属性值。
car标识对car设备做的特殊配置,可以配置的属性字段有上文提到的:minAPIVersion。
如果使用该属性对car设备做了特殊配置,则应用在car设备中会采用此处配置的属性值,并忽略在app.json5公共区域配置的属性值。
对象该标签可缺省,缺省时car设备使用app.json5公共区域配置的属性值。
default标识对default设备做的特殊配置,可以配置的属性字段有上文提到的:minAPIVersion。
如果使用该属性对default设备做了特殊配置,则应用在default设备中会采用此处配置的属性值,并忽略在app.json5公共区域配置的属性值。
对象该标签可缺省,缺省时default设备使用app.json5公共区域配置的属性值。
targetBundleName标识当前包所指定的目标应用, 标签值的取值规则和范围与bundleName标签一致。字符串该标签可缺省,缺省时当前包为非overlay特性的应用。
targetPriority标识当前应用的优先级, 当targetBundleName字段配置之后,当前应用为overlay特征的应用, 该标签的额取值范围为1~100数值该标签可缺省, 缺省值为1。
generateBuildHash标识当前应用的所有HAP/HSP是否由打包工具生成哈希值。如果存在,则在系统OTA升级但应用的versionCode保持不变时,可根据哈希值判断应用是否需要升级。
该字段若为true,该应用下的所有hap和hsp都会由打包工具生成其哈希值。
注:该字段仅对预置应用生效。
布尔值该标签可缺省, 缺省值为false。
GWPAsanEnabled标识应用程序是否开启GWP-asan堆内存检测工具,用于对内存越界、内存释放后使用等内存破坏问题进行分析。
- true:当前工程开启GWP-asan检测。
- false:当前工程不开启GWP-asan检测。
布尔值该标签可缺省, 缺省值为false。

最后,为了能够让大家跟上互联网时代的技术迭代,赶上互联网开发人员寒冬期间一波红利,在这里跟大家分享一下我自己近期学习心得以及参考网上资料整理出的一份最新版的鸿蒙学习提升资料,有需要的小伙伴自行领取,限时开源,先到先得~

 🚀写在最后

  • 如果你觉得这篇内容对你还蛮有帮助,我想邀请你帮我三个小忙:
  • 点赞,转发,有你们的 『点赞和评论』,才是我创造的动力。
  • 关注小编,同时可以期待后续文章ing🚀,不定期分享原创知识。
  • 想要获取更多完整鸿蒙最新VIP学习资料,请点击→纯血版全套鸿蒙HarmonyOS学习资料

  • 16
    点赞
  • 17
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值