1# 打包拆包工具使用说明 2 3## 简介 4 5packing_tool子系统用于生成打包工具和拆包工具，其中打包工具用于hap，app，hqf，appqf，har，hsp包的生成，拆包工具用于对hap，app，hqf，appqf，har，hsp包的拆包及对hap，hsp，app，appqf的解析。具体的功能介绍如下： 6 7打包工具子系统架构图如下： 8 9 10 11## 1. 打包指令说明 12 13### 1.1 hap包模式打包指令 14 15#### 1.1.1 示例 16 17- Stage模型的打包命令示例： 18 19 20``` 21java -jar app_packing_tool.jar --mode hap --json-path <option> --resources-path <option> --ets-path <option> --index-path <option> --pack-info-path <option> --out-path path\out\srcEntrance.hap --force true --compress-level 5 --pkg-context-path <option> 22``` 23 24- FA模型的打包命令示例： 25 26 27``` 28java -jar app_packing_tool.jar --mode hap --json-path <option> --maple-so-path [option] --profile-path [option] --maple-so-dir [option] --dex-path [option] --lib-path [option] --resources-path [option] --index-path [option] --out-path <option> --force [option] --compress-level 5 29``` 30 31#### 1.1.2 参数含义及规范 32 33| 指令 | 是否必选项 | 选项 | 描述 | 备注 | 34|------------------|-------|----------------------|-----------------------------------------------------------|------------| 35| --mode | 是 | hap | 打包类型。 | NA | 36| --json-path | 是 | NA | .json文件路径，FA模型文件名必须为config.json；stage模型文件名必须为module.json。 | NA | 37| --profile-path | 否 | NA | CAPABILITY.profile文件路径。 | NA | 38| --maple-so-path | 否 | NA | maple so文件输入路径，so文件路径，文件名必须以.so为后缀。如果是多个so需要用“，”分隔。 | NA | 39| --maple-so-dir | 否 | NA | maple so目录输入路径。 | NA | 40| --dex-path | 否 | NA | 1.dex文件路径，文件名必须以.dex为后缀。如果是多个dex需要用“，”分隔。2.dex文件路径也可以为目录。 | NA | 41| --lib-path | 否 | NA | lib库文件路径。 | NA | 42| --resources-path | 否 | NA | resources资源包路径。 | NA | 43| --index-path | 否 | NA | .index文件路径，文件名必须为resources.index。 | NA | 44| --pack-info-path | 否 | NA | pack.info文件路径，文件名必须为pack.info。 | NA | 45| --rpcid-path | 否 | NA | rpcid.sc文件路径，文件名必须为rpcid.sc。 | NA | 46| --js-path | 否 | NA | 存放js文件目录路径。 | 仅stage模型生效 | 47| --ets-path | 否 | NA | 存放ets文件目录路径。 | 仅stage模型生效 | 48| --out-path | 是 | NA | 目标文件路径，文件名必须以.hap为后缀。 | NA | 49| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | NA | 50| --an-path | 否 | NA | 存放an文件的路径。 | 仅stage模型生效 | 51| --ap-path | 否 | NA | 存放ap文件的路径。 | 仅stage模型生效 | 52| --dir-list | 否 | NA | 可指定目标文件夹列表，将其打入hap包内。 | NA | 53| --compress-level | 否 | number | 压缩等级，默认值1，可选等级1-9。在应用配置compressNativeLibs参数为true的情况下生效，数值越大压缩率越高、压缩速度越慢。 | NA | 54| --pkg-context-path | 否 | NA | 可指定语境信息表文件路径，文件名必须为pkgContextInfo.json。 | 仅stage模型生效 | 55 56### 1.2 har包模式打包指令 57 58#### 1.2.1 示例 59 60``` 61java -jar app_packing_tool.jar --mode har --json-path [option] --jar-path [option] --lib-path [option] --resources-path [option] --out-path [option] --force [option] 62``` 63 64#### 1.2.2 参数含义及规范 65 66| 指令 | 是否必选项 | 选项 | 描述 | 67|-----------------|-------|-------------|-----------------------------------------------------------| 68| --mode | 是 | har | 打包类型。 | 69| --json-path | 是 | NA | .json文件路径，FA模型文件名必须为config.json；stage模型文件名必须为module.json。 | 70| --jar-path | 否 | NA | 1.jar文件路径，文件名必须以.jar为后缀。如果是多个jar需要用“，”分隔。2.jar文件路径也可以为目录。 | 71| --lib-path | 否 | NA | lib库文件路径。 | 72| --resource-path | 是 | NA | resources资源包路径。 | 73| --out-path | 是 | NA | 目标文件路径，文件名必须以.har为后缀。 | 74| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 75 76### 1.3 app包模式打包指令 77 78#### 1.3.1 示例 79 80``` 81java -jar app_packing_tool.jar --mode app --hap-path <option> --hsp-path <option> --out-path [option] --signature-path [option] --certificate-path [option] --pack-info-path [option] --force [option] 82``` 83 84#### 1.3.2 参数含义及规范 85 86| 指令 | 是否必选项 | 选项 | 描述 | 87|--------------------|-------|-------------|--------------------------------------------------------------| 88| --mode | 是 | app | 多个hap需满足hap的合法性校验。 | 89| --hap-path | 是 | NA | 1.hap包文件路径，文件名必须以.hap为后缀。如果时多个hap包需要用“，”分隔。2.hap包文件路径也可以是目录。 | 90 | --hsp-path | 否 | NA | 1.hsp包文件路径，文件名必须以.hsp为后缀。如果时多个hsp包需要用“，”分隔。2.hsp包文件路径也可以是目录。 | 91| --pack-info-path | 是 | NA | 文件名必须为pack.info。 | 92| --out-path | 否 | NA | 目标文件路径，文件名必须以.app为后缀。 | 93| --signature-path | 否 | NA | 签名路径。 | 94| --certificate-path | 否 | NA | 证书路径。 | 95| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 96 97#### 1.3.3 打包app时hap的合法性校验 98 99在对工程内的hap包打包生成app包时，需要保证被打包的每个hap在json文件中配置的bundleName，versionCode，minCompatibleVersionCode相同，minAPIVersion，targetAPIVersion，apiReleaseType相同，moduleName唯一，对于fa模型，还需要保证json文件中配置的package唯一。 100 101### 1.4 多工程打包 102 103#### 1.4.1 示例 104 105``` 106java -jar app_packing_tool.jar --mode multiApp --hap-list 1.hap,2.hap --app-list 1.app,2.app --out-path final.app 107``` 108 109#### 1.4.2 参数含义及规范 110 111| 指令 | 是否必选项 | 选项 | 描述 | 112|------------|-------|-----------|---------------------------------------------------------------------------------------------------| 113| --mode | 是 | multiApp | 打包类型，在将多个hap打入同一个app时，需保证每个hap满足合法性校验规则。 | 114| --hap-list | 否 | hap的路径 | 1.hap包文件路径，文件名必须以.hap为后缀。如果是多个hap包需要”，“分隔。2.hap文件路径也可以是目录。 | 115| --hsp-list | 否 | hsp的路径 | 1.hsp包文件路径，文件名必须以.hsp为后缀。如果是多个hsp包需要”，“分隔。2.hsp文件路径也可以是目录。 | 116| --app-list | 否 | app的路径 | 1.app文件路径，文件名必须以.app为后缀。如果是多个app包需要用”，“分隔。2.app文件路径也可以是目录。3.--hap-list，--hsp-list，--app-list不可以都不传。 | 117| --out-path | 是 | NA | 目标文件路径，文件名必须以.app为后缀。 | 118| --force | 否 | 默认值为false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 119 120#### 1.4.3 多工程打包hap合法性校验 121 122需要保证被打包的每个hap在json文件中配置的bundleName，versionCode，minCompatibleVersionCode相同，minAPIVersion，targetAPIVersion，apiReleaseType相同，moduleName唯一，同一设备entry唯一，对于fa模型，还需要保证json文件中配置的package唯一。 123 124### 1.5 hqf模式打包指令 125 126#### 1.5.1 示例 127 128``` 129java -jar app_packing_tool.jar --mode hqf --json-path <option> --lib-path <option> --ets-path <option> --resources-path <option> --out-path <option> 130``` 131 132#### 1.5.2 参数含义及规范 133 134| 指令 | 是否必选项 | 选项 | 描述 | 135|-------------|-------|-------------|------------------------------------| 136| --mode | 是 | hqf | 打包类型。 | 137| --json-path | 是 | NA | .json文件路径，文件名必须为patch.json。 | 138| --lib-path | 否 | NA | lib库文件的路径。 | 139| --ets-path | 否 | NA | 存放ets文件目录路径。 | 140| --resources-path | 否 | NA | resources资源包路径。 | 141| --out-path | 是 | NA | 目标文件路径，文件名必须以.hqf为后缀。 | 142| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 143 144### 1.6 appqf模式打包指令 145 146#### 1.6.1 示例 147 148``` 149java -jar app_packing_tool.jar --mode appqf --hqf-list <option> --out-path <option> 150``` 151 152#### 1.6.2 参数含义及规范 153 154| 指令 | 是否必选项 | 选项 | 描述 | 155|------------|-------|-------------|------------------------------------| 156| --mode | 是 | appqf | 打包类型。 | 157| --hqf-list | 是 | NA | hqf文件路径，多个hqf以英文逗号隔开。 | 158| --out-path | 是 | NA | 目标文件路径，文件名必须以.appqf为后缀。 | 159| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 160 161 162### 1.7 hsp模式打包指令 163 164#### 1.7.1 示例 165``` 166java -jar path\app_packing_tool.jar --mode hsp --json-path <option> --resources-path <option> --ets-path <option> --index-path <option> --pack-info-path <option> --out-path path\out\library.hsp --force true --compress-level 5 --pkg-context-path <option> 167``` 168 169#### 1.7.2 参数含义及规范 170 171| 指令 | 是否必选项 | 选项 | 描述 | 172|------------------|-------|----------------------|-----------------------------------------------------------| 173| --mode | 是 | hsp | 打包类型。 | 174| --json-path | 是 | NA | .json文件路径，文件名必须为module.json。 | 175| --profile-path | 否 | NA | CAPABILITY.profile文件路径。 | 176| --dex-path | 否 | NA | 1.dex文件路径，文件名必须以.dex为后缀。如果是多个dex需要用“，”分隔。2.dex文件路径也可以为目录。 | 177| --lib-path | 否 | NA | lib库文件路径。 | 178| --resources-path | 否 | NA | resources资源包路径。 | 179| --index-path | 否 | NA | .index文件路径，文件名必须为resources.index。 | 180| --pack-info-path | 否 | NA | pack.info文件路径，文件名必须为pack.info。 | 181| --js-path | 否 | NA | 存放js文件目录路径。 | 182| --ets-path | 否 | NA | 存放ets文件目录路径。 | 183| --out-path | 是 | NA | 目标文件路径，文件名必须以.hsp为后缀。 | 184| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 185| --an-path | 否 | NA | 存放an文件的路径。 | 186| --ap-path | 否 | NA | 存放ap文件的路径。 | 187| --dir-list | 否 | NA | 可指定目标文件夹列表，将其打入hap包内 | 188| --compress-level | 否 | number | 压缩等级，默认值1，可选等级1-9。在应用配置compressNativeLibs参数为true的情况下生效，数值越大压缩率越高、压缩速度越慢。 | 189| --pkg-context-path | 否 | NA | 可指定语境信息表文件路径，文件名必须为pkgContextInfo.json。 | 190 191### 1.8 versionNormalize模式指令 192 193如果一个应用由多个团队开发，当只有一个hap或hsp需要修改升级时，可以调用此命令，将多个hap、hsp的版本统一。本命令会修改所传入的hap、hsp的版本号和版本名称，并在指定目录生成修改后的同名hap、hsp，以及一个version_record.json文件，用于记录所有hap、hsp原有的版本号、版本名称。 194 195#### 1.8.1 示例 196``` 197java -jar path\app_packing_tool.jar --mode versionNormalize --input-list 1.hap,2.hsp --version-code 1000001 --version-name 1.0.1 --out-path path\out\ 198``` 199 200#### 1.8.2 参数含义及规范 201 202| 指令 | 是否必选项 | 选项 | 描述 | 203|----------------|-------|------------------|-------------------------------------------------------------------| 204| --mode | 是 | versionNormalize | 命令类型。 | 205| --input-list | 是 | hap或hsp的路径 | 1.hap或hsp包文件路径，文件名必须以.hap或.hsp为后缀。如果是多个hap包需要”，“分隔。2.hap包或hsp包目录。 | 206| --version-code | 是 | 版本号 | 指定的版本号，hap、hsp的版本号会被修改为该版本。需要为整数，且不小于所有传入的hap、hsp的版本号。 | 207| --version-name | 是 | 版本名称 | 指定的版本名称，hap、hsp的版本名称会被修改为该版本名称。 | 208| --out-path | 是 | NA | 目标文件路径，需要为一个目录。 | 209 210### 1.9 packageNormalize模式指令 211 212内部多个应用共享一个基建HSP时，为了便于集成，HSP的包名会被设置为空。可以调用此命令，将集成态HSP的包名和版本号设置成应用侧的包名和版本号，并在指定目录生成修改后的同名HSP。 213 214#### 1.9.1 示例 215``` 216java -jar path\app_packing_tool.jar --mode packageNormalize --hsp-list path\1.hsp,path\2.hsp --bundle-name com.example.myapplication --version-code 1000001 --out-path path\out\ 217``` 218 219#### 1.9.2 参数含义及规范 220 221| 指令 | 是否必选项 | 选项 | 描述 | 222|----------------|-------|------------------|-----------------------------------------------------| 223| --mode | 是 | packageNormalize | 命令类型。 | 224| --hsp-list | 是 | HSP的路径 | 1.HSP包文件路径，文件名必须以.hsp为后缀。如果是多个HSP包需要”，“分隔。2.HSP包目录。 | 225| --bundle-name | 是 | 包名 | 指定的包名，HSP的包名会被修改为指定的包名。 | 226| --version-code | 是 | 版本号 | 指定的版本号，HSP的版本号会被修改为该版本号。需要为整数，且大于0。 | 227| --out-path | 是 | NA | 目标文件路径，需要为一个目录。 | 228 229 230## 2. 拆包指令说明 231 232### 2.1 hap包模式拆包指令 233 234#### 2.1.1 示例 235 236``` 237java -jar app_unpacking_tool.jar --mode <option> --hap-path <options> --out-path [option] --force [option] 238``` 239 240#### 2.1.2 参数含义及规范 241 242| 指令 | 是否必选项 | 选项 | 描述 | 243| ---------- | ---------- | ------------- | ------------------------------------------------------------ | 244| --mode | 是 | hap | 拆包类型。 | 245| --hap-path | 是 | NA | hap包路径。 | 246| --rpcid | 否 | true或者false | 是否单独将rpcid文件从hap包中提取到指定目录，如果为true，将仅提取rpcid文件，不对hap包进行拆包。 | 247| --out-path | 是 | NA | 拆包目标文件路径。 | 248| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 249 250### 2.2 har包模式拆包指令 251 252#### 2.2.1 示例 253 254``` 255java -jar app_unpacking_tool.jar --mode <options> --har-path <option> --out-path [option] --force [option] 256``` 257 258#### 2.2.2 参数含义及规范 259 260| 指令 | 是否必选项 | 选项 | 描述 | 261| ---------- | ---------- |-------------| ----------------------------------------------------------- | 262| --mode | 是 | har | 拆包类型。 | 263| --har-path | 是 | NA | har包路径。 | 264| --out-path | 是 | NA | 拆包目标文件路径。 | 265| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 266 267### 2.3 app包模式拆包指令 268 269#### 2.3.1 示例 270 271``` 272java -jar app_unpacking_tool.jar --mode <options> --app-path <option> --out-path [option] --force [option] 273``` 274 275#### 2.3.2 参数含义及规范 276 277| 指令 | 是否必选项 | 选项 | 描述 | 278| ---------- | ---------- |-------------| ----------------------------------------------------------- | 279| --mode | 是 | app | 拆包类型。 | 280| --app-path | 是 | NA | app包路径。 | 281| --out-path | 是 | NA | 拆包目标文件路径。 | 282| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 283 284### 2.4 从hap包中获取rpcid文件 285 286#### 2.4.1 示例 287 288``` 289java -jar app_unpacking_tool.jar --mode hap --rpcid true --hap-path <option> --out-path <option> --force true 290``` 291 292#### 2.4.2 参数含义及规范 293 294| 指令 | 是否必选项 | 选项 | 描述 | 295| ---------- | ---------- | ------------- | ------------------------------------------------------------ | 296| --mode | 是 | hap | 拆包类型 | 297| --rpcid | 否 | true或者false | 是否单独将rpcid文件从hap包中提取到指定目录，如果为true，将仅提取rpcid文件，不对hap包进行拆包。 | 298| --hap-path | 是 | NA | hap包路径 | 299| --out-path | 是 | NA | 拆包rpcid目标文件路径 | 300| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 301 302### 2.5 hsp包模式拆包指令 303 304#### 2.5.1 示例 305 306``` 307java -jar app_unpacking_tool.jar --mode <option> --hsp-path <options> --out-path [option] --force [option] 308``` 309 310#### 2.5.2 参数含义及规范 311 312| 指令 | 是否必选项 | 选项 | 描述 | 313|------------| ---------- |-------------|------------------------------------| 314| --mode | 是 | hsp | 拆包类型。 | 315| --hsp-path | 是 | NA | hsp包路径。 | 316| --out-path | 是 | NA | 拆包目标文件路径。 | 317| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 318 319### 2.6 appqf模式拆包指令 320 321#### 2.6.1 示例 322 323``` 324java -jar app_unpacking_tool.jar --mode <option> --appqf-path <options> --out-path [option] --force [option] 325``` 326 327#### 2.6.2 参数含义及规范 328 329| 指令 | 是否必选项 | 选项 | 描述 | 330|--------------| ---------- |-------------|------------------------------------| 331| --mode | 是 | appqf | 拆包类型。 | 332| --appqf-path | 是 | NA | appqf包路径。 | 333| --out-path | 是 | NA | 拆包目标文件路径。 | 334| --force | 否 | true或者false | 默认值为false，如果为true，表示当目标文件存在时，强制删除。 | 335 336## 3. 包解析接口 337 338### 3.1 接口目录 339 340| 类名 | 接口原型 | 类型 | 接口详细描述 | 341| ------------------ | ------------------------------------------------------------ | -------- |-------------------------------------------------------------------| 342| UncompressEntrance | UncomperssResult parseApp(String appPath,String parseMode,String deviceType,String hapName) | Java接口 | 接口功能：根据参数解析app包的pack.info信息 输入参数：app包路径，解析参数 返回值：UncomperssResult | 343| UncompressEntrance | UncomperssResult parseApp(InputStream input,String parseMode,String deviceType,String hapName,String outPath) | Java接口 | 接口功能：根据参数解析app包的pack.info信息 输入参数：app文件流，解析参数 返回值：UncomperssResult | 344| UncompressEntrance | UncomperssResult parseHap(String hapPath) | Java接口 | 接口功能：根据参数解析app包的json配置文件 输入参数：hap包路径，解析参数 返回值：UncomperssResult | 345| UncompressEntrance | UncomperssResult parseHap(InputStream input) | Java接口 | 接口功能：根据参数解析app包的json配置文件 输入参数：hap包文件流，解析参数 返回值：UncomperssResult | 346 347## 4. 拆包工具信息字段 348 349### 4.1 UncomperssResult（Bundle信息）结构体信息 350 351| 字段 | 类型 | 描述 | 备注 | 352| ----------------| ------------------ |----------------------------------------| ---- | 353| result | boolean | 标识此次解析是否成功 | NA | 354| message | String | 解析失败时返回失败原因 | NA | 355| packInfos | List\<PackInfo> | bundle中pack.info文件的packages信息 | NA | 356| profileInfos | List\<profileInfo> | 应用的配置信息 | NA | 357| profileInfosStr | List\<String> | 应用的配置信息 | NA | 358| icon | String | 返回入口组件的icon路径，如果没有入口组件，则返回第一个组件的icon信息 | NA | 359| label | String | 返回入口组件的label，如果没有入口组件，则返回第一个组件的label信息 | NA | 360 361### 4.2 PackInfo结构体信息 362 363| 字段 | 类型 | 描述 | 备注 | 364| ------------------- | ------------- | --------------------------------------- | ---- | 365| name | String | 包名 | NA | 366| moduleName | String | Hap名称 | NA | 367| moduleType | String | module的类型 | NA | 368| deviceType | List\<String> | 表示当前hap包所支持的设备类型 | NA | 369| deliveryWithInstall | boolean | 标识当前hap是否在用户主动安装的时候安装 | NA | 370 371### 4.3 ProfileInfo结构体信息 372 373| 字段 | 类型 | 描述 | 备注 | 374| ------------ | ------------------------------ | ------------------------------------------ | ------------------------------------------------------------ | 375| hapName | String | 标识当前解析的hap包名称 | NA | 376| appInfo | AppInfo结构体（见下述AppInfo） | 标识APP信息的结构体（见下述AppInfo信息） | NA | 377| deviceConfig | Map\<String,DeviceConfig> | 标识设备信息 | 存储类型为Map\<String,String>，存储设备类型名称及对应设备类型的信息，在stage模型中，这个字段存储在app结构体中 | 378| hapInfo | HapInfo结构体（见下述HapInfo） | 标识hap包中module信息（见下述HapInfo信息） | NA | 379 380### 4.4 AppInfo结构体信息 381 382| 字段 | 类型 | 描述 | 备注 | 383|--------------------------------|---------|-----------------------------------------------------------------------------|-------------| 384| bundleName | String | 标识app的包名称 | NA | 385| vendor | String | 标识app的供应商信息 | NA | 386| relatedBundleName | String | 标识app相关bundle的包名 | NA | 387| versionName | String | 标识app中的versionName信息 | NA | 388| versionCode | String | 标识app中的versionCode信息 | NA | 389| targetApiVersion | int | 标识应用运行需要的API目标版本 | NA | 390| compatibleApiVersion | int | 标识应用兼容的API版本 | NA | 391| appName | String | 标识显示在桌面上的ability的label | NA | 392| appNameEN | String | 标识显示在桌面上的ability的label | NA | 393| releaseType | String | 标识应用运行需要的API目标版本的类型 | NA | 394| shellVersionCode | String | 标识HarmonyOS中的API版本 | NA | 395| shellVersionName | String | 标识HarmonyOS中的API版本名称 | NA | 396| multiFrameworkBundle | String | 标识bundleName | NA | 397| debug | boolean | 标识应用是否可调试 | NA | 398| icon | String | 标识应用的图标路径 | NA | 399| label | String | 标识应用的label | NA | 400| description | String | 标识应用的描述信息 | stage模型新增 | 401| minCompatibleVersionCode | int | 标识应用能够兼容的最低版本号 | NA | 402| distributedNotificationEnabled | boolean | 标记该应用是否开启分布式通知 | stage模型新增 | 403| bundleType | String | 标识bundle的类型，取值：<br/>- app：普通应用<br/>- atomicService：元服务 <br/>- shared：应用间共享库 | NA | 404| compileSdkVersion | String | 标识编译该应用时使用的sdk版本 | stage模型新增 | 405| compileSdkType | String | 标识编译该应用时使用的sdk类别 | stage模型新增 | 406| labels | HashMap\<String, String> | 标识多语言应用程序AppJson的标签。 | NA | 407| descriptions | HashMap\<String, String> | 标识多语言应用程序AppJson的说明。 | NA | 408| compileSdkVersion | String | 标识编译该应用时使用的sdk版本 | NA | 409| compileSdkType | String | 标识编译该应用时使用的sdk类别 | NA | 410 411### 4.5 HapInfo结构体信息 412 413| 字段 | 类型 | 描述 | 备注 | 414| ---------------------|-----------------------------------------------|------------------------------------| ---------------------------------------| 415| appModel | AppModel枚举值 | 标识应用的框架模型<br/>- FA：FA模型<br/>- STAGE：Stage模型 | NA | 416| packageStr | String | 标识应用的包信息 | FA模型特有 | 417| name | String | 标识当前module的名字 | NA | 418| description | String | 标识hap包的描述信息 | FA模型特有 | 419| supportedModes | List\<String> | 标识hap包的支持的模式 | NA | 420| abilities | List\<AbilityInfo> | 标识hap包ability信息 | NA | 421| defPermissions | List\<DefPermission> | 标识hap包DefPermission信息 | NA | 422| definePermissions | List\<DefinePermission> | 标识hap包DefinePermission信息 | NA | 423| defPermissionsGroups | List\<DefPermissionsGroups> | 标识hap包DefPermissionsGroups 信息 | NA | 424| distro | Distro结构体 | 标识hap包的distro信息 | NA | 425| reqCapabilities | List\<String> | 标识hap包reqCapabilities信息 | NA | 426| deviceType | List\<String> | 标识hap可以运行在哪类设备上 | 对应stage模型中的deviceTypes | 427| metaData | MetaData结构体（见下述metaData） | 标识hap的自定义元信息 | NA | 428| dependencies | List\<DependencyItem> | 标识hap包DependencyItem信息 | NA | 429| isJs | boolean | 标识该应用是否是js应用 | FA模型特有 | 430| reqPermissions | list\<ReqPermission> | 标识应用申请的权限的集合 | 对应stage模型的requestPermissions | 431| commonEvents | CommonEvent结构体（见下述CommentEvent） | 标识静态事件 | NA | 432| shortcuts | list\<Shortcut> | 标识应用的shortcuts信息 | NA | 433| distroFilter | DistroFilter结构体 | 标识应用市场按设备形态分发的信息 | NA | 434| srcEntrance | String | 标识应用对应的入口代码路径 | stage模型新增 | 435| process | String | 标识hap的进程名 | stage模型新增 | 436| mainElement | String | 标识hap的入口ability名称或者extension名称 | stage模型新增，FA模型将mainAbility的值赋值给mainElement | 437| uiSyntax | String | 定义该JS Component的语法类型 | stage模型新增 | 438| pages | List\<String> | 列举JS Component中每个页面信息 | stage模型新增 | 439| extensionAbilityInfos| List\<ExtensionAbilityInfo> | 描述extensionAbility的配置信息 | stage模型新增 | 440| moduleAtomicService | ModuleAtomicService结构体（见下述ModuleAtomicService） | 描述hap的元服务信息 | NA | 441| formInfos | List\<AbilityFormInfo> | 描述卡片的信息 | NA | 442| descriptions | HashMap\<String, String> | 标识hap的说明信息 | NA | 443 444### 4.6 AbilityInfo结构体信息 445 446| 字段 | 类型 | 描述 | 备注 | 447|-------------------|--------------------------| ------------------------------------------------- | ------------------------------- | 448| name | String | 标识当前ability的逻辑名 | NA | 449| description | String | 标识ability的描述 | NA | 450| descriptionRes | String | 标识ability资源的描述 | NA | 451| icon | String | 标识ability图标 | NA | 452| iconPath | String | 标识ability图标路径 | NA | 453| label | String | 标识ability对用户显示的名称 | NA | 454| labelRes | String | 标识ability对用户显示的名称资源 | NA | 455| type | String | 标识ability类型 | Stage模型下该值直接赋予page类型 | 456| formsEnabled | boolean | 标识ability卡片是否使能 | NA | 457| formInfo | FormInfo结构体 | 描述卡片的信息 | NA | 458| uri | String | 标识ability的uri信息 | FA模型支持 | 459| launchType | String | 标识ability中的launcherType信息 | NA | 460| orientation | String | 标识ability中的orientation信息 | NA | 461| visible | boolean | 标识ability中的visible信息 | NA | 462| grantPermission | boolean | 标识ability中的grantPermission信息 | NA | 463| readPermission | String | 标识ability中的readPermission信息 | NA | 464| writePermission | String | 标识ability中的writePermission信息 | NA | 465| uriPermissionMode | String | 标识ability中的uriPermissionMode信息 | NA | 466| uriPermissionPath | String | 标识ability中的uriPermissionPath信息 | NA | 467| directLaunch | boolean | 标识ability中的directLaunch信息 | NA | 468| mission | String | 标识ability中的mission信息 | NA | 469| targetAbility | String | 标识ability中的targetAbility信息 | NA | 470| multiUserShared | boolean | 标识ability中的multiUserShared信息 | NA | 471| supportPipMode | boolean | 标识ability中的supportPipMode信息 | NA | 472| srcLanguage | String | 标识ability中的srcLanguage信息 | NA | 473| srcPath | String | 标识ability中的srcPath信息 | NA | 474| srcEntrance | String | 标识ability中的srcEntrance信息 | NA | 475| continuable | boolean | 标识ability中的continuable信息 | NA | 476| metaData | MetaData结构体（见下述MetaData） | 标识ability的自定义元信息 | NA | 477| configChanges | List\<String> | 标识ability中的configChanges信息 | NA | 478| formInfos | List\<AbilityFormInfo> | 标识ability中的forms信息 | NA | 479| permissions | List\<String> | 标识ability中的permissions信息 | NA | 480| skills | List\<SkillInfo> | 标识ability中的skills信息 | NA | 481| backgroundModes | List\<String> | 标识ability中的backgroundModes信息 | NA | 482| labels | HashMap\<String, String> | 标识多语言下ability对用户显示的名称 | NA | 483| descriptions | HashMap\<String, String> | 标识多语言下ability的描述 | NA | 484 485### 4.7 Distro结构体信息 486 487| 字段 | 类型 | 描述 | 备注 | 488| ------------------- |---------| --------------------------------------- | ------------------------------------------------------------ | 489| moduleName | String | 标识当前module的名字 | 对应Stage模型中module结构体中的moduleName字段 | 490| moduleType | String | 标识当前hap的类型 | 对应Stage模型中module结构体中的moduleType字段 | 491| deliveryWithInstall | boolean | 标识当前hap是否在用户主动安装的时候安装 | 对应Stage模型中module结构体中的deliveryWithInstall字段 | 492| installationFree | int | 标识当前hap是否支持免安装特性 | 对应Stage模型中module结构体中的installationFree字段，json文件中如果配置了该字段为true，返回1，配置为false，返回0，未配置返回2 | 493| virtualMachine | String | 标识当前hap运行的目标虚拟机类型，供云端分发使用，如应用市场和分发中心 | 对应Stage模型中module结构体中的virtualMachine字段 | 494 495### 4.8 MetaData结构体信息 496 497| 字段 | 类型 | 描述 | 备注 | 498| -------------- |----------------------| -------------------------------- | ------------------------- | 499| parameters | List\<MetaDataInfo> | 标识Metadata的参数信息 | FA模型特有，stage模型废弃 | 500| results | List\<MetaDataInfo> | 标识Metadata的results信息 | FA模型特有，stage模型废弃 | 501| customizeDatas | List\<CustomizeData> | 标识Metadata的customizeDatas信息 | NA | 502 503### 4.9 MetaDataInfo结构体信息 504 505| 字段 | 类型 | 描述 | 备注 | 506| ----------- | ------ | --------------------------------- | ------------------------- | 507| name | String | 标识MetaDataInfo的name信息 | FA模型特有，stage模型废弃 | 508| description | String | 标识MetaDataInfo的description信息 | FA模型特有，stage模型废弃 | 509| type | String | 标识MetaDataInfo的type信息 | FA模型特有，stage模型废弃 | 510 511### 4.10 CustomizeData结构体信息 512 513| 字段 | 类型 | 描述 | 备注 | 514| ----- | ------ | ---------------------------- | ----------------------- | 515| name | String | 标识CustomizeData的name信息 | 对应stage模型的metadata | 516| value | String | 标识CustomizeData的value信息 | 对应stage模型的metadata | 517| extra | String | 标识CustomizeData的extra信息 | 对应stage模型的metadata | 518 519### 4.11 ReqPermission结构体信息 520 521| 字段 | 类型 | 描述 | 备注 | 522| --------- | ---------------------------------- |------------------------------------------------------------| ---- | 523| name | String | 标识ReqPermission的名称信息 | NA | 524| reason | String | 当申请的权限为user_grant权限时此字段必填，描述申请权限的原因 | NA | 525| usedScene | UsedScene结构体（见下述UsedScene） | 描述权限使用的场景和时机。场景类型有：ability、调用时机（when），可配置多个ability | NA | 526| reasons | HashMap\<String, String> | 当申请的权限为user_grant权限时此字段必填，描述申请权限的原因 | NA | 527 528### 4.12 UsedScene结构体信息 529 530| 字段 | 类型 | 描述 | 备注 | 531| ------- | ------------- | ------------------------------------------------------------ | ---- | 532| ability | List\<String> | 标识需要使用到该权限的元能力（ability），该标签值为数组形式 | NA | 533| when | String | 标识使用该权限的时机，值为inuse/always，表示为仅允许前台使用和前后台都可使用 | NA | 534 535### 4.13 Shortcut结构体信息 536 537| 字段 | 类型 | 描述 | 备注 | 538| ---------- | ---------------------- | :----------------------------------------------------------- | ---- | 539| shortcutId | String | 标识ShortCut的Id | NA | 540| label | String | 标识ShortCut的标签信息 | NA | 541| icon | String | 标识ShortCut的图标信息 | NA | 542| intents | List\<IntentInfo> | 标识快捷方式内定义的目标intent信息集合，每个intent可配置两个子标签，targetClass,targetBundle | NA | 543| labels | HashMap\<String, String> | 标识多语言下ShortCut对用户显示的名称 | NA | 544 545### 4.14 IntentInfo结构体信息 546 547| 字段 | 类型 | 描述 | 备注 | 548| ------------ | ------ | ---------------- | ---- | 549| targetClass | String | 快捷方式目标类型 | NA | 550| targetBundle | String | 快捷方式目标包名 | NA | 551 552### 4.15 DistroFilter结构体信息 553 554| 字段 | 类型 | 描述 | 备注 | 555| ------------- | ------------------- | ------------------------------------- | ---- | 556| apiVersion | ApiVersion结构体 | 标识DistroFilter中的apiVersion信息 | NA | 557| screenShape | ScreenShape结构体 | 标识DistroFilter中的screenShape信息 | NA | 558| screenDensity | ScreenDensity结构体 | 标识DistroFilter中的screenDensity信息 | NA | 559| screenWindow | ScreenWindow结构体 | 标识DistroFilter中的screenWindow信息 | NA | 560| countryCode | CountryCode结构体 | 标识DistroFilter中的countryCode信息 | NA | 561 562### 4.16 ApiVersion结构体信息 563 564| 字段 | 类型 | 描述 | 备注 | 565| ------ | ------------- | ------------------------ | ---- | 566| policy | String | 标识结构体中的policy信息 | NA | 567| value | List\<String> | 标识结构体中的value信息 | NA | 568 569### 4.17 ScreenShape结构体信息 570 571| 字段 | 类型 | 描述 | 备注 | 572| ------ | ------------- | ------------------------ | ---- | 573| policy | String | 标识结构体中的policy信息 | NA | 574| value | List\<String> | 标识结构体中的value信息 | NA | 575 576### 4.18 ScreenDensity结构体信息 577 578| 字段 | 类型 | 描述 | 备注 | 579| ------ | ------------- | ------------------------ | ---- | 580| policy | String | 标识结构体中的policy信息 | NA | 581| value | List\<String> | 标识结构体中的value信息 | NA | 582 583### 4.19 ScreenWindow结构体信息 584 585| 字段 | 类型 | 描述 | 备注 | 586| ------ | ------------- | ------------------------ | ---- | 587| policy | String | 标识结构体中的policy信息 | NA | 588| value | List\<String> | 标识结构体中的value信息 | NA | 589 590### 4.20 CountryCode结构体信息 591 592| 字段 | 类型 | 描述 | 备注 | 593| ------ | ------------- | ------------------------ | ---- | 594| policy | String | 标识结构体中的policy信息 | NA | 595| value | List\<String> | 标识结构体中的value信息 | NA | 596 597### 4.21 ExtensionAbilityInfo结构体信息 598 599| 字段 | 类型 | 描述 | 备注 | 600| --------------- | ------------------------ | ----------------------------------------------------- | ----------------------------------- | 601| name | String | 标识当前extensionAbility的逻辑名 | stage模型支持 | 602| srcEntrance | String | 标识extensionAbility所对应的js代码路径 | stage模型支持 | 603| icon | String | 标签标识extensionAbility图标 | stage模型支持 | 604| label | String | 标识extensionAbility对用户显示的名称 | stage模型支持 | 605| description | String | 标识extensionAbility的描述 | stage模型支持 | 606| type | String | 标识extensionAbility的类型：form、workScheduler、inputMethod、service、accessibility、dataShare、fileShare、wallpaper、backup | stage模型支持，目前仅解析了form、staticSubscriber的信息、其他类型（如：workScheduler、inputMethod、service、accessibility、dataShare、fileShare、wallpaper、backup）暂未解析 | 607| permissions | List\<String> | 标识被其它应用的ability调用时需要申请的权限的集合 | stage模型支持 | 608| readPermission | String | 标识读取ability的数据所需的权限 | stage模型支持 | 609| writePermission | String | 标识向ability写数据所需的权限 | stage模型支持 | 610| visible | boolean | 标识extensionAbility是否可以被其它应用调用 | stage模型支持 | 611| skills | List\<SkillInfo> | 标识extensionAbility能够接收的意图的特征集 | stage模型支持 | 612| metadataInfos | List\<ModuleMetadataInfo>| 标识extensionAbility能够接收的元数据信息 | stage模型支持 | 613| metadata | MetaData结构体 | 标识extensionAbility的元信息 | 将metadata中的信息赋值到CustomizeData中 | 614| uri | String | 标识extensionAbility提供的数据uri | stage模型支持 | 615| descriptions | HashMap\<String, String> | 标识多语言下extensionAbility的描述 | NA | 616| labels | HashMap\<String, String> | 标识多语言下extensionAbility对用户显示的名称 | NA | 617 618### 4.22 SkillInfo结构体信息 619 620| 字段 | 类型 | 描述 | 备注 | 621| -------- | ------------------- |----------------------| ---- | 622| actions | List\<String> | 标识能够接收的意图的action值的集合 | NA | 623| entities | List\<String> | 标识能够接收的意图的元能力的类别集合 | NA | 624 625### 4.23 UriInfo结构体信息 626 627| 字段 | 类型 | 描述 | 备注 | 628| ------------- | ------ |------------------------| ---- | 629| schema | String | 标识ModuleUriInfo的范式信息 | NA | 630| host | String | 标识ModuleUriInfo的宿主信息 | NA | 631| port | String | 标识ModuleUriInfo的端口信息 | NA | 632| pathStartWith | String | 标识ModuleUriInfo的路径前缀 | NA | 633| pathRegex | String | 标识ModuleUriInfo的路径正则信息 | NA | 634| path | String | 标识ModuleUriInfo的路径信息 | NA | 635| type | String | 标识ModuleUriInfo的种类 | NA | 636 637### 4.24 AbilityFormInfo结构体信息 638 639| 字段 | 类型 | 描述 | 备注 | 640| ------------------- | -------------------------| ------------------------------------------------------------ |-----------| 641| name | String | 标识forms的名称 | NA | 642| type | String | 标签标识卡片的类型 | NA | 643| updateEnabled | boolean | 标识该卡片是否支持定时刷新 | NA | 644| scheduledUpdateTime | String | 标签标识卡片顶点刷新的时间，采用24小时计数，精确到分钟 | NA | 645| updateDuration | int | 标识卡片定时刷新的更新频率，单位为30分钟，取值为30的倍数值 | NA | 646| supportDimensions | List\<String> | 标识卡片外观规格，取值为”1 * 2“，”2 * 2“，”2 * 4“，”4 * 4“ | NA | 647| defaultDimension | String | 标识卡片默认外观规格，取值必须在supportDimensions配置的列表中 | NA | 648| MetaData | MetaData | 标识卡片的自定义信息 | NA | 649| description | String | 标识forms的描述 | stage模型新增 | 650| src | String | 标签JS卡片对应的UI代码 | NA | 651| windowInfo | ModuleWindowInfo结构体 | 标签能力窗体的窗口。 | NA | 652| isDefault | boolean | 标识该卡片是否为默认卡片，每个hap有且只能有一个默认卡片 | NA | 653| colorMode | String | 标识卡片的色调，取值为auto、dark、light其中之一 | NA | 654| formConfigAbility | String | 标识卡片调整的Ability名称 | NA | 655| formVisibleNotify | String | 标识卡片是否被允许使用卡片可见性通知 | NA | 656| providerAbility | String | 卡片的提供方所在的Ability或者extension名称，1.FA模型：如果卡片配置在service类型的ability中，providerAbility配置为mainAbility 2.FA模型：如果卡片配置在Page类型的Ability中，providerAbility配置为当前Ability 3.FA模型：如果没有配置mainAbility，providerAbility配置为当前hap包中的优先使用system.home，否则第一个page的Ability 4.stage模型中（follow上述规则），providerAbility配置为mainElement | NA | 657| descriptions | HashMap\<String, String> | 标识多语言下ability的描述 | NA | 658 659 660 661### 4.25 CommonEvent结构体信息 662 663| 字段 | 类型 | 描述 | 备注 | 664| ---------- | ------------- | -------------------------------------- | ------------------------------------------------ | 665| name | String | 当前静态公共事件对应的类名 | Stage模型从staticSubscriber类型的Extension中获取 | 666| permission | String | 标识实现该静态公共事件需要申请的权限 | Stage模型从staticSubscriber类型的Extension中获取 | 667| data | List\<String> | 当前静态公共时间需要携带的额外数据数组 | Stage模型从staticSubscriber类型的Extension中获取 | 668| type | List\<String> | 配置当前静态公共时间的类别数组 | Stage模型从staticSubscriber类型的Extension中获取 | 669| events | List\<String> | 标识能够接收的意图的event值的集合 | Stage模型从staticSubscriber类型的Extension中获取 | 670 671### 4.26 DependencyItem结构体信息 672 673| 字段 | 类型 | 描述 | 备注 | 674|--------------| ------ |--------------| ---- | 675| bundleName | String | 共享包的bundleName | NA | 676| moduleName | String | 共享包的moduleName | NA | 677| versionCode | String | 共享包的版本号 | NA | 678 679### 4.27 ModuleAtomicService结构体信息 680 681| 字段 | 类型 | 描述 | 备注 | 682|--------------|------------------------|----------------| ---- | 683| preloadItems | list\<PreloadItem> | 预加载对象 | NA | 684 685### 4.28 PreloadItem结构体信息 686 687| 字段 | 类型 | 描述 | 备注 | 688|--------------|--------|----------------| ---- | 689| moduleName | String | 预加载的模块名 | NA | 690 691### 4.29 DeviceConfig结构体信息 692 693| 字段 | 类型 | 描述 | 备注 | 694|--------------------------------|-------- |------------------------------------------| ---- | 695| targetReqSdk | String | 标识应用程序DeviceConfig的目标请求Sdk版本 | NA | 696| compatibleReqSdk | String | 标识应用程序DeviceConfig的兼容请求Sdk版本 | NA | 697| jointUserid | String | 标识应用程序DeviceConfig的jointUserid | NA | 698| process | String | 标识应用程序DeviceConfig的进程 | NA | 699| arkFlag | String | 标识应用程序DeviceConfig的arkFlag | NA | 700| targetArkVersion | String | 标识应用程序DeviceConfig的targetArkVersion | NA | 701| compatibleArkVersion | String | 标识应用程序DeviceConfig的兼容ArkVersion | NA | 702| directLaunch | boolean | 标识应用程序DeviceConfig的直接启动 | NA | 703| distributedNotificationEnabled | boolean | 标识应用程序AppJson的distributedNotificationEnabled | NA | 704 705### 4.30 DefPermission结构体信息 706 707| 字段 | 类型 | 描述 | 备注 | 708|----------------|--------------------------|-------------------------------------------| ---- | 709| name | String | 标识指示DefPermission的名称 | NA | 710| grantMode | String | 标识DefPermission的grantMode | NA | 711| group | String | 标识DefPermission的组 | NA | 712| label | String | 标识DefPermission的标签 | NA | 713| description | String | 标识DefPermission的描述 | NA | 714| availableScope | List\<String> | 标识DefPermission的可用范围 | NA | 715| labels | HashMap\<String, String> | 标识多语言应用程序DefPermission的标签 | NA | 716| descriptions | HashMap\<String, String> | 标识多语言应用程序DefPermission的说明 | NA | 717 718### 4.31 DefinePermission结构体信息 719 720| 字段 | 类型 | 描述 | 备注 | 721|------------------------|--------------------------|----------------------------------------------------| ---- | 722| name | String | 标识DefPermission的名称 | NA | 723| grantMode | String | 标识DefPermission的grantMode | NA | 724| availableLevel | String | 标识DefPermission的组 | NA | 725| provisionEnable | boolean | 标识模块定义权限的提供启用 | NA | 726| distributedSceneEnable | boolean | 标识ModuleDefinePermissions的distributedSceneEnable | NA | 727| label | String | 标识DefPermission的标签 | NA | 728| description | String | 标识DefPermission的描述 | NA | 729| descriptions | HashMap\<String, String> | 标识多语言应用程序DefPermission的说明 | NA | 730| labels | HashMap\<String, String> | 标识多语言应用程序DefPermission的标签 | NA | 731 732### 4.32 DefPermissionsGroups结构体信息 733 734| 字段 | 类型 | 描述 | 备注 | 735|-------------|---------|------------------------------| ---- | 736| name | String | 标识DefPermissionGroup的名称 | NA | 737| order | String | 标识DefPermissionGrou的顺序 | NA | 738| icon | String | 标识DefPermissionGroup的图标 | NA | 739| label | String | 标识DefPermissionGroup的标签 | NA | 740| description | String | 标识DefPermissionGroup的描述 | NA | 741| request | boolean | 标识DefPermissionGroup的请求 | NA | 742 743### 4.33 FormInfo结构体信息 744 745| 字段 | 类型 | 描述 | 备注 | 746|---------------|---------------|--------------------------| ---- | 747| formEntity | List\<String> | 标识formInfo的formEntity | NA | 748| minHeight | String | 标识formInfo的最小高度 | NA | 749| defaultHeight | String | 标识formInfo的默认高度 | NA | 750| minWidth | String | 标识formInfo的最小宽度 | NA | 751| defaultWidth | String | 标识formInfo的默认宽度 | NA | 752 753### 4.34 ModuleMetadataInfo结构体信息 754 755| 字段 | 类型 | 描述 | 备注 | 756|----------|---------|------------------------------| ---- | 757| name | String | 标识ModuleMetadataInfo的名称 | NA | 758| value | String | 标识ModuleMetadataInfo的值 | NA | 759| resource | String | 标识ModuleMetadataInfo的资源 | NA | 760 761### 4.35 ModuleWindowInfo结构体信息 762 763| 字段 | 类型 | 描述 | 备注 | 764|-----------------|---------|-------------------------------------| ---- | 765| designWidth | int | 标识模块已用场景的设计宽度 | NA | 766| autoDesignWidth | boolean | 标识ModuleUsedScene的autoDesignWidth | NA |
){kind=link}