OpenHarmony DevEco Studio使用指南-OpenHarmony工程介绍
OpenHarmony APP工程结构
在进行OpenHarmony应用/服务开发前,应该掌握OpenHarmony应用/服务的逻辑结构。
OpenHarmony应用/服务发布形态为APP Pack(Application Package,简称APP),它是由一个或多个HAP(OpenHarmony Ability Package)以及描述APP Pack属性的pack.info文件组成。
一个HAP在工程目录中对应一个Module,它是由代码、资源、第三方库及应用/服务配置文件组成,HAP可以分为Entry和Feature两种类型。
- Entry:应用/服务的主模块,可独立安装运行。在一个工程中同一个设备类型只支持一个Entry类型的模块。
- Feature:应用/服务的动态特性模块。一个APP可以包含一个或多个feature类型的HAP,也可以不含。
基于FA模型和基于Stage模型开发的应用,应用程序包结构并不相同。
Stage模型应用程序包结构如下图所示。更多说明请参见应用开发基础知识中的Stage模型应用程序包结构。
FA模型应用程序包结构如下图所示。更多说明请参见应用开发基础知识中的FA模型应用程序包结构。
工程目录结构
FA模型和Stage模型的工程目录结构存在差异,API version8只支持FA模型,API version9则两者都支持。下面分别介绍FA模型和Stage模型的工程目录结构。
ArkTS工程目录结构(Stage模型)
ArkTS Stage模型支持API Version 9,其工程目录结构如下图所示:
- AppScope > app.json5:应用的全局配置信息。
- entry:OpenHarmony工程模块,编译构建生成一个HAP。
○ src > main > ets:用于存放ArkTS源码。
○ src > main > ets > entryability:应用/服务的入口。
○ src > main > ets > pages:应用/服务包含的页面。
○ src > main > resources:用于存放应用/服务所用到的资源文件,如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考资源文件的分类。
资源目录 | 资源文件说明 |
base>element | 包括字符串、整型数、颜色、样式等资源的json文件。每个资源均由json格式进行定义,例如:
|
base>media | 多媒体文件,如图形、视频、音频等文件,支持的文件格式包括:.png、.gif、.mp3、.mp4等。 |
base>profile | 用于存储任意格式的原始资源文件。 |
○ src > main > module.json5:模块配置文件,主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。
○ entry > build-profile.json5:当前的模块信息、编译信息配置项,包括buildOption、targets配置等。
○ entry >hvigorfile.ts:模块级编译构建任务脚本。
- build-profile.json5:应用级配置信息,包括签名、产品配置等。
- hvigorfile.ts:应用级编译构建任务脚本。
ArkTS工程目录结构(FA模型)
ArkTS FA模型支持API Version 8~9,其工程目录结构如下图所示:
- entry:OpenHarmony工程模块,编译构建生成一个HAP。
○ src > main > ets:用于存放ArkTS源码。
○ src > main > ets > MainAbility:应用/服务的入口。
○ src > main > ets > MainAbility > pages:MainAbility包含的页面。
○ src > main > ets > MainAbility > app.ets:承载Ability生命周期。
○ src > main > resources:用于存放应用/服务所用到的资源文件,如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考资源文件的分类。
资源目录 | 资源文件说明 |
base>element | 包括字符串、整型数、颜色、样式等资源的json文件。每个资源均由json格式进行定义,例如:
|
base>media | 多媒体文件,如图形、视频、音频等文件,支持的文件格式包括:.png、.gif、.mp3、.mp4等。 |
rawfile | 用于存储任意格式的原始资源文件。rawfile不会根据设备的状态去匹配不同的资源,需要指定文件路径和文件名进行引用。 |
○ src > main > config.json:模块配置文件,主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。
○ entry > build-profile.json5:当前的模块信息、编译信息配置项,包括buildOption、targets配置等。
○ entry > hvigorfile.ts:模块级编译构建任务脚本。
- build-profile.json5:应用级配置信息,包括签名、产品配置等。
- hvigorfile.ts:应用级编译构建任务脚本。
JS工程目录结构(FA模型)
JS工程只支持FA模型,支持API Version 8~9,其工程目录结构如下图所示:
- entry:OpenHarmony工程模块,编译构建生成一个HAP。
○ src > main > js:用于存放js源码。
○ src > main > js > MainAbility:应用/服务的入口。
○ src > main > js > MainAbility > i18n:用于配置不同语言场景资源内容,比如应用文本词条、图片路径等资源。
○ src > main > js > MainAbility > pages:MainAbility包含的页面。
○ src > main > js > MainAbility > app.js:承载Ability生命周期。
○ src > main > resources:用于存放应用/服务所用到的资源文件,如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考资源文件的分类。
资源目录 | 资源文件说明 |
base>element | 包括字符串、整型数、颜色、样式等资源的json文件。每个资源均由json格式进行定义,例如:
|
base>media | 多媒体文件,如图形、视频、音频等文件,支持的文件格式包括:.png、.gif、.mp3、.mp4等。 |
rawfile | 用于存储任意格式的原始资源文件。rawfile不会根据设备的状态去匹配不同的资源,需要指定文件路径和文件名进行引用。 |
○ src > main > config.json:模块配置文件,主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。
○ entry > build-profile.json5:当前的模块信息、编译信息配置项,包括buildOption、targets配置等。
○ entry > hvigorfile.ts:模块级编译构建任务脚本。
- build-profile.json5:应用级配置信息,包括签名、产品配置等。
- hvigorfile.ts:应用级编译构建任务脚本。
C++工程目录结构(Stage模型)
C++ Stage模型支持API Version 9,支持使用ArkTS+C++进行开发,其工程目录结构如下图所示。
- entry:OpenHarmony工程模块,编译构建生成一个HAP。
○ src > main > cpp > types:用于存放C++的API接口描述文件
○ src > main > cpp > types> libentry > index.d.ts:描述C++ API接口行为,如接口名、入参、返回参数等。
○ src > main > cpp > types> libentry> package.json:配置.so三方包声明文件的入口及包名。
○ src > main > cpp > CMakeLists.txt:CMake配置文件,提供CMake构建脚本。
○ src > main > cpp > hello.cpp:定义C++ API接口的文件。
○ src > main > ets:用于存放ArkTS源码,其详细介绍请参考ArkTS工程目录结构(Stage模型)介绍。
○ src > main > resources:用于存放应用/服务所用到的资源文件,如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考资源文件的分类。
资源目录 | 资源文件说明 |
base>element | 包括字符串、整型数、颜色、样式等资源的json文件。每个资源均由json格式进行定义,例如:
|
base>media | 多媒体文件,如图形、视频、音频等文件,支持的文件格式包括:.png、.gif、.mp3、.mp4等。 |
rawfile | 用于存储任意格式的原始资源文件。rawfile不会根据设备的状态去匹配不同的资源,需要指定文件路径和文件名进行引用。 |
○ entry > src > main > mudule.json5:Stage模块配置文件,主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。
○ entry > build-profile.json5:当前的模块信息、编译信息配置项,包括buildOption、targets配置等。
○ entry > hvigorfile.ts:模块级编译构建任务脚本。
- build-profile.json5:应用级配置信息,包括签名、产品配置等。
- hvigorfile.ts:应用级编译构建任务脚本。
C++工程目录结构(FA模型)
C++ FA模型支持API Version 8~9,支持使用ArkTS+C++或JS+C++进行开发,其工程目录结构相似,下面将以ArkTS+C++工程为例进行介绍,其工程目录结构如下图所示。
- entry:OpenHarmony工程模块,编译构建生成一个HAP。
○ src > main > cpp > types:用于存放C++的API接口描述文件
○ src > main > cpp > types> libentry > index.d.ts:描述C++ API接口行为,如接口名、入参、返回参数等。
○ src > main > cpp > types> libentry> package.json:配置.so三方包声明文件的入口及包名。
○ src > main > cpp > CMakeLists.txt:CMake配置文件,提供CMake构建脚本。
○ src > main > cpp > hello.cpp:定义C++ API接口的文件。
○ src > main > ets:用于存放ArkTS源码,其详细介绍请参考ArkTS工程目录结构(FA模型)介绍。
○ src > main > resources:用于存放应用/服务所用到的资源文件,如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考资源文件的分类。
资源目录 | 资源文件说明 |
base>element | 包括字符串、整型数、颜色、样式等资源的json文件。每个资源均由json格式进行定义,例如:
|
base>media | 多媒体文件,如图形、视频、音频等文件,支持的文件格式包括:.png、.gif、.mp3、.mp4等。 |
rawfile | 用于存储任意格式的原始资源文件。rawfile不会根据设备的状态去匹配不同的资源,需要指定文件路径和文件名进行引用。 |
○ entry > src > main > config.json:FA模块配置文件,主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。
○ entry > build-profile.json5:当前的模块信息、编译信息配置项,包括buildOption、targets配置等。
○ entry > hvigorfile.ts:模块级编译构建任务脚本。
- build-profile.json5:应用级配置信息,包括签名、产品配置等。
- hvigorfile.ts:应用级编译构建任务脚本。