app.json5配置文件


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",
    "distributedNotificationEnabled": true,
    "minAPIVersion": 9,
    "targetAPIVersion": 9,
    "apiReleaseType": "Release",
    "debug": false,
    "entityType": "media",
    "car": {
      "minAPIVersion": 8,
    }
  },
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

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

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

属性名称 含义 数据类型 是否可缺省
bundleName 标识应用的Bundle名称,用于标识应用的唯一性。该标签不可缺省。标签的值命名规则 :
- 字符串以字母、数字、下划线和符号“.”组成。
- 以字母开头。
- 最小长度7个字节,最大长度127个字节。
推荐采用反域名形式命名(如com.example.demo,建议第一级为域名后缀com,第二级为厂商/个人名,第三级为应用名,也可以多级)。
其中,随系统源码编译的应用建议命名为“com.ohos.demo”形式, ohos标识OpenHarmony系统应用。
字符串 该标签不可缺省。
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最小版本。 数值 由bundle-profile.json5中的compatibleSdkVersion生成。
targetAPIVersion 标识应用运行需要的API目标版本。 数值 由bundle-profile.json5中的compileSdkVersion生成。
apiReleaseType 标识应用运行需要的API目标版本的类型,采用字符串类型表示。取值为“CanaryN”、“BetaN”或者“Release”,其中,N代表大于零的整数。
- Canary:受限发布的版本。
- Beta:公开发布的Beta版本。
- Release:公开发布的正式版本。
该字段由DevEco Studio读取当前使用的SDK的Stage来生成。
字符串 该标签可缺省,由IDE生成并覆盖。
distributedNotificationEnabled 标识应用是否开启分布式通知,当开启分布式通知时,同一分布式组网下的两个设备(A和B),当设备A收到一条消息时,设备B会收到一天分布式消息用于设备B的使用者去查看设备A的消息。
- true:开启。
- false:不开启。
布尔值 该标签可缺省,缺省值为false。
entityType 标识应用的类别,分别有:
- game:游戏类。
- media:影音类。
- communication:社交通信类。
- news:新闻类。
- travel:出行类。
- utility:工具类。
- shopping:购物类。
- education:教育类。
- kids:少儿类。
- business:商务类。
- photography:拍摄类。
- unspecified:不属于上述的任何一类。
字符串 该标签可以缺省,缺省为unspecified。
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公共区域配置的属性值。
default 标识对default设备做的特殊配置,可以配置的属性字段有上文提到的:minAPIVersion、distributedNotificationEnabled。
如果使用该属性对default设备做了特殊配置,则应用在default设备中会采用此处配置的属性值,并忽略在app.json5公共区域配置的属性值。
对象 该标签可缺省,缺省时default设备使用app.json5公共区域配置的属性值。