OpenHarmony工程介绍

OpenHarmony APP工程结构

在进行OpenHarmony应用/服务开发前，应该掌握OpenHarmony应用/服务的逻辑结构。

OpenHarmony应用/服务发布形态为APP Pack（Application Package，简称APP），它是由一个或多个HAP（OpenHarmony Ability Package）包以及描述APP Pack属性的pack.info文件组成。

一个HAP在工程目录中对应一个Module，它是由代码、资源、第三方库及应用/服务配置文件组成，可以分为Entry和Feature两种类型。

• Entry：应用/服务的主模块，可独立安装运行。在一个工程中同一个设备类型只支持一个Entry类型的模块。

• Feature：应用/服务的动态特性模块。一个APP可以包含一个或多个feature类型的HAP，也可以不含。

HAP是Ability的部署包，OpenHarmony应用/服务代码围绕Ability组件展开，它是由一个或多个Ability组成。Ability分为两种类型：FA（Feature Ability）和PA（Particle Ability）。FA/PA是应用/服务的基本组成单元，能够实现特定的业务功能。FA有UI界面，而PA无UI界面。

工程目录结构

FA模型和Stage模型的工程目录结构存在差异，API version8只支持FA模型，API version9则两者都支持。下面分别介绍FA模型和Stage模型的工程目录结构。

eTS工程目录结构（FA模型）

FA模型的eTS工程目录结构如下图所示：

• entry：OpenHarmony工程模块，编译构建生成一个Hap包。
  • src > main > ets：用于存放ets源码。
  • src > main > ets > MainAbility：应用/服务的入口。
  • src > main > ets > MainAbility > pages：MainAbility包含的页面。
  • src > main > ets > MainAbility > app.ets：承载Ability生命周期。
  • src > main > resources：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考资源文件的分类。

    资源目录	资源文件说明
    base>element	包括字符串、整型数、颜色、样式等资源的json文件。每个资源均由json格式进行定义，例如： boolean.json：布尔型 color.json：颜色 float.json：浮点型 intarray.json：整型数组 integer.json：整型 pattern.json：样式 plural.json：复数形式 strarray.json：字符串数组 string.json：字符串值
    base>media	多媒体文件，如图形、视频、音频等文件，支持的文件格式包括：.png、.gif、.mp3、.mp4等。

  • src > main > config.json：模块配置文件，主要包含HAP包的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。
  • build-profile.json5：当前的模块信息、编译信息配置项，包括buildOption、targets配置等。
  • hvigorfile.js：模块级编译构建任务脚本。
• build-profile.json5：应用级配置信息，包括签名、产品配置等。
• hvigorfile.js：应用级编译构建任务脚本。

JS工程目录结构（FA模型）

FA模型的JS工程目录结构如下图所示：

• 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格式进行定义，例如： boolean.json：布尔型 color.json：颜色 float.json：浮点型 intarray.json：整型数组 integer.json：整型 pattern.json：样式 plural.json：复数形式 strarray.json：字符串数组 string.json：字符串值
    base>media	多媒体文件，如图形、视频、音频等文件，支持的文件格式包括：.png、.gif、.mp3、.mp4等。

  • src > main > config.json：模块配置文件，主要包含HAP包的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。
  • entry > build-profile.json5：当前的模块信息、编译信息配置项，包括buildOption、targets配置等。
  • entry > hvigorfile.js：模块级编译构建任务脚本。
• build-profile.json5：应用级配置信息，包括签名、产品配置等。
• hvigorfile.js：应用级编译构建任务脚本。

C++模板创建的工程目录结构（FA模型）

用C++模板创建的eTS工程或JS工程目录结构相似，如下图所示，以eTS工程为例介绍各文件的作用。

• 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：用于存放ets源码。
  • src > main > resources：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考资源文件的分类。

    资源目录	资源文件说明
    base>element	包括字符串、整型数、颜色、样式等资源的json文件。每个资源均由json格式进行定义，例如： boolean.json：布尔型 color.json：颜色 float.json：浮点型 intarray.json：整型数组 integer.json：整型 pattern.json：样式 plural.json：复数形式 strarray.json：字符串数组 string.json：字符串值。
    base>media	多媒体文件，如图形、视频、音频等文件，支持的文件格式包括：.png、.gif、.mp3、.mp4等。

  • entry > src > main > config.json：模块配置文件，主要包含HAP包的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。
  • entry > build-profile.json5：当前的模块信息、编译信息配置项，包括buildOption、targets配置等。
  • entry > hvigorfile.js：模块级编译构建任务脚本。
• build-profile.json5：应用级配置信息，包括签名、产品配置等。
• hvigorfile.js：应用级编译构建任务脚本。

eTS工程目录结构（Stage模型）

Stage模型的eTS工程目录结构如下图所示：

• AppScope > app.json5：应用的全局配置信息。
• entry：OpenHarmony工程模块，编译构建生成一个Hap包。
  • src > main > ets：用于存放ets源码。
  • src > main > ets > Application > AbilityStage.ts：实现AbilityStage接口。
  • src > main > ets > MainAbility：应用/服务的入口。
  • src > main > ets > MainAbility > MainAbility.ts：承载Ability生命周期。
  • src > main > ets > pages：MainAbility包含的页面。
  • src > main > resources：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考资源文件的分类。

    资源目录	资源文件说明
    base>element	包括字符串、整型数、颜色、样式等资源的json文件。每个资源均由json格式进行定义，例如： boolean.json：布尔型 color.json：颜色 float.json：浮点型 intarray.json：整型数组 integer.json：整型 pattern.json：样式 plural.json：复数形式 strarray.json：字符串数组 string.json：字符串值
    base>media	多媒体文件，如图形、视频、音频等文件，支持的文件格式包括：.png、.gif、.mp3、.mp4等。
    base>profile	用于存储任意格式的原始资源文件。

  • src > main > module.json5：模块配置文件，主要包含HAP包的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。
  • entry > build-profile.json5：当前的模块信息、编译信息配置项，包括buildOption、targets配置等。
  • entry >hvigorfile.js：模块级编译构建任务脚本。
• build-profile.json5：应用级配置信息，包括签名、产品配置等。
• hvigorfile.js：应用级编译构建任务脚本。

C++模板创建的工程目录结构（Stage模型）

用C++模板创建的eTS工程目录结构相如下图所示：

• AppScope > app.json5：应用的全局配置信息。
• 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：用于存放ets源码。
  • src > main > resources：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考资源文件的分类。

    资源目录	资源文件说明
    base>element	包括字符串、整型数、颜色、样式等资源的json文件。每个资源均由json格式进行定义，例如： boolean.json：布尔型 color.json：颜色 float.json：浮点型 intarray.json：整型数组 integer.json：整型 pattern.json：样式 plural.json：复数形式 strarray.json：字符串数组 string.json：字符串值。
    base>media	多媒体文件，如图形、视频、音频等文件，支持的文件格式包括：.png、.gif、.mp3、.mp4等。
    base>profile	用于存储任意格式的原始资源文件。

  • entry > src > main > module.json5：模块配置文件，主要包含HAP包的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。
  • entry > build-profile.json5：当前的模块信息、编译信息配置项，包括buildOption、targets配置等。
  • entry > hvigorfile.js：模块级编译构建任务脚本。
• build-profile.json5：应用级配置信息，包括签名、产品配置等。
• hvigorfile.js：应用级编译构建任务脚本。