鸿蒙应用程序框架基础
- 应用程序包基础知识
- 应用的多Module设计机制
- Module类型
- Stage模型应用程序包结构
- 开发态包结构
- 编译包形态
- 发布台包结构
- 选择合适的包类型
应用程序包基础知识
应用的多Module设计机制
- **支持模块化开发:**一个应用通常会包含多种功能,将不同的功能特性按模块来划分和管理是一种良好的设计方式。在开发过程中,我们可以将每个功能模块作为一个独立的Module进行开发,Module中可以包含源代码、资源文件、第三方库、配置文件等,每一个Module可以独立编译,实现特定的功能。在这种模块化、松耦合的应用管理方式有助于应用的开发、维护与拓展。
- **支持多设备适配:**一个应用往往需要适配多种设备类型,在采用多Module设计的应用中,每个Module都会标注所支持的设备类型。有些Module支持全部类型的设备,有些Module只支持一种或几种类型的设备,那么在应用市场分发应用包时,也能够根据设备类型做精准的筛选和匹配,从而将不同的包合理的组合和部署到对应的设备上。
Module类型
Module按照使用场景可以分为两种类型:
- **Ability类型的Module:**用于实现应用的功能和特性。每一个Ability类型的Module编译后,会生成一个以.hap为后缀的文件,我们称其为HAP(Harmony Ability Package)包。HAP包可以独立安装和运行,是应用安装的基本单位,一个应用中可以包含一个或者多个HAP包,具体包含如下两种类型。
- entry类型的Module: 应用的主模块,包含应用的入口界面、入口图标和主功能特性,编译后生成entry类型的HAP。每一个应用分发到同一类型的设备上的应用程序包,只能包含唯一一个entry类型的HAP。
- feature类型的Module:应用的动态特性模块,编译后生成feture类型的HAP。一个应用中可以包含一个或者多个feature类型的HAP,也可以不包含。
- **Library类型的Module:**用于实现代码和资源的共享。同一个Library类型的Module可以被其他的Module多次引用,合理的使用该类型的Module,能够降低开发和维护成本。Library类型的module分为Static和Shared两种类型,编译后会生成共享包。
- Static Library:静态共享库。编译后会生成一个以.har为后缀的文件,即静态共享包HAR(Harmony Archive)。
- Shared Library:动态共享库。编译后会生成一个以.hsp为后缀的文件,即动态共享包HSP(Harmony Shared Package)。实际上,Shared Library编译后除了会生成一个.hsp文件,还会生成一个.har文件。这个.har文件中包含了HSP对外导出的接口,应用中的其他模块需要通过.har文件来应用HSP的功能。为了表述方便,我们通常认为Shared Library编译后生成HSP。
HAR和HSP两种共享包的主要区别体现在:
共享包类型 | 编译和运行方式 | 发布和引用方式 |
---|---|---|
HAR | HAR中的代码和资源跟随使用方编译,如果有多个使用方,他们的编译产物会存在多份相同拷贝。在编译HAR时,建议开启混淆能力,保护代码资产。 | HAR除了支持应用内引用,还可以独立打包发布,供其他应用引用。 |
HSP | HSP中的代码可以独立编译,运行时在一个进程中的代码只会存在一份。 | HSP一般随应用打包,当前支持应用内和集成态HSP。应用内HSP只支持应用内引用,集成态HSP支持发布到ohpm私仓和跨应用引用。 |
HAR和HSP在APP包中的形态示意图:
Stage模型应用程序包结构
开发态包结构
工程结构示意图:
工程结构主要包含的文件类型及用途如下:
- AppScope目录有DevEco Studio自动生成,不可修改。
- Module目录名称可以由DevEco Studio自动生成(比如entry、library等),也可以自定义。
文件类型 | 说明 |
---|---|
配置文件 | 包括应用级配置信息、以及Module级配置信息: AppScope > app.json5:app.json5配置文件,用于声明应用的全局配置信息,比如应用Bundle名称、应用名称、应用图标、应用版本号等。 Module > src > main > module.json5:module.json5配置文件,用于声明Module基本信息、支持的设备类型、所含的组件信息、运行所需申请的权限等。 |
ArkTs源码文件 | Module > src > main >ets: 用于存放Module的ArkTs源码文件(.ets文件) |
资源文件 | 包括应用资源文件、以及Module级资源文件,支持图形、多媒体、字符串、布局文件等。 AppScope > resources: 用于存放应用需要用到的资源文件。 Module > src > main > resources:用于存放该Module需要用到的资源文件。 |
其他配置文件 | 用于编译构建,包括构建配置文件、编译构建任务脚本、混淆规则文件、依赖的共享包信息等。 build-profile.json5:工程机或Module级的构建配置文件,包括应用签名、产品配置等。 hvigorfile.ts:应用级或Module的编译构建任务脚本,可以自定义编译构建工具版本、控制构建行为的配置参数。 obfuscation-rules.txt:混淆规则文件。混淆开启后,在使用Release模式进行编译时,会对代码进行编译、混淆及压缩处理,保护代码资产。 oh-package.json5:用于存放依赖库的信息,包括所依赖的三方库和共享包。 |
编译包形态
开发态与编译态试图的对照关系如下:
从开发态到编译态,Module中的文件会发生如下变更:
- ets目录:ArkTs源码编译生成.abc文件
- resources目录:AppScope目录下的资源文件会合并到Module下边的资源目录中,如果两个目录存在重名文件,编译后只会保留AppScope目录下的资源文件。
- module配置文件:AppScope目录下的app.json5文件字段会合并到Module下面的module.json5文件中,编译后生成HAP或者HSP最终的module.json文件。在编译HAP和HSP时,会把他们所依赖的HAR直接编译到HAP和HSP中。
发布台包结构
每个应用中至少包含一个.hap文件,可能包含若干个.hsp文件,也可能不包含。一个应用中的所有.hap文件和.hsp文件合并在一起称为一个Bundle,其对应的bundleName是应用的唯一标识。
当应用发布上架到应用市场时,需要将Bundle打包为一个.app文件用于上架,这个.app文件称为App Pack(Application Package),与此同时,DevEco Studio会自动生成一个pack.info文件。pack.info文件猫叔了App Pack中每个HAP和HSP的属性,包含App中的bundleName和versionCode信息,以及Module中的name、type和abilites等信息。
注意:
- App Pack是发布上架到应用市场的基本单元,但是不能在设备上直接运行和安装。
- 在应用签名、云端分发、端侧安装时,都是以HAP/HSP为单元进行的。
编译发布与上架部署流程图
选择合适的包类型
HAP、HAR、HSP三者的功能和使用场景对比如下:
Module类型 | 包类型 | 说明 |
---|---|---|
Ability | HAP | 应用功能模块,可以独立安装和运行。 必须包含一个entry类型的HAP,可选包含一个或者多个feture类型的HAP |
Static Library | HAR | 静态共享包,编译态复用。 - 支持应用内共享,也可以发布后供其他应用使用。 - 作为二方库,发布到OHPM私仓,供公司内部其他应用使用。 - 作为三方库,发布到OHPM中心仓,供其他应用使用。 - 多包应用相同的HAR时,会造成多包间代码和资源的重复拷贝,导致应用包体积膨胀。 - 注意:编译HAR时,建议开启混淆能力,保护代码资产。 |
Shared Library | HSP | 动态共享包,运行时复用 - 当前仅支持应用内共享。 - 当多个包共同引用同一个共享包时,采用HSP代替HAR,可以避免HAR造成的多包件代码和资源的重复拷贝,从而减小应用包的大小。 |
HAP、HSP、HAR支持的规格对比如下:
规格 | HAP | HAR | HSP |
---|---|---|---|
支持在配置文件中声明UIAbility组件与ExtensionAbility组件 | √ | × | × |
支持在配置文件中声明pages页面 | √ | × | √ |
支持包含资源文件与.so文件 | √ | √ | √ |
支持依赖其他HAR文件 | √ | √ | √ |
支持依赖其他HSP文件 | √ | √ | √ |
支持在设备上独立安装运行 | √ | × | × |
说明:
- HAR虽然不支持在配置文件中声明pages页面,但是可以包含pages页面,并通过命名路由的方式进行跳转。
- 由于HSP只支持在应用内共享,如果HAR依赖了HSP,则该HAR文件仅支持在应用内共享,不支持发布到二方仓或者三方仓供其他应用使用,否则会导致编译失败。
- HAR和HSP均不支持循环依赖,也不支持依赖传递。