Stage模型应用程序包结构
开发态包结构
在DevEco Studio上创建一个项目工程,并尝试创建多个不同类型的Module。根据实际工程中的目录对照本文章进行学习,可以有助于理解开发态的应用程序结构。
图1 项目工程结构示意图
工程结构主要包含的文件类型及用途如下:
- AppScope目录:由DevEco Studio自动生成,不可更改。
- Module目录:名称可以由DevEco Studio自动生成或自定义,例如entry、library等。
文件类型说明
文件类型 | 说明 |
---|---|
配置文件 | 包括应用级配置信息、以及 Module 级配置信息: - AppScope > app.json5:app.json5 配置文件,用于声明应用的全局配置信息,比如应用 Bundle 名称、应用名称、应用图标、应用版本号等。 - Module_name > src > main > module.json5:module.json5 配置文件,用于声明 Module 基本信息、支持的设备类型、所含的组件信息、运行所需申请的权限等。 |
ArkTS 源码文件 | Module_name > src > main > ets:用于存放 Module 的 ArkTS 源码文件(.ets 文件)。 |
资源文件 | 包括应用级资源文件、以及 Module 级资源文件,支持图形、多媒体、字符串、布局文件等。 - AppScope > resources:用于存放应用需要用到的资源文件。 - Module_name > src > main > resources:用于存放该 Module 需要用到的资源文件。 |
其他配置文件 | 用于编译构建,包括构建配置文件、编译构建任务脚本、混淆规则文件、依赖的共享包信息等。 - build - profile.json5:工程级或 Module 级的构建配置文件,包括应用签名、产品配置等。 - hvigorfile.ts:应用级或 Module 级的编译构建任务脚本,开发者可以自定义编译构建工具版本、控制构建行为的配置参数。 - obfuscation - rules.txt:混淆规则文件。混淆开启后,在使用 Release 模式进行编译时,会对代码进行编译、混淆及压缩处理,保护代码资产。 - oh - package.json5:用于存放依赖库的信息,包括所依赖的三方库和共享包。 |
编译态包结构
不同类型的Module编译后会生成对应的HAP、HAR、HSP等文件。
图2 开发态与编译态的工程结构视图
发布态包结构
每个应用中至少包含一个.hap文件,可能包含若干个.hsp文件、也可能不含,一个应用中的所有.hap与.hsp文件合在一起称为Bundle。
图3 编译发布与上架部署流程图
选择合适的包类型
HAP、HAR、HSP三者的功能和使用场景总结对比如下:
Module 类型 | 包类型 | 说明 |
---|---|---|
Ability | HAP | 应用的功能模块,可以独立安装和运行,必须包含一个 entry 类型的 HAP,可选包含一个或多个 feature 类型的 HAP。 |
Static Library | HAR | 静态共享包,编译态复用。 - 支持应用内共享,也可以发布后供其他应用使用。 - 作为二方库,发布到 OHPM 私仓,供公司内部其他应用使用。 - 作为三方库,发布到 OHPM 中心仓,供其他应用使用。 - 多包(HAP/HSP)引用相同的 HAR 时,会造成多包间代码和资源的重复拷贝,从而导致应用包膨大。 - 注意:编译 HAR 时,建议开启混淆能力,保护代码资产。 |
Shared Library | HSP | 动态共享包,运行时复用。 - 当前仅支持应用内共享。 - 当多包(HAP/HSP)同时引用同一个共享包时,采用 HSP 替代 HAR,可以避免 HAR 造成的多包间代码和资源的重复拷贝,从而减小应用包大小。 |
规格对比
规格 | HAP | HAR | HSP |
---|---|---|---|
支持在配置文件中声明UIAbility组件与ExtensionAbility组件 | √ | × | × |
支持在配置文件中声明pages页面 | √ | × | √ |
支持包含资源文件与.so文件 | √ | √ | √ |
支持依赖其他HAR文件 | √ | √ | √ |
支持依赖其他HSP文件 | √ | √ | √ |
支持在设备上独立安装运行 | √ | × | × |
说明:
- HAR 虽然不支持在配置文件中声明 pages 页面,但是可以包含 pages 页面,并通过命名路由的方式进行跳转。
- 由于 HSP 仅支持应用内共享,如果 HAR 依赖了 HSP,则该 HAR 文件仅支持应用内共享,不支持发布到二方仓或三方仓供其他应用使用,否则会导致编译失败。
- HAR 和 HSP 均不支持循环依赖,也不支持依赖传递。