1# app.json5配置文件 2 3## 配置文件示例 4 5 6先通过一个示例，整体认识一下app.json5配置文件。 7 8```json 9{ 10 "app": { 11 "bundleName": "com.application.myapplication", 12 "vendor": "example", 13 "versionCode": 1000000, 14 "versionName": "1.0.0", 15 "icon": "$media:layered-image", 16 "label": "$string:app_name", 17 "description": "$string:description_application", 18 "minAPIVersion": 9, 19 "targetAPIVersion": 9, 20 "apiReleaseType": "Release", 21 "debug": false, 22 "car": { 23 "minAPIVersion": 8 24 }, 25 "targetBundleName": "com.application.test", 26 "targetPriority": 50, 27 "appEnvironments": [ 28 { 29 "name":"name1", 30 "value": "value1" 31 } 32 ], 33 "maxChildProcess": 5, 34 "multiAppMode": { 35 "multiAppModeType": "multiInstance", 36 "maxCount": 5 37 }, 38 "hwasanEnabled": false, 39 "ubsanEnabled": false, 40 "cloudFileSyncEnabled": false, 41 "configuration": "$profile:configuration" 42 }, 43} 44``` 45## 配置文件标签 46 47app.json5配置文件包含以下标签。 48 49 50 **表1** app.json5配置文件标签说明 51 52| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 53| -------- | -------- | -------- | -------- | 54| bundleName | 标识应用的Bundle名称，用于标识应用的唯一性。命名规则如下 ：<br/>- 必须为以点号（.）分隔的字符串，且至少包含三段，每段中仅允许使用英文字母、数字、下划线（_）。<br/>- 首段以英文字母开头，非首段以数字或英文字母开头，每一段以数字或者英文字母结尾。<br/>- 不允许多个点号（.）连续出现。<br/>- 字符串最小长度为7字节，最大长度128字节。<br/>- 推荐采用反域名形式命名（如“com.example.demo”，建议第一级为域名后缀com，第二级为厂商/个人名，第三级为应用名，也可以多级）。<br/>对于随系统源码编译的应用，建议命名为“com.ohos.demo”形式，其中的ohos标识系统应用。 | 字符串 | 该标签不可缺省。 | 55| bundleType| 标识应用的Bundle类型，用于区分应用或者原子化服务。支持的取值如下：<br/>- app：当前Bundle为应用。<br/>- atomicService：当前Bundle为原子化服务。<br/>- shared：当前Bundle为共享库应用，预留字段。<br/>- appService：当前Bundle为系统级共享库应用，仅供系统应用使用。 | 字符串| 该标签可缺省，缺省值为app。 | 56| debug | 标识应用是否可调试。<br/>- true：可调试，一般用于开发阶段。<br/>- false：不可调试，一般用于发布阶段。 | 布尔值 | 由DevEco Studio编译构建时生成。该标签可缺省，缺省值为false。 | 57| [icon](#icon标签) | 标识[应用的图标](../application-models/application-component-configuration-stage.md)，取值为图标资源文件的索引。 | 字符串 | 该标签不可缺省。 | 58| label | 标识[应用的名称](../application-models/application-component-configuration-stage.md)，取值为字符串资源的索引，字符串长度不超过63字节。 | 字符串 | 该标签不可缺省。 | 59| description | 标识应用的描述信息。取值为长度不超过255字节的字符串，内容为描述信息的字符串资源索引。 | 字符串 | 该标签可缺省，缺省值为空。 | 60| vendor | 标识对应用开发厂商的描述，取值为长度不超过255字节的字符串。 | 字符串 | 该标签可缺省，缺省值为空。 | 61| versionCode | 标识应用的版本号，取值为小于2^31次方的正整数。此数字仅用于确定某个版本是否比另一个版本更新，数值越大表示版本越高。<br/>开发者可以将该值设置为任何正整数，但是必须确保应用的新版本都使用比旧版本更大的值。 | 数值 | 该标签不可缺省。 | 62| versionName | 标识向用户展示的应用版本号。<br/>取值为长度不超过127字节的字符串，仅由数字和点构成，推荐采用“A.B.C.D”四段式的形式。四段式推荐的含义如下所示。<br/>第一段：主版本号/Major，范围0\~99，重大修改的版本，如实现新的大功能或重大变化。<br/>第二段：次版本号/Minor，范围0\~99，表示实现较突出的特点，如新功能添加或大问题修复。<br/>第三段：特性版本号/Feature，范围0\~99，标识规划的新版本特性。<br/>第四段：修订版本号/Patch，范围0\~999，表示维护版本，如修复bug。 | 字符串 | 该标签不可缺省。 | 63| minCompatibleVersionCode | 标识应用能够兼容的最低历史版本号，用于应用跨设备兼容性判断。取值范围为0~2147483647。 | 数值 | 该标签可缺省，缺省值等于versionCode标签值。 | 64| minAPIVersion | 标识应用运行需要的SDK的API最小版本。取值范围为0~2147483647。 | 数值 | 应用编译构建时由build-profile.json5中的compatibleSdkVersion自动生成。 | 65| targetAPIVersion | 标识应用运行需要的API目标版本。取值范围为0~2147483647。 | 数值 | 应用编译构建时由build-profile.json5中的compileSdkVersion自动生成。 | 66| apiReleaseType | 标识应用运行需要的API目标版本的类型，采用字符串类型表示。取值为“CanaryN”、“BetaN”或者“Release”，其中，N代表大于零的整数。<br/>- Canary：受限发布的版本。<br/>- Beta：公开发布的Beta版本。<br/>- Release：公开发布的正式版本。 | 字符串 | 应用编译构建时根据当前使用的SDK的Stage自动生成。即便手动配置了取值，编译构建时也会被覆盖。 | 67| accessible | 标识应用是否能访问应用的安装目录，仅针对Stage模型的系统应用和预置应用生效。 | 布尔值 | 该标签可缺省，缺省值为false。 | 68| multiProjects | 标识当前工程是否支持多个工程的联合开发。<br/>- true：当前工程支持多个工程的联合开发。多工程开发可参考[多工程构建](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V13/ide-hvigor-multi-projects-V13)。<br/>- false：当前工程不支持多个工程的联合开发。 | 布尔值 | 该标签可缺省，缺省值为false。 | 69| asanEnabled | 标识应用程序是否开启asan检测，用于辅助定位buffer越界造成的crash问题。<br/>- true：当前工程开启asan检测。<br/>- false：当前工程不开启asan检测。 | 布尔值 | 该标签可缺省，缺省值为false。 | 70| tablet | 标识对tablet设备做的特殊配置，可以配置的属性字段有上文提到的：minAPIVersion。<br/>如果使用该属性对tablet设备做了特殊配置，则应用在tablet设备中会采用此处配置的属性值，并忽略在app.json5公共区域配置的属性值。 | 对象 | 该标签可缺省，缺省时tablet设备使用app.json5公共区域配置的属性值。 | 71| tv | 标识对tv设备做的特殊配置，可以配置的属性字段有上文提到的：minAPIVersion。<br/>如果使用该属性对tv设备做了特殊配置，则应用在tv设备中会采用此处配置的属性值，并忽略在app.json5公共区域配置的属性值。 | 对象 | 该标签可缺省，缺省时tv设备使用app.json5公共区域配置的属性值。 | 72| wearable | 标识对wearable设备做的特殊配置，可以配置的属性字段有上文提到的：minAPIVersion。<br/>如果使用该属性对wearable设备做了特殊配置，则应用在wearable设备中会采用此处配置的属性值，并忽略在app.json5公共区域配置的属性值。 | 对象 | 该标签可缺省，缺省时wearable设备使用app.json5公共区域配置的属性值。 | 73| car | 标识对car设备做的特殊配置，可以配置的属性字段有上文提到的：minAPIVersion。<br/>如果使用该属性对car设备做了特殊配置，则应用在car设备中会采用此处配置的属性值，并忽略在app.json5公共区域配置的属性值。 | 对象 | 该标签可缺省，缺省时car设备使用app.json5公共区域配置的属性值。 | 74| default | 标识对default设备做的特殊配置，可以配置的属性字段有上文提到的：minAPIVersion。<br/>如果使用该属性对default设备做了特殊配置，则应用在default设备中会采用此处配置的属性值，并忽略在app.json5公共区域配置的属性值。 | 对象 | 该标签可缺省，缺省时default设备使用app.json5公共区域配置的属性值。 | 75|targetBundleName|标识当前包所指定的目标应用, 标签值的取值规则和范围与bundleName标签一致。配置该字段的应用为具有overlay特征的应用。|字符串|该标签可缺省，缺省值为空。| 76|targetPriority|标识当前应用的优先级，取值范围为1~100。配置targetBundleName字段之后，才支持配置该字段。|数值|该标签可缺省, 缺省值为1。| 77|generateBuildHash |标识当前应用的所有HAP和HSP是否由打包工具生成哈希值。<br/>该字段配置为true时，该应用下的所有HAP和HSP都会由打包工具生成对应的哈希值。系统OTA升级时，若应用的versionCode保持不变，可根据哈希值判断应用是否需要升级。<br/>**说明：** <br/>该字段仅对预置应用生效。|布尔值|该标签可缺省, 缺省值为false。| 78| GWPAsanEnabled | 标识应用程序是否开启GWP-asan堆内存检测工具，用于对内存越界、内存释放后使用等内存破坏问题进行分析。<br/>- true：当前工程开启GWP-asan检测。<br/>- false：当前工程不开启GWP-asan检测。 | 布尔值 | 该标签可缺省, 缺省值为false。 | 79| [appEnvironments](#appenvironments标签) | 标识当前模块配置的应用环境变量。 | 对象数组 | 该标签可缺省，缺省值为空。 | 80| maxChildProcess | 标识当前应用自身可创建的子进程的最大个数，取值范围为0到512，0表示不限制，当应用有多个模块时，以entry模块的配置为准。 | 数值 | 该标签可缺省，缺省时使用系统配置的默认值。 | 81| [multiAppMode](#multiappmode标签) | 标识当前应用配置的多开模式。仅bundleType为app的应用的entry或feature模块配置有效，存在多个模块时，以entry模块的配置为准。 | 对象 | 该标签可缺省，缺省值为空。 | 82| hwasanEnabled | 标识应用程序是否开启HWAsan检测。HWAsan(HardWare-assisted AddressSanitizer)是利用Top-Byte-Ignore特性实现的增强版Asan，与Asan相比HWAsan的内存开销更低，检测到的内存错误范围更大。<br/>- true：当前工程开启HWAsan检测。<br/>- false：当前工程不开启HWAsan检测。 | 布尔值 | 该标签可缺省，缺省值为false。 | 83| ubsanEnabled | 标识应用程序是否开启UBsan检测。<br/>UBsan(Undefined Behavior Sanitizer)是一个用于运行时检测程序中未定义行为的工具，旨在帮助开发人员发现代码中潜在的错误和漏洞。<br/>- true：当前工程开启UBsan检测。<br/>- false：当前工程不开启UBsan检测。 | 布尔值 | 该标签可缺省，缺省值为false。 | 84| cloudFileSyncEnabled | 标识当前应用是否启用端云文件同步能力。 <br/>- true：当前应用启用端云文件同步能力。<br/>- false：当前应用不启用端云文件同步能力。 | 布尔值 | 该标签可缺省，缺省值为false。 | 85| [configuration](#configuration标签) | 标识当前应用字体大小跟随系统配置的能力。<br/>该标签是一个profile文件资源，用于指定描述应用字体大小跟随系统变更的配置文件。| 字符串 | 该标签可缺省，缺省时configuration使用不跟随系统默认设定。 | 86 87## icon标签 88 89此标签标识[应用的图标](../application-models/application-component-configuration-stage.md)和对分层图标配置文件的索引。 90 91支持分层图标的配置，具体方式如下： 92 931. 将图标的前景资源和背景资源放在AppScope/resources/base/media目录下。 94 952. 在上述media目录下创建一个json文件（例如：layered-image.json），在文件中引用前景资源和背景资源，详见[图标资源规范](https://developer.huawei.com/consumer/cn/doc/design-guides/application-icon-0000001953444009#section634668113212)。 96 97分层图标资源文件示例： 98 99```json 100{ 101 "layered-image"： 102 { 103 "background":"$media:background", //背景资源 104 "foreground":"$media:foreground" //前景资源 105 } 106} 107``` 108 109icon标签示例： 110 111```json 112{ 113 "app":{ 114 "icon":"$media:layered-image" 115 } 116} 117``` 118 119## appEnvironments标签 120 121此标签标识应用配置的环境变量。应用运行时有时会依赖一些三方库，这些三方库会使用到一些自定义的环境变量，为了不修改三方库的实现逻辑，可以在工程的配置文件中设置自定义的环境变量，以供运行时期使用。 122 123**表2** appEnvironments标签说明 124 125| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 126| -------- | -------- | -------- | -------- | 127| name | 标识环境变量的变量名称。取值为长度不超过4096字节的字符串。 | 字符串 | 该标签可缺省，缺省值为空。 | 128| value | 标识环境变量的值。取值为长度不超过4096字节的字符串。 | 字符串 | 该标签可缺省，缺省值为空。 | 129 130appEnvironments标签示例： 131 132```json 133{ 134 "app": { 135 "appEnvironments": [ 136 { 137 "name":"name1", 138 "value": "value1" 139 } 140 ] 141 } 142} 143``` 144 145## multiAppMode标签 146 147应用多开模式。 148 149**表3** multiAppMode标签说明 150 151| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 152| -------- | -------- | -------- | -------- | 153| multiAppModeType | 标识应用多开模式类型，支持的取值如下：<br/>- multiInstance：多实例模式。该字段仅支持2in1设备，常驻进程不支持该字段。<br/>- appClone：应用分身模式。 | 字符串 | 该标签不可缺省。 | 154| maxCount | 标识最大允许的应用多开个数，支持的取值如下：<br/>- multiInstance模式：取值范围1\~10。<br/>- appClone模式：取值范围1\~5。 | 数值 | 该标签不可缺省。 | 155 156multiAppMode标签示例： 157 158```json 159{ 160 "app": { 161 "multiAppMode": { 162 "multiAppModeType": "appClone", 163 "maxCount": 5 164 } 165 } 166} 167``` 168 169## configuration标签 170 171该标签是一个profile文件资源，用于指定描述应用字体大小跟随系统变更的配置文件。 172 173configuration标签示例： 174 175```json 176{ 177 "app": { 178 "configuration": "$profile:configuration" 179 } 180} 181``` 182 183在开发视图的AppScope/resources/base/profile下面定义配置文件configuration.json，其中文件名"configuration"可自定义，需要和configuration标签指定的信息对应。配置文件中列举了当前应用字体大小跟随系统变化的属性。 184 185 **表4** configuration标签说明 186 187| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 188| -------- | -------- | -------- | -------- | 189| fontSizeScale | 应用字体大小是否跟随系统，支持的取值如下：<br/>- followSystem：跟随系统。<br/>- nonFollowSystem：不跟随系统。| 字符串 | 该标签可缺省，缺省值为nonFollowSystem。 | 190| fontSizeMaxScale | 应用字体大小选择跟随系统后，配置的最大比例，支持的取值：1、1.15、1.3、1.45、1.75、2、3.2。 <br/> fontSizeScale为nonFollowSystem时，该项不生效。 | 字符串 | 该标签可缺省，缺省值为3.2。 | 191 192configuration标签示例： 193 194```json 195{ 196 "configuration": { 197 "fontSizeScale": "followSystem", 198 "fontSizeMaxScale": "3.2" 199 } 200} 201``` 202