HarmonyOS Developer DevEco Studio使用指南-工程管理

HarmonyOS工程介绍

HarmonyOS APP包结构

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

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

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

• Entry：应用/服务的主模块，可独立安装运行。一个APP中，对于同一类型的设备，可以包含一个或多个Entry类型的HAP，如果同一类型的设备包含多个Entry模块，需要​​配置distroFilter分发规则​​，使得应用市场在做应用的云端分发时，对该设备类型下不同规格的设备进行精确分发。
• Feature：应用/服务的动态特性模块。一个APP可以包含零到多个Feature类型的HAP。只有包含Ability的HAP才能够独立运行。

基于FA模型和基于Stage模型开发的应用，应用程序包结构并不相同。

Stage模型应用程序包结构如下图所示。更多说明请参见​​应用开发基础知识中的Stage模型应用程序包结构​​。

FA模型应用程序包结构如下图所示。更多说明请参见​​应用开发基础知识中的FA模型应用程序包结构​​。

切换工程视图

DevEco Studio工程目录结构提供工程视图和HarmonyOS视图。工程创建或打开后，默认显示工程视图，如果要切换到HarmonyOS视图，在左上角单击Project > Ohos进行切换。

HarmonyOS支持API Version 4~9。HarmonyOS API Version 4~7和API Version 8~9的构建工具和构建插件不同。其中，API Version 4~7构建体系是由Gradle构建工具和构建插件组成；API Version 8~9构建体系是由Hvigor构建工具和构建插件组成。所以API Version 4~7和API Version 8~9的工程目录结构存在差异。下面按照不同开发语言分别介绍API Version 4~7和API Version 8~9的工程目录结构。

工程目录结构（API Version 8~9）

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

ArkTS Stage模型支持API Version 9，其工程目录结构如下图所示：

• entry：HarmonyOS工程模块，编译构建生成一个HAP。

      ○ src > main > ets：用于存放ArkTS源码。

      ○ src > main > ets > entryability：应用/服务的入口。

      ○ src > main > ets > pages：应用/服务包含的页面。

      ○ src > main > resources：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考​​资源文件的分类​​。

      ○ src > main > module.json5：Stage模型模块配置文件，主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。

      ○ entry >build-profile.json5：当前的模块信息、编译信息配置项，包括buildOption、targets配置等。

      ○ entry >hvigorfile.ts：模块级编译构建任务脚本。

• build-profile.json5：应用级配置信息，包括签名、产品配置等。
• hvigorfile.ts：应用级编译构建任务脚本。

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

ArkTS FA模型支持API Version 8~9，其工程目录结构如下图所示：

• entry：HarmonyOS工程模块，编译构建生成一个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：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考​​资源文件的分类​​。

      ○ src > main > config.json：模块配置文件，主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。

      ○ entry > build-profile.json5：当前的模块信息、编译信息配置项，包括buildOption、targets配置等。

      ○ entry > hvigorfile.ts：模块级编译构建任务脚本。

• build-profile.json5：应用级配置信息，包括签名、产品配置等。
• hvigorfile.ts：应用级编译构建任务脚本。

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

JS工程只支持FA模型，Hvigor工程支持API Version 8~9，其工程目录结构如下图所示：

• entry：HarmonyOS工程模块，编译构建生成一个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：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考​​资源文件的分类​​。

      ○ 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：HarmonyOS工程模块，编译构建生成一个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：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考​​资源文件的分类​​。

      ○ 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模型，Hvigor工程支持API Version 8~9，支持使用ArkTS+C++或JS+C++进行开发，其工程目录结构相似，下面将以ArkTS+C++工程为例进行介绍，其工程目录结构如下图所示。

• entry：HarmonyOS工程模块，编译构建生成一个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：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考​​资源文件的分类​​。

      ○ entry > src > main > config.json：FA模块配置文件，主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。

      ○ entry > build-profile.json5：当前的模块信息、编译信息配置项，包括buildOption、targets配置等。

      ○ entry > hvigorfile.ts：模块级编译构建任务脚本。

• build-profile.json5：应用级配置信息，包括签名、产品配置等。
• hvigorfile.ts：应用级编译构建任务脚本。

工程目录结构（API Version 4~7）

ArkTS工程目录结构

API Version 7的ArkTS工程目录结构如下图所示：

• ets > default> pages > index.ets：.ets结尾的ArkTS文件，这个文件用于描述UI布局、样式、事件交互和页面逻辑。
• ets > default > app.ets：用于应用/服务的全局逻辑和应用/服务生命周期管理。
• java目录：作为HarmonyOS应用或原子化服务的启动入口。
• resources目录：用于存放资源配置文件，比如：国际化字符串、资源限定相关资源和rawfile资源等。
• entry>src > main > config.json：模块配置文件，主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。

JS工程目录结构

API Version 4~7的JS工程目录结构如下图所示：

• java目录：作为HarmonyOS应用/服务的启动入口。
• common目录：用于存放公共资源文件，如媒体资源、自定义组件和JS文档等。
• i18n目录：用于存放多语言的json文件，可以在该目录下定义应用/服务在不同语言系统下显示的内容，如应用/服务文本词条、图片路径等，详情请参考​​多语言支持​​。
• pages目录：pages文件夹下可以包含1个或多个页面，每个页面都需要创建一个文件夹。页面文件夹下主要包含3种文件类型：css、js和hml文件。

      ○ pages>index>index.hml文件：hml文件定义了页面的布局结构，使用到的组件，以及这些组件的层级关系，详情请参考​​HML语法参考​​。

      ○ pages>index>index.css文件：css文件定义了页面的样式与布局，包含样式选择器和各种样式属性等，详情请参考​​CSS语法参考​​。

      ○ pages>index>index.js文件：js文件描述了页面的行为逻辑，此文件里定义了页面里所用到的所有的逻辑关系，比如数据、事件等，详情请参考​​JS语法参考​​。

• app.js文件：全局的JS逻辑文件和应用/服务的生命周期管理。
• resources：用于存放资源配置文件，比如：全局样式、多分辨率加载等配置文件。resources资源引用示例请参考​​根据设备分辨率加载图片​​。
• entry>src > main > config.json：模块配置文件，主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。

C++模板创建的工程目录结构

C++模板创建的Java工程（API Version 4~7）目录结构如下图所示：

• entry>src>main>cpp：用于存放C++源码。
• entry>src>main>java：用于存放Java源码。
• entry>src>main>resources：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考​​资源文件的分类​​。

• entry>src > main > config.json：模块配置文件，主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。

Java工程目录结构

API Version 4~7的Java工程目录结构如下图所示：

• .gradle：Gradle配置文件，由系统自动生成，一般情况下不需要进行修改。
• entry：默认启动模块（主模块），开发者用于编写源码文件以及开发资源文件的目录。

   ○ entry>libs：用于存放entry模块的依赖文件。

   ○ entry>src>main>java：用于存放Java源码。 

   ○ entry>src>main>java>com.example.myapplication>slice>MainAbilitySlice：承载单个页面的具体逻辑实现和界面UI。

   ○ entry>src>main>java>com.example.myapplication>MainAbility：应用/服务的入口。

   ○ entry>src>main>resources：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。关于资源文件的详细说明请参考​​资源文件的分类​​。

• entry>src > main > config.json：模块配置文件，主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。

文章转载自：​​https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/project_overview-0000001053822398-V3​​